Skip to content

Commit cfcbae9

Browse files
NormBNormB
authored
fix: align ASCII diagrams across documentation (#70)
- NETWORK_SEGMENTATION.md: Uniform 12-char wide boxes, proper spacing - REDIS.md: Restructured cluster nodes with aligned inner boxes - TROUBLESHOOTING.md: Centered header, consistent border width - fastapi-api-first/README.md: Standardized API workflow diagram
1 parent 0d8ce54 commit cfcbae9

File tree

4 files changed

+119
-95
lines changed

4 files changed

+119
-95
lines changed

‎docs/NETWORK_SEGMENTATION.md‎

Lines changed: 55 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -45,45 +45,61 @@ DevStack Core implements **4-tier network segmentation** to provide logical isol
4545
## Network Architecture
4646

4747
```
48-
┌─────────────────────────────────────────────────────────────────┐
49-
│ DEVSTACK CORE NETWORKS │
50-
│ (4-Tier Segmentation) │
51-
└─────────────────────────────────────────────────────────────────┘
52-
53-
┌─────────────────────────────────────────────────────────────────┐
54-
│ VAULT NETWORK (172.20.1.0/24) - Infrastructure Tier │
55-
│ ┌─────────┐ │
56-
│ │ Vault │◄───── All services connect here for secrets │
57-
│ └─────────┘ │
58-
└─────────────────────────────────────────────────────────────────┘
59-
│
60-
│ AppRole Auth
61-
▼
62-
┌─────────────────────────────────────────────────────────────────┐
63-
│ DATA NETWORK (172.20.2.0/24) - Data Tier │
64-
│ ┌──────────┐ ┌───────┐ ┌─────────┐ ┌────────┐ ┌──────────┐ │
65-
│ │PostgreSQL│ │ MySQL │ │ MongoDB │ │Redis x3│ │ RabbitMQ │ │
66-
│ └──────────┘ └───────┘ └─────────┘ └────────┘ └──────────┘ │
67-
└─────────────────────────────────────────────────────────────────┘
68-
│
69-
│ Database Connections
70-
▼
71-
┌─────────────────────────────────────────────────────────────────┐
72-
│ APP NETWORK (172.20.3.0/24) - Application Tier │
73-
│ ┌─────────┐ ┌──────────────────────────────────────┐ │
74-
│ │ Forgejo │ │ Reference APIs (Python/Go/Node/ │ │
75-
│ │ (Git) │ │ Rust/TypeScript) │ │
76-
│ └─────────┘ └──────────────────────────────────────┘ │
77-
└─────────────────────────────────────────────────────────────────┘
78-
│
79-
│ Metrics & Logs
80-
▼
81-
┌─────────────────────────────────────────────────────────────────┐
82-
│ OBSERVABILITY NETWORK (172.20.4.0/24) - Monitoring Tier │
83-
│ ┌────────────┐ ┌─────────┐ ┌──────┐ ┌────────┐ ┌─────────┐ │
84-
│ │ Prometheus │ │ Grafana │ │ Loki │ │ Vector │ │cAdvisor │ │
85-
│ └────────────┘ └─────────┘ └──────┘ └────────┘ └─────────┘ │
86-
└─────────────────────────────────────────────────────────────────┘
48+
┌───────────────────────────────────────────────────────────────────────────┐
49+
│ DEVSTACK CORE NETWORKS │
50+
│ (4-Tier Segmentation) │
51+
└───────────────────────────────────────────────────────────────────────────┘
52+
53+
┌───────────────────────────────────────────────────────────────────────────┐
54+
│ VAULT NETWORK (172.20.1.0/24) - Infrastructure Tier │
55+
│ │
56+
│ ┌─────────────┐ │
57+
│ │ Vault │ ◄───── All services connect here for secrets │
58+
│ └─────────────┘ │
59+
│ │
60+
└───────────────────────────────────────────────────────────────────────────┘
61+
│
62+
│ AppRole Auth
63+
▼
64+
┌───────────────────────────────────────────────────────────────────────────┐
65+
│ DATA NETWORK (172.20.2.0/24) - Data Tier │
66+
│ │
67+
│ ┌────────────┐ ┌────────────┐ ┌────────────┐ ┌────────────┐ │
68+
│ │ PostgreSQL │ │ MySQL │ │ MongoDB │ │ Redis x3 │ │
69+
│ └────────────┘ └────────────┘ └────────────┘ └────────────┘ │
70+
│ │
71+
│ ┌────────────┐ │
72+
│ │ RabbitMQ │ │
73+
│ └────────────┘ │
74+
│ │
75+
└───────────────────────────────────────────────────────────────────────────┘
76+
│
77+
│ Database Connections
78+
▼
79+
┌───────────────────────────────────────────────────────────────────────────┐
80+
│ APP NETWORK (172.20.3.0/24) - Application Tier │
81+
│ │
82+
│ ┌─────────────┐ ┌─────────────────────────────────────────────────────┐ │
83+
│ │ Forgejo │ │ Reference APIs (Python/Go/Node/Rust/TypeScript) │ │
84+
│ │ (Git) │ └─────────────────────────────────────────────────────┘ │
85+
│ └─────────────┘ │
86+
│ │
87+
└───────────────────────────────────────────────────────────────────────────┘
88+
│
89+
│ Metrics & Logs
90+
▼
91+
┌───────────────────────────────────────────────────────────────────────────┐
92+
│ OBSERVABILITY NETWORK (172.20.4.0/24) - Monitoring Tier │
93+
│ │
94+
│ ┌────────────┐ ┌────────────┐ ┌────────────┐ ┌────────────┐ │
95+
│ │ Prometheus │ │ Grafana │ │ Loki │ │ Vector │ │
96+
│ └────────────┘ └────────────┘ └────────────┘ └────────────┘ │
97+
│ │
98+
│ ┌────────────┐ │
99+
│ │ cAdvisor │ │
100+
│ └────────────┘ │
101+
│ │
102+
└───────────────────────────────────────────────────────────────────────────┘
87103
```
88104

89105
---

‎docs/REDIS.md‎

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -63,23 +63,29 @@ graph TB
6363

6464
**Text Summary:**
6565
```
66-
┌────────────────────────────────────────────┐
67-
│ Redis Cluster (16384 slots) │
68-
├────────────────────────────────────────────┤
69-
│ │
70-
│ Node 1 (172.20.2.13:6379) │
71-
│ Master | Slots 0-5460 (5461 slots) │
72-
│ Ports: 6379 (non-TLS), 6390 (TLS) │
73-
│ │
74-
│ Node 2 (172.20.2.14:6380) │
75-
│ Master | Slots 5461-10922 (5462 slots) │
76-
│ Ports: 6380 (non-TLS), 6391 (TLS) │
77-
│ │
78-
│ Node 3 (172.20.2.15:6381) │
79-
│ Master | Slots 10923-16383 (5461 slots) │
80-
│ Ports: 6381 (non-TLS), 6392 (TLS) │
81-
│ │
82-
└────────────────────────────────────────────┘
66+
┌─────────────────────────────────────────────────────────────────────────────┐
67+
│ Redis Cluster (16384 slots) │
68+
├─────────────────────────────────────────────────────────────────────────────┤
69+
│ │
70+
│ ┌─────────────────────────────────────────────────────────────────────┐ │
71+
│ │ Node 1 (172.20.2.13:6379) │ │
72+
│ │ Master | Slots 0-5460 (5461 slots) │ │
73+
│ │ Ports: 6379 (non-TLS), 6390 (TLS) │ │
74+
│ └─────────────────────────────────────────────────────────────────────┘ │
75+
│ │
76+
│ ┌─────────────────────────────────────────────────────────────────────┐ │
77+
│ │ Node 2 (172.20.2.14:6380) │ │
78+
│ │ Master | Slots 5461-10922 (5462 slots) │ │
79+
│ │ Ports: 6380 (non-TLS), 6391 (TLS) │ │
80+
│ └─────────────────────────────────────────────────────────────────────┘ │
81+
│ │
82+
│ ┌─────────────────────────────────────────────────────────────────────┐ │
83+
│ │ Node 3 (172.20.2.15:6381) │ │
84+
│ │ Master | Slots 10923-16383 (5461 slots) │ │
85+
│ │ Ports: 6381 (non-TLS), 6392 (TLS) │ │
86+
│ └─────────────────────────────────────────────────────────────────────┘ │
87+
│ │
88+
└─────────────────────────────────────────────────────────────────────────────┘
8389
```
8490

8591
**Data Sharding:**

‎docs/TROUBLESHOOTING.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -132,17 +132,17 @@ flowchart TD
132132
### Quick Diagnostic Commands
133133

134134
```
135-
┌─────────────────────────────────────────────────────────────┐
136-
│ QUICK DIAGNOSTICS │
137-
├─────────────────────────────────────────────────────────────┤
138-
│ │
139-
│ Overall status: ./devstack health │
140-
│ Service logs: ./devstack logs SERVICE │
141-
│ Vault status: ./devstack vault-status │
142-
│ Container status: docker ps -a │
143-
│ Resource usage: docker stats │
144-
│ │
145-
└─────────────────────────────────────────────────────────────┘
135+
┌─────────────────────────────────────────────────────────────────────────────┐
136+
│ QUICK DIAGNOSTICS │
137+
├─────────────────────────────────────────────────────────────────────────────┤
138+
│ │
139+
│ Overall status: ./devstack health │
140+
│ Service logs: ./devstack logs SERVICE │
141+
│ Vault status: ./devstack vault-status │
142+
│ Container status: docker ps -a │
143+
│ Resource usage: docker stats │
144+
│ │
145+
└─────────────────────────────────────────────────────────────────────────────┘
146146
```
147147

148148
---

0 commit comments

Comments
 (0)