docs: Document the boxes
Add a top-level `README.md` mapping the boxes and per-machine docs under `docs/boxes/` (grouped `colony/`, `home/`, `misc/`), one file per host, VM and container documenting role, services and networking with source pointers. Also point `AGENTS.md` at the new docs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,27 @@
|
||||
# whale2
|
||||
|
||||
A podman/OCI host on colony dedicated to game servers (kept off `shill` so the
|
||||
container churn and resource use stay isolated).
|
||||
|
||||
- **Source:** [`nixos/boxes/colony/vms/whale2/`](../../../nixos/boxes/colony/vms/whale2)
|
||||
(`default.nix`, `valheim.nix`, `minecraft/`, `enshrouded.nix`)
|
||||
- **nixpkgs:** `mine`
|
||||
- **Host:** VM on `colony`
|
||||
|
||||
## Role
|
||||
|
||||
- Runs OCI containers via **podman** (`virtualisation.oci-containers`, netavark
|
||||
backend) on a dedicated `colony` bridge network (`oci`) with both IPv4 and
|
||||
IPv6, so each game server gets its own routable address.
|
||||
- Game servers configured in-repo: **Valheim**, **Minecraft** (several worlds —
|
||||
see `extraAssignments`: `simpcraft`, `simpcraft-staging`, `kevcraft`,
|
||||
`kinkcraft`, `graeme`), and **Enshrouded** (currently commented out).
|
||||
- `/var/lib/containers` is an XFS data disk (project quotas).
|
||||
|
||||
## Networking
|
||||
|
||||
- `vms` interface with `routing` / `internal` (alt name `oci`) assignments.
|
||||
- An `oci` bridge carrying the `prefixes.oci` v4/v6 ranges; per-game addresses
|
||||
are handed out via `extraAssignments` (`valheim-oci`, `simpcraft-oci`, …) and
|
||||
exposed to the internet through `estuary`'s port forwards.
|
||||
- Firewall trusts the `oci` interface and forwards `vms → oci`.
|
||||
Reference in New Issue
Block a user