Skip to content

Commit c76c6b1

Browse files
authored
Merge pull request #1881 from abeykoon/add-config-group-usage-info
Add usage information to configuration groups doc page
2 parents 91e2809 + a9e2caf commit c76c6b1

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

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

Lines changed: 24 additions & 8 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,12 +29,11 @@ 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
37-
- Configuration groups created will be listed in the **Choreo Internal Marketplace**, improving visibility and discoverability for developers.
3837
- All configuration groups will also be listed in the component deployment drawers, allowing developers to easily link them during deployment.
3938

4039
## Link and use configuration groups
@@ -58,7 +57,7 @@ To link a configuration group to a component, follow the steps given below:
5857

5958
- Choose the configuration group you want to link to the component.
6059
- Specify the **Mount Path** to mount the configuration files.
61-
60+
6261
!!!note
6362
All configurations within the selected configuration group will be mounted as individual files to the specified mount path/directory.
6463

@@ -71,7 +70,7 @@ To link a configuration group to a component, follow the steps given below:
7170
To view & edit a configuration group, follow the steps given below:
7271

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

7776
!!!note
@@ -82,7 +81,7 @@ To view & edit a configuration group, follow the steps given below:
8281

8382
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.
8483

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

8786
- Add or remove configuration keys.
8887
- Update the configuration group's display name and description.
@@ -97,6 +96,23 @@ To edit the configuration values, click the edit icon in the corresponding set o
9796
- **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.**
9897
- **Removing an environment:** All configuration values for the removed environment will be deleted.
9998

99+
### View configuration group usage
100+
101+
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.
102+
103+
This view is useful when you need to identify which components require redeployment after updating a configuration group.
104+
105+
To view configuration group usage:
106+
107+
1. Select a configuration group from the list.
108+
2. Click the **Usage** tab.
109+
3. Use the search bar to filter by project or component name.
110+
4. Click on a component to navigate directly to its deploy page.
111+
112+
!!! note
113+
- A component is considered to be using a configuration group once it is deployed to a specific environment.
114+
- 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.
115+
100116
## Delete a configuration group
101117

102118
To delete a configuration group, follow the steps given below:
@@ -105,7 +121,7 @@ To delete a configuration group, follow the steps given below:
105121
Deleting a configuration group is a permanent, non-reversible action. Ensure that the configuration group is not linked to any component before deleting it.
106122

107123
1. In the [Choreo Console](https://console.choreo.dev/), go to the top navigation menu. Click **Organization** and select your organization.
108-
2. In the left navigation menu, click **DevOps** and then click **Configuration Groups**.
124+
2. In the left navigation menu, click **DevOps** and then click **Configuration Groups**.
109125
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.
110126
4. Review the details, then type the configuration group name to confirm the deletion.
111127
5. Click **Delete**.

0 commit comments

Comments
 (0)