Skip to content

Commit d2e6444

Browse files
authored
Added Bulk Restart in AG Doc (#5080)
1 parent 42b27f1 commit d2e6444

File tree

1 file changed

+51
-16
lines changed

1 file changed

+51
-16
lines changed

docs/user-guide/application-groups.md

Lines changed: 51 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,11 @@ Users need to have [Build and deploy permission](../user-guide/global-configurat
137137

138138
### Hibernating and Unhibernating Apps
139139

140+
{% hint style="warning" %}
141+
### Who Can Perform This Action?
142+
Users need to have [Build & deploy permission](../global-configurations/authorization/user-access.md#role-based-access-levels) or above (along with access to the environment and application) to hibernate or unhibernate applications.
143+
{% endhint %}
144+
140145
Since every application comes with an option to hibernate, the same is true for application groups. Using application group, you can hibernate one or more applications belonging to the same environment if you do not want them to consume resources (replica count will be set to 0).
141146

142147
In other words, you can hibernate running applications or unhibernate hibernated applications as per your requirement.
@@ -145,11 +150,11 @@ In other words, you can hibernate running applications or unhibernate hibernated
145150

146151
1. In the `Overview` page of your application group, use the checkboxes to choose the applications you wish to hibernate, and click the **Hibernate** button.
147152

148-
![Figure 18a: Selecting Apps to Hibernate](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/hibernate-apps.jpg)
153+
![Figure 18a: Selecting Apps to Hibernate](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/hibernate-apps-v1.jpg)
149154

150155
2. Confirm the hibernation.
151156

152-
![Figure 18b: Confirming Hibernation](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/confirm-hibernation.jpg)
157+
![Figure 18b: Confirming Hibernation](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/confirm-hibernation-v1.jpg)
153158

154159
3. Hibernation will initiate as shown below. You may close the window.
155160

@@ -161,45 +166,74 @@ Your applications pods would be scaled down and would stop incurring costs.
161166

162167
1. In the same `Overview` page, you can use the checkboxes to choose the hibernated applications you wish to unhibernate, and click the **Unhibernate** button.
163168

164-
![Figure 19a: Selecting Hibernated Apps to Unhibernate](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/unhibernate-apps.jpg)
169+
![Figure 19a: Selecting Hibernated Apps to Unhibernate](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/unhibernate-apps-v1.jpg)
165170

166171
2. Confirm the unhibernation.
167172

168-
![Figure 19b: Confirming Unhibernation](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/confirm-unhibernation.jpg)
173+
![Figure 19b: Confirming Unhibernation](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/confirm-unhibernation-v1.jpg)
169174

170175
3. Unhibernation will initiate as shown below. You may close the window.
171176

172177
![Figure 19c: Initiation Status of Unhibernation](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/initiated-unhibernation.jpg)
173178

174179
Your applications would be up and running in some time.
175180

181+
### Restart Workloads
182+
183+
{% hint style="warning" %}
184+
### Who Can Perform This Action?
185+
Users need to have [Build & deploy permission](../global-configurations/authorization/user-access.md#role-based-access-levels) or above (along with access to the environment and application) to restart workloads in bulk.
186+
{% endhint %}
187+
188+
Restarting workloads might be necessary if you want your new code or configuration to come into effect, or you are experiencing issues like crashing of pods.
189+
190+
Using application group, you can select the workloads (i.e., Pod, Deployment, ReplicaSet, etc.) of specific applications and restart them.
191+
192+
1. Use the checkboxes to choose the applications whose workloads you wish to restart, and click the **Restart Workload** button.
193+
194+
![Figure 20a: Selecting Apps to Restart](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/restart-workloads-v1.jpg)
195+
196+
2. Next to the application, click the workload dropdown to view all the individual workloads of an application. Choose only the ones you wish to restart.
197+
198+
![Figure 20b: Choosing Workloads](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/choose-workload.jpg)
199+
200+
Moreover, you can easily select, deselect, or choose multiple workloads as shown below.
201+
202+
![Figure 20c: Selecting and Unselecting Workloads](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/bulk-restart.gif)
203+
204+
3. Click **Restart Workloads**.
205+
206+
![Figure 20d: Restarting Workloads](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/select-workloads.jpg)
207+
208+
Restarting workloads might take time depending on the number of applications.
209+
176210
### Filtering Applications
177211

178212
Assume you have multiple applications (maybe 10, 50, 100, or more) showing up in an application group. If you want to limit your operations (build/deploy/other) to a specific set of applications, the filter feature will help you narrow down the list. Thus, you will see only those applications you select from the filter (be it on the `Overview` page, `Build & Deploy` page, and so on.)
179213

180214
1. Click the filter next to the application group as shown below.
181215

182-
![Figure 20: Filter Option](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/app-filter-1.jpg)
216+
![Figure 21: Filter Option](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/app-filter-1.jpg)
183217

184218
2. The filter will show all the applications present in the group. Click to select the relevant ones.
185219

186-
![Figure 21: All Apps](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/app-filter-2.jpg)
220+
![Figure 22: All Apps](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/app-filter-2.jpg)
187221

188222
3. The filter narrows down the list of applications as shown below.
189223

190-
![Figure 22: Filtered Apps](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/app-filter-3.jpg)
224+
![Figure 23: Filtered Apps](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/app-filter-3.jpg)
191225

192226
4. (Optional) If required, you can save the filter for future use by clicking **Save selection as filter**.
193227

194-
![Figure 23: Saving a Filter](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/save-filter.jpg)
228+
![Figure 24: Saving a Filter](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/save-filter.jpg)
195229

196230
5. Add a name and description to the filter to help you know its purpose, and click **Save**.
197231

198-
![Figure 24: Naming a Filter](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/save-filter-2.jpg)
232+
![Figure 25: Naming a Filter](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/save-filter-2.jpg)
199233

200234
Now when you access the application group, your saved filter will be visible on top.
201235

202-
![Figure 25: Saved Filter](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/save-filter-3.jpg)
236+
![Figure 26: Saved Filter](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/save-filter-3.jpg)
203237

204238
{% hint style="info" %}
205239

@@ -234,16 +268,17 @@ Users can delete a saved filter if they have Admin/Manager access on all applica
234268

235269
### Changing Branch
236270

271+
{% hint style="warning" %}
272+
### Who Can Perform This Action?
273+
Users need to have [Admin role](../user-guide/global-configurations/authorization/user-access.md#role-based-access-levels) or above (along with access to the environment and applications) to update their branch.
274+
{% endhint %}
275+
237276
Assume you have a few applications whose [build pipelines](../reference/glossary.md#build-pipeline) fetch from the `main` branch of your code repository. However, you decided to maintain a `master` branch, and you want all the upcoming CI builds to consider the `master` branch as the source. Devtron provides you the option to change the branch at both levels—individual application as well as application group.
238277

239278
1. In the **Build & Deploy** tab of your application group, select the intended applications and click the **Change Branch** button present at the bottom.
240279

241-
![Figure 26: Changing Branch](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/change-branch.jpg)
280+
![Figure 27: Changing Branch](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/change-branch.jpg)
242281

243282
2. Enter the new branch name. If your build pipeline has `Branch Regex` as the Source Type, you must ensure your new branch name matches the regex (regular expression) provided in that build pipeline. Once done, click **Update Branch**.
244283

245-
![Figure 27: Updating Branch Name](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/update-branch.jpg)
246-
247-
{% hint style="info" %}
248-
Users need to have [Admin role](../user-guide/global-configurations/authorization/user-access.md#role-based-access-levels) or above (along with access to the environment and applications) to update their branch
249-
{% endhint %}
284+
![Figure 28: Updating Branch Name](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/update-branch.jpg)

0 commit comments

Comments
 (0)