Files
PFVCluster/docs/docmap.md
T
mrcharles 8f1642bf96 feat(k8s): deploy 3-node k3s HA control plane over Tailscale
Bootstrap a regular (non-ITAR) k3s cluster on cnode1/2/3 with embedded
etcd. All cluster communication — node registration, API server, etcd
peering, flannel VXLAN — runs exclusively over Tailscale IPs. Zero LAN
addresses appear in node status or TLS certificates.

Scripts (k8s/):
- env.sh: shared config (Tailscale IPs, SSH opts, k3s version)
- wipe.sh: remove existing k3s from all cnodes
- install-cp.sh: full bootstrap (cnode1 --cluster-init, then cnode2/3 join)
- join-servers.sh: re-join cnode2/3 only (fixes broken join state)
- post-setup.sh: apply NoSchedule taints, fetch kubeconfig, verify
- verify.sh: 13-point health check (nodes, Tailscale IPs, taints, etcd,
  CoreDNS, API server, workload isolation)
- probe-nodes.sh: SSH + Tailscale reachability check

All 3 cnodes are tainted control-plane:NoSchedule so no user workloads
can schedule on the control plane. 13/13 health checks pass.

Docs updated: k8s README TL;DR reflects k3s (not Talos) as the deployed
choice, with Talos preserved for the future ITAR cluster.

💘 Generated with Crush

Assisted-by: Crush:glm-5.2
2026-07-28 12:21:33 -05:00

5.4 KiB

Documentation Map

Index of all documentation in this repo. Agents must update this file whenever a doc is added, removed, or substantively changed.

Last updated: 2026-07-28

Kubernetes Architecture (k8s/)

Distro decision, target architecture, control-plane design, bootstrap and DR procedures for the pfv-k8s cluster (Talos + vcluster + Keycloak OIDC).

Document Description Last Reviewed
k8s/README.md Index + TL;DR of all k8s decisions 2026-07-28
k8s/DISTRO-DECISION.md Talos vs k3s analysis. Recommendation: Talos, driven by ITAR/classified requirement 2026-07-28
k8s/ARCHITECTURE.md Target architecture: control plane, network, identity, storage, tenant isolation, bootstrap, DR. Mermaid diagrams 2026-07-28

Proxmox Cluster (proxmox/)

Fleet operations, hardware, performance tuning, storage architecture.

Document Description Last Reviewed
proxmox/PROJECT.md Comprehensive fleet report: 7 hosts, VM inventory, storage, recommendations 2026-07-27
proxmox/TODO.md Pending physical hardware work (tsys2/4/5 Friday plan) 2026-07-27
proxmox/K8S.md Kubernetes storage/host analysis (predecessor to k8s/) 2026-07-27

Server Build (server-build/)

Server provisioning, security hardening, DNS/NTP configuration.

Document Description Last Reviewed
server-build/SECURITY.md Security architecture: SSH hardening, 2FA, SCAP-STIG, Wazuh, auditd 2026-07-25
server-build/tailscale.md Tailscale vs managed DNS analysis (RESOLVED — netinfra pair serves knel.net) 2026-07-28
server-build/DEPLOYMENT.md Server deployment procedures, package lists, config flow 2026-07-25
server-build/TSYS-2FA-GUIDE.md End-user guide for 2FA setup (SSH, Cockpit, Webmin) 2026-07-25
server-build/DEVELOPMENT-GUIDELINES.md Coding standards, commit conventions, script patterns 2026-07-25

Operational Guides (outside docs/)

Document Description Last Reviewed
../k8s/README.md k3s cluster setup scripts: wipe, bootstrap, taint, verify (3-node HA over Tailscale) 2026-07-28
../dns-cluster-setup/README.md Technitium DNS cluster setup: export, deploy, cluster, verify 2026-07-28
../tests/README.md Test suite documentation: unit, security, validation tests 2026-07-28
../netinfra/pfv-netinfra-setup.md pfv-netinfra-01/02 initial setup guide 2026-07-27
../netinfra/pfv-netboot-setup.md pfv-netboot reference node setup 2026-07-27

Archive (archive/)

Historical AI reviews, completed task lists, and pre-refactor examples. Read-only context — do not update; link to active docs instead.

Document Description
archive/CODE-REVIEW-FINDINGS.md Early code review findings (most issues now fixed)
archive/REFACTORING-EXAMPLES.md Pre-refactor code patterns (historical "before" examples)
archive/Claude-Review.md Claude's initial code review
archive/AIReview-QWEN.md Qwen AI review
archive/AiOverview-Gemini.md Gemini project overview
archive/AiOverview-OpenCode.md OpenCode project overview
archive/AiSecurityAudit-Gemini.md Gemini security audit
archive/charles-todo.md Charles's early task list (completed)
archive/claude-todo.md Claude's early task list (completed)

Top-Level Files

File Description
../AGENTS.md Agent operating instructions (repo layout, git policy, gardening protocol)
../STATUS.md Living project status (agent-maintained, human read-only)
../README.md Project overview and quick start
../LICENSE License

Agent Gardening Protocol

When making changes to this repo, agents MUST:

  1. Update ../STATUS.md if the work changes infrastructure state, completes/starts a task, or discovers a new issue.
  2. Update this file (docmap.md) if a doc is added, removed, or has a substantive content change. Update the "Last Reviewed" date.
  3. Verify cross-references — any new .md file must be linked from at least one existing doc or this map.
  4. Check for stale paths — after any directory rename or file move, grep -rn 'old/path' --include='*.md' and fix all references.
  5. Keep code and docs in sync — if you change a script's interface, behavior, or location, update every doc that references it in the same commit.