Skip to content
SHC Docs

Reference

Exhaustive lookup for when you know what you’re searching for. Audience: anyone consulting the spec of a command, endpoint, config key, error code, or term.

For prose walkthroughs, see ../guide/. For internals, see ../architecture/.


Every shc command, grouped by subcommand. Pages are hand-written where prose adds value; auto-generated from the command classes otherwise.

  • Overview: global flags, output formats, exit codes
  • CLI symbols: what = : @ / + ! , mean inside a flag’s value, and the --expose and --scale grammars
  • Labels and selectors: node labels, the selector grammar, --where and --prefer, named node selectors and constraints
  • Published ports: how a deployment is reached from outside on next, the --expose grammar, the listen rules, and the refusals

Core operator commands (hand-written):

Auto-generated from command classes:

Endpoints exposed under /api/method/* and /api/resource/*. The exhaustive per-module (method, path) inventory is the generated HTTP route reference; regenerate with make docs/generate. The pages below add hand-maintained request/response notes for the major operator modules; modules without a dedicated page (auth, ca, dns, doctor, user, …) are still fully listed in the route reference.

  • Config files: file formats, scopes, precedence

  • Config keys: every key in default.yaml with its default

  • Token lifespans: the 4 h access token default, the idle-timeout interaction, revocation lag

  • Environment variables: SHC_* env overrides

  • File locations: where SHC stores data, logs, cache

  • The SSO display-name var: keycloak.displayName / saml.displayName, the catalogue-wide name for the login-page label, why its value is the provider noun, and the two apps that do not fit

  • The resource model on next: CPU, memory and disk per service, per scope, per volume and per node, each line marked built, partly built or not built, with the code that does it

  • Quota model: caps versus derivation: the two mechanisms that share the word “quota”, which one gives every container its limits, which one enforcement checks against, the ratio defaults and what null in default.yaml means, plus the measured state of both production estates

Operational timeouts are role-named keys under the timeouts: section of default.yaml (e.g. timeouts.keycloak, timeouts.backup, timeouts.drain), read via core/timeouts.

Provisioning and driving a cluster as code: the custom shc provider, the core + shc/<cloud> module library, and ~18 per-substrate examples.

  • Adapter reference: every platform adapter with its declared load/migrate capabilities (auto-generated)
  • Platform support: which host OSes SHC supports, exactly which subsystems refuse off Linux, and the coded error each raises
  • Runtime exceptions: the one list of gaps where an app sees a runtime differ from docker, each with its ticket and the apps that live with it
  • Init-time decisions: every decision fixed at shc init or at node join, classified HARD / SOFT / CHANGEABLE / LOSSY, with what each one costs to change
  • The address block: the one IPv4 block every SHC range is carved from, the four ranges it gives, and what to do on a site that already uses them
  • Legacy and breaking changes: every breaking change since v0.0.14 grouped by who feels it (and which ones shipped unannounced), plus every legacy, dead and never-implemented path still in the tree, classified and ranked by what it costs to keep