Skip to content

Commit 068fbdf

Browse files
authored
Gitops app groups (#793)
* Add app group info Added prelim version of app group content * Update app group content Updated content to create, monitor and manage app groups * Update applications-dashboard.md * Add missing legacy content to app topics * Update applications-dashboard.md Fixed xrefs to updated titles * Update applications-dashboard.md * Add content for app groups Initial draft version * Update gitops-app-groups.md * Add screenshots * Update app groups Added screenshots and edited content * Edit app groups and add new screenshot * Update gitops-app-groups.md * Update app group info in app dashboard Removed app group details and added bullet item and reference in overview * Add nav entry for app groups Added entry to nav yaml for app groups * Add annotation aspect Implemented feedback from Kostis and added example of app manifest with the app group annotation * Add beta version note to app groups Added note with Beta version indication to app groups
1 parent 66fd4fb commit 068fbdf

File tree

12 files changed

+231
-21
lines changed

12 files changed

+231
-21
lines changed

_data/nav.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,8 @@
353353
url: "/create-application"
354354
- title: Monitoring GitOps applications
355355
url: "/applications-dashboard"
356+
- title: Application Groups for GitOps applications
357+
url: "/gitops-app-groups"
356358
- title: Managing GitOps applications
357359
url: "/manage-application"
358360
- title: Progressive delivery with GitOps

_docs/administration/account-user-management/gitops-abac.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Restrict access to GitOps entities through ABAC"
44
toc: true
55
---
66

7-
>This feature is currently in Beta.
7+
>**NOTE**: This feature is currently in Beta.
88
99
Control access to entities in GitOps through ABAC (Attribute-Based Access Control). ABAC allows fine-grained access to application entities through the use of rules.
1010
For GitOps, you can currently define ABAC for application entities in the Codefresh UI or programmatically via Terraform.

_docs/deployments/gitops/applications-dashboard.md

Lines changed: 41 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,12 @@ toc: true
77
---
88

99

10-
Monitor applications across clusters, and the deployments, resources, and services for an application in the GitOps Apps dashboard. As a one-stop shop for Argo Rollouts and Argo CD, the GitOps Apps dashboard in Codefresh delivers on the challenge of keeping track of your applications and their deployments, whatever the frequency and scale, across all clusters in your enterprise. A wide range of filters, progressive delivery views, and enriched CI and CD information, provide full traceability and visibility to your deployments.
10+
Monitor individual applications or groups of GitOps applications in the GitOps Apps dashboard. This article focuses on individual GitOps applications.
11+
12+
* **Applications**
13+
Monitor deployments, resources, and services of individual applications.
14+
As a one-stop shop for Argo Rollouts and Argo CD, the Applications tab in the GitOps Apps dashboard delivers on the challenge of keeping track of your applications and their deployments, whatever the frequency and scale, across all clusters in your enterprise. A wide range of filters, progressive delivery views, and enriched CI and CD information, provide full traceability and visibility to your deployments.
1115

12-
Select the view format for Applications in the GitOps Apps dashboard, as either [List or Card views](#select-view-mode-for-the-gitops-apps-dashboard). The default view displays all applications deployed within the last 30 days. Customize the scope through filters to display the [information](#gitops-apps-dashboard-application-information) you need.
1316

1417
{% include
1518
image.html
@@ -21,22 +24,31 @@ caption="GitOps Apps dashboard: List view"
2124
max-width="60%"
2225
%}
2326

24-
Identify applications with [health and sync errors](#identify-gitops-applications-with-warningserrors), and then select an application to drill down into its resources, deployments, and services:
25-
* [Get status from application header](#monitor-gitops-application-status-in-application-header)
26-
* [View deployment and configuration info for selected application](#view-deployment-configuration-info-for-selected-gitops-application)
27-
* [Monitor resources for selected GitOps application](#monitor-resources-for-selected-gitops-application)
28-
* [Monitor deployments for selected GitOps application](#monitor-deployments-for-selected-gitops-application)
29-
* [Monitor services for selected GitOps application](#monitor-services-for-selected-gitops-application)
27+
Select the view format for Applications in the GitOps Apps dashboard, as either [List or Card views](#select-view-mode-for-the-gitops-apps-dashboard). The default view displays all applications deployed within the last 30 days. Customize the scope through filters to display the [information](#gitops-apps-dashboard-application-information) you need.
28+
29+
Identify applications with [health and sync errors](#identify-gitops-applications-with-warningserrors), and then select an application to drill down into its resources, deployments, and services:
30+
* [Get status from application header](#monitor-gitops-application-status-in-application-header)
31+
* [View deployment and configuration info for selected application](#view-deployment-configuration-info-for-selected-gitops-application)
32+
* [Monitor resources for selected GitOps application](#monitor-resources-for-selected-gitops-application)
33+
* [Monitor deployments for selected GitOps application](#monitor-deployments-for-selected-gitops-application)
34+
* [Monitor services for selected GitOps application](#monitor-services-for-selected-gitops-application)
35+
3036

3137

3238

3339

34-
>**NOTE**:
35-
For information on creating and managing <!--- application groups, -->applications and application resources, see [Creating GitOps applications]({{site.baseurl}}/docs/deployments/gitops/create-application/) and [Managing GitOps applications]({{site.baseurl}}/docs/deployments/gitops/manage-application/).
3640

41+
* **Application Groups**
42+
Monitor the deployments of a group of applications in parallel. Instead of having to switch between applications, see the deployment history, compare and analyze build, PR (Pull Request), and issue tracking information across similar applications to gain insights.
3743

44+
See [Application Group information](#application-group-information).
3845

3946

47+
>**NOTE**:
48+
For information on creating and managing Application Groups, applications and application resources for GitOps, see [Creating GitOps applications]({{site.baseurl}}/docs/deployments/gitops/create-application/) and [Managing GitOps applications]({{site.baseurl}}/docs/deployments/gitops/manage-application/).
49+
50+
51+
4052

4153
## Select view mode for the GitOps Apps dashboard
4254
View deployed applications in either List (the default) or Card views. Both views are sorted by the most recent deployments.
@@ -80,11 +92,11 @@ Here's a description of the information and actions you can see for individual a
8092
| -------------- | -------------- |
8193
|Application filters | Filter by a range of attributes to customize the information in the dashboard to bring you what you need. {::nomarkdown} <ul><li>Application state<br>A snapshot that displays a breakdown of the deployed applications by their health status.<br>Click a status to filter by applications that match it.<br>Codefresh tracks Argo CD's set of health statuses. See the official documentation on <a href="https://argo-cd.readthedocs.io/en/stable/operator-manual/health" target=”_blank”>Health sets</a>.</li><li>Application attributes<br>Attribute filters support multi-selection, and results are based on an OR relationship within the same filter with multiple options, and an AND relationship between filters.<br>Clicking <b>More Filters</b> gives you options to filter by Health status, Cluster names, Namespace, and Type. <br><ul><li>Application Type: Can be any of the following<ul><li>Applications: Standalone applications. See the official documentation on <a href="https://argo-cd.readthedocs.io/en/stable/operator-manual/declarative-setup/#applications" target=”_blank”>Applications</a>.</li><li>ApplicationSet: Applications created using the ApplicationSet Custom Resource (CR) template. An ApplicationSet can generate single or multiple applications. See the official documentation on <a href="https://argo-cd.readthedocs.io/en/stable/user-guide/application-set" target=”_blank”>Generating Applications with ApplicationSet</a>.</li><li>Git Source: Applications created by Codefresh that includes other applications and CI resources. See <a href="https://codefresh.io/docs/docs/installation/gitops/git-sources/">Git Sources</a>.</li></ul></li></li><li>Labels:The K8s labels defined for the applications. The list displays labels of <i>all</i> the applications, even if you have applied filters.<br>To see the available labels, select <b>Add</b>, and then select the required label and one or more values. <br>To filter by the labels, select <b>Add</b> and then <b>Apply</b>.<br> See the official documentation on <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/labels" target=”_blank”>Labels and selectors</a>.</li></ul></ul>{:/}|
8294
|{::nomarkdown}<img src="../../../../images/icons/icon-mark-favorite.png?display=inline-block">{:/}| Star applications as favorites and view only the starred applications.{::nomarkdown}<br>Select the <img src="../../../../images/icons/icon-mark-favorite.png?display=inline-block"> to star the application as a favorite.<br><br>To filter by favorite applications, on the filters bar, select <img src="../../../../images/icons/icon-fav-starred.png?display=inline-block">.<br>{:/} TIP: If you star applications as favorites in the GitOps Apps dashboard, you can filter by the same applications in the [DORA metrics dashboard]({{site.baseurl}}/docs/dashboards/dora-metrics/#metrics-for-favorite-applications). |
83-
8495
|Application actions| Options to monitor/manage applications through the application's context menu. {::nomarkdown}<ul><li>Quick view<br>A comprehensive read-only view of the deployment and definition information for the application.</li>{:/}See [Application Quick View](#view-deployment-configuration-info-for-selected-gitops-application) in this article.{::nomarkdown}<li>Synchronize/Sync<br>Manually synchronize the application.</li>{:/}See [Manually sync applications]({{site.baseurl}}/docs/deployments/gitops/manage-application/#manually-synchronize-an-application).{::nomarkdown}<li>Edit<br>Modify application definitions.</li>{:/}See [Edit application definitions]({{site.baseurl}}/docs/deployments/gitops/manage-application/#edit-application-definitions).{::nomarkdown}<li>Refresh and Hard Refresh: Always available in the application's toolbar. <ul><li>Refresh: Retrieve desired (Git) state, compare with the live (cluster) state, and refresh the application to sync with the desired state.</li><li>Hard Refresh: Refresh the application to sync with the Git state, while removing the cache.</li></ul>See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#refreshhard-refresh-gitops-applications">Refresh/hard refresh GitOps applications</a>.{:/} |
8596

8697

8798

99+
88100
## Identify GitOps applications with warnings/errors
89101
Errors are flagged in the **Warnings/Errors** button, displayed at the top right of the Applications tab in the GitOps Apps dashboard. Clicking the button shows the list of applications with the warnings/errors and the possible reasons for these.
90102

@@ -215,7 +227,6 @@ The Quick View includes the following tabs:
215227
## Monitor resources for selected GitOps application
216228

217229

218-
219230
Monitor the resources deployed in the current version of the selected application in the Current State tab.
220231
Selecting an application from the GitOps Apps dashboard takes you to the Current State tab, which as its title indicates, displays the
221232
live state of the application's resources (Kubernetes objects) on the cluster, including health, sync state, manifests, and logs.
@@ -244,7 +255,6 @@ What can you do with application resources?
244255
* [Events](#events-for-application-resources)
245256

246257

247-
248258
### View modes for application resources
249259

250260
The Current State tab supports Tree and List view formats.
@@ -391,6 +401,22 @@ caption="Current State filtered by IgnoreExtraneous resources"
391401
max-width="50%"
392402
%}
393403

404+
### Delete application resources
405+
Delete specific resources in an application directly from the Codefresh UI.
406+
407+
1. In the Codefresh UI, from the sidebar, under OPS, select **GitOps Apps**.
408+
1. From the Application dashboard, select the application with the resource to delete.
409+
1. From the context menu of the resource, select **Delete**.
410+
411+
{% include
412+
image.html
413+
lightbox="true"
414+
file="/images/applications/current-state-delete-resource.png"
415+
url="/images/applications/current-state-delete-resource.png"
416+
alt="Current State: Delete an application resource"
417+
caption="Current State: Delete an application resource"
418+
max-width="50%"
419+
%}
394420

395421
### Delete application resources
396422
Delete specific resources in an application directly from the Codefresh UI.
@@ -524,8 +550,8 @@ max-width="50%"
524550

525551

526552

527-
528553
## Monitor deployments for selected GitOps application
554+
529555
Monitor an ongoing deployment for the selected application, and review its historical deployments.
530556
The Timeline tab displays the history of deployments for the selected application, sorted by the most recent deployment (default), labeled **Current Version** at the top.
531557

@@ -670,8 +696,8 @@ max-width="50%"
670696

671697

672698

673-
## Monitor services for selected GitOps application
674699

700+
## Monitor services for selected GitOps application
675701

676702

677703
The Services tab shows the K8s services for each deployment of the application.

_docs/deployments/gitops/create-application.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,15 @@ General configuration settings define the group to which the application belongs
5050
max-width="70%"
5151
%}
5252

53-
<!--- ### Groups
53+
54+
### Groups
5455
Optional. The group or groups to which to add the application.
55-
You can group applications based on criteria meaningful to your organization, such as environment, region, or any other relevant attribute. You can then view deployments for these applications in the same location in the Groups tab of the GitOps Apps dashboard. A new view for GitOps Application, App Groups allow you to collate multiple applications view their timelines.
56+
You can group applications based on criteria meaningful to your organization, such as environment, region, or any other relevant attribute. You can then view deployments for these applications in the same location in the Groups tab of the GitOps Apps dashboard. A new view for GitOps applications, Groups allow you to collate multiple applications view their timelines.
57+
58+
Select an existing group or groups, or create a new application group by typing a name and pressing Enter.
5659

57-
Select an existing group, or create a new application group by typing a name and pressing Enter.
60+
5861

59-
-->
6062

6163
### Source
6264
The Git repository to be tracked for changes to the application's source code.

0 commit comments

Comments
 (0)