sklpdocs

sklet apply

sklet apply [flags] [stack]

Description

Apply a stack from .sklp/<stack>/deploy.yaml on this node

Arguments

ArgumentRequiredNotes
stackno

Flags

FlagAliasesTypeDefaultEnvDescription
--space—stringproduction—space to deploy (named or ephemeral)
--repo—string.—repository root the deploy file is relative to
--foreground—bool——run the supervisor in the foreground (Ctrl-C to stop) instead of detaching (systemd --user, or setsid when unavailable); debug use
--listen—string——also expose the control API on this TCP address (e.g. :9443) over TLS + a Bearer token, for remote piloting without SSH; the local socket is always served
--force—bool——adopt a space already deployed by a DIFFERENT stack (else the cross-stack re-apply is refused to avoid reconciling away the owner's services)
--gateway-mode—stringsingleton—front door for this LOCAL node: per-space (native mux on :9080/:9443) or singleton (legacy traefik); a control-plane node instead uses `sklet agent --gateway-mode`

Technical details

Technical details

Raw command JSON

{
  "path": [
    "sklet",
    "apply"
  ],
  "slug": "apply",
  "name": "apply",
  "short": "Apply a stack from .sklp/<stack>/deploy.yaml on this node",
  "synopsis": "sklet apply [flags] [stack]",
  "flags": [
    {
      "name": "space",
      "usage": "space to deploy (named or ephemeral)",
      "type": "string",
      "default": "production"
    },
    {
      "name": "repo",
      "usage": "repository root the deploy file is relative to",
      "type": "string",
      "default": "."
    },
    {
      "name": "foreground",
      "usage": "run the supervisor in the foreground (Ctrl-C to stop) instead of detaching (systemd --user, or setsid when unavailable); debug use",
      "type": "bool"
    },
    {
      "name": "listen",
      "usage": "also expose the control API on this TCP address (e.g. :9443) over TLS + a Bearer token, for remote piloting without SSH; the local socket is always served",
      "type": "string"
    },
    {
      "name": "force",
      "usage": "adopt a space already deployed by a DIFFERENT stack (else the cross-stack re-apply is refused to avoid reconciling away the owner's services)",
      "type": "bool"
    },
    {
      "name": "gateway-mode",
      "usage": "front door for this LOCAL node: per-space (native mux on :9080/:9443) or singleton (legacy traefik); a control-plane node instead uses `sklet agent --gateway-mode`",
      "type": "string",
      "default": "singleton"
    }
  ],
  "positionals": [
    {
      "name": "stack",
      "required": false
    }
  ]
}

See also