titan-iac/knowledge/INDEX.md

Atlas Knowledge Base (KB)

This folder is the source-of-truth “memory” for Atlas/Titan assistants (and for humans). It is designed to be:

• Accurate (grounded in GitOps + read-only cluster tools)
• Maintainable (small docs + deterministic generators)
• Safe (no secrets; refer to Secret/Vault paths by name only)

Layout

• knowledge/runbooks/: human-written docs (short, chunkable Markdown).
• knowledge/catalog/: generated machine-readable facts (YAML/JSON).
• knowledge/diagrams/: generated Mermaid diagrams (.mmd) derived from the catalog.

Regeneration

• Update manifests/docs, then regenerate generated artifacts:
  • python scripts/knowledge_render_atlas.py --write

Authoring rules

• Never include secret values. Prefer secretRef names or Vault paths like kv/atlas/....
• Prefer stable identifiers: Kubernetes namespace/name, DNS hostnames, Flux kustomization paths.
• Keep each runbook small; one topic per file; use headings.
• When in doubt, link to the exact file path in this repo that configures the behavior.