Merge pull request 'Update repo model for app-of-apps adoption' (#4) from update-agents-repo-model into main
Reviewed-on: #4 Reviewed-by: kimo <kkaaikala@yahoo.com>
This commit was merged in pull request #4.
This commit is contained in:
@@ -0,0 +1,20 @@
|
||||
# Repository guidance
|
||||
|
||||
## Repo model
|
||||
- GitOps source of truth for one Kubernetes cluster: Argo CD Applications, Helm values, and Kustomize manifests. No application code.
|
||||
- One directory per app: `gitea/`, `headlamp/`, `immich/`, `keycloak/`, `metrics-server/`.
|
||||
- All nine live Argo CD Applications are declared in `applications/<name>.yaml` (`cnpg`, `external-secrets`, `gitea`, `headlamp`, `immich`, `keycloak`, `metrics-server`, `nextcloud`, `openbao`), captured spec-for-spec from the cluster.
|
||||
- `root-app.yaml` defines the root Application `all-apps`, which manages everything in `applications/` on `main`. It is applied manually with no `automated`, `prune`, or `selfHeal`; edits to `applications/` take effect after a manual sync of `all-apps`.
|
||||
- The older untracked Argo manifests in the working tree (`gitea/app.yaml`, `immich/proj.yaml`, `immich/repo.yaml`) are stale and must not be imported; use `applications/` instead.
|
||||
- `keycloak` and `openbao` were already `OutOfSync/Healthy` before adoption; treat that as the baseline, not a migration regression.
|
||||
- Charts come from remote/OCI repos; values live here and are wired via multi-source Argo apps with `$values/<app>/values.yaml`. Edit `<app>/values.yaml`, not chart sources; changes take effect on Argo sync.
|
||||
- gitea chart version is pinned in its Argo app; keycloak is pinned via the remote base ref in `keycloak/kustomization.yaml`; immich's Helm chart is pinned in `applications/immich.yaml` while its values source still tracks `HEAD`. Upgrade steps: `gitea/README.md`, `keycloak/README.md`.
|
||||
|
||||
## Verification
|
||||
- No build/test/lint/CI config or task runner exists. Useful checks: `kustomize build <app>` for `immich/` and `keycloak/`, and `kubectl apply --dry-run=server -f <manifest>`.
|
||||
- `kubectl` uses context `kubernetes-admin@kubernetes`; the `argocd` CLI is not installed.
|
||||
- Lint changed manifests with `kube-linter lint <file.yaml>`; pass explicit file paths (pointing it at a directory reports "no valid objects found").
|
||||
|
||||
## Code changes
|
||||
- Create pull requests at https://gitea.grxe.io/ ; never commit or print it. Only use the stored credentials.
|
||||
- There is no `.gitignore`: `git add -A` would stage `gitea.token`, `opencode.json`, `.DS_Store`, and the untracked Argo manifests. Stage files explicitly.
|
||||
Reference in New Issue
Block a user