stack module
Routers
Section titled “Routers”router→ prefix/api/method(tags: stack)
Hand-maintained notes against modules/stack/router.go. Route inventory (generated): routes.md. Response models (generated): response-models/stack.md.
Lifecycle verbs that install, uninstall, or update a deployment live in the
appmodule (shc.stack.install,shc.stack.uninstall,shc.stack.update,shc.stack.status); replicas change throughshc.stack.update’sscale_overrides. Log streaming (shc.stack.logs.stream) lives in thelogsmodule. Relocate isshc.stack.relocatein theclonemodule.
| Method | Path | Permission |
|---|---|---|
GET | /api/method/shc.stack.config | stack:manage |
GET | /api/method/shc.stack.dry_run | stack:manage |
GET | /api/method/shc.stack.inspect | stack:manage |
GET | /api/method/shc.stack.logs | stack:read |
POST | /api/method/shc.stack.exec | stack:manage |
POST | /api/method/shc.stack.restart | stack:operate |
POST | /api/method/shc.stack.start | stack:operate |
POST | /api/method/shc.stack.stop | stack:operate |
POST | /api/method/shc.container.restart | open |
GET /api/method/shc.stack.config
Section titled “GET /api/method/shc.stack.config”- source:
modules/stack/router.go
GET /api/method/shc.stack.dry_run
Section titled “GET /api/method/shc.stack.dry_run”- summary: render the compose plan for a deployment without applying it.
- source:
modules/stack/router.go
GET /api/method/shc.stack.inspect
Section titled “GET /api/method/shc.stack.inspect”- summary: one-shot bundle for the HUD Inspect panel and
shc inspect. - source:
modules/stack/router.go; the handler calls the daemon-wired Inspector atdaemon/services_seams_stack.go
StackInspectResponse is a one-shot bundle covering everything the HUD’s
Inspect panel and the shc inspect CLI need without follow-up calls.
Field inventory (generated): response-models/payload-shapes.md.
Semantics the generated table can’t carry: composed_config is the parsed
docker compose config --format json output, best-effort with a 5s
timeout (absent when compose can’t resolve); containers holds one entry
per container on the node that carries the deployment’s three shc.*
labels, whatever compose project made it (replica projects included), with
Health enriched from the metrics stats cache; health_rollup summarises containers[].Health
as healthy / starting / unhealthy / unknown / "".
GET /api/method/shc.stack.logs
Section titled “GET /api/method/shc.stack.logs”- query params:
stack_name,environment,service,tail,timestamps - source:
modules/stack/router.go
POST /api/method/shc.stack.exec
Section titled “POST /api/method/shc.stack.exec”- source:
modules/stack/router.go
POST /api/method/shc.stack.restart
Section titled “POST /api/method/shc.stack.restart”- source:
modules/stack/router.go
POST /api/method/shc.stack.start
Section titled “POST /api/method/shc.stack.start”- source:
modules/stack/router.go
POST /api/method/shc.stack.stop
Section titled “POST /api/method/shc.stack.stop”- source:
modules/stack/router.go
POST /api/method/shc.container.restart
Section titled “POST /api/method/shc.container.restart”- summary: restart a single container within a deployment.
- source:
modules/stack/router.go