diff --git a/docs/workflows/docker-workflow.md b/docs/workflows/docker-workflow.md new file mode 100644 index 0000000..3967076 --- /dev/null +++ b/docs/workflows/docker-workflow.md @@ -0,0 +1,64 @@ +# Docker-Workflow (Bruchtal Standard) + +Dieser Workflow ist verbindlich für alle Änderungen an Docker-Stacks in Bruchtal. + +Ziel: +- Keine Konfiguration direkt auf der VM +- Alles versioniert in Git +- Reproduzierbare Deployments +- Dokumentation immer synchron zur Infrastruktur + +--- + +## Grundprinzip + +**Konfiguration passiert lokal in VS Code.** +Die VM ist nur noch Laufzeitumgebung. + + +1. Lokal ändern, egal +2. Committen & Pushen +3. Auf VM pullen +4. Container neu starten + +--- + +## Workflow "neuer Container" +- VSCode starten in ~Bruchtal mit code . => VS startet sauber mit der Giteinstellung +**ALLE ÄNDERUNGEN NUR IN VS** + +### neuen Containeranlegen +- Bruchtal/ anlegen +- Bruchtal//docker-compose.yml anlegen +- docker-compose.yml editieren, +- commit mit Message "infra(): docker-compose.yml neu angelegt" +- push + + +### neuen Container dokumentieren +- Bruchtal/docs/ anlegen +- Bruchtal/docs//.md anlegen +- .md editieren, Blaupause z.B: wikijs.md +- commit message docs(): Dokumentation angelegt +- Bruchtal/mkdocs.md: nav sinnvoll ergänzen +- commit message docs(mkdocs): ergänzt +- push + +### Übernehmen auf VM Docker +```bash +ssh docker +cd /docker/Bruchtal +git pull +cd /docker/Bruchtal/ +docker compose up -d +``` + +## Repository-Struktur +Bruchtal/ +├── docker/ +│ └── / +│ └── docker-compose.yml +└── docs/ + └── docker/ + └── / + └── .md diff --git a/mkdocs.yml b/mkdocs.yml index 4d2eac7..10d2dcf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,10 +8,11 @@ theme: nav: - Übersicht: index.md + - Workflows: + - docker-workflow: workflows/docker-workflow.md - Netzwerk: - Topologie: network/topology.md - Tunnel: network/tunnel.md - - Proxmox: - VMs: proxmox/vms.md - Docker: @@ -20,4 +21,4 @@ nav: - Architektur: docker/architecture.md - Backup_Storage: - Backup: backup/backup.md - - Storage: backup/storage.md + - Storage: backup/storage.md \ No newline at end of file