How rodrigorodrigues/microservices-design-patterns works
Main Components
• Core Services: Represent each microservice as a separate component:
• Java-based services: admin-server, authentication-service, person-service, user-service, edge-server, redis-jackson-security-webauthn-otp.
• Other language-based services: go-service, nodejs-service, kotlin-service, python-service, quarkus-service.
• Shared Libraries/Commons: authentication-common and web-common, which provide common configurations and utilities across services.
• Frontends: react-webapp (web application) and react-native-app (Android/native app).
• Supporting Infrastructure:
• API Gateway / Edge service: The edge-server that routes and filters incoming requests.
• Service Discovery & Configuration: Mark a component representing Consul (for service discovery and configuration management) and Spring Cloud Config.
• Monitoring & Logging: Include monitoring components such as Prometheus, Grafana, Jaeger (for distributed tracing), and logging aggregators (Logstash, Loki).
• Databases: Each microservice uses its own database instance (typically MongoDB for persistence) and a shared Redis instance for session information.
• The frontend applications (React and React Native) call the API Gateway/edge-server.
• The edge-server routes authenticated requests to individual microservices.
• Each microservice communicates with its own dedicated database and may also interact with shared resources (e.g., Redis).
• A centralized configuration component (Consul/Config Server) feeds configuration data to the services.
• Service discovery (also provided by Consul) shows how services locate and communicate with one another.
• CI/CD pipelines (both Travis and GitHub Actions) are used to build, test, and deploy these services; you might illustrate these as external tooling that triggers builds and deployment processes.
Architectural Patterns and Technologies
• Microservices Pattern: Show each microservice as an independent deployable unit.
• API Gateway Pattern: Emphasize the edge-server that secures, routes, and aggregates service responses.
• “Database per Service” Pattern: Indicate multiple, independent MongoDB instances.
• Containerization & Orchestration: Illustrate Docker images and the Kubernetes deployment layer.
• CI/CD Integration: Optionally, include a side-panel illustrating CI/CD pipelines targeting multiple platforms (linux/amd64, linux/arm64).
Adding Detailed Elements
• Inside it, partition areas for:
• Back-end services (each microservice as an individual block).
• Frontend applications.
• Infrastructure components such as Consul, Redis, and MongoDB.
• CI/CD pipelines (as external systems that are part of the deployment management process).
• Use legends or notes to clarify which services are implemented in which language, so the multi-language nature of the system is highlighted.
Be Detailed, But Stay Organized
• Detail deployment artifacts such as Dockerfiles, Kubernetes manifests, and CI/CD configuration files (which are visible in the file tree) to emphasize the modern DevOps approach.