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.
| Flow | What it covers |
|---|---|
| install.md | shc install — the 16-step app install pipeline with its rollback contract |
| upgrade.md | shc update — snapshot/apply/revert with double-failure handling |
| uninstall.md | shc uninstall + ordered multi-stack teardown (best-effort forward) |
| backup-restore.md | shc backup create and restore — restic path, local .bak path, restore pipeline |
| clone-move.md | shc clone and shc move — the shared 8-phase pipeline and the in-place rename fast-path inside move |
| cluster-join.md | shc node token + shc node join — from bootstrap token to mesh-member |
| event-lifecycle.md | Docker event / audit event → SSE subscriber |
When to use this section vs. module pages
Section titled “When to use this section vs. module pages”- A module page (“what does
appown?”) 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.
shc@docs:~$