Skip to content

Commit ee41c98

Browse files
authored
Merge pull request #1882 from abeykoon/add-config-group-usage-info-new
[Devops]Add usage information to configuration groups doc page
2 parents c76c6b1 + c7aae2a commit ee41c98

File tree

1 file changed

+27
-10
lines changed

1 file changed

+27
-10
lines changed

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

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To create a new configuration group, follow the steps given below:
1818
1. In the [Choreo Console](https://console.choreo.dev/), go to the top navigation menu. Click **Organization** and select your organization.
1919
2. In the left navigation menu, click **DevOps** and then click **Configuration Groups**.
2020
3. On the **Configuration Groups** page, click **Create** and specify the following details to create a new configuration group:
21-
21+
2222
- **Name**: A name for the configuration group (Unique within the organization).
2323
- **Description**: A description for the configuration group (Optional).
2424
- **Define Keys**: Define the keys for the configuration group.
@@ -29,8 +29,8 @@ To create a new configuration group, follow the steps given below:
2929

3030
- By default, all the environments are grouped together allowing you to manage configuration smoothly. You can separate and manage configuration values for each environment as needed.
3131

32-
- **Create**: Click **Create** to create the configuration group.
33-
32+
- **Create**: Click **Create** to create the configuration group.
33+
3434
4. Now you can link this configuration group to any component within the organization.
3535

3636
!!!note
@@ -46,9 +46,9 @@ Linking a configuration group will inject the values defined in the group during
4646
To link a configuration group to a component, follow the steps given below:
4747

4848
1. Navigate to the component you want to link the configuration group using top navigation menu.
49-
2. On the left navigation menu, click **DevOps** and click **CD Pipelines**.
49+
2. On the left navigation menu, click **DevOps** and click **CD Pipelines**.
5050
3. Click **Configure & Deploy**, this will open the configuration and deployment wizard.
51-
3. In the wizard, link the configuration groups as **Environment Variables** or **File Mounts**, based on your requirements.
51+
4. In the wizard, link the configuration groups as **Environment Variables** or **File Mounts**, based on your requirements.
5252

5353
=== "Environment Variables"
5454

@@ -59,20 +59,20 @@ To link a configuration group to a component, follow the steps given below:
5959

6060
- Choose the configuration group you want to link to the component.
6161
- Specify the **Mount Path** to mount the configuration files.
62-
62+
6363
!!!note
6464
All configurations within the selected configuration group will be mounted as individual files to the specified mount path/directory.
6565

6666
- Click **Link** to link the configuration group to the component.
6767

68-
4. Complete the deployment wizard by providing the required details and click **Deploy** to deploy the component with the updated configurations.
68+
5. Complete the deployment wizard by providing the required details and click **Deploy** to deploy the component with the updated configurations.
6969

7070
## View & edit a configuration group
7171

7272
To view & edit a configuration group, follow the steps given below:
7373

7474
1. In the [Choreo Console](https://console.choreo.dev/), go to the top navigation menu. Click **Organization** and select your organization.
75-
2. In the left navigation menu, click **DevOps** and then click **Configuration Groups**.
75+
2. In the left navigation menu, click **DevOps** and then click **Configuration Groups**.
7676
3. In the **Configuration Groups** list, select the desired configuration group to view.
7777

7878
!!!note
@@ -83,7 +83,7 @@ To view & edit a configuration group, follow the steps given below:
8383

8484
Configuration keys and values within a configuration group can be modified, and these changes will take effect when the components using the configuration group are redeployed.
8585

86-
To edit the configuration group definition, click **Edit the Configuration Group** and make the necessary updates:
86+
To edit the configuration group definition, click **Edit the Configuration Group**, navigate to the **Configurations** tab and make the necessary updates:
8787

8888
- Add or remove configuration keys.
8989
- Update the configuration group's display name and description.
@@ -98,6 +98,23 @@ To edit the configuration values, click the edit icon in the corresponding set o
9898
- **Adding a new environment:** Non-sensitive configuration values will be copied to the new environment, but sensitive values will not be. As a result, sensitive values will be cleared across all environments in the set. **New values must be provided for sensitive configurations.**
9999
- **Removing an environment:** All configuration values for the removed environment will be deleted.
100100

101+
### View configuration group usage
102+
103+
A configuration group can be linked to multiple components across different projects within your organization. The **Usage** tab provides visibility into all components that reference the selected configuration group, organized by project in a tree view.
104+
105+
This view is useful when you need to identify which components require redeployment after updating a configuration group.
106+
107+
To view configuration group usage:
108+
109+
1. Select a configuration group from the list.
110+
2. Click the **Usage** tab.
111+
3. Use the search bar to filter by project or component name.
112+
4. Click on a component to navigate directly to its deploy page.
113+
114+
!!! note
115+
- A component is considered to be using a configuration group once it is deployed to a specific environment.
116+
- The same configuration group can be linked when deploying to multiple environments. The environments in which each component uses the configuration group are displayed in square brackets next to the component name.
117+
101118
## Delete a configuration group
102119

103120
To delete a configuration group, follow the steps given below:
@@ -106,7 +123,7 @@ To delete a configuration group, follow the steps given below:
106123
Deleting a configuration group is a permanent, non-reversible action. Ensure that the configuration group is not linked to any component before deleting it.
107124

108125
1. In the [Choreo Console](https://console.choreo.dev/), go to the top navigation menu. Click **Organization** and select your organization.
109-
2. In the left navigation menu, click **DevOps** and then click **Configuration Groups**.
126+
2. In the left navigation menu, click **DevOps** and then click **Configuration Groups**.
110127
3. In the **Configuration Groups** list, click the delete icon next to the configuration group you want to delete. This will display a confirmation dialog with details about the impact of the deletion.
111128
4. Review the details, then type the configuration group name to confirm the deletion.
112129
5. Click **Delete**.

0 commit comments

Comments
 (0)