How koushikgurijala/robotshop works
Main Components
• Microservices: Each service (cart, catalogue, dispatch, payment, ratings, shipping, user, web) is implemented as a containerized application (with its own Dockerfile). Label these as “Business Services.”
• Supporting Infrastructure:
– Database Containers: MongoDB (for catalogue or other data), MySQL (for ratings or transactional data).
– Messaging Systems: RabbitMQ for event dissemination and Redis for caching.
– Logging/Monitoring: Fluentd is included for log collection and forwarding.
• Testing and Mimicking Components:
– Test Doubles/Mocks: The “mockitoApp” module shows examples of service mocking using Mockito.
– Load Generators: The “load-gen” directory.
• Deployment and Orchestration:
– Deployment scripts for DCOS, Kubernetes (with Istio – see canary.yaml, gateway.yaml, Helm charts), OpenShift, and Swarm indicate that this application is meant to be deployed in multi-orchestrator environments.
– CI/CD Pipelines: Under .github/workflows there are various pipeline configuration files for automated builds, push, and tests.
Relationships and Data Flows
• How the frontend “web” service interacts with business logic services (cart, catalogue, payment, etc.).
• REST or HTTP API calls between the “web” service and other microservices.
• Logging (Fluentd) as peripherals receiving logs from services.
• Testing layer: for example, “load-gen” might send simulated requests to the “web” service, and “mockitoApp” can be shown as a separate service or tool that simulates or verifies interactions.
• CI/CD pipelines (GitHub actions) and orchestration engines (Kubernetes, DCOS, etc.) as an outer layer managing deployments of all these components.
Architectural Patterns and Design Principles
• Microservices Architecture: Emphasize that each service is containerized and independently deployable.
• Service Virtualization: Note that the README emphasizes test doubles (stubs, mocks, and virtualization) to simulate external systems in testing.
• Multi-environment Deployment: Indicate that similar deployments exist for Kubernetes, DCOS, OpenShift, and Swarm – each with their own manifests and Helm charts.
• CI/CD and DevOps Focus: Show that continuous testing, shift-left testing mechanisms, and automated pipelines are a central design element.
Relevant Technologies
• Containerization: Dockerfiles for every service.
• Orchestration: Kubernetes (with Helm charts, Istio templates), plus DCOS, OpenShift, and Swarm – represent these layers distinctly.
• Testing Tools: Mockito (for mocking in “mockitoApp”), WireMock (as mentioned in the README), and references to Broadcom DevTest.
• CI/CD: GitHub workflows for deployment pipelines.
Details
• While the project can be broken into many small components, capturing each microservice and related infrastructure is essential.
• Pay special attention to differentiating deployment manifests (K8s/Helm, DCOS, OpenShift, Swarm) as they validate the readiness for multiple deployment environments.
• Use labels that indicate whether a component is a “service”, “database”, “orchestration artifact”, or “testing tool” to help clarify the structure.