🏗️ Ingress Prerequisites - Architecture & API Documentation
📊 How to View These Diagrams:
Method Command/Action VS Code Extension Install bierner.markdown-mermaid- then pressCtrl+Shift+Vto previewMermaid CLI npm i -g @mermaid-js/mermaid-cli && mmdc -i ARCHITECTURE.md -o arch.svgOnline Editor Copy diagrams to mermaid.live GitHub Push to GitHub - renders automatically in markdown preview MkDocs Already configured in your mkdocs.ymlwithpymdownx.superfences
📐 High-Level Architecture
🔌 Service Port Map
🌐 API Endpoint Reference
Frontend Service (Port 8080)
Backend Service (Port 3000)
Product Service (Port 8080)
Cart Service (Port 9090)
Auth Service (Port 7070)
User Service (Port 3000)
Admin Panel (Port 9000)
Config Service (Port 4000)
Health Check Service (Port 8080)
🔄 Request Flow Diagrams
E-Commerce Flow
Admin Monitoring Flow
🌐 Kubernetes DNS Resolution
📁 Helm Chart Structure
🚀 Deployment Sequence
🎯 Ingress Routing Examples
📊 Complete API Reference Table
| Service | Port | Method | Endpoint | Description | Response |
|---|---|---|---|---|---|
| Frontend | 8080 | GET | / | Homepage | HTML |
| GET | /products | Product catalog | HTML (proxies) | ||
| GET | /cart | Shopping cart | HTML (proxies) | ||
| GET | /services | Service status | HTML | ||
| GET | /api | API docs | HTML | ||
| GET | /about | About page | HTML | ||
| GET | /contact | Contact page | HTML | ||
| GET | /health | Health check | JSON | ||
| Backend | 3000 | GET | / | Dashboard | HTML |
| GET | /stats | Request stats | HTML | ||
| GET | /metrics | System metrics | HTML | ||
| GET | /info | System info | HTML | ||
| GET | /logs | Recent logs | HTML | ||
| GET | /api/endpoints | API reference | JSON | ||
| GET | /health | Health check | JSON | ||
| GET | /ready | Readiness probe | JSON | ||
| Product | 8080 | GET | / | All products | HTML |
| GET | /featured | Featured items | HTML | ||
| GET | /categories | Categories list | HTML | ||
| GET | /category/:name | By category | HTML | ||
| GET | /product/:id | Product detail | HTML | ||
| GET | /search?q= | Search products | HTML | ||
| GET | /api/products | All products | JSON | ||
| GET | /api/product/:id | Product by ID | JSON | ||
| GET | /health | Health check | JSON | ||
| Cart | 9090 | GET | / | View cart | HTML |
| GET/POST | /add | Add to cart | HTML | ||
| GET | /remove?id= | Remove item | HTML | ||
| GET | /update?id=&qty= | Update quantity | HTML | ||
| GET | /clear | Clear cart | HTML | ||
| GET | /summary | Cart summary | HTML | ||
| GET | /checkout | Checkout | HTML | ||
| GET | /history | Order history | HTML | ||
| GET | /api/cart | Cart data | JSON | ||
| Auth | 7070 | GET | / | Auth dashboard | HTML |
| GET/POST | /login | User login | HTML | ||
| GET/POST | /register | Registration | HTML | ||
| GET | /logout?session= | Logout | HTML | ||
| GET | /sessions | Active sessions | HTML | ||
| GET | /users | User list | HTML | ||
| GET | /validate?token= | Validate token | JSON | ||
| GET | /refresh?token= | Refresh token | JSON | ||
| GET | /health | Health check | JSON | ||
| User | 3000 | GET | / | User dashboard | HTML |
| GET | /users | User list | HTML | ||
| GET | /user/:id | User profile | HTML | ||
| GET/POST | /create | Create user | HTML | ||
| GET/POST | /edit/:id | Edit user | HTML | ||
| GET | /delete/:id | Delete user | HTML | ||
| GET | /search?q= | Search users | HTML | ||
| GET | /departments | Department view | HTML | ||
| GET | /api/users | All users | JSON | ||
| Admin | 9000 | GET | / | Admin dashboard | HTML |
| GET | /services | Service list | HTML | ||
| GET | /metrics | Metrics | HTML | ||
| GET | /logs | Admin logs | HTML | ||
| GET | /config | Configuration | HTML | ||
| GET | /network | Network view | HTML | ||
| GET | /api/status | Service status | JSON | ||
| Config | 4000 | GET | / | Config dashboard | HTML |
| GET | /features | Feature flags | HTML | ||
| GET | /services | Service config | HTML | ||
| GET | /database | DB config | HTML | ||
| GET | /security | Security config | HTML | ||
| GET | /audit | Audit log | HTML | ||
| GET | /toggle?feature= | Toggle flag | HTML | ||
| GET | /api/config | Full config | JSON | ||
| Health | 8080 | GET | / | Health dashboard | HTML |
| GET | /details | Service details | HTML | ||
| GET | /history | Health history | HTML | ||
| GET | /health | Health check | JSON | ||
| GET | /ready | Readiness probe | JSON | ||
| GET | /live | Liveness probe | JSON | ||
| GET | /api/services | All services | JSON |
🛠️ Quick Commands
bash
# View this file with Mermaid rendering
code ARCHITECTURE.md # Then Ctrl+Shift+V for preview
# Generate SVG diagrams
npm install -g @mermaid-js/mermaid-cli
mmdc -i ARCHITECTURE.md -o diagrams/architecture.svg -t dark
# Generate PNG diagrams
mmdc -i ARCHITECTURE.md -o diagrams/architecture.png -t dark -b transparent
# Generate PDF
mmdc -i ARCHITECTURE.md -o diagrams/architecture.pdf -t dark
# View in browser (mermaid.live)
xdg-open "https://mermaid.live"