Patterns icon
Pattern guide

Reference Config

Define a canonical reference configuration as the source of truth.

Intent

Use a canonical reference configuration as the source of truth for validation and enforcement.

When to use

  • Multiple environments must stay aligned.
  • Compliance requires a clear baseline.
  • Automation needs a definitive desired state.

Core mechanics

  • Define the reference config and schema.
  • Store it in version control.
  • Compare live state to the reference and apply deltas.

Implementation checklist

  1. Document the reference config and schema.
  2. Version the reference in the repo.
  3. Define environment overrides explicitly.
  4. Build validation and diff checks.
  5. Schedule regular compliance reviews.

Failure modes and mitigations

  • Outdated reference -> review on a defined cadence.
  • Hidden overrides -> document and enforce override rules.
  • Manual edits -> detect drift and alert.

Observability and validation

  • Diff counts and compliance status per target.
  • Last reviewed date and version.

Artifacts

  • Reference config file.
  • Schema documentation.
  • Diff report.
Seen in production

Seen in production as

Atlas project

PrivateGPTConf/env/default

Ship a known-good PrivateGPT configuration snapshot that the setup scripts can copy into a local installation. Provide default settings.yaml …

Related

Related patterns