2ba0c07cd3
Addresses the WKS PoC review (Notion 2026-05-26). All docs in English. - README: purpose, docs table of contents, annotated repo tree - docs/getting_started.md: prerequisites (WKS account, OIDC, SSH, VPN) + first deploy - docs/ansible.md: playbook table, "Running Ansible", service parameters, cheatsheet - docs/secrets.md: canonical Bao login (moved out of README) + demo defaults - docs/operations.md: full Makefile reference - docs/inventories.md: repo layout, topology, standard folder structure, walkthrough - docs/testing.md: static checks, inventory resolution, smoke test / dry run - remove ARCHITECTURE.md (architecture docs live externally) Also includes the gymburgdorf inventory build-out (bookstack, homarr, opnform, send) and scripts/bao-seed.sh. site.yml keeps a third traefik play (traefik_servers minus the vagrant _dmz/_backend split) so the demo inventories still configure their reverse proxy after the rebase onto main. |
||
|---|---|---|
| .. | ||
| ansible.md | ||
| getting_started.md | ||
| inventories.md | ||
| operations.md | ||
| README.md | ||
| secrets.md | ||
| testing.md | ||
Documentation — reference-ansible
Entry point for this repository's in-depth documentation. The
demo-gymburgdorf inventory serves
as a running example throughout.
Demo-only. All role defaults (passwords, tokens, RPC secrets) are insecure and intended exclusively for demo setups. See secrets.md § Demo-Only-Defaults.
Table of contents
| Document | Content |
|---|---|
| getting_started.md | Prerequisites (access, tools), first deploy step by step |
| operations.md | Setup, prerequisites, deploy flow, smoke test, known gaps |
| secrets.md | OpenBao login, secret lookup pattern, demo-only defaults, threat boundaries |
| inventories.md | Repository layout, roles origin, inventory topology, new-tenant walkthrough |
| ansible.md | Playbooks (site.yml), per-service parameters, variable cheat sheet |
| testing.md | Static checks, inventory resolution, smoke test/dry run before the deploy |
Quick links
- First time here? → getting_started.md
- Create a new tenant → inventories.md § Walkthrough
- Which variable goes where? → ansible.md § Variable cheat sheet
- Store a secret in Bao → secrets.md § Secret pattern
- Run a deploy → operations.md § Deploy