How mudigal-technologies/microservices-sample works
Main Components
a. Client Layer:
• Web Application (Angular-based frontend)
• Connection to API Gateway
b. API Gateway Layer:
• Netflix Zuul as the API Gateway
• Routing paths (/service-one/, /service-two/)
c. Service Layer:
• Service One (Spring Boot microservice)
• Service Two (Spring Boot microservice)
• Each with their respective databases
d. Infrastructure Components:
• Consul (Service Registration & Discovery)
• RabbitMQ (Asynchronous Communication)
• ELK Stack (Elasticsearch, Logstash, Kibana)
• Weave Scope (Monitoring)
[Client Layer]
• ↓
[API Gateway Layer]
• ↓
[Service Registry Layer]
• ↓
[Service Layer]
• ↓
[Data Layer]
Connection Types
• Log streaming (wavy lines)
Specific Implementation Details
a. Following flows:
• Service registration flow with Consul
• Service discovery through API Gateway
• RabbitMQ message exchange between services
• Log aggregation flow to ELK stack
b. Key components with their ports:
• API Gateway (8080)
• Consul UI (8500)
• RabbitMQ (15672)
• Kibana (5601)
• Elasticsearch (9200)
Additional Elements
Include:
• Docker container boundaries
• Service names and versions
• Database types (MySQL for service-two)
• Key configuration endpoints
• Health check paths
• Swagger API documentation endpoints
Notes Section
Callouts for:
• Scalability points
• Resilience patterns
• Security boundaries
• Monitoring points
• Log collection paths
• The microservices architecture pattern
• Service independence
• Asynchronous communication
• Centralized logging
• Service discovery mechanism
• Container-based deployment
Remember to maintain a balance between detail and clarity, focusing on the architectural decisions while avoiding overwhelming implementation details.
This system design should clearly show how the application achieves its microservices goals through service independence, scalability, and resilience, while maintaining observability through the integrated monitoring and logging solutions.