deploys/, and Argo CD syncs those manifests to the cluster.
Prerequisites
- Write access to your platform repository
- uv
- Git
Repository layout
The vars file
Each deploy has a vars file atvars/<deploy-name>.yaml. The generator validates it against a schema and stops with an error if it finds an unknown key or an invalid value.
The main top-level keys are:
Enable an app
Each app has a section underapp_config. Set enabled to turn it on or off:
instances list to run a separate instance per project.
Configure sign-in
Theapp_config.dex section controls how users sign in. It sets the identity provider connectors (google, microsoft, and oidc) and any local static_passwords. See Sign in and get initial credentials.
Add users
List platform users underusers.users. Each user has an email, a username, and roles:
cake-admin role are platform admins. The allowed_namespaces list gives a user edit access to additional shared namespaces.
Generate the deploy
After you edit a vars file, render its manifests intodeploys/<deploy-name>/:
<deploy-name> is the vars file name without .yaml. The generator also applies anything in overrides/<deploy-name>/ to the rendered manifests.
Reconcile all deploys
The reconcile script regenerates every deploy invars/ from the current template. Run it after you change the template or upgrade to a new platform release, or to check for drift between deploys/ and the vars files:
deploys/ has uncommitted changes. To overwrite them, add --force:
test or -integ. Run gen-deploy for those deploys directly.
Apply your changes
Commit the vars file and the regenerateddeploys/ directory together, then open a pull request. After it merges into the branch Argo CD tracks (app_config.defaults.target_revision), Argo CD picks up the new manifests. If automated sync is enabled for your deploy (app_config.defaults.sync_policy), Argo CD applies them on its own. Otherwise, sync the changed applications in Argo CD.
Overrides and custom apps
If the vars file doesn’t expose a setting you need, add an override inoverrides/<deploy-name>/:
- For a Helm app, add
<app>.values.yamlwith only the values you want to change. - For a Kustomize app, add an
<app>/directory with akustomization.yamlthat referencesdeploys/<deploy-name>/<app>and patches it.
custom/<deploy-name>/ and list them in its kustomization.yaml.