Manage Configurations and Secrets¶

Choreo allows you to easily manage and version your component's configurations and secrets as file mounts or environment variables.

Note

All configurations and secrets are stored in an encrypted secret vault in the cloud data plane managed by WSO2. For private data planes, they are stored in your cloud environment's attached secret manager.

The difference between configurations and secrets¶

Choreo treats all configurations and secrets as sensitive content, but lets you choose between secret or configuration when creating file mounts or environment variables.

Secrets are write-only. Once created, you cannot view or retrieve their content via the Choreo Console, but you can overwrite them anytime.
Configurations can be read and updated via the Choreo Console after creation.

Note

For sensitive data such as database passwords, cloud credentials, or service accounts, use secrets rather than configurations.

Add an environment variable to your container¶

To add environment variables to your component:

Sign in to the Choreo Console.
Click your component in the Component Listing pane.
Navigate to Deploy page in the left menu.
Click Manage Configs and Secrets in the environment card.
Expand Environment Variables and click + Add a Configuration.
Enter the variable name and value. Mark as a secret if the value is sensitive.

Note
Secret environment variables cannot be read after creation.
Click Add.
Click Save and Deploy.

Add a file mount to your container¶

To add a file mount to your component:

Sign in to the Choreo Console.
Click your component in the Component Listing pane.
Navigate to Deploy page in the left menu.
Click Manage Configs and Secrets in the environment card.
Expand File Mount and click + Add a File Mount.
Specify the Mount Path where the file should be mounted inside the container. Use an absolute path including filename and extension.
Enter or paste the configuration content. Mark as a secret if the content is sensitive.

Note
Secret file mounts cannot be read after creation.
Click Save.
Click Save and Deploy.

Update an existing configuration or a secret¶

To update a configuration or secret:

Sign in to the Choreo Console.
Click your component in the Component Listing pane.
Navigate to Deploy page in the left menu.
Click Manage Configs and Secrets in the environment card.
To update an environment variable, expand Environment Variables and click the edit icon next to the variable. To update a file mount, expand File Mount and click the edit icon next to the file.
Click Update.
Click Save and Deploy.

Delete an existing configuration or a secret¶

To delete a configuration or secret:

Sign in to the Choreo Console.
Click your component in the Component Listing pane.
Navigate to Deploy page in the left menu.
Click Manage Configs and Secrets in the environment card.
To delete an environment variable, expand Environment Variables and click the delete icon next to the variable. To delete a file mount, expand File Mount and click the delete icon next to the file.
Confirm the deletion when prompted.
Click Save and Deploy.

Manage Ballerina configurables¶

Choreo manages Ballerina configurables for your Ballerina components.

You can modify Ballerina configurables via the Deploy page when deploying or promoting a Ballerina application.

Tip

Use configurables instead of environment variables to add file mounts to Ballerina components. Environment variables are primarily for components written in other languages.

Alternative configuration management approach¶

Warning

This alternative method is not recommended for managing configurations and secrets in Choreo.

Add an environment variable to your container¶

To add environment variables:

Sign in to the Choreo Console.
Click your component in the Component Listing pane.
Navigate to DevOps > Configs & Secrets in the left menu.
Click + Create.
Select Environment Variables in the Create a Config or Secret pane.
Select Mark as a Secret if the values contain sensitive information.

Note

Secret environment variables cannot be read after creation.
Enter a Display Name to identify this configuration.

Tip

The display name is for identification only and doesn't affect the actual environment variables.
Enter your environment variables as key-value pairs. Click Add Item to create additional variables.
Click Create.

Add a file mount to your container¶

To add a file mount to your component:

Sign in to the Choreo Console.
Click your component in the Component Listing pane.
Navigate to DevOps > Configs & Secrets in the left menu.
Click + Create.
Select File Mount in the Create a Config or Secret pane.
Select Mark as a Secret if the file contains sensitive information.

Note

Secret file mounts cannot be read after creation.
Enter a Display Name to identify this file mount.

Tip

The display name is for identification only and doesn't affect the file mount or its content.
Specify the File Mount Path where the file should be mounted inside the container. Use an absolute path including filename and extension.

Tip

The mount path filename doesn't need to match your configuration name or uploaded filename.
Either upload a configuration file or paste content directly into the editor.
Click Create.

Note

Configurations and secrets apply immediately. Your container's running replicas will undergo a rolling restart to reflect the changes.

Update an existing configuration or secret¶

To update a configuration or secret:

Sign in to the Choreo Console.
Click your component in the Component Listing pane.
Navigate to DevOps > Configs & Secrets in the left menu.
Click the edit icon next to the configuration or secret you want to update.
Make your changes and click Save.

Delete an existing configuration or a secret¶

To delete a configuration or secret:

Sign in to the Choreo Console.
Click your component in the Component Listing pane.
Navigate to DevOps > Configs & Secrets in the left menu.
Click the delete icon next to the configuration or secret you want to delete.
Type the name to confirm deletion.
Click Delete.