sjat/MakerFLOSS
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
MakerFLOSS/docs/hardware/index.md

68 lines
2.6 KiB
Markdown
Raw Permalink Normal View History

feat(docs): MkDocs Material site + auto-generated hardware overview Bootstraps an MkDocs Material documentation site (rendered to docs.makerfloss.eu by the Forgejo Actions runner). The first feature is an auto-generated hardware overview built from per-host YAML frontmatter blocks under docs/hardware/. - mkdocs.yml, requirements.txt: MkDocs Material 9.5 + pyyaml - Makefile: docs-index | docs-build | docs-serve | docs-check - scripts/gen_overview.py: stdlib + pyyaml generator, deterministic and offline. Reads scripts/overview_config.yml — category-driven so services/vms can plug in later without touching the script. - scripts/overview_config.yml: hardware schema and index layout - docs/hardware/{makerfloss,fisi,tembo}.md: 3 sample entries - docs/hardware/index.md: GENERATED, committed (CI fails on drift) - docs/index.md: site landing page - .forgejo/workflows/docs.yml: drift-check + mkdocs build --strict + rsync site/ to /srv/docs-makerfloss/html on push to main - .gitignore: site/, .venv, __pycache__ Schema: - hostname, kind, status (required; kind/status are enums) - model, location, cpu, cpu_cores, cpu_threads, ram_gb, storage_gb, storage_type (enum), storage_notes, nic_gbps (all optional) - Filename stem MUST equal hostname (enforced by generator) - Extra optional fields are accepted silently and live on the per-page Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-17 21:10:58 +02:00
# Hardware Overview
_Auto-generated from `docs/hardware/*.md` — do not edit by hand. Run `make docs-index` after changing a file._
feat(rack): populate provisional network topology (sw01, pp01, links) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-24 15:09:02 +02:00
## Patch panels
| Hostname | Location | CPU | RAM | Storage | NIC | Status |
|---|---|---|---|---|---|---|
| [pp01](pp01.md) | | | | | | in-use |
added all devices to rack
2026-06-29 22:27:52 +02:00
| [pp02](pp02.md) | | | | | | in-use |
feat(rack): populate provisional network topology (sw01, pp01, links) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-24 15:09:02 +02:00
feat(rack): enable mermaid, populate provisional power data Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-24 14:41:46 +02:00
## PDUs
| Hostname | Location | CPU | RAM | Storage | NIC | Status |
|---|---|---|---|---|---|---|
| [pdu01](pdu01.md) | | | | | | in-use |
| [pdu02](pdu02.md) | | | | | | in-use |
fix(hardware): set pdu03/pdu04 to rack01 and regenerate indices Camilla's "Changed PDU values" commit added pdu03/pdu04 frontmatter but left the auto-generated docs/hardware/index.md stale, failing the CI drift check. Correct both PDUs from the placeholder racks rack33/rack11 to rack01 (where all current hardware lives) and regenerate the hardware index and rack01 elevation via `make docs-index`. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-29 21:19:20 +02:00
| [pdu03](pdu03.md) | | | | | | in-use |
| [pdu04](pdu04.md) | | | | | | in-use |
feat(rack): enable mermaid, populate provisional power data Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-24 14:41:46 +02:00
feat(docs): MkDocs Material site + auto-generated hardware overview Bootstraps an MkDocs Material documentation site (rendered to docs.makerfloss.eu by the Forgejo Actions runner). The first feature is an auto-generated hardware overview built from per-host YAML frontmatter blocks under docs/hardware/. - mkdocs.yml, requirements.txt: MkDocs Material 9.5 + pyyaml - Makefile: docs-index | docs-build | docs-serve | docs-check - scripts/gen_overview.py: stdlib + pyyaml generator, deterministic and offline. Reads scripts/overview_config.yml — category-driven so services/vms can plug in later without touching the script. - scripts/overview_config.yml: hardware schema and index layout - docs/hardware/{makerfloss,fisi,tembo}.md: 3 sample entries - docs/hardware/index.md: GENERATED, committed (CI fails on drift) - docs/index.md: site landing page - .forgejo/workflows/docs.yml: drift-check + mkdocs build --strict + rsync site/ to /srv/docs-makerfloss/html on push to main - .gitignore: site/, .venv, __pycache__ Schema: - hostname, kind, status (required; kind/status are enums) - model, location, cpu, cpu_cores, cpu_threads, ram_gb, storage_gb, storage_type (enum), storage_notes, nic_gbps (all optional) - Filename stem MUST equal hostname (enforced by generator) - Extra optional fields are accepted silently and live on the per-page Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-17 21:10:58 +02:00
## Servers
docs(hardware): drop the model field Removed from per-host frontmatter, the index column, and the Specs table. Model values kept churning (case manufacturer vs. "custom") without adding useful information. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-27 10:37:04 +02:00
| Hostname | Location | CPU | RAM | Storage | NIC | Status |
|---|---|---|---|---|---|---|
| [makerfloss.eu](makerfloss.eu.md) | Hetzner HEL1 (cloud) | AMD EPYC (shared vCPU) · 2c | 4 GB | 40 GB NVME | 1 GbE | in-use |
added all devices to rack
2026-06-29 22:27:52 +02:00
| [nas01](nas01.md) | The pile | ? | ? | ? | ? | staging |
| [nas02](nas02.md) | The pile | ? | ? | ? | ? | staging |
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
| [srv01](srv01.md) | The pile | ? | ? | ? | ? | in-use |
refactor(hardware): rename mf00-mf04 to srv01-srv05, add cluster field Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-24 16:23:23 +02:00
| [srv02](srv02.md) | The pile | Intel Core i5-8500 @ 3.00GHz · 6c | 8 GB | 40 GB NVME | 1 GbE | staging |
| [srv03](srv03.md) | The pile | Intel Core i5-8500 @ 3.00GHz · 6c | 16 GB | 40 GB NVME | 1 GbE | staging |
| [srv04](srv04.md) | The pile | Intel Core i5-3570K @ 3.40GHz · 4c | 8 GB | 500 GB HDD | 1 GbE | staging |
| [srv05](srv05.md) | The pile | Intel Core i5-3570K @ 3.40GHz · 4c | 8 GB | 500 GB HDD | 1 GbE | staging |
added all devices to rack
2026-06-29 22:27:52 +02:00
| [srv06](srv06.md) | The pile | ? | ? | ? | ? | staging |
| [srv07](srv07.md) | The pile | ? | ? | ? | ? | staging |
feat(rack): populate provisional network topology (sw01, pp01, links) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-24 15:09:02 +02:00
feat(rack): place TaPPaaS nodes on shelf shf01 (provisional)
2026-06-24 17:51:52 +02:00
## Shelves
| Hostname | Location | CPU | RAM | Storage | NIC | Status |
|---|---|---|---|---|---|---|
| [shf01](shf01.md) | | | | | | in-use |
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
| [shf02](shf02.md) | | | | | | in-use |
| [shf03](shf03.md) | | | | | | in-use |
| [shf04](shf04.md) | | | | | | in-use |
feat(rack): place TaPPaaS nodes on shelf shf01 (provisional)
2026-06-24 17:51:52 +02:00
feat(rack): populate provisional network topology (sw01, pp01, links) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-24 15:09:02 +02:00
## Switches
| Hostname | Location | CPU | RAM | Storage | NIC | Status |
|---|---|---|---|---|---|---|
| [sw01](sw01.md) | | | | | | in-use |
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
| [sw02](sw02.md) | | | | | | staging |
| [sw03](sw03.md) | | | | | | staging |
| [sw04](sw04.md) | | | | | | staging |
| [sw05](sw05.md) | | | | | | staging |
## UPS
| Hostname | Location | CPU | RAM | Storage | NIC | Status |
|---|---|---|---|---|---|---|
| [ups01](ups01.md) | | | | | | staging |
| [ups02](ups02.md) | | | | | | staging |
## WAN uplinks
| Hostname | Location | CPU | RAM | Storage | NIC | Status |
|---|---|---|---|---|---|---|
| [wan01](wan01.md) | ISP demarcation | | | | | in-use |
| [wan02](wan02.md) | ISP demarcation | | | | | staging |
Reference in a new issue Copy permalink