jakman85andClaude Opus 4.8
de26a53d4b
- Add CONTRIBUTING.md: interim local-git rules (no work on main; every change a feature branch merged into main) and the target state (Gitea-hosted repos, GitOps source cutover, CI/CD via Gitea Actions running the Kyverno gate + Chainsaw conformance Job, PR merge gate). Note the self-hosted-git bootstrapping circularity + off-cluster mirror/backup mitigation. - AGENTS.md: add section 12 (version-control workflow). - docs/05: source-of-truth migration (local bootstrap -> self-hosted Gitea). - docs/13 + roadmap: reprioritize Gitea as bootstrapping-critical, onboarded early (WS-APPS step 2); nextcloud onboarding split out. - task-board: T-6.1a (gitea early), T-6.1b (source+CI migration to Gitea). Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
69 lines
5.0 KiB
Markdown
69 lines
5.0 KiB
Markdown
# Roadmap — Workstreams
|
||
|
||
A **workstream** is a durable area of ownership. Each maps to an agent role
|
||
([`../agents/roles.md`](../agents/roles.md)), owns a set of specs, exposes **interfaces** other
|
||
workstreams depend on, and delivers against requirement IDs. Interfaces are contracts — change them
|
||
only via [`../agents/coordination-protocol.md`](../agents/coordination-protocol.md).
|
||
|
||
| ID | Workstream | Owns (specs) | Serves | Depends on |
|
||
|---|---|---|---|---|
|
||
| **WS-INFRA** | Infra & cluster bring-up | [02](../docs/02-environments-and-provisioning.md) | R-PLAT-01, R-ENV-* | — |
|
||
| **WS-GITOPS** | GitOps, CI, catalog renderer | [05](../docs/05-gitops-and-delivery.md), [13](../docs/13-service-catalog.md) | R-GITOPS-*, R-UPD-02 | WS-INFRA |
|
||
| **WS-NET** | Networking, isolation, egress, ingress | [03](../docs/03-networking-isolation-and-egress.md), [09](../docs/09-dns-and-ingress.md) | R-NET-*, R-DNS-* | WS-INFRA |
|
||
| **WS-STORAGE** | Storage, state, backup/DR | [04](../docs/04-storage-and-state.md) | R-STATE-* | WS-INFRA |
|
||
| **WS-SEC** | Secrets, TLS, RBAC, auditability | [07](../docs/07-security-and-secrets.md), [08](../docs/08-tls-and-certificates.md) | R-SEC-*, R-TLS-* | WS-INFRA, WS-NET |
|
||
| **WS-OBS** | Observability & alerting | [10](../docs/10-observability-and-alerting.md) | R-OBS-* | WS-INFRA, WS-STORAGE |
|
||
| **WS-UPDATE** | Automated updates | [11](../docs/11-automated-updates.md) | R-UPD-* | WS-GITOPS, WS-OBS |
|
||
| **WS-VM** | KubeVirt IaaS | [06](../docs/06-vm-workloads-kubevirt.md) | R-PLAT-03 | WS-NET, WS-STORAGE |
|
||
| **WS-APPS** | Service onboarding (13 services) | [13](../docs/13-service-catalog.md) | app requirements | WS-GITOPS, WS-NET, WS-STORAGE, WS-SEC, WS-OBS |
|
||
| **WS-C2** | Command & Control UI | [12](../docs/12-command-center-ui.md) | R-C2-* | WS-OBS, WS-APPS, WS-SEC |
|
||
| **WS-TEST** | Conformance testing (cross-cutting) | [14](../docs/14-testing-and-conformance.md) | R-TEST-* | WS-INFRA, WS-GITOPS |
|
||
|
||
## Key interfaces (contracts between workstreams)
|
||
|
||
- **ServiceDefinition schema** (WS-GITOPS owns) — the operator surface every app/VM is expressed in.
|
||
WS-APPS, WS-VM consume it; WS-NET/STORAGE/SEC/OBS render pieces of it. **The most important
|
||
contract in the system.**
|
||
- **Network baseline & policy rendering** (WS-NET) — default-deny + how `dependencies` and `egress`
|
||
compile to CiliumNetworkPolicies/egress routing. Consumed by WS-APPS/WS-VM.
|
||
- **StorageClasses** (WS-STORAGE) — `longhorn` (replicated) and `bulk` (media). Consumed by everyone
|
||
with state.
|
||
- **Issuer + Gateway TLS** (WS-SEC + WS-NET) — wildcard cert + Gateway listeners that HTTPRoutes
|
||
attach to.
|
||
- **Observability contract** (WS-OBS) — how a service declares metrics/SLIs/alerts and gets
|
||
dashboards. Consumed by WS-APPS/WS-VM.
|
||
- **Update policy contract** (WS-UPDATE) — ImagePolicy/Renovate conventions a ServiceDefinition's
|
||
`update` block maps to.
|
||
- **Conformance harness + gate** (WS-TEST) — the reproducible test framework (**Kyverno** for L0
|
||
policy, **Chainsaw** for L1/L2/L3 behavior + fault-injection, [ADR-0011](../decisions/adr-0011-test-tooling-kyverno-chainsaw.md)),
|
||
requirement-coverage report, and CI/phase gates every workstream's tests plug into. Each workstream
|
||
**authors its own behavior tests** against this harness ([14](../docs/14-testing-and-conformance.md)).
|
||
|
||
## Parallelization guidance
|
||
- **WS-TEST stands up the conformance harness early (Phase 0–1)** so every other workstream lands
|
||
with passing, reproducible tests from day one — testing is not a trailing phase.
|
||
- After WS-INFRA delivers a cluster + Flux (Phase 1), WS-NET, WS-STORAGE, WS-SEC can proceed largely
|
||
in parallel (Phase 2).
|
||
- WS-OBS, WS-UPDATE, WS-VM layer on next (Phases 3–5), overlapping.
|
||
- WS-APPS is gated on the platform contracts being stable; onboard services in the dependency order
|
||
below.
|
||
- WS-C2 is last-ish (Phase 6) since it aggregates everything.
|
||
|
||
## WS-APPS onboarding order (respect dependencies from [13](../docs/13-service-catalog.md))
|
||
1. **pihole** (DNS underpinning) →
|
||
2. **gitea** — **bootstrapping-critical; brought online early** so the platform self-hosts its git
|
||
and CI/CD; after it is stable, WS-GITOPS cuts Flux's source over to Gitea and moves CI to Gitea
|
||
Actions ([`../docs/05-gitops-and-delivery.md`](../docs/05-gitops-and-delivery.md),
|
||
[`../CONTRIBUTING.md`](../CONTRIBUTING.md)). DR-critical → off-cluster backup + mirror. →
|
||
3. **plex** (largest; validates bulk tier + public exposure) →
|
||
4. **qbittorrent, jackett** (VPN + kill-switch proof) → 5. **sonarr, radarr** (VPN + arr↔downloader
|
||
allows) → 6. **seerr** (cross-service allows to arr + plex) → 7. **nextcloud** (DR-critical data +
|
||
backups) → 8. **minecraft, unifi, semaphore, kasm** (remaining).
|
||
|
||
**GitOps source migration** (WS-GITOPS, tied to step 2): local bootstrap source → self-hosted Gitea;
|
||
CI (Kyverno gate + Chainsaw conformance Job trigger) moves to Gitea Actions; PRs become the enforced
|
||
merge gate into `main`.
|
||
|
||
Each onboarding is a full acceptance-gate pass ([`../agents/definition-of-done.md`](../agents/definition-of-done.md)),
|
||
not just a merged manifest.
|