docs: update root README with quick start and structure
This commit is contained in:
parent
15935b78aa
commit
038adef94a
1 changed files with 54 additions and 15 deletions
69
README.md
69
README.md
|
|
@ -1,18 +1,57 @@
|
||||||
# railiance-bootstrap
|
# Railiance Bootstrap
|
||||||
|
|
||||||
**Railiance Bootstrap** — opinionated, reproducible IaC to rebuild Coulomb infra from scratch.
|
Railiance is an opinionated **Infrastructure-as-Code framework** —
|
||||||
|
think *Rails for Ops*: convention over configuration, reproducibility first.
|
||||||
|
|
||||||
## Goals
|
This repo (`railiance-bootstrap`) is the **entry point**:
|
||||||
- Two Linux machines + this Git repo + credentials ⇒ full rebuild
|
from two bare Linux servers, a Git repo, and credentials, you can rebuild
|
||||||
- GitOps-first with ArgoCD/Flux
|
a fully automated Kubernetes-based environment.
|
||||||
- OODA (Observe→Orient→Decide→Act) encoded as pipelines
|
|
||||||
- Tests define success at every step
|
|
||||||
|
|
||||||
## Layout
|
---
|
||||||
```
|
|
||||||
ansible/ # host bootstrap
|
## 🚀 Quick Start
|
||||||
helm/ # charts & values
|
|
||||||
k8s/ # raw manifests/CRDs
|
1. **Clone this repo**
|
||||||
tests/ # expectation tests (bash/py)
|
```bash
|
||||||
docs/ # operator notes, OODA SOPs
|
git clone <your-gitea-url>/railiance-bootstrap.git
|
||||||
```
|
cd railiance-bootstrap
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Configure Gitea access**
|
||||||
|
Edit `~/.railiance_gitea.conf` with your server URL, username, and token.
|
||||||
|
*(Never commit this file!)*
|
||||||
|
|
||||||
|
3. **Bootstrap a host**
|
||||||
|
Run the Ansible playbooks in `ansible/` to set up k3s, Helm, kubectl.
|
||||||
|
|
||||||
|
4. **Deploy baseline services**
|
||||||
|
Use `helm/` charts to roll out essential services (GitOps, monitoring, etc.).
|
||||||
|
|
||||||
|
5. **Validate**
|
||||||
|
Check the automated tests in `tests/` to confirm infra health.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📂 Repo Structure
|
||||||
|
|
||||||
|
- `ansible/` — Playbooks for provisioning
|
||||||
|
- `helm/` — Opinionated Helm charts
|
||||||
|
- `k8s/` — Kubernetes manifests
|
||||||
|
- `tests/` — Automated validation
|
||||||
|
- `docs/` — Documentation (see [docs/README.md](./docs/README.md))
|
||||||
|
- `tools/` — Helper scripts (e.g. `create_railiance_repo.sh`)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🤝 Contributing
|
||||||
|
|
||||||
|
See [docs/CONTRIBUTING.md](./docs/CONTRIBUTING.md).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🌍 Vision
|
||||||
|
|
||||||
|
Railiance aims for **self-reliant infrastructure**:
|
||||||
|
automation you can rebuild from scratch, with calmness and clarity.
|
||||||
|
|
||||||
|
> *From bare metal to resilient clusters — in one repo.*
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue