Restructure top-level to exactly three .md files: - AGENTS.md (agent operating instructions) - README.md (project overview, links to status + docmap) - STATUS.md (living project status, agent-maintained, human read-only) Add docs/docmap.md as the single documentation index/map. All docs are categorized (active, operational guides, historical) with last-reviewed dates. Includes the agent gardening protocol requiring agents to update STATUS.md and docmap.md after every work session. Rewrite AGENTS.md to be lean: points to docmap.md for doc discovery, encodes the automatic gardening protocol (keep docs/code in sync, grep for stale paths after renames, update STATUS.md after infrastructure changes). All references are Gitea-renderable relative links. Simplify README.md: header links to STATUS.md + docmap.md + AGENTS.md, doc table replaced with pointer to docmap.md. 🤖 Generated with [Crush](https://github.com/charmassociates/crush) Assisted-by: GLM-5 via Crush <crush@charm.land>
49 lines
1.6 KiB
Markdown
49 lines
1.6 KiB
Markdown
# PFVCluster
|
|
|
|
Unified infrastructure repo for the Known Element Enterprises Proxmox R&D cluster.
|
|
|
|
**[→ Current Status](STATUS.md)** · **[→ Documentation Index](docs/docmap.md)** · **[→ Agent Guidelines](AGENTS.md)**
|
|
|
|
## Directory Structure
|
|
|
|
| Directory | Description |
|
|
|-----------|-------------|
|
|
| [`provisioning/`](provisioning/) | Server provisioning (SetupNewSystem.sh, security hardening, 2FA, NTP/DNS config, SNMP, Dell OMSA) |
|
|
| [`tests/`](tests/) | Test suite + VM validation harness |
|
|
| [`dns-cluster-setup/`](dns-cluster-setup/) | Technitium DNS cluster replication scripts |
|
|
| [`perf/`](perf/) | Proxmox performance tuning, fleet audit, iperf, switch diagnostics |
|
|
| [`netinfra/`](netinfra/) | pfv-netinfra-01/02 DNS/NTP setup + audit scripts |
|
|
| [`switches/`](switches/) | Switch configuration captures |
|
|
| [`docs/`](docs/) | All documentation ([see docmap](docs/docmap.md)) |
|
|
| [`vendor/`](vendor/) | Vendored KNELShellFramework |
|
|
|
|
## Quick Start
|
|
|
|
### Provision a new server
|
|
```bash
|
|
sudo bash provisioning/SetupNewSystem.sh
|
|
```
|
|
|
|
### Validate on the sandbox VM
|
|
```bash
|
|
VM_ID=6000 ./tests/vm-validation.sh all
|
|
```
|
|
|
|
### Deploy DNS cluster
|
|
```bash
|
|
cd dns-cluster-setup/ && ./setup.sh all
|
|
```
|
|
|
|
### Deploy perf tunings
|
|
```bash
|
|
cd perf/ && ./deploy-tuning.sh
|
|
```
|
|
|
|
## Architecture
|
|
|
|
- **Proxmox hosts**: 7 standalone PVE installs managed via PDM
|
|
- **DNS**: Technitium (authoritative) + Pi-hole (recursive) on pfv-netinfra-01/02
|
|
- **NTP**: pfv-netinfra-01/02 (redundant, LAN IPs, stratum 2/3)
|
|
- **Production**: Cloudron VPS in Reston VA (this cluster is R&D only)
|
|
- **Backups**: Proxmox Backup Server (PBS)
|