From 3103c3458bec7d28f427679803a307f8ee01d40a Mon Sep 17 00:00:00 2001 From: blaipr Date: Mon, 26 Oct 2026 09:17:23 +0100 Subject: [PATCH] docs: describe the config layout without naming other tools --- README.md | 2 +- docs/configuration.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 284db56..4a36c9c 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/configuration.md b/docs/configuration.md index 810dc3c..a5b30b3 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -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. @@ -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).