Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 20 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
[![Loki](https://img.shields.io/badge/Loki-F5A800?style=plastic&logo=grafana&logoColor=white)](https://grafana.com/oss/loki/)
[![pfSense](https://img.shields.io/badge/pfSense-FreeBSD%2015-212121?style=plastic)](https://www.pfsense.org)

[Start here](docs/runbooks/successor-handover.md) ·
[Architecture](docs/architecture.md) ·
[Network](docs/network.md) ·
[Observability](docs/observability.md) ·
Expand All @@ -34,6 +35,15 @@ house actually depends on, which changed the requirements considerably — a
broken experiment is a learning opportunity, a broken DHCP server is a domestic
incident.

**Arriving without the context?**
[`docs/runbooks/successor-handover.md`](docs/runbooks/successor-handover.md) is
the front door: what this estate is, what to check on day one and in what order,
what fails soonest if nobody touches anything, where the secrets are and what is
needed to decrypt them, and what can be switched off. **This repository is the
operator-facing documentation** — the wiki on `oracle` is the household's, and
[ADR-0011](docs/adr/0011-keep-the-wiki-internal.md) is why they are different
documents for different readers.

## Highlights

- **Network segmented by trust, not by function.** Seven VLANs; IoT, media and
Expand Down Expand Up @@ -70,9 +80,10 @@ incident.
the Makefile, the scripts, the workflow and the runbooks resolves its image
from `compose.yaml` too, so an image that is not pinned there cannot be run
at all.
- **Documented decisions and runbooks.** Fourteen ADRs covering what was chosen
and what was rejected — including the costs accepted knowingly; twelve
runbooks for the operations that are easy to get wrong at 1am.
- **Documented decisions and runbooks.** 23 ADRs covering what was chosen
and what was rejected — including the costs accepted knowingly; 19
runbooks for the operations that are easy to get wrong at 1am, one of which
is the handover page a successor reads first.

## Architecture

Expand Down Expand Up @@ -179,12 +190,12 @@ Full topology and data flow in [`docs/architecture.md`](docs/architecture.md).
│ ├── architecture.md network.md hardware.md
│ ├── observability.md security.md roadmap.md
│ ├── adr/ # 23 architecture decision records
│ └── runbooks/ # deploy, converge, add device, rotate creds, certs,
│ # key backup, purge, restore the firewall,
│ # restore the stack, ship firewall logs,
│ # verify the alert path, enable suricata,
│ # fit the UPS battery, add a host override,
│ # build the lab guest
│ └── runbooks/ # successor handover (start here), deploy, converge,
│ # add device, rotate creds, certs, key backup,
│ # purge, restore the firewall, restore the stack,
│ # ship firewall logs, verify the alert path,
│ # enable suricata, fit the UPS battery,
│ # add a host override, build the lab guest
└── Makefile # make help
```

Expand Down
Loading