Skip to content

Commit 40f8d28

Browse files
Merge pull request #1891 from NipunFernando/PE
[PE] Update Ballerina component configuration sections to allow configuration group linking
2 parents 72f6d95 + c913267 commit 40f8d28

File tree

5 files changed

+15
-3
lines changed

5 files changed

+15
-3
lines changed

en/developer-docs/docs/develop-components/use-configuration-form.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Choreo allows you to inject values for your configurations through a rich user interface.
22

33
!!! info
4-
- This feature is currently only available for Go, Python, Java, .NET, NodeJs, Ruby and PHP build presets (excluding Web Applications).
4+
- This feature is currently only available for Ballerina, Go, Python, Java, .NET, NodeJs, Ruby and PHP build presets (excluding Web Applications).
55
- The configuration form is supported starting from component.yaml v1.2.
66

77
You can configure configurations in the [component.yaml](./manage-component-source-configurations.md). Based on these configurations, a form is displayed in the Choreo console. Users can define environment variables and file keys under the `configurations` section in the component.yaml.

en/developer-docs/docs/devops-and-ci-cd/manage-configuration-groups.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Configuration groups can be defined at organization level and link to components
99
- All configuration group values are encrypted and stored in environment-specific key vaults.
1010
- Management of configuration groups is restricted to users with Choreo Admin, DevOps, and Platform Engineer roles.
1111
- Developers can discover configuration groups available within the organization via the **Choreo Internal Marketplace**.
12-
- This feature is currently not supported for Ballerina build presets, Web Applications, or Test Runner components.
12+
- This feature is currently not supported for Web Applications or Test Runner components.
1313

1414
## Create a configuration group
1515

@@ -42,6 +42,9 @@ The configuration groups created at organization level can be linked to any comp
4242

4343
Linking a configuration group will inject the values defined in the group during deployment. The values are mapped to environment variable names or file names based on the keys defined in the configuration group. If needed, you can customize the environment variable name or file name by updating the mapping at deployment.
4444

45+
!!! note
46+
To link configuration groups to Ballerina component configurables, click **Allow Linking Configuration Groups** at the top of the configuration form during deployment. This enables a link icon next to each configurable field, allowing you to map configuration group values.
47+
4548
To link a configuration group to a component, follow the steps given below:
4649

4750
1. Navigate to the component you want to link the configuration group.

en/developer-docs/docs/devops-and-ci-cd/manage-configurations-and-secrets.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,9 @@ You can modify Ballerina configurables via the **Deploy** page when deploying or
8989
Use configurables instead of environment variables to add file mounts to Ballerina components.
9090
Environment variables are primarily for components written in other languages.
9191

92+
!!! note
93+
To link configuration groups to Ballerina component configurables, click **Allow Linking Configuration Groups** at the top of the configuration form during deployment. This enables a link icon next to each configurable field, allowing you to map configuration group values.
94+
9295
## Alternative configuration management approach
9396

9497
!!! Warning "Warning"

en/pe-docs/docs/devops/manage-configuration-groups.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Configuration groups can be defined at organization level and link to components
99
- All configuration group values are encrypted and stored in environment-specific key vaults.
1010
- Management of configuration groups is restricted to users with Choreo Admin, DevOps, and Platform Engineer roles.
1111
- Developers can discover configuration groups available within the organization via the **Choreo Internal Marketplace**.
12-
- This feature is currently not supported for Ballerina build presets, Web Applications, or Test Runner components.
12+
- This feature is currently not supported for Web Applications or Test Runner components.
1313

1414
## Create a configuration group
1515

@@ -43,6 +43,9 @@ The configuration groups created at organization level can be linked to any comp
4343

4444
Linking a configuration group will inject the values defined in the group during deployment. The values are mapped to environment variable names or file names based on the keys defined in the configuration group. If needed, you can customize the environment variable name or file name by updating the mapping at deployment.
4545

46+
!!! note
47+
To link configuration groups to Ballerina component configurables, click **Allow Linking Configuration Groups** at the top of the configuration form during deployment. This enables a link icon next to each configurable field, allowing you to map configuration group values.
48+
4649
To link a configuration group to a component, follow the steps given below:
4750

4851
1. Navigate to the component you want to link the configuration group using top navigation menu.

en/pe-docs/docs/k8s-operations/manage-configurations-and-secrets.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,9 @@ You can modify Ballerina configurables via the **CD Pipelines** page when deploy
8989
Use configurables instead of environment variables to add file mounts to Ballerina components.
9090
Environment variables are primarily for components written in other languages.
9191

92+
!!! note
93+
To link configuration groups to Ballerina component configurables, click **Allow Linking Configuration Groups** at the top of the configuration form during deployment. This enables a link icon next to each configurable field, allowing you to map configuration group values.
94+
9295
## Alternative configuration management approach
9396

9497
!!! Warning "Warning"

0 commit comments

Comments
 (0)