> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cake.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Configure the platform

> Change your Cake Platform installation with the vars file, generate deploy manifests, and reconcile them with the platform template.

Your Cake Platform installation is configured as code in your platform repository, a copy of the Cake Platform template that Cake set up for your organization. You describe each deploy in a vars file. A generator renders that file into the Kubernetes manifests in `deploys/`, and Argo CD syncs those manifests to the cluster.

## Prerequisites

* Write access to your platform repository
* [uv](https://docs.astral.sh/uv/getting-started/installation/)
* Git

## Repository layout

| Directory | Contents |
| - | - |
| `vars/` | One vars file per deploy, such as `vars/prod-us-east-2.yaml`. This is the file you edit. |
| `deploys/` | Manifests generated from the vars files. Don't edit these directly. |
| `template/` | The platform template the generator renders. Cake updates it with each platform release. |
| `overrides/` | Per-deploy patches for settings the vars file doesn't support. |
| `custom/` | Per-deploy Argo CD applications that aren't part of the platform. |
| `infrastructure/` | Terraform for the cluster and AWS resources. |

## The vars file

Each deploy has a vars file at `vars/<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:

| Key | Description |
| - | - |
| `base_hostname` | The DNS name the deploy is served from |
| `cluster_name` | The EKS cluster name |
| `git_repo_url` | The platform repository Argo CD syncs from |
| `organization_name` | Your organization's display name |
| `aws` | AWS account ID, region, and related AWS resource IDs |
| `shared_app_pg` | Host and port of the shared PostgreSQL database for platform apps |
| `app_config` | Which apps are enabled and how each one is configured |
| `users` | Platform users and their roles |
| `subdomains` | Subdomains that require OAuth2 sign-in |

### Enable an app

Each app has a section under `app_config`. Set `enabled` to turn it on or off:

```yaml theme={null}
app_config:
  langfuse:
    enabled: true
  trino:
    enabled: false
```

Some apps, such as MLflow, Langfuse, LiteLLM, and Langflow, accept an `instances` list to run a separate instance per [project](https://docs.cake.ai/platform/overview.md#concepts).

### Configure sign-in

The `app_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](https://docs.cake.ai/platform/sign-in-and-credentials.md).

### Add users

List platform users under `users.users`. Each user has an email, a username, and roles:

```yaml theme={null}
users:
  users:
  - email: ada@example.com
    username: ada
    roles:
    - cake-user
    - cake-admin
    allowed_namespaces: []
```

Users with the `cake-admin` role are [platform admins](https://docs.cake.ai/platform/sign-in-and-credentials.md#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 into `deploys/<deploy-name>/`:

```bash theme={null}
uv run gen-deploy <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 in `vars/` 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:

```bash theme={null}
uv run scripts/reconcile_existing_deploys.sh
```

The script stops if `deploys/` has uncommitted changes. To overwrite them, add `--force`:

```bash theme={null}
uv run scripts/reconcile_existing_deploys.sh --force
```

The script skips deploys whose names contain `test` or `-integ`. Run `gen-deploy` for those deploys directly.

## Apply your changes

Commit the vars file and the regenerated `deploys/` 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](https://docs.cake.ai/platform/components/operations.md#argo-cd).

## Overrides and custom apps

If the vars file doesn't expose a setting you need, add an override in `overrides/<deploy-name>/`:

* For a Helm app, add `<app>.values.yaml` with only the values you want to change.
* For a Kustomize app, add an `<app>/` directory with a `kustomization.yaml` that references `deploys/<deploy-name>/<app>` and patches it.

Overrides can break on platform upgrades, so keep them small and use them only when the vars file can't make the change.

To deploy your own applications alongside the platform, add them to `custom/<deploy-name>/` and list them in its `kustomization.yaml`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.