|
1 | 1 | # Infrastructure Diagrams |
2 | 2 |
|
3 | | -This folder contains Draw.io diagrams for the Kainos Studio infrastructure architecture. |
| 3 | +This folder contains high-level architecture diagrams for the Kainos Studio infrastructure using Mermaid syntax for better visibility and version control. |
4 | 4 |
|
5 | 5 | ## 📊 Available Diagrams |
6 | 6 |
|
7 | | -### End-to-End Architecture |
8 | | -- **[kainos-studio-architecture.drawio](./kainos-studio-architecture.drawio)** - Complete system architecture |
9 | | -- **[kainos-studio-architecture.png](./kainos-studio-architecture.png)** - PNG export of architecture |
| 7 | +### High-Level Architecture |
| 8 | +- **[kainos-studio-architecture.md](./kainos-studio-architecture.md)** - Complete system architecture overview |
10 | 9 |
|
11 | | -### Environment Flow Diagrams |
12 | | -- **[dev-deployment-flow.drawio](./dev-deployment-flow.drawio)** - Development environment deployment flow |
13 | | -- **[staging-deployment-flow.drawio](./staging-deployment-flow.drawio)** - Staging environment deployment flow |
14 | | -- **[prod-deployment-flow.drawio](./prod-deployment-flow.drawio)** - Production environment deployment flow |
| 10 | +### Deployment Flow Diagrams |
| 11 | +- **[dev-deployment-flow.md](./dev-deployment-flow.md)** - Development environment deployment flow |
| 12 | +- **[staging-deployment-flow.md](./staging-deployment-flow.md)** - Staging environment deployment flow |
| 13 | +- **[prod-deployment-flow.md](./prod-deployment-flow.md)** - Production environment deployment flow |
15 | 14 |
|
16 | | -## 🎨 How to Edit Diagrams |
| 15 | +## 🎨 Viewing Diagrams |
17 | 16 |
|
18 | | -1. **Online**: Visit [draw.io](https://app.diagrams.net/) and open the `.drawio` files |
19 | | -2. **VS Code**: Install the Draw.io Integration extension |
20 | | -3. **Desktop**: Download Draw.io desktop application |
| 17 | +All Mermaid diagrams render directly in GitHub for easy viewing and collaboration. |
21 | 18 |
|
22 | 19 | ## 📋 Diagram Standards |
23 | 20 |
|
24 | | -- Use AWS/Azure official icons from the shape libraries |
| 21 | +- Use consistent color coding: |
| 22 | + - Orange (#FF9900): AWS services |
| 23 | + - Blue (#0078D4): Azure services |
| 24 | + - Green (#28A745): Application components |
| 25 | + - Red (#DC3545): Security boundaries |
| 26 | + - Gray (#6C757D): External services |
| 27 | + |
25 | 28 | - Include environment labels (dev/staging/prod) |
26 | 29 | - Show data flow directions with arrows |
27 | | -- Include security boundaries and zones |
28 | | -- Use consistent color coding: |
29 | | - - Orange: AWS services |
30 | | - - Blue: Azure services |
31 | | - - Green: Application components |
32 | | - - Red: Security boundaries |
33 | | - - Gray: External services |
| 30 | +- Keep diagrams high-level and focused |
| 31 | +- Use meaningful component names |
34 | 32 |
|
35 | 33 | ## 🔄 Updating Diagrams |
36 | 34 |
|
37 | 35 | When infrastructure changes: |
38 | | -1. Update the relevant `.drawio` file |
39 | | -2. Export as PNG for easy viewing |
40 | | -3. Commit both files to version control |
| 36 | +1. Update the relevant `.md` file with Mermaid syntax |
| 37 | +2. Test rendering in GitHub |
| 38 | +3. Commit changes to version control |
41 | 39 | 4. Update this README if new diagrams are added |
0 commit comments