57 lines
2.3 KiB
Markdown
57 lines
2.3 KiB
Markdown
# railiance-cluster
|
|
[](LICENSE)
|
|
|
|
S2 cluster runtime home for Railiance: Kubernetes substrate ownership, cluster
|
|
operators, kubeconfig delivery, backup/preflight safety rails, and published
|
|
cluster facts that downstream workload rails depend on.
|
|
|
|
This repo is the Kubernetes substrate owner, not the long-term home for the
|
|
generic workload-on-Kubernetes contract. The staged workload lifecycle,
|
|
`railiance/app.toml`, and overlay/wrapper scaffolding now belong canonically to
|
|
`rail-kubernetes`; this repo keeps only a migration-window compatibility shim
|
|
and temporary compatibility copies while the split completes.
|
|
|
|
## Current Boundary
|
|
|
|
- S2-owned here: k3s bootstrap, Helm and kubeconfig access, cluster-level
|
|
backup/preflight, smoke checks, and published substrate expectations.
|
|
- Transitional here only: the compatibility shim and temporary copies for the
|
|
generic Stage 1/2/3 workload lifecycle, `railiance/app.toml`, canary and
|
|
promotion CLI commands, and overlay scaffolding.
|
|
- Reviewed move map:
|
|
[docs/rail-kubernetes-extraction-map.md](docs/rail-kubernetes-extraction-map.md)
|
|
- Published substrate profile:
|
|
[docs/rail-kubernetes-substrate-profile.md](docs/rail-kubernetes-substrate-profile.md)
|
|
- Compatibility shim:
|
|
[docs/rail-kubernetes-compatibility-shim.md](docs/rail-kubernetes-compatibility-shim.md)
|
|
|
|
## Quick Start
|
|
|
|
1. Clone this repo.
|
|
```bash
|
|
git clone <your-gitea-url>/railiance-cluster.git
|
|
cd railiance-cluster
|
|
```
|
|
2. Configure Gitea access in `~/.railiance_gitea.conf`.
|
|
3. Bootstrap a host with the Ansible playbooks in `ansible/`.
|
|
4. Validate the cluster substrate with the documented smoke/preflight targets.
|
|
|
|
## Repo Structure
|
|
|
|
- `ansible/` - S2 bootstrap playbooks
|
|
- `helm/` - retained cluster-side helper manifests
|
|
- `tests/` - cluster validation and HA smoke checks
|
|
- `docs/` - S2 substrate docs plus transitional rail-kubernetes specs
|
|
- `tools/` - S2 operations plus compatibility tooling that is being split out
|
|
- `workplans/` - repo-local cluster work records
|
|
|
|
## Key Docs
|
|
|
|
- [SCOPE.md](SCOPE.md)
|
|
- [docs/README.md](docs/README.md)
|
|
- [docs/rail-kubernetes-extraction-map.md](docs/rail-kubernetes-extraction-map.md)
|
|
- [docs/rail-kubernetes-substrate-profile.md](docs/rail-kubernetes-substrate-profile.md)
|
|
|
|
## Contributing
|
|
|
|
See [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md).
|