Override data plane cluster configurations

Cluster overrides let you customize Deployment configuration for one data plane cluster. They don’t change platform-level control-plane settings.

Use Configure Astro Private Cloud if you need to decide whether a setting belongs in platform config or in a cluster override.

Astro Private Cloud (APC) has two types of Deployment configurations that you can set at the data plane cluster level.

• Default configuration: The base, system-provided configuration. You can override default values, but you can’t delete default keys.
• Custom configuration: Your own additional keys and values. You can add, modify, or delete these keys.

Prerequisites

• An APC control plane is installed and reachable.
• You have System Admin permissions in the APC UI or access to the Houston API.
• The data plane cluster is healthy and accessible from the control plane.

Update your cluster

You can define cluster configurations when you first register a cluster or later by updating the cluster via the UI or Houston API.

• Registration: The form includes an optional Cluster Override field. You can supply initial overrides when registering.
• Edit: The cluster page contains your overall cluster information and a Deployment Configuration section.
  • Cluster Information: View and edit the cluster name.
  • Current Configuration: Read-only view of the default configurations.
  • Configuration Override: Editable area where you provide override values for base keys and/or add custom keys.
  • After you add overrides, the Current Configuration shows a read-only, git-style diff of added/modified values.
• Houston API: To automate cluster management, you can use the updateCluster GraphQL mutation in the Houston API playground at https://houston.<base-domain>/v1/playground or using a script that leverages curl or a GraphQL library in a programming language.

See the example mutation below, which uses query variables to pass the deploymentsConfigOverride as JSON to create a ConfigMap for each Airflow Deployment:

1
mutation UpdateCluster($id: Uuid!, $override: JSON) {
2
  updateCluster(
3
    id: $id
4
    deploymentsConfigOverride: $override
5
  ) {
6
    id
7
    config
8
  }
9
}

Query variables:

1
{
2
  "id": "<cluster-id>",
3
  "override": {
4
    "helm": {
5
      "airflow": {
6
        "extraObjects": [
7
          {
8
            "apiVersion": "v1",
9
            "kind": "ConfigMap",
10
            "metadata": {
11
              "name": "{{ .Release.Name }}-custom-config",
12
              "namespace": "{{ .Release.Namespace }}"
13
            },
14
            "data": {
15
              "my-key": "my-value"
16
            }
17
          }
18
        ]
19
      }
20
    }
21
  }
22
}

deploymentsConfigOverride deep-merges object keys into the existing cluster configuration, so separate API calls accumulate. Arrays, such as extraObjects, are always replaced in full. To add another array entry, re-send the complete array.

Update cluster information

Only the Cluster name is editable as a cluster property in the Cluster Information section. You must use Configuration Override to make changes to Deployment configurations by overriding the base Deployment configuration.

Override base configuration

Add your own keys and values to tailor behavior per cluster. You can’t delete default keys, but you can override their values to make custom configurations.

Additional notes

• Cluster overrides apply to deployments.* values for the selected data plane cluster.
• In APC 1.x, cluster override is the only override layer after platform config.
• Settings outside deployments.* stay in values.yaml, typically under astronomer.houston.config, and require a Helm upgrade.
• Use Apply a config change for platform-level values and Configure Astro Private Cloud for the full hierarchy.

Best practices

• Keep overrides minimal. Prefer Base Config unless a cluster truly deviates.
• Use consistent naming and comments for custom keys.
• Review the diff in Current Configuration to validate the final effective settings before you Update Cluster.