cfgdriftdocs

Tutorials / Gallery

Three reproducible end-to-end demos. Each lives in the repository under docs/gallery/ with a README.md (scenario + steps + expected output), a run.sh (idempotent, one-shot reproduction), baseline/config files, and an expected_output.txt. No demo server is needed — everything runs locally against real cfgdrift CLI commands.

Demo 1 — nginx config drift
Plugin parser (mydsl) + range constraint + remediation hint + key-level self-healing.
 Demo 2 — K8s ConfigMap simulation
Multi-environment compare + correlation constraint + sensitive-value masking.
 Demo 3 — CI gate
Exit-code 0/1/2 contract + JSON report + single-file offline HTML artifact.

How to run

# from the repository root (any Python 3.8+)
bash docs/gallery/nginx/run.sh
bash docs/gallery/configmap/run.sh
bash docs/gallery/ci-gate/run.sh

Each script is set -euo pipefail, idempotent, and uses a scratch working directory so your ~/.cfgdrift data stays untouched (override with CFGDRIFT_HOME).