docs(deploy): Update Dokumetation Workflow
This commit is contained in:
@@ -0,0 +1,33 @@
|
|||||||
|
# 🏗 Bruchtal Docker-Architektur
|
||||||
|
|
||||||
|
## Übersicht
|
||||||
|
|
||||||
|
Die Bruchtal-Infrastruktur läuft vollständig containerisiert auf einer VM.
|
||||||
|
Alle Dienste kommunizieren über ein dediziertes Docker-Netzwerk, nutzen Git zur Versionierung und automatisches Deploy über Webhooks.
|
||||||
|
|
||||||
|
**Hauptkomponenten:**
|
||||||
|
|
||||||
|
| Service | Containername | Funktion |
|
||||||
|
|----------------|-------------------|---------|
|
||||||
|
| Gitea | `gitea` | Git-Server für Infrastruktur & Dokumentation |
|
||||||
|
| Wiki.js | `wikijs` | Wissensmanagement & Dokumentation |
|
||||||
|
| MkDocs | `bruchtal-docs` | Statische Markdown-Dokumentation |
|
||||||
|
| Webhook | `bruchtal-webhook`| Automatisches Deploy bei Git Push |
|
||||||
|
| Docker Host | VM | Plattform für alle Container |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🔗 Netzwerke
|
||||||
|
|
||||||
|
Alle Container laufen im **gemeinsamen Docker-Netzwerk** `bruchtal-net`:
|
||||||
|
|
||||||
|
- Kommunikation per Service-Namen (`gitea`, `bruchtal-webhook`)
|
||||||
|
- Keine Abhängigkeit von Host-IP
|
||||||
|
- Isoliert von anderen VM-Netzwerken
|
||||||
|
|
||||||
|
Beispiel Docker-Compose-Netzwerkdefinition:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
networks:
|
||||||
|
bruchtal-net:
|
||||||
|
external: true
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ Ziel:
|
|||||||
- Alles versioniert in Git
|
- Alles versioniert in Git
|
||||||
- Reproduzierbare Deployments
|
- Reproduzierbare Deployments
|
||||||
- Dokumentation immer synchron zur Infrastruktur
|
- Dokumentation immer synchron zur Infrastruktur
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Grundprinzip
|
## Grundprinzip
|
||||||
@@ -18,9 +17,17 @@ Die VM ist nur noch Laufzeitumgebung.
|
|||||||
|
|
||||||
1. Lokal ändern, egal was
|
1. Lokal ändern, egal was
|
||||||
2. Committen & Pushen
|
2. Committen & Pushen
|
||||||
3. Auf VM pullen
|
3. der Pull auf der VM wird automatisch über einen Webhook ausgeführt
|
||||||
4. Container neu starten
|
4. Container neu starten
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
flowchart LR
|
||||||
|
Dev -->|git push| Gitea
|
||||||
|
Gitea -->|POST Hook| Webhook
|
||||||
|
Webhook -->|git pull| Workspace
|
||||||
|
Workspace -->|Markdown changes| MkDocs
|
||||||
|
MkDocs -->|serve| Browser
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Workflow "neuer Container"
|
## Workflow "neuer Container"
|
||||||
|
|||||||
29
mkdocs.yml
29
mkdocs.yml
@@ -22,4 +22,31 @@ nav:
|
|||||||
- It-Tools: docker/it-tools/it-tools.md
|
- It-Tools: docker/it-tools/it-tools.md
|
||||||
- Backup_Storage:
|
- Backup_Storage:
|
||||||
- Backup: backup/backup.md
|
- Backup: backup/backup.md
|
||||||
- Storage: backup/storage.md
|
- Storage: backup/storage.md
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
markdown_extensions:
|
||||||
|
- pymdownx.superfences
|
||||||
|
- pymdownx.highlight
|
||||||
|
- pymdownx.snippets
|
||||||
|
- pymdownx.tasklist
|
||||||
|
- pymdownx.tabbed
|
||||||
|
- pymdownx.mark
|
||||||
|
- pymdownx.tilde
|
||||||
|
- pymdownx.critic
|
||||||
|
- pymdownx.inlinehilite
|
||||||
|
- pymdownx.details
|
||||||
|
- pymdownx.keys
|
||||||
|
- pymdownx.emoji
|
||||||
|
- pymdownx.betterem
|
||||||
|
- pymdownx.caret
|
||||||
|
- pymdownx.mark
|
||||||
|
- pymdownx.smartsymbols
|
||||||
|
- pymdownx.magiclink
|
||||||
|
- pymdownx.superfences:
|
||||||
|
custom_fences:
|
||||||
|
- name: mermaid
|
||||||
|
class: mermaid
|
||||||
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
||||||
Reference in New Issue
Block a user