Skip to content

Creating Your Website

SPAship operator is declarative way of deployment so you need to describe your desired environments and what components are deployed under specific contexts.

Create Website Manifest

Example of website.yaml file

apiVersion: v1

# Environments
envs:
  dev:
    branch: main                       # dev git branch (can be git tag)
  prod:
    branch: prod                       # prod git branch (can be git tag e.g. "1.0.0")
    deployment:
      replicas: 2                      # per environment deployment configuration

# List of Website Components / Blocks
components:
  - context: /theme                    # URL context of website shared component
    kind: git
    spec:
      url: https://github.com/spaship/spaship-examples.git
      dir: /websites/01-simple/theme   # sub directory within git repo
  - context: /                         # URL context of main SPA
    kind: git
    spec:
      url: https://github.com/spaship/spaship-examples.git
      dir: /websites/01-simple/home

Push it into your git repo

git add website.yaml
git push

Reference

See Website Specification for more details.