Environment Overrides

You can view all environments associated with an application under the Environment Overrides section.

The Environment Overrides section allows you to customize the Deployment Template, ConfigMaps, and Secrets for different environments such as development, testing, staging, and production.

How it works

• When you add a deployment pipeline to an application's workflow, each environment configuration initially inherits the Deployment Template, ConfigMap and Secret from the Base Configurations of the application.

• The Environment Overrides section lets you customize those Deployment Template, ConfigMap and Secret per environment without affecting those of other environments. For example, in a non-production environment, you might allocate 100m CPU, while in production, you may increase it to 500m to handle higher traffic.

Environment Configurations Page

1. In your application, go to Configurations → Environment Overrides.

   
2. Select an environment whose configurations you wish to modify.

   
3. You will get the following options (similar to the Base Configurations page):

   • Deployment Template

   • ConfigMaps

   • Secrets

   

Let's visit each of the configuration files and see how to override their values for the selected environment (say banking-final).

Override Deployment Template

As you can see, the Deployment Template for the banking-final environment shows 3 tabs:

• Inherited

• No override or Override

• Dry run

1. Go to the Inherited tab. This will show the inherited configuration in a read-only YAML editor. You cannot edit any values here.

   
2. Clicking No override to override the inherited configuration (if not done already).

   
3. Click the Create Override button.

   
4. In the same tab (now labelled as Override), you can choose any one mode for changing the configuration values:

   • YAML - This mode has a YAML based editor intended for advanced users. Click here to know more about each key-value pair within the YAML section.

   • GUI - This mode has a user-friendly interface intended for beginner to advanced users. Click here to know more about each field within the GUI section.

Let's choose YAML mode for now and proceed. If you prefer GUI mode, go to Override Deployment Template using GUI section.

1. You can override the values using any merge strategy:

   • Patch

   • Replace

Using Patch Strategy

Suppose you want to update only one field (e.g., "username" = "johndoe") in a deployment template. Using the patch strategy, you can just update the field to "username" = "mathew". All other fields in the deployment template will remain unchanged.

• Only the fields you explicitly specify are updated.

• The patched template will continue to depend on the base configuration, so all other inherited fields remain unchanged and will continue to inherit in future.

• Best for minor edits.

If you know the fields you wish to change, simply enter the changed key-value fields along with indentation (if any).

Using Replace Strategy

Suppose you update your deployment chart version (e.g., from 4.0.0 to 4.0.1). Although the new chart version contains new features and key-value pairs, if you prefer to keep a few configurations unchanged regardless of the new key-value pairs added in the new chart version, you can use the replace strategy.

• The entire configuration is replaced with your new environment-specific settings.

• The replaced template will no longer depend or inherit from base configuration anymore.

• Best for a complete override.

Override Deployment Template using GUI

Override ConfigMap & Secret

If you want to configure your ConfigMap and Secret at the application-level then you can provide them in ConfigMaps and Secrets, but if you want to have environment-specific ConfigMap and Secret, use Environment Override to create them. At the time of deployment, it will pick both of them and pass them to your cluster.

The process to override both ConfigMaps and Secrets is similar to Override Deployment Template. Refer the tutorials below to know the process in YAML mode. In case you wish to use GUI mode, skip to Overriding in GUI mode.

Patch Strategy

Replace Strategy

Override ConfigMaps and Secrets using GUI

Delete Override

This action will discard the current overrides and the base configuration file (in this example, deployment template) will be restored back for the environment.

1. On the right side, click the kebab menu (3 vertical dots).

2. Click Delete Override.

3. Confirm the deletion in the dialogbox.

Protected Environment Configurations

Any changes made to the protected environment configurations (Deployment Template, ConfigMap, Secret) will require approval if an approval policy is enforced. When you want to edit a protected configuration, you can do it in the following ways:

• Normal Edit - Where changes to the protected configuration are made only after getting approval from the approver(s).

• Express Edit - Where you bypass the approval process and directly make changes to the protected configuration.

Normal Edit

Follow the below steps to edit a protected configuration:

1. Navigate to the Applications page and click on your preferred application.

2. Go to the Configurations → Base Configurations.

3. Click on your preferred configuration (e.g., ConfigMaps) and select the ConfigMap you'd like to edit.

4. Modify the values either by using GUI or YAML editor.

5. Click Save Changes. The Base Configurations pop-up page will be displayed.

   • Save as draft - Select this option if you want to continue making your changes later but save your changes as a draft for now.

   • Propose changes - Select this option if you want to propose your changes to the approvers. You can then select the approvers to get notified regarding the change from the Select approvers to notify drop-down box.

6. Enter your comments (reason for making the changes) in the Comment text box.

7. Click Propose Changes. The corresponding approver will be notified via email regarding your request.

Express Edit

Express edits allow you to bypass the approval process and make direct edits to the configurations. Follow the below steps to make express edits:

1. Navigate to the Applications page and click on your preferred application.

2. Go to the Configurations → Base Configurations.

3. Click on your preferred configuration (e.g., ConfigMaps) and select the ConfigMap you'd like to edit.

4. Click on the Edit button.

1. Modify the values either by using GUI or YAML editor.

2. Click on Publish Changes to direcly publish your changes.