docs: Add basic README

2025-06-20 21:19:57 +02:00
parent 311b76795b
commit 2584ff39f9
1 changed files with 30 additions and 0 deletions
@@ -0,0 +1,30 @@
+# Manifests
+
+Manifest repo managed using [Helmfile](https://github.com/helmfile/helmfile).
+
+Repository structure:
+
+```bash
+/
+├── helmfile.d/                                                 # Helmfiles, *.yaml.gotmpl
+├── charts/                                                     # Our own charts, e.g `Atlantis`
+├── values                                                      # Values for helmfiles
+│   ├── <chart>
+│   │   ├── env.yaml.gotmpl                                     # Values to be templated in `values/`
+│   │   ├── kustomize                                           # Kustomizations per environment
+│   │   ├── manifests                                           # Raw manifests
+│   │   │   ├── <chart>.yaml                                    # Argo App for bootstrap
+│   │   │   ├── dashboards                                      # Grafana dashboards
+│   │   │   │   └── <chart>-metrics.yaml
+│   │   │   └── policies                                        # Cilium and Kyverno policies
+│   │   │       ├── CiliumNetworkPolicy-allow-api-server.yaml   
+│   │   │       └── KyvernoPolicy-regred-secret.yaml            
+│   │   └── values                                              # Values for each environment
+│   │       ├── <chart>-staging.yaml.gotmpl                     # Values for staging environment
+│   │       ├── <chart>-prod.yaml.gotmpl                        # Values for prod environment
+│   │       └── <chart>.yaml.gotmpl                             # Standard values for all environments
+│   │
+│   ├── env.yaml                                             # Standard values for all cluster
+│   ├── env-oceanbox.yaml                                    # Values overrides for oceanbox 
+│   ├── env-ekman.yaml                                       # Values overrides for ekman
+```