0027 (ADR-005): The YAML file is the source of truth #32

New issue

Open

opened 2026-09-30 10:10:46 -03:00 by marcos-mendez · 0 comments

marcos-mendez commented

2026-09-30 10:10:46 -03:00

(Migrated from github.com)

Decision (maintainer, 2026-09-30). Every installation, simple or advanced, manual or automated, emits a complete YAML with everything discovered and chosen, explicit defaults included. It is the documentation and the advanced interface; one answer file replicates many installations. It is re-emitted after every upgrade (0039).

Handbook: docs/decisions/0027-the-yaml-file-is-the-source-of-truth.md (handbook#26)

Amends: brief section 5.2 (the instance spec is also written back, complete), 0009 (explicit defaults remove "absent means default" ambiguity, the class of keel#46), 0020 (the file records the installation role, not the elected one).

First tasks

keel command that renders the full spec with defaults from what inspect reads, and a test that re-applying it is a no-op.
Emit it at the end of first boot in every mode (simple, cloud simple, cloud advanced).

**Decision (maintainer, 2026-09-30).** Every installation, simple or advanced, manual or automated, emits a complete YAML with everything discovered and chosen, explicit defaults included. It is the documentation and the advanced interface; one answer file replicates many installations. It is re-emitted after every upgrade (0039). **Handbook:** `docs/decisions/0027-the-yaml-file-is-the-source-of-truth.md` (handbook#26) **Amends:** brief section 5.2 (the instance spec is also written back, complete), 0009 (explicit defaults remove "absent means default" ambiguity, the class of keel#46), 0020 (the file records the installation role, not the elected one). **First tasks** - [ ] `keel` command that renders the full spec with defaults from what inspect reads, and a test that re-applying it is a no-op. - [ ] Emit it at the end of first boot in every mode (simple, cloud simple, cloud advanced).