my-homelab-configs/README.md

34 lines
1.3 KiB
Markdown

# Homelab Kubernetes Pipeline
<!-- Generated from README.md.tmpl by scripts/render-docs. Edit README.md.tmpl and homelab.yml, then regenerate. -->
This repo bootstraps a hybrid kubeadm cluster and then hands app delivery to Argo CD.
## Quick Start
From the Debian server:
```bash
cd ~/my-homelab-configs
./jeannie up
```
## Documentation Hub
The detailed technical specifications have been moved to the `/docs` directory:
- [Architecture & Infrastructure](docs/architecture.md) - Cluster layout, Networking, and Edge path.
- [Deployment Guide](docs/deployment.md) - Prerequisites, bootstrap flow, and validation.
- [AI Operations](docs/ai-ops.md) - Jeannie AI tools, Evals, and Safety cases.
- [Application Ops](docs/app-ops.md) - App delivery, Gitea, and Website management.
- [Service Catalog](docs/service-catalog.md) - Live inventory of all hosts and services.
## Inventory
The canonical non-secret inventory is [homelab.yml](homelab.yml). Keep LAN IPs, Tailscale IPs, public hostnames, ports, storage paths, and service ownership there.
`./jeannie` reads `homelab.yml` at startup and exports matching OpenTofu variables.
`scripts/render-docs` renders the documentation and the static service catalog page.
Run `./jeannie up` and `./jeannie nuke` only from the Debian homelab server.