Skip to content

Commit

Permalink
adr: add microservice structure
Browse files Browse the repository at this point in the history
Signed-off-by: Victor Login <batazor@evrone.com>
  • Loading branch information
batazor committed Apr 8, 2023
1 parent c465d47 commit 5f6b666
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/ADR/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ for information team about cases for updated ADR.
- [ADR-0006](./decisions/0006-codeowner.md) - Codeowner
- [ADR-0011](./decisions/0011-application-architecture-documentation.md) - Application architecture documentation
- [ADR-0012](./decisions/0012-use-monorepository.md) - Use monorepository
- [ADR-0021](./decisions/0021-microservice-structure.md) - Microservice structure
- **Lifecycle**
- [ADR-0016](./decisions/0016-lifecycle-deploy.md) - Lifecycle deploy
- **Naming**
Expand Down
47 changes: 47 additions & 0 deletions docs/ADR/decisions/0021-microservice-structure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# 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/{{serviceName}}.Dockerfile
├── ops/docker-compose/application/{{serviceName}}/{{serviceName}}.yml
├── ops/Helm/{{serviceName}}/Chart.yaml
├── ops/gitlab/workflows/matrix_build_base.yml
├── ops/gitlab/workflows/matrix_build_helm.yml
├── ops/argocd/shortlink/{{serviceName}}/application.yaml
├── docs/c4/containers/services
├── internal/services/{{serviceName}}
│ ├── application/
│ ├── cmd/
│ ├── di/
│ ├── domain/
│ ├── infrastructure/
│ ├── tests/
│ └── README.md
└── README.md
```

### Project README

The project README should contain the following sections:

- Project description
- C4 container diagram
- C4 component diagram
- C4 use case diagram

## Consequences

We have a clear structure for our microservices.

0 comments on commit 5f6b666

Please sign in to comment.