Skip to content

Commit 548f2b2

Browse files
committed
docs: fixed mermaid diagrams
1 parent 3346999 commit 548f2b2

3 files changed

Lines changed: 55 additions & 55 deletions

File tree

docs/architecture.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -9,56 +9,56 @@ The system is built on a **stacks-based architecture** using Ansible and Docker
99
```mermaid
1010
graph TB
1111
subgraph "User Interface"
12-
USER[🧑‍💻 User] -- runs --> TASK["🔵 Taskfile.yml<br/>(e.g., task ansible:deploy:full)"]
12+
USER("User") -- runs --> TASK("Taskfile.yml (e.g., task ansible:deploy:full)")
1313
end
1414
1515
subgraph "Configuration Files"
16-
DOT_ENV["📄 .env<br/>Secrets & Variables"]
17-
INVENTORY["⚙️ ansible/inventory/<br/>Host & Group Definitions"]
18-
STACKS_DIR["📁 stacks/<br/>One folder per service"]
16+
DOT_ENV(".env (Secrets & Variables)")
17+
INVENTORY("ansible/inventory/ (Host & Group Definitions)")
18+
STACKS_DIR("stacks/ (One folder per service)")
1919
end
2020
2121
subgraph "Orchestration Engine"
22-
ANSIBLE["🤖 Ansible<br/>(ansible-playbook)"]
23-
PLAYBOOKS["📚 ansible/playbooks/<br/>(e.g., deploy/stacks.yml)"]
22+
ANSIBLE("Ansible (ansible-playbook)")
23+
PLAYBOOKS("ansible/playbooks/ (e.g., deploy/stacks.yml)")
2424
end
2525
2626
subgraph "Deployment Target: Docker Swarm Cluster"
27-
MANAGER["👑 Manager Node"]
28-
WORKERS["- Worker Nodes"]
29-
SWARM_NETWORK["🕸️ Overlay Network<br/>(traefik-public)"]
27+
MANAGER("Manager Node")
28+
WORKERS("Worker Nodes")
29+
SWARM_NETWORK("Overlay Network (traefik-public)")
3030
end
3131
3232
subgraph "Core Running Services"
33-
TRAEFIK["🚪 Traefik<br/>(Reverse Proxy)"]
34-
DNS["🌐 Technitium DNS<br/>(Internal DNS)"]
35-
MONITORING["📊 Prometheus/Grafana<br/>(Monitoring)"]
33+
TRAEFIK("Traefik (Reverse Proxy)")
34+
DNS("Technitium DNS (Internal DNS)")
35+
MONITORING("Prometheus/Grafana (Monitoring)")
3636
end
3737
3838
subgraph "Application Services"
39-
APPS["🚀 Applications<br/>(Home Assistant, Photoprism, etc.)"]
39+
APPS("Applications (Home Assistant, etc.)")
4040
end
4141
4242
%% Data Flow
4343
USER --> TASK
44-
TASK -- triggers --> ANSIBLE
45-
ANSIBLE -- reads --> PLAYBOOKS
46-
ANSIBLE -- uses --> DOT_ENV
47-
ANSIBLE -- uses --> INVENTORY
48-
ANSIBLE -- reads service definitions from --> STACKS_DIR
44+
TASK -- "triggers" --> ANSIBLE
45+
ANSIBLE -- "reads" --> PLAYBOOKS
46+
ANSIBLE -- "uses" --> DOT_ENV
47+
ANSIBLE -- "uses" --> INVENTORY
48+
ANSIBLE -- "reads service definitions from" --> STACKS_DIR
4949
5050
%% Deployment Flow
51-
ANSIBLE -- deploys to --> MANAGER
52-
MANAGER -- manages --> WORKERS
53-
MANAGER -- creates --> SWARM_NETWORK
54-
MANAGER -- deploys --> TRAEFIK
55-
MANAGER -- deploys --> DNS
56-
MANAGER -- deploys --> MONITORING
57-
MANAGER -- deploys --> APPS
51+
ANSIBLE -- "deploys to" --> MANAGER
52+
MANAGER -- "manages" --> WORKERS
53+
MANAGER -- "creates" --> SWARM_NETWORK
54+
MANAGER -- "deploys" --> TRAEFIK
55+
MANAGER -- "deploys" --> DNS
56+
MANAGER -- "deploys" --> MONITORING
57+
MANAGER -- "deploys" --> APPS
5858
5959
%% Service Interaction
60-
TRAEFIK -- routes traffic to --> APPS
61-
DNS -- resolves domains for --> APPS
60+
TRAEFIK -- "routes traffic to" --> APPS
61+
DNS -- "resolves domains for" --> APPS
6262
end
6363
```
6464

docs/architecture/overview.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ The platform deploys Docker containers using Docker Swarm across one or more mac
88

99
```mermaid
1010
graph LR
11-
subgraph "Configuration"
12-
A["📄 .env file"]
13-
B["⚙️ ansible/inventory/02-hosts.yml"]
14-
C["📁 stacks/"]
11+
subgraph Configuration
12+
A[".env file"]
13+
B["ansible/inventory/02-hosts.yml"]
14+
C["stacks/"]
1515
end
16-
subgraph "Execution"
17-
D["🤖 Ansible<br/>(triggered by 'task')"]
16+
subgraph Execution
17+
D["Ansible (triggered by 'task')"]
1818
end
19-
subgraph "Result"
20-
E["🐝 Docker Swarm Cluster"]
21-
F["🚀 Running Services"]
19+
subgraph Result
20+
E["Docker Swarm Cluster"]
21+
F["Running Services"]
2222
end
2323
2424
A --> D

docs/index.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -179,33 +179,33 @@ task ansible:deploy:stack -- -e "stack_name=homepage"
179179
```mermaid
180180
graph TB
181181
subgraph "User & Configuration"
182-
USER[🧑‍💻 User]
183-
TASK[🔵 Taskfile.yml]
184-
DOT_ENV["📄 .env"]
185-
INVENTORY["⚙️ ansible/inventory/02-hosts.yml"]
186-
STACKS_DIR["📁 stacks/"]
182+
USER("User")
183+
TASK("Taskfile.yml")
184+
DOT_ENV(".env")
185+
INVENTORY("ansible/inventory/02-hosts.yml")
186+
STACKS_DIR("stacks/")
187187
end
188188
189189
subgraph "Orchestration"
190-
ANSIBLE["🤖 Ansible Playbooks"]
190+
ANSIBLE("Ansible Playbooks")
191191
end
192192
193193
subgraph "Docker Swarm Cluster"
194-
MANAGER["👑 Manager Node"]
195-
WORKER["- Worker Node"]
196-
TRAEFIK["🚪 Traefik Proxy"]
197-
APPS["🚀 Apps"]
194+
MANAGER("Manager Node")
195+
WORKER("Worker Node")
196+
TRAEFIK("Traefik Proxy")
197+
APPS("Apps")
198198
end
199199
200-
USER -- runs --> TASK
201-
TASK -- triggers --> ANSIBLE
202-
ANSIBLE -- reads --> DOT_ENV
203-
ANSIBLE -- reads --> INVENTORY
204-
ANSIBLE -- reads --> STACKS_DIR
205-
ANSIBLE -- deploys to --> MANAGER
206-
MANAGER -- manages --> WORKER
207-
MANAGER -- runs --> TRAEFIK
208-
MANAGER -- runs --> APPS
200+
USER -- "runs" --> TASK
201+
TASK -- "triggers" --> ANSIBLE
202+
ANSIBLE -- "reads" --> DOT_ENV
203+
ANSIBLE -- "reads" --> INVENTORY
204+
ANSIBLE -- "reads" --> STACKS_DIR
205+
ANSIBLE -- "deploys to" --> MANAGER
206+
MANAGER -- "manages" --> WORKER
207+
MANAGER -- "runs" --> TRAEFIK
208+
MANAGER -- "runs" --> APPS
209209
```
210210

211211
## 🚀 Getting Started

0 commit comments

Comments
 (0)