veronica
f0d2dd9920
Applies the document contract from
docs/plans/2026-08-20_stack-docs-flatten-and-alignment.md section 3, partially:
`kind` and `status` only. `parent` is deliberately held until the flatten in
section 4 lands, so that 127 documents do not have to be re-pointed by hand
when docs/fleet/NORTH_STAR.yaml moves to docs/NORTH_STAR.yaml.
Scope, measured on origin/next at 63069149:
127 live docs = all *.md under docs/ minus docs/archive/ minus docs/_old_structure/
104 stamped here
19 held operator judgement (plan section 9), worklist in the same PR
3 held the SUPERSEDED TASKS.md stamps, which cite the moving path
1 untouched docs/fleet/FLEET-DOCTRINE.md, already stamped in W1
Kinds applied: 54 guide, 34 record, 9 spec, 6 tracking, 1 projection.
Every row carries a confidence and a one-line rationale in the worklist.
Two collisions with the existing state, both flagged rather than resolved:
1. docs/README.md:150-160 already documents a front-matter convention
(title/type/audience/status/source_of_truth) with its own allowed values.
It is applied to 4 of 127 files. Its `status` vocabulary is
current|draft|deprecated|historical; the new contract's is active|superseded-by.
The key collides. This commit lets the new contract win and rewrites
`status: current` to `status: active` on those 4 files, keeping their other
legacy keys untouched. No code reads any of them: `git grep source_of_truth`
outside docs/ returns nothing. docs/README.md still prescribes the old
convention and is an operator row, so it is not edited here.
2. Two of the plan's 20 operator rows are YAML files, not markdown
(docs/fleet/examples/roster-v2.yaml, docs/openapi-tess.yaml), and the
contract's front-matter form has no defined meaning for a .yaml document.
That gap also applies to docs/fleet/NORTH_STAR.yaml, the source of truth
itself. Raised in the worklist.
A third row from the plan, docs/fleet/north-star.md, no longer exists: W1
renamed it to docs/fleet/FLEET-DOCTRINE.md.
Verification: 104/104 parse with the expected kind and status in front matter;
the check was shown to reject a wrong kind before it was trusted. The diff
removes 4 lines total, all of them `status: current`.
46 lines
1.9 KiB
Markdown
46 lines
1.9 KiB
Markdown
---
|
|
kind: guide
|
|
status: active
|
|
---
|
|
|
|
# Fleet Configuration Backup and Restore Boundary
|
|
|
|
**Issue:** #758 · **Card:** FCM-M4-001
|
|
|
|
This page defines evidence that must exist before a roster v1-to-v2 cutover. FCM-M4-001 lists these
|
|
prerequisites in non-executable recovery evidence but does not validate that backups exist and performs
|
|
no backup, migration, canary, or restore. FCM-M4-002 owns the executable reversible canary and rollback
|
|
gates.
|
|
|
|
## Preserve before cutover
|
|
|
|
- The authoritative v1 roster, byte-for-byte, with a SHA-256 identity.
|
|
- Existing per-agent legacy `.env`, strict `.env.local`, and quarantine files under private
|
|
permissions.
|
|
- Reviewed per-local-agent systemd and exact-socket tmux observations.
|
|
- The canonical v2 candidate and its SHA-256 identity.
|
|
- Inventory-only remote agents and connector configuration as evidence, not local control-plane input.
|
|
|
|
`.env.generated` is a rebuildable projection and is not restored as authority. It must be regenerated
|
|
from the selected authoritative roster. `.env.local` is operator-owned strict data and must not be
|
|
overwritten or absorbed into generated output. Quarantined source remains private evidence; public
|
|
diagnostics expose only rule code, key name, and SHA-256.
|
|
|
|
## Restore requirements
|
|
|
|
A later rollback implementation must restore the authoritative roster and operator-owned environment
|
|
files, regenerate managed projections, and preserve each reviewed pre-cutover stopped/running state.
|
|
It must never start an agent observed stopped and must never reconcile an inventory-only remote or
|
|
connector entry.
|
|
|
|
The preview evidence deliberately records:
|
|
|
|
- executable: false;
|
|
- required backup artifacts;
|
|
- source and candidate identities;
|
|
- lifecycle observations and resulting desired states;
|
|
- environment relocation/quarantine dispositions;
|
|
- FCM-M4-002 as the executable rollback gate owner.
|
|
|
|
Do not interpret a ready preview as a completed backup, migration, canary, or rollback.
|