How bsgip/envoy works
Main Components
a) Core Services (3 main applications):
• Server Application (Primary API Service)
• Admin Application
• Notification Service
b) External Dependencies:
• PostgreSQL Database
• RabbitMQ (Optional, for notifications)
• Azure AD (Optional, for authentication)
c) Client Integration Points:
• Smart Devices (CSIP-Aus compliant)
• Admin Clients
• Monitoring Systems
Client Layer (Top)
• Smart Devices (2030.5/CSIP/CSIP-Aus)
• Admin Clients
• Monitoring Systems
API Gateway Layer
• TLS Termination
• Certificate Validation
• Azure AD Authentication (if enabled)
Application Layer (Core Services)
• Server Application
• API Modules (sep2, csip_aus)
• CRUD Operations
• Managers
• Mappers
• Admin Application
• API Endpoints
• CRUD Operations
• Notification Service
• Task Workers
• Notification Handlers
Message Queue Layer
• RabbitMQ (for async notifications)
Data Layer
• PostgreSQL Database
• Cache System
Connection Types
• Double lines: Database connections
Key Elements to Highlight
a) Security Features:
• TLS Termination
• Certificate-based Authentication
• Azure AD Integration
• HTTP Basic Auth for Admin
b) Data Flows:
• Smart Device Communications
• Notification Paths
• Admin Operations
• Database Interactions
c) Scalability Points:
• Worker Pools
• Message Queue
• Database Connections
Additional Details
Annotations for:
• Supported Standards (2030.5, CSIP, CSIP-Aus)
• Configuration Options
• Database Migration Paths
• Environment Variables
Implementation Notes
• FastAPI-based Implementation
• Async Nature of Operations
• Multiple Service Integration
• Extensibility Points
This system design should reflect the modular nature of the project while highlighting its core functionality as a CSIP-Aus compliant utility server with multiple integration points and optional features.