Skip to content
SHC Docs

Flows

Step-by-step walkthroughs of the multi-stage pipelines in SHC. Each page traces the code end-to-end, citing the actual source files and line numbers — if the code changes, these pages are expected to drift and should be updated.

These are how it actually executes docs. For the conceptual contract of a subsystem, see the corresponding module page. For how to use a feature, see the operator guide or the app-development docs.

FlowWhat it covers
install.mdshc install — the 16-step app install pipeline with its rollback contract
upgrade.mdshc update — snapshot/apply/revert with double-failure handling
uninstall.mdshc uninstall + ordered multi-stack teardown (best-effort forward)
backup-restore.mdshc backup create and restore — restic path, local .bak path, restore pipeline
clone-move.mdshc clone and shc move — the shared 8-phase pipeline and the in-place rename fast-path inside move
cluster-join.mdshc node token + shc node join — from bootstrap token to mesh-member
event-lifecycle.mdDocker event / audit event → SSE subscriber
  • A module page (“what does app own?”) is a conceptual overview. Stable. Changes when responsibilities change.
  • A flow page (“what runs when you click install?”) is a procedural trace. Less stable. Changes when the pipeline changes.

Flow pages freely link back into module pages, security, and config references — they are the glue.