Skip to content

docs: describe the config layout without naming other tools #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
blaipr merged 1 commit into from
Oct 26, 2026
Merged

docs: describe the config layout without naming other tools #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ network, and a change made by hand on a system shows up as drift.
- **Self-describing connectors**: a script says what it manages, each type's key and what goes first
- **One application, one system**: its address and credentials live in config, never in git
- **Run history**: which commit was applied, when, and the result of every operation
- **Config as code, AWX style**: one item per file, any folders; `name` is the identity
- **Config as code**: one item per file, any folders; `name` is the identity
- **Strict validation**: a typo in desired state or config fails before any system is touched
- **Web UI and LDAP sign-in**: the same UI family and sign-in as unified-api, on its own address
- **Secrets from Vault or env**, metrics for Prometheus, live config reload, single binary
Expand Down
6 changes: 3 additions & 3 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Configuration

Everything is YAML in one directory (`CONFIG_DIR`, default `./config`), laid out the way AWX config
as code is: `config.yaml` at the root holds the server settings, and every other `*.yaml` / `*.yml`
Everything is YAML in one directory (`CONFIG_DIR`, default `./config`), one item per file:
`config.yaml` at the root holds the server settings, and every other `*.yaml` / `*.yml`
file, at any depth, holds items under a typed top-level key. Parsing is strict: an unknown key fails
startup naming the file and the key. `unified-gitops --check-config` validates the directory exactly
as startup does, and exits.
Expand Down Expand Up @@ -36,7 +36,7 @@ as startup does, and exits.
read as an application.
- **One item per file is the convention**, not a rule: a file may hold several items, of several
types. A `name` defined twice is an error naming both files.
- **`name` is the identity**, as in AWX: what other items reference, what the API and the state
- **`name` is the identity**: what other items reference, what the API and the state
directory use. Letters, digits, `-`, `_` and `.`. `description` is optional, for people.
- **References drop the `_id`:** `connector`, `project`, `credential`, `credentials`.
- Hidden files and folders are skipped; symlinks are followed (a ConfigMap mount is links).
Expand Down
Loading