this repo has no description
docs: update project structure
+57
+57
README.md
+57
README.md
···
5
5
> use cases, so it might not be directly useful to you. For a ready-to-use
6
6
> solution, please refer to my [homelab project](https://github.com/khuedoan/homelab).
7
7
8
+
## Project structure
9
+
10
+
```
11
+
├── flake.nix # Contains dependencies required by this project for both local and CI/CD
12
+
├── Makefile # Entry point for all manual actions
13
+
├── compose.yaml # Servers required for running locally
14
+
├── infra # Infrastructure definition
15
+
│ ├── modules # Terraform modules
16
+
│ │ ├── network
17
+
│ │ ├── instance
18
+
│ │ ├── cluster
19
+
│ │ └── ...
20
+
│ ├── local # Terragrunt configuration for the local environment
21
+
│ │ └── ...
22
+
│ └── ${ENV} # Terragrunt configuration for the ${ENV} environment
23
+
│ ├── root.hcl # Root config used by other Terragrunt files
24
+
│ ├── secrets.yaml # Encrypted secrets
25
+
│ ├── tfstate # Bootstrap Terraform state
26
+
│ ├── ${CLOUD}
27
+
│ │ └── ${REGION}
28
+
│ │ └── ${MODULE}
29
+
│ │ └── terragrunt.hcl
30
+
│ ├── metal
31
+
│ │ └── vn-south-1
32
+
│ │ ├── bootstrap
33
+
│ │ │ └── terragrunt.hcl
34
+
│ │ └── cluster
35
+
│ │ └── terragrunt.hcl
36
+
│ └── ...
37
+
├── platform # Highly privileged platform components
38
+
│ └── ${ENV}
39
+
│ ├── grafana.yaml
40
+
│ ├── temporal.yaml
41
+
│ ├── wireguard.yaml
42
+
│ └── ...
43
+
├── apps # User applications, standardized with strict controls
44
+
│ ├── ${NAMESPACE}
45
+
│ │ └── ${APP}
46
+
│ │ └── ${ENV}.yaml
47
+
│ └── khuedoan
48
+
│ └── blog
49
+
│ ├── local.yaml
50
+
│ └── production.yaml
51
+
├── controller # Automation controller for the entire project - think GitHub Actions, but better
52
+
│ ├── activities # Temporal activities (git clone, terragrunt apply, etc.)
53
+
│ │ ├── git.go
54
+
│ │ ├── terragrunt.go
55
+
│ │ └── ...
56
+
│ ├── workflows # Temporal workflows, define a sequence of activities
57
+
│ │ ├── infra.go
58
+
│ │ ├── app.go
59
+
│ │ └── ...
60
+
│ ├── worker # Worker process that executes the workflows
61
+
│ └── Dockerfile # Builds the image for the controller, can run locally or on a cluster
62
+
└── test # High level tests
63
+
```
64
+
8
65
## Features
9
66
10
67
### Infrastructure