Apply a Software platform configuration change
When you install Astronomer, a number of platform-level settings will be set by default. If you'd like to change any of those settings based on the needs of your organization, you can do so at any time using Helm.
For example, you can:
- Integrate an auth system
- Add a registry backend
- Change resource allocation limits
- Update any other key-value pair specified in the default configuration file
To configure these settings, follow the steps below.
If you're interested in upgrading Astronomer to a new patch version of the platform, read Upgrade to a Patch Version.
Step 1: Open your config.yaml file
This file was created when you installed Astronomer using one of the following guides:
To access your config.yaml file directly from an existing Software installation, run the following command:
helm get values <your-installation-release-name> -n <your-installation-namespace> > config.yaml
If you retrieve your file this way, delete USER-SUPPLIED VALUES: from the first line before changing any other configurations.
Step 2: Update Key-Value Pairs
To update any of your existing settings, modify them directly in your config.yaml file. To update a setting you haven't already specified, copy the corresponding key-value pair from the default configuration file into your config.yaml file and modify the value from there.
When you have finished updating the key-value pairs, ensure that they have the same relative order and indentation as they do in the default configuration file. If they don't, your changes might not be properly applied.
Step 3: Push changes to Astronomer
- Identify your platform namespace and release name. Your platform release name can be found in your list of active namespaces. To show this list, run:
kubectl get ns
To identify the value for your platform release name, run:
helm ls -n <your-platform-namespace>
- Save your config.yaml file and run a helm upgrade by running:
helm upgrade <your-platform-release-name> astronomer/astronomer -f config.yaml -n <your-platform-namespace> --version=<your-platform-version>
- Confirm that the key-value pairs were successfully updated by running:
helm get values <your-platform-release-name> -n <your-platform-namespace>