sklpdocs

sklp deploy delete

sklp deploy delete [flags] [stack]

Description

Delete a deployed space's runtime (stop containers, remove its artifacts)

Arguments

ArgumentRequiredNotes
stackno

Flags

FlagAliasesTypeDefaultEnvDescription
--file—string——explicit path to deploy.yaml (overrides the <stack> layout resolution)
--space—stringproduction—space to delete
--repo—string.—repository root the deploy file is relative to
--v—bool——also destroy the space's named volumes — the data goes with it, irreversibly
--server-addrstring——remote supervisor control API (https://host:9443); when set, pilot it over the network instead of the local socket
--token—string——Bearer token for --server (prefer --token-file or SKLP_CONTEXT_TOKEN to keep it out of the process list)
--token-file—string——file holding the Bearer token for --server
--ca-fingerprint—string——pin the server certificate by its sha256 fingerprint (printed by the server / `sklp deploy fingerprint`)
--insecure—bool——skip TLS verification for --server (LAN bootstrap only; prefer --ca-fingerprint)
--context—string——deploy context to read server/token/ca-fingerprint from (default: the active context)
--config—string——path to a config file to read (one file per node/VM, e.g. lungor.yaml); overrides the default ~/.config/sklp/config.yaml

Technical details

Technical details

Raw command JSON

{
  "path": [
    "sklp",
    "deploy",
    "delete"
  ],
  "slug": "deploy-delete",
  "name": "delete",
  "short": "Delete a deployed space's runtime (stop containers, remove its artifacts)",
  "synopsis": "sklp deploy delete [flags] [stack]",
  "flags": [
    {
      "name": "file",
      "usage": "explicit path to deploy.yaml (overrides the <stack> layout resolution)",
      "type": "string"
    },
    {
      "name": "space",
      "usage": "space to delete",
      "type": "string",
      "default": "production"
    },
    {
      "name": "repo",
      "usage": "repository root the deploy file is relative to",
      "type": "string",
      "default": "."
    },
    {
      "name": "v",
      "usage": "also destroy the space's named volumes — the data goes with it, irreversibly",
      "type": "bool"
    },
    {
      "name": "server",
      "aliases": [
        "addr"
      ],
      "usage": "remote supervisor control API (https://host:9443); when set, pilot it over the network instead of the local socket",
      "type": "string"
    },
    {
      "name": "token",
      "usage": "Bearer token for --server (prefer --token-file or SKLP_CONTEXT_TOKEN to keep it out of the process list)",
      "type": "string"
    },
    {
      "name": "token-file",
      "usage": "file holding the Bearer token for --server",
      "type": "string"
    },
    {
      "name": "ca-fingerprint",
      "usage": "pin the server certificate by its sha256 fingerprint (printed by the server / `sklp deploy fingerprint`)",
      "type": "string"
    },
    {
      "name": "insecure",
      "usage": "skip TLS verification for --server (LAN bootstrap only; prefer --ca-fingerprint)",
      "type": "bool"
    },
    {
      "name": "context",
      "usage": "deploy context to read server/token/ca-fingerprint from (default: the active context)",
      "type": "string"
    },
    {
      "name": "config",
      "usage": "path to a config file to read (one file per node/VM, e.g. lungor.yaml); overrides the default ~/.config/sklp/config.yaml",
      "type": "string"
    }
  ],
  "positionals": [
    {
      "name": "stack",
      "required": false
    }
  ]
}

See also