titan-iac/knowledge/INDEX.md
jenkins 0da9e4c82d refactor: restructure services layout, retire oceanus, add aether scaffolding
- Move flat service manifests into structured subdirs (apps/, bootstrap-jobs/,
  repair-jobs/, migration-jobs/, validation-jobs/, node-ops/, networking/)
- Retire oneoffs/ directories across services
- Remove oceanus cluster and its host roles; add aether cluster + terraform scaffolding
- Reorganize scripts/ into ops/, render/, sync/, manual-tests/
- Add Makefile with render/validate/test/flux targets and repo-structure tests
- Update flux-system application CRs to the new paths
- Add hermes-automated-triage-24h-plan knowledge doc (+ comms mirror)
- Refresh knowledge catalogs, dashboards, vmalert rules, quality contract

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-08-05 16:21:36 -03:00

1.0 KiB

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/render/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.