suble.yml reference

name: web                      # instance hostname (lowercase, digits, hyphens)
plan: BXS.s1                   # plan code — see the dashboard catalog

# --- source: pick exactly one -------------------------------------------------
image: ghcr.io/me/app:1.4.2    # build: | image: | app: | os: | template:

# --- container ----------------------------------------------------------------
env:
  NODE_ENV: production
  DATABASE_URL: ${DATABASE_URL}         # ${VAR} expands from your shell/CI at deploy
  STRIPE_KEY: "%{project.stripeKey}%"   # %{project.NAME}% = a shared Suble variable
volumes:
  - "data:/var/lib/app"           # named volumes persist across redeploys
resources:
  cpus: "0.5"                     # CPU share (e.g. 0.5, 2)
  memory: 512m                    # memory limit (e.g. 512m, 1g)
expose:
  domain: app.example.com         # ingress + automatic Let's Encrypt TLS
  port: 8080

# --- deploy: how re-deploys roll out -----------------------------------------
deploy:
  strategy: rolling               # rolling (default) | canary | blue-green | immediate
  replicas: 3                     # load-balanced copies (requires expose:)
  max_unavailable: 1              # replicas cycled per batch (rolling/canary) — 1 or "25%"
  drain: 10                       # seconds to let an old container finish before it's stopped
  keep: 3                         # image versions kept on the VM for `suble rollback` (older pruned)
  healthcheck:
    type: http                    # docker (default) | http | tcp
    path: /healthz
    port: 8080                    # inferred from expose:/ports: if omitted
    status: 200
    initial_delay: 5              # wait before the first probe (slow boot)
    interval: 3                   # seconds between probes
    retries: 10                   # failed probes tolerated before aborting
    timeout: 60                   # overall deadline to become healthy

firewall: smart                   # off | smart | strict
networks: ["my-net"]
backup: basic                     # none | basic | extended

# a DIFFERENT repo — same cluster "shop", its own service, its own pipeline.
name: api
service:
  cluster: shop
  image: registry.suble.io/acme/api:2.1.0
  port: 8080
  replicas: 2
  domain: api.example.com

# an internal worker — no domain, so it isn't exposed by the LB
# (still reachable from the other services inside the cluster).
name: worker
service:
  cluster: shop
  image: registry.suble.io/acme/worker:2.1.0
  port: 9000
  replicas: 2

# a raw-TCP service — a non-HTTP protocol published straight through the LB.
# protocol: tcp + listenPort ⇒ HAProxy forwards raw TCP to your containers (no domain, no TLS
# termination — your app does its own TLS). For game servers, brokers, custom protocols, etc.
name: game
service:
  cluster: shop
  image: registry.suble.io/acme/game-server:1.0
  port: 25565           # the container's port
  replicas: 3
  protocol: tcp
  listenPort: 25565     # the external LB port clients connect to (not 80/443)

# .github/workflows/deploy.yml — deploy this repo's service on every push to main.
name: Deploy to Suble
on:
  push:
    branches: [main]
jobs:
  deploy:
    runs-on: ubuntu-latest   # runners have Docker, so `build:` works
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      # A project API key authenticates the CLI (no browser). `update` is non-interactive:
      # it builds + pushes (if build:) and reconciles the service into the cluster.
      - run: npx @suble/cli@latest update
        env:
          SUBLE_API_KEY: ${{ secrets.SUBLE_API_KEY }}
          SUBLE_PROJECT: ${{ vars.SUBLE_PROJECT }}   # or set project: in suble.yml

# .gitlab-ci.yml
deploy:
  image: node:20
  services: [docker:dind]      # build runs against Docker-in-Docker
  variables:
    DOCKER_HOST: tcp://docker:2375
  script:
    - npx @suble/cli@latest update
  # SUBLE_API_KEY + SUBLE_PROJECT set as masked CI/CD variables
  rules:
    - if: $CI_COMMIT_BRANCH == "main"

# No file needed — manage a cluster's services straight from the CLI:
suble cluster create shop --size BXS.s1 --replicas 3 --ha
suble cluster service add shop web --image nginx:1.27 --port 80 --replicas 3 --domain app.example.com
suble cluster service add shop api --image ghcr.io/acme/api:2.1 --port 8080 --replicas 2
suble cluster service scale shop api --replicas 4
suble cluster service deploy shop web --image nginx:1.29   # rolling, one at a time
suble cluster show shop
suble cluster service rm shop worker