d51f2d62b6
Add a top-level README mapping the boxes and a full docs/ tree: topic pages (architecture, networking, deployment), per-site box pages for colony and home with containers nested under their hosts, remote and mobile boxes, the installer, and the home switch fabric reference (folded in from home-switches.md, with AGENTS.md and code comments retargeted to its new home). Box pages carry marked assignment tables that CI regenerates from nixos.allAssignments. AGENTS.md points at the new docs and keeps its terse agent version of the mechanics, referring to the topic pages for depth.
2.1 KiB
2.1 KiB
qclk
A WireGuard management appliance for the qclk network — it terminates the management
tunnel and routes/NATs the qclk prefix. No service daemon is currently defined in the config;
the container provides the network plumbing and opens the API port.
- Source:
shill/containers/qclk/(default.nix) - Host: NixOS container on
shill
Role
- WireGuard
managementinterface — listens on UDP51821(lib.my.c.colony.qclk.wgPort, allowed through the firewall;estuaryport-forwards it here) with the private key from theqclk/wg.keyage secret. Managed devices are static peers, each pinned to its own address in theqclkprefix (10.100.4.0/24); the peer list currently has a single entry (host 2). - Routing/NAT — the container itself is host 1 of the
qclkprefix.shillroutes10.100.4.0/24to this container, and outbound traffic fromhost0intomanagementis SNATed to the container'sqclkaddress. Forwarding intomanagementis accepted from the AS211024 trusted IPv4 ranges (lib.my.c.as211024.trusted.v4). - API port — TCP
8080is accepted on themanagementinterface (apiPort), but noteservices = { }: whatever serves the qclk API is not defined in this configuration today.
Network assignments
| Name | Assignment | IPv4 | IPv6 | Domain | Notes |
|---|---|---|---|---|---|
| qclk-ctr | internal | 10.100.2.10/24 gw 10.100.2.1 |
2a0e:97c0:4d2:12::a/64 |
ams1.int.nul.ie | |
| qclk | qclk | 10.100.4.1/24 |
— | — |
Two assignments: internal on the ctrs network like the other containers, and qclk — host 1
of the qclk prefix on the management WireGuard interface (IPv4 only, no DNS name).
Notable config files
nixos/boxes/colony/vms/shill/containers/qclk/default.nix— container definition: WireGuard netdev, peer list and firewall rules