Files
factory/doc/README.md
Gabriel Radureau 8330d82225 docs(runbooks): add "new web app" setup runbook under doc/runbooks/
Document, as a tree-docs tree, the end-to-end procedure to stand up a new
web application on the Arcodange platform — a mechanic spread across the
factory, tools and app repos with non-trivial ordering dependencies.

Covers: Gitea repo creation (org-secret inheritance), Postgres DB + owner
role (factory/postgres/iac), platform Vault declaration (gitea_cicd_<app>
+ policies, tools/hashicorp-vault/iac), the app Helm chart (VSO dynamic
secrets via pgbouncer), the app Terraform (app_roles module), the CI
workflows (tofu apply + image build, incl. the copy-pasted role pitfall),
and ArgoCD registration (factory/argocd/values.yaml). Adds a naming-
conventions concept page and an ordered checklist.

Wires the legacy doc/adr "setup hello world web app" item and the factory
README to the runbook. New docs live under doc/ (singular) per the PR #8
convention.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-05-31 17:22:30 +02:00

1.8 KiB

Factory > Doc

Documentation Factory

Last Updated: 2026-05-31 Status: Production · maintenue activement Related: README racine du dépôt · Collection Ansible arcodange.factory

C'est quoi ?

Le dossier doc/ rassemble la documentation de la plateforme Arcodange (k3s + Gitea + ArgoCD + OpenTofu + Vault + Postgres, auto-hébergée sur 3 Raspberry Pi). On y trouve deux familles :

  • les ADR (records de décisions d'architecture), qui expliquent pourquoi la plateforme est faite ainsi ;
  • les runbooks, qui expliquent comment exécuter une procédure opérationnelle de bout en bout.

Note

Convention du dépôt (cf. PR #8) : la documentation vit sous doc/ (singulier). Un ancien dossier docs/ (pluriel) a pu traîner non-suivi par git — ne pas y ajouter de contenu.

Sections

Section Ce qu'on y trouve Statut
Runbooks Procédures opérationnelles pas-à-pas (créer une app, etc.)
ADR Décisions d'architecture + checklist de mise en place de la plateforme

Légende de statut

actif · 🟡 dégradé/beta · 🔴 critique/EOL · ⚠️ problème connu · désactivé

Comment éditer cette documentation

  1. Ajouter une page → la créer depuis le template adéquat et ajouter sa ligne dans la table d'index du README.md parent.
  2. Supprimer une page → la marquer Décommissionnée (date) d'abord ; supprimer le fichier et sa ligne d'index ensemble une fois qu'elle est vraiment partie.
  3. Garder les liens croisés bidirectionnels → quand on lie A→B, ajouter B→A.
  4. Mettre à jour Last Updated: en tête de la racine concernée après tout changement de structure.