# prometric-testing/recruitment-assessment-sr-java-engineer architecture

> Architecture diagram of the GitHub repository prometric-testing/recruitment-assessment-sr-java-engineer, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-12). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/prometric-testing/recruitment-assessment-sr-java-engineer
- Repository: https://github.com/prometric-testing/recruitment-assessment-sr-java-engineer

## Overview

##### Project type and purpose
- This is a sample microservices demo application comprising two Java-based modules—`sample-api` (an HTTP REST service) and `sample-worker` (a Kafka consumer/worker)—deployed on Kubernetes. It uses Docker for packaging, Terraform for cloud/infrastructure provisioning, and Kustomize/Kubernetes manifests for deployment to dev/qa/prod clusters.

##### File structure
- Top‐level modules:
- `sample-api/` – Spring‐boot‐style REST API
- `sample-worker/` – Kafka consumer worker
- Infrastructure-as-code:
- `infra/terraform/` – cloud resource provisioning (e.g., VPC, EKS, ECR)
- `infra/kubernetes/` – kustomize overlays and base manifests per environment
- Build & CI:
- `Makefile` – wrapper for Docker builds & kubectl commands
- GitHub workflows under `.github/workflows` for linting/tests/cache clearing

##### README for additional insights
- Describes end-to-end developer workflow:
- Build Docker images
- Push/ pull from ECR
- Apply Kustomize overlays → Kubernetes manifests
- Run in local Docker‐Desktop or remote clusters
- Debug via port‐forward and remote JVM attach
- Mentions Kafka topics and client utilities under the `kafka` namespace

- Component block is labeled with its module name and technology (e.g., “sample-api (Spring Boot)”).
- Environment overlays (dev/qa/prod) only if needed for clarity.
- Where secrets/config-env are injected (ConfigMaps, Secrets).
- Horizontal scaling/web-tier (HPA manifests) and autoscaling.
- End-to-end flow: code → Docker → ECR → Kubernetes → runtime.
- Make the dependencies explicit so new engineers can trace build, deploy, and runtime interactions at a glance.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Developer Machine
    subgraph "Developer Machine"
        Client["External Client (curl/browser)"]:::external
        DevContainer["VSCode DevContainer"]:::external
        DockerDesktop["Docker Desktop"]:::external
        Kubectl["kubectl CLI"]:::external
        README["README.md"]:::external
    end

    %% CI/CD Pipeline
    subgraph "CI/CD Pipeline"
        GitHubActions["GitHub Actions"]:::cicd
        MakefileNode["Makefile"]:::cicd
    end

    %% Cloud Infrastructure
    subgraph "Cloud"
        Terraform["Terraform (infra)"]:::infra
        ECR["AWS ECR (Docker Registry)"]:::infra
        K8sCluster["Kubernetes Cluster"]:::infra
    end

    %% Kubernetes Cluster Contents
    subgraph K8sCluster
        subgraph "Namespace: sample"
            API["sample-api (Spring Boot) ×N"]:::app
            Worker["sample-worker (Kafka consumer) ×N"]:::app
        end
        subgraph "Namespace: kafka"
            KafkaBroker["Kafka Broker (CP)"]:::infraCode
            KafkaClient["Kafka Client Pod"]:::infraCode
        end
        Manifests["K8s Manifests"]:::infraCode
        Kustomize["Kustomize Overlays"]:::infraCode
    end

    %% Interactions
    Client -->|"HTTP /sample"| API
    API -->|"produce sample.hello"| KafkaBroker
    Worker -->|"consume sample.hello"| KafkaBroker

    DevContainer --> DockerDesktop
    DockerDesktop --> Kubectl

    GitHubActions -->|"docker build & push"| ECR
    GitHubActions -->|"terraform apply"| Terraform
    GitHubActions -->|"kubectl apply"| Kubectl

    ECR -->|"image pull"| API
    ECR -->|"image pull"| Worker

    Terraform -->|"provision EKS"| K8sCluster

    %% Click Events
    click API "https://github.com/prometric-testing/recruitment-assessment-sr-java-engineer/tree/main/sample-api/"
    click Worker "https://github.com/prometric-testing/recruitment-assessment-sr-java-engineer/tree/main/sample-worker/"
    click Terraform "https://github.com/prometric-testing/recruitment-assessment-sr-java-engineer/tree/main/infra/terraform/"
    click Manifests "https://github.com/prometric-testing/recruitment-assessment-sr-java-engineer/tree/main/infra/kubernetes/manifests/"
    click Kustomize "https://github.com/prometric-testing/recruitment-assessment-sr-java-engineer/tree/main/infra/kubernetes/config/"
    click MakefileNode "https://github.com/prometric-testing/recruitment-assessment-sr-java-engineer/tree/main/Makefile"
    click GitHubActions "https://github.com/prometric-testing/recruitment-assessment-sr-java-engineer/tree/main/.github/workflows/"
    click DevContainer "https://github.com/prometric-testing/recruitment-assessment-sr-java-engineer/blob/main/.devcontainer/devcontainer.json"
    click README "https://github.com/prometric-testing/recruitment-assessment-sr-java-engineer/blob/main/README.md"

    %% Styles
    classDef app fill:#ADD8E6,stroke:#000
    classDef infra fill:#FFA07A,stroke:#000
    classDef infraCode fill:#F4A460,stroke:#000
    classDef cicd fill:#90EE90,stroke:#000
    classDef external fill:#D3D3D3,stroke:#000
```
