# swayam-prakash-bhuyan/sock-shop-demo architecture

> Architecture diagram of the GitHub repository swayam-prakash-bhuyan/sock-shop-demo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-24). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/swayam-prakash-bhuyan/sock-shop-demo
- Repository: https://github.com/swayam-prakash-bhuyan/sock-shop-demo

## Overview

##### Project type and purpose
- This is the “Sock Shop” reference microservices demo: a full-stack, containerized, multi-architecture e-commerce application built to showcase cloud-native and microservice patterns on Kubernetes/OpenShift.
- It comprises eight independent microservices (front-end, carts, catalogue, orders, payment, user, shipping, queue-master) plus backing databases and a message broker (RabbitMQ).

##### File structure
- Top-level “automation” folder holds Dockerfiles for each microservice and its supporting DB container (e.g., Dockerfile-carts, Dockerfile-catalogue, Dockerfile-user-db, etc.).
- “manifests” contains a Kustomize base (manifests/base) defining Deployments, Services, PVCs for each component, plus overlays (manifests/overlays/…) for different deployment scenarios (fyre, multi, multi-hpa, power, etc.).

##### README for architecture insights
- Lists each microservice and its repo, and notes the use of Spring Boot, Go kit, Node.js.
- Describes three deployment overlays (fyre, multi, multi-hpa) showing that k8s is a primary platform.
- Links to an existing “Architecture.png” showing service interactions and data flow between UI, services, queues, and databases.

a. Main components
- External: Browser or API client.
- Front-end service (Node.js).
- Backend microservices: carts, catalogue, orders, payment, user, shipping, queue-master.
- Message broker: RabbitMQ.
- Databases: carts-db, catalogue-db, orders-db, user-db, session-db.
- Kubernetes constructs: Deployments (Pods), Services, PVCs; Route/Ingress for front-end.
b. Relationships & interactions
- Browser → front-end (HTTP/HTTPS).
- front-end → API calls to carts, catalogue, orders, payment, user, shipping (HTTP/gRPC).
- carts, orders, shipping, payment may publish/consume events via queue-master & RabbitMQ.
- Each service reads/writes its own database.
- session-db used by front-end or user service for session persistence.
c. Architectural patterns & principles
- Independent microservices, each with its own data store (database per service pattern).
- API gateway / UI layer (front-end) decouples client from microservices.
- Asynchronous messaging for certain flows (via RabbitMQ + queue-master).
- Containerization + Kubernetes native objects (Deployments, Services, PVCs, HPA in multi-hpa overlay).
- Multi-architecture image support for heterogeneous clusters.
d. Key technologies
- Node.js (front-end), Spring Boot (orders, payment, user, shipping), Go kit (catalogue, queue-master, carts).
- Docker, Kubernetes (Kustomize manifests, Deployments/Services), OpenShift Route or Ingress.
- RabbitMQ for messaging, MongoDB or equivalent for microservice databases.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Presentation Tier
    subgraph "Presentation Tier"
        direction TB
        Browser["Browser/API Client"]:::external
        FrontEndSvc["Front-end Service"]:::frontend
        FrontEndDep["Front-end Deployment (Pod)"]:::frontend
        RouteFE["Route/Ingress"]:::k8s
    end

    %% API Tier
    subgraph "API Tier"
        direction TB
        CartsSvc["Carts Service"]:::micro
        CatalogueSvc["Catalogue Service"]:::micro
        OrdersSvc["Orders Service"]:::micro
        PaymentSvc["Payment Service"]:::micro
        UserSvc["User Service"]:::micro
        ShippingSvc["Shipping Service"]:::micro
    end

    %% Messaging Tier
    subgraph "Messaging Tier"
        direction TB
        RabbitMQSvc["RabbitMQ Service"]:::message
        RabbitMQDep["RabbitMQ Deployment (Pod)"]:::message
        QueueMasterSvc["Queue-master Service"]:::message
        QueueMasterDep["Queue-master Deployment (Pod)"]:::message
    end

    %% Data Tier
    subgraph "Data Tier"
        direction TB
        CartsDB["Carts DB"]:::db
        CatalogueDB["Catalogue DB"]:::db
        OrdersDB["Orders DB"]:::db
        UserDB["User DB"]:::db
        SessionDB["Session DB"]:::db
    end

    %% Connections: Presentation -> API
    Browser -->|"HTTP/HTTPS"| FrontEndSvc
    RouteFE --> FrontEndSvc
    FrontEndSvc --> FrontEndDep

    %% Front-end -> backend services
    FrontEndDep -->|"HTTP/gRPC"| CartsSvc
    FrontEndDep -->|"HTTP/gRPC"| CatalogueSvc
    FrontEndDep -->|"HTTP/gRPC"| OrdersSvc
    FrontEndDep -->|"HTTP/gRPC"| PaymentSvc
    FrontEndDep -->|"HTTP/gRPC"| UserSvc
    FrontEndDep -->|"HTTP/gRPC"| ShippingSvc

    %% Messaging interactions
    CartsSvc -->|AMQP| RabbitMQSvc
    OrdersSvc -->|AMQP| RabbitMQSvc
    ShippingSvc -->|AMQP| RabbitMQSvc
    PaymentSvc -->|AMQP| RabbitMQSvc
    RabbitMQSvc --> QueueMasterSvc

    %% Microservices -> Databases
    CartsSvc --> CartsDB
    CatalogueSvc --> CatalogueDB
    OrdersSvc --> OrdersDB
    UserSvc --> UserDB
    FrontEndSvc --> SessionDB

    %% Kubernetes internals dashed grouping (optional)
    classDef k8s fill:none,stroke:#888,stroke-dasharray: 5 5,color:#555;
    classDef frontend fill:#b3cde0,stroke:#036,stroke-width:1px,color:#036;
    classDef micro fill:#c7e9c0,stroke:#236,stroke-width:1px,color:#236;
    classDef db fill:#feb24c,stroke:#a45a00,stroke-width:1px,color:#a45a00;
    classDef message fill:#decbe4,stroke:#642,stroke-width:1px,color:#642;
    classDef external fill:#fdd0a2,stroke:#842,color:#842;

    %% Click Events
    click FrontEndDep "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/tree/main/automation/Dockerfile-front-end"
    click FrontEndSvc "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/blob/main/manifests/base/10-front-end-svc.yaml"
    click RouteFE "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/blob/main/manifests/base/29-route-front-end.yaml"

    click CartsSvc "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/blob/main/manifests/base/02-carts-svc.yaml"
    click CartsDB "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/blob/main/manifests/base/01-carts-dep.yaml"

    click CatalogueSvc "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/blob/main/manifests/base/06-catalogue-svc.yaml"
    click CatalogueDB "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/blob/main/manifests/base/07-catalogue-db-dep.yaml"

    click OrdersSvc "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/blob/main/manifests/base/12-orders-svc.yaml"
    click OrdersDB "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/blob/main/manifests/base/13-orders-db-dep.yaml"

    click PaymentSvc "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/blob/main/manifests/base/16-payment-svc.yaml"

    click UserSvc "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/blob/main/manifests/base/26-user-svc.yaml"
    click UserDB "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/blob/main/manifests/base/27-user-db-dep.yaml"

    click ShippingSvc "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/blob/main/manifests/base/24-shipping-svc.yaml"

    click QueueMasterSvc "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/blob/main/manifests/base/18-queue-master-svc.yaml"
    click RabbitMQSvc "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/blob/main/manifests/base/20-rabbitmq-svc.yaml"

    click SessionDB "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/blob/main/manifests/base/21-session-db-dep.yaml"

    click OrdersSvc "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/tree/main/automation/Dockerfile-orders"
    click PaymentSvc "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/tree/main/automation/Dockerfile-payment"
    click UserSvc "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/tree/main/automation/Dockerfile-user"
    click ShippingSvc "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/tree/main/automation/Dockerfile-shipping"
    click QueueMasterSvc "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/tree/main/automation/Dockerfile-queue-master"
    click RabbitMQDep "https://github.com/swayam-prakash-bhuyan/sock-shop-demo/tree/main/automation/Dockerfile-rabbitmq"
```
