21. microservice structure

Date: 2023-04-08

Status

Accepted

Context

We want to have a clear structure for our microservices.

Decision

We will use the following structure:

├── ops/dockerfile/.Dockerfile
├── ops/docker-compose/application//.yml
├── ops/Helm///Chart.yaml
├── .gitlab/ci/workflows/matrix_build_base.yml
├── .gitlab/ci/workflows/matrix_build_helm.yml
├── ops/argocd/boundaries///application.yaml
└── boundaries/
    ├── application/
    ├── docs/
    │   └── ADR/
    │       └── decisions/
    │           └── 0001-init.md
    ├── cmd/
    ├── di/
    ├── domain/
    ├── infrastructure/
    ├── tests/
    ├── Makefile
    └── README.md

Project README

The project README should contain the following sections:

• Project description
• C4 container diagram
• C4 component diagram
• ERD diagram (if needed)
• C4 use case diagrams

For the use case diagram, we add a sequence diagram for each use case.

ADR: 0001-init.md

The ADR should contain the following sections:

• Status
• Goal
• Docs

Consequences

We have a clear structure for our microservices.