Ensure configuration documentation and validation rules match the real runtime contract: types/structures, default values, actual scope, and when validation happens.
Apply these checks to every configurable field: 1) Type/shape must support the operational use-case
// Prefer multi-value matching to support canary/prod-blue/prod-green without extra keys
"discovery_args": {
"metadata_match": {
"env": ["canary", "prod-blue", "prod-green"],
"version": ["v1", "v2"]
}
}
2) Be explicit about validation bypass vs runtime resolution
Use $secret://... or $env://... in plugin string fields.
Schema constraints apply to the resolved value at runtime, not during config loading.
3) Document true blast radius (shared/core toggles)
4) Align documented defaults with code
This prevents configuration drift, misleading docs, and rollout-time surprises—especially for environment-specific settings and feature flags.
Enter the URL of a public GitHub repository