You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: en/pe-docs/docs/devops/manage-configuration-groups.md
+27-10Lines changed: 27 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ To create a new configuration group, follow the steps given below:
18
18
1. In the [Choreo Console](https://console.choreo.dev/), go to the top navigation menu. Click **Organization** and select your organization.
19
19
2. In the left navigation menu, click **DevOps** and then click **Configuration Groups**.
20
20
3. On the **Configuration Groups** page, click **Create** and specify the following details to create a new configuration group:
21
-
21
+
22
22
-**Name**: A name for the configuration group (Unique within the organization).
23
23
-**Description**: A description for the configuration group (Optional).
24
24
-**Define Keys**: Define the keys for the configuration group.
@@ -29,8 +29,8 @@ To create a new configuration group, follow the steps given below:
29
29
30
30
- 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.
31
31
32
-
-**Create**: Click **Create** to create the configuration group.
33
-
32
+
-**Create**: Click **Create** to create the configuration group.
33
+
34
34
4. Now you can link this configuration group to any component within the organization.
35
35
36
36
!!!note
@@ -46,9 +46,9 @@ Linking a configuration group will inject the values defined in the group during
46
46
To link a configuration group to a component, follow the steps given below:
47
47
48
48
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**.
50
50
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.
52
52
53
53
=== "Environment Variables"
54
54
@@ -59,20 +59,20 @@ To link a configuration group to a component, follow the steps given below:
59
59
60
60
- Choose the configuration group you want to link to the component.
61
61
- Specify the **Mount Path** to mount the configuration files.
62
-
62
+
63
63
!!!note
64
64
All configurations within the selected configuration group will be mounted as individual files to the specified mount path/directory.
65
65
66
66
- Click **Link** to link the configuration group to the component.
67
67
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.
69
69
70
70
## View & edit a configuration group
71
71
72
72
To view & edit a configuration group, follow the steps given below:
73
73
74
74
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**.
76
76
3. In the **Configuration Groups** list, select the desired configuration group to view.
77
77
78
78
!!!note
@@ -83,7 +83,7 @@ To view & edit a configuration group, follow the steps given below:
83
83
84
84
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.
85
85
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:
87
87
88
88
- Add or remove configuration keys.
89
89
- 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
98
98
- **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.**
99
99
- **Removing an environment:** All configuration values for the removed environment will be deleted.
100
100
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
+
101
118
## Delete a configuration group
102
119
103
120
To delete a configuration group, follow the steps given below:
@@ -106,7 +123,7 @@ To delete a configuration group, follow the steps given below:
106
123
Deleting a configuration group is a permanent, non-reversible action. Ensure that the configuration group is not linked to any component before deleting it.
107
124
108
125
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**.
110
127
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.
111
128
4. Review the details, then type the configuration group name to confirm the deletion.
0 commit comments