Files
PFVCluster/docs/docmap.md
T
mrcharles fa0c77fb58 fix(console): switch conman from ser2net-telnet to direct serial access
The ser2net layer between conman and the serial devices was causing
stair-stepping in terminal output. conman's dev="host:port" uses telnet
protocol, but ser2net's accepter was raw TCP (no telnet mode). The telnet
NVT state machine in conman was stripping bare CR characters from device
output — particularly from Dell switches that use old-style \n\r (LF+CR)
line endings instead of standard \r\n. In telnet, a bare \r not followed
by \n or NUL is non-compliant and gets dropped, leaving bare \n that
causes stair-stepping in the raw-mode terminal.

Fix: conman now opens serial devices directly via the stable udev
symlinks (/dev/consoles/<name>) with seropts, eliminating the telnet
layer entirely. ser2net is stopped and disabled but remains installed
for emergency TCP access (documented workflow: stop conmand, start
ser2net, use telnet, then reverse).

Architecture change:
  Before: device → serial → ser2net (raw TCP) → conman (telnet NVT) → terminal
  After:  device → serial → conman (direct) → terminal

Verified: 7/7 serial devices held by conmand, 7/7 log files capturing,
all \r bytes preserved in terminal output (confirmed via PTY capture).

💘 Generated with Crush

Assisted-by: Crush:glm-5.2
2026-07-29 18:29:31 -05:00

6.3 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-29 (DHCP migration)

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/docs/README.md Index + TL;DR of all k8s decisions 2026-07-28
k8s/docs/DISTRO-DECISION.md Talos vs k3s analysis. Decision: k3s for regular R&D cluster; Talos preserved for future ITAR/classified 2026-07-28
k8s/docs/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/docs/PROJECT.md Comprehensive fleet report: 7 hosts, VM inventory, storage, recommendations 2026-07-27
proxmox/docs/CAPACITY-GOALS.md Authoritative capacity targets (80% RAM, ~50% idle CPU) + workload placement model (compute / RackRental / infra) 2026-07-29
proxmox/docs/AUDIT-2026-07-29.md Current & only audit. Consolidated RAM/CPU + HDD disk placement with corrected storage topology, current/target inventory, action checklist 2026-07-29
proxmox/docs/TODO.md Pending physical hardware work (tsys2/4/5 Friday plan) 2026-07-27
proxmox/docs/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
../netinfra/dhcp-migration.md DHCP migration: pfv-netboot → netinfra-01/02 (ISC failover-peer, COMPLETE) 2026-07-29
../powerman/README.md Cyclades PM10i PDU management via powerman on pfv-tsys1 2026-07-28
../console/README.md Serial console management (conman direct-serial) for 7 network switches on pfv-tsys4 2026-07-29
../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.