MakerFLOSS/scripts/overview_config.yml
sjat 4dc975062a
All checks were successful
Build docs site / build (push) Successful in 49s
Build slides / build (push) Successful in 1m11s
docs(hardware): reconcile rack01 to as-mounted layout and document cabling
Rebuild rack01 from the physically remounted hardware:
- Correct stale positions/ports/outlets for pp01, pp02, sw01, pdu01-04
- Model shelves as 1U trays (towers stand above without consuming rack U's);
  add shf02 and empty half-depth shf03/shf04
- Add ups01/ups02; reseat nas01/02 and sw02-05; move srv04-07 onto shf02
- Add `wan` hardware kind; add WAN demarcation hosts wan01 (active) and
  wan02 (staging)
- Document full live network wiring: srv01-07 -> pp02 -> sw01 (LAN) and
  srv01 eth0 -> pp02 -> pp01 -> wan01 (WAN); keep non-active lines
  (wan2, working-table patches, sw01 mgmt) in notes only
- Regenerate hardware index + rack01 elevation/network/power artifacts

Also includes the in-progress generator updates (gen_rack.py, gen_overview.py,
Makefile, tests) that the regenerated artifacts depend on.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-30 21:31:48 +02:00

74 lines
2.1 KiB
YAML

# Configuration for scripts/gen_overview.py
#
# Each top-level key is a category. The generator is invoked with
# --category <name> and looks up its block here. To add a new category
# (services, vms, ...) later, copy a block and adjust the fields.
hardware:
title: "Hardware Overview"
source_dir: docs/hardware
output_file: docs/hardware/index.md
key_field: hostname
required_fields:
- hostname
- kind
- status
enums:
kind: [server, laptop, sbc, switch, ap, desktop, pdu, patch-panel, shelf, blank, ups, kvm, wan]
status: [in-use, staging, spare, broken, donated]
storage_type: [nvme, ssd, hdd, mixed]
group_by: kind
# Human-friendly H2 names per group_by value. Anything missing falls back
# to the raw value title-cased + "s".
group_titles:
server: Servers
laptop: Laptops
sbc: Single-board computers
switch: Switches
ap: Access points
desktop: Desktops
pdu: PDUs
patch-panel: Patch panels
shelf: Shelves
blank: Blank panels
ups: UPS
kvm: KVM
wan: WAN uplinks
sort_by: hostname
columns:
- { header: Hostname, kind: key-link, field: hostname }
- { header: Location, field: location }
- { header: CPU, kind: cpu }
- { header: RAM, kind: ram }
- { header: Storage, kind: storage }
- { header: NIC, kind: nic }
- { header: Status, field: status }
services:
title: "Services Overview"
source_dir: docs/services
output_file: docs/services/index.md
key_field: name
required_fields:
- name
- kind
- status
enums:
kind: [web-app, static-site, dns, slide-builder, library, reverse-proxy, mail]
status: [in-use, staging, planned, broken, decommissioned]
group_by: kind
group_titles:
web-app: Web applications
static-site: Static sites
dns: DNS
slide-builder: Slide builders
library: Libraries
reverse-proxy: Reverse proxies
mail: Mail
sort_by: name
columns:
- { header: Name, kind: key-link, field: name }
- { header: URL, kind: url-link, field: url }
- { header: Host, field: host }
- { header: Tech, field: tech }
- { header: Status, field: status }