vh
4971e5ad41
- services.yaml: PFI-UDMSE (10.100.0.1, NH3 edge) under Infra - NH3, ESH-UDMPM (10.0.0.1) under Infra - ESH. PFI-UDMSE replaces the retired Fortigate 101F at NH3 — comment updated. Both use si-ubiquiti. Diff also folds in the previously-deployed-but-uncommitted PBS-ANA / PBS-NH3 / IRV section / retired NH3-SW1 cleanup, bringing the tracked copy in sync with what's live on esh-docker-vm. - docs/README.md: navigation map of the docs/ tree (orientation / runbooks / pfi) with what-goes-where conventions. - docs/runbooks/tea-0.14.0-linux-amd64.sha256: deleted (build artifact, not a runbook). - STATUS.md: items 11 / 13 / 15 marked done; 15 leaves Matrix and chromadb consolidation candidates as future focused-session work.
54 lines
2.2 KiB
Markdown
54 lines
2.2 KiB
Markdown
# docs/
|
|
|
|
Navigation map for the documentation tree. New session? Read
|
|
[`orientation.md`](orientation.md) first — it's the narrative overview
|
|
of the fleet, backup architecture, governing principles, and gotchas,
|
|
and it points at everything else.
|
|
|
|
## Tree
|
|
|
|
```
|
|
docs/
|
|
├── orientation.md # start here — fleet overview + where-to-look guide
|
|
├── runbooks/ # ops runbooks (recovery, deployment phases)
|
|
│ ├── disaster-recovery.md
|
|
│ └── pbs-deployment.md
|
|
└── pfi/ # PFI-specific reference (services, models, VMs)
|
|
├── chromadb-setup.md
|
|
├── docker-stack.md
|
|
├── model-list.md
|
|
├── proxmox-vms.md
|
|
├── recommended-model-settings.md
|
|
├── vm-102-matrix-appservice.md
|
|
└── vm-102-matrix-synapse.md
|
|
```
|
|
|
|
## What goes where
|
|
|
|
- **`runbooks/`** — step-by-step ops procedures. Anything you'd reach
|
|
for during an incident or while standing up new infrastructure.
|
|
Examples: disaster recovery (blast-radius tiers + restoration steps),
|
|
PBS deployment (9-phase rollout). New runbook → new file here.
|
|
- **`pfi/`** — PFI-specific reference material that's too narrow for the
|
|
top-level CLAUDE.md but doesn't change incident response. AI model
|
|
inventory, recommended inference settings, Matrix bridge config,
|
|
Proxmox VM map. New stable reference → new file here.
|
|
- **Top-level (`docs/orientation.md`, `docs/README.md`)** — narrative
|
|
guides about the workspace itself, not about specific infra.
|
|
|
|
## Cross-references
|
|
|
|
- Fleet topology + servers table: top-level [`CLAUDE.md`](../CLAUDE.md).
|
|
- Open work + recent milestones: top-level [`STATUS.md`](../STATUS.md).
|
|
- Durable cross-session facts: `~/.claude/projects/-home-lkraven-development-eshpfi-management/memory/`.
|
|
|
|
## Conventions
|
|
|
|
- Markdown, GitHub-flavored. CommonMark renders fine in most viewers.
|
|
- File names are lowercase-kebab-case, descriptive. No dates in
|
|
filenames — git history covers that.
|
|
- One topic per file. If a file grows past ~500 lines, look for a
|
|
natural split before adding more.
|
|
- No checked-in binaries or checksums. Build/release artifacts belong
|
|
in a build pipeline or `tools/`, not `docs/`.
|