reef-railiance/README.md

50 lines
1.7 KiB
Markdown

# reef-railiance
Wave-1 grouped home reef for Railiance-managed server substrates.
## Purpose
`reef-railiance` is the first concrete `reef-*` repo in Railiance.
It owns the grouped home-substrate boundary that should describe current and
future Railiance home servers without creating one repo per machine.
This repo exists to hold:
- the source-controlled reef declaration for the Railiance home substrate
- grouped substrate identity and topology facts
- rail and workload binding surfaces for this reef
- the migration path from source-backed S1 facts in `railiance-infra`
## Boundary
`reef-railiance` does not own:
- generic S1 provisioning, hardening, or server inventory authority
- generic Kubernetes runtime ownership
- platform-service governance or workload packaging
- one permanent repo per host in the Railiance home substrate
Those concerns stay with `railiance-infra`, `railiance-cluster`,
`railiance-platform`, or the relevant `rapp-*` repo.
## Current Status
This repo now owns the wave-1 grouped home-reef boundary for Railiance.
The retained S1 compatibility path while reef localization is still in flight
is documented in `docs/retained-s1-handoff.md`.
The boundary and source material come from:
- `railiance-master/docs/reef-first-wave-rollout.md`
- `railiance-master/docs/reef-substrate-model.md`
- `railiance-infra/docs/reef-first-wave-source-map.md`
## Initial Layout
- `declarations/reef.yaml` — source-controlled reef contract
- `substrate/` — grouped substrate identity and topology facts
- `bindings/` — rail and `rapp` binding surfaces for this reef
- `docs/` — wave-1 contract and source import plan
- `docs/retained-s1-handoff.md` — migration-window split with `railiance-infra`
- `workplans/` — repo-local execution work