Skip to content

Commit ae21e92

Browse files
NimRegevNimRegev
authored
Update app topics prods envs (#848)
* Add env and product info to manage applications * Add env & product blurbs Added env & product blurbs to monitor apps topic, and xrefs to create app topic * Update app topics with xrefs to products and envs Edited descriptions and xrefs to products and env topics * Content updates * Update manage-application.md
1 parent 73b56c3 commit ae21e92

File tree

8 files changed

+116
-29
lines changed

8 files changed

+116
-29
lines changed

‎_docs/dashboards/gitops-environments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The **GitOps Environments** dashboard introduces a new dimension to your GitOps
2828
Read this [blog](https://codefresh.io/blog/introducing-the-worlds-first-dashboard-for-gitops-environments/) on the world's first dashboard for GitOps Environments.
2929

3030
**What is an Environment in Codefresh GitOps?**
31-
An Environment is an entity in Codefresh defined by one or more K8s clusters and namespaces. It consolidates information for all Argo CD applications deployed to those clusters and namespaces, allowing you to easily track what's deployed where at any given moment.
31+
An Environment is a custom entity in Codefresh defined by one or more pairs of K8s clusters and namespaces. It consolidates information for all Argo CD applications deployed to those clusters and namespaces, allowing you to easily track what's deployed where at any given moment.
3232

3333
Codefresh allows you to define Environments that can exist without any applications deployed to them.
3434

‎_docs/deployments/gitops.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Codefresh has a native module for GitOps deployments powered by Argo CD and Argo
1212
* You can [edit/delete/rollback]({{site.baseurl}}/docs/deployments/gitops/manage-application/) applications while still keeping the state in Git.
1313
* Perform [Canary releases]({{site.baseurl}}/docs/deployments/gitops/install-argo-rollouts/) via the dedicated UI.
1414

15-
15+
Explore our unique GitOps [Environments]({{site.baseurl}}/docs/dashboards/gitops-environments/) and [Products]({{site.baseurl}}/docs/dashboards/gitops-products/) dashboards, designed for visualizing, monitoring, and managing Argo CD applications within their deployment environments.
1616

1717

1818

‎_docs/deployments/gitops/applications-dashboard.md

Lines changed: 46 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,14 @@ toc: true
77
---
88

99

10-
Monitor individual applications or groups of Argo CD applications in the GitOps Apps dashboard. This article focuses on individual Argo CD applications.
10+
Monitor Argo CD applications individually or within groups in the GitOps Apps dashboard.
11+
12+
This article focuses on monitoring individual Argo CD applications in the GitOps Apps dashboard. To monitor deployments of a group of applications in parallel, see [Application Group information]({{site.baseurl}}/docs/deployments/gitops/gitops-app-groups/).
13+
14+
**Monitor deployments, resources, and services of individual applications**
15+
As a one-stop shop for Argo Rollouts and Argo CD, the GitApps dashboard and its Applications tab 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 of deployments.
1116

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.
1517

16-
1718
{% include
1819
image.html
1920
lightbox="true"
@@ -24,27 +25,59 @@ caption="GitOps Apps dashboard: List view"
2425
max-width="70%"
2526
%}
2627

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+
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.
2829

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+
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:
3031
* [Get status from application header](#monitor-gitops-application-status-in-application-header)
3132
* [View deployment and configuration info for selected Argo CD application](#view-deployment-configuration-info-for-selected-argo-cd-application)
3233
* [Monitor resources for selected Argo CD application](#monitor-resources-for-selected-argo-cd-application)
3334
* [Monitor deployments for selected Argo CD application](#monitor-deployments-for-selected-argo-cd-application)
3435
* [Monitor services for selected Argo CD application](#monitor-services-for-selected-argo-cd-application)
3536

3637

38+
>**TIP**:Codefresh adds a whole new dimension to monitoring Argo CD applications through two unique GitOps dashboards: [GitOps Environments](#gitops-environments--argo-cd-applications) and [GitOps Products](#gitops-products--argo-cd-applications).
3739
38-
* **Application Groups**
39-
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.
40+
41+
For information on creating and managing Argo CD applications, application resources, and Application Groups, see [Creating Argo CD applications]({{site.baseurl}}/docs/deployments/gitops/create-application/) and [Managing Argo CD applications]({{site.baseurl}}/docs/deployments/gitops/manage-application/).
4042

41-
See [Application Group information]({{site.baseurl}}/docs/deployments/gitops/gitops-app-groups/).
43+
## GitOps Environments & Argo CD applications
44+
To track, optimize, and manage deployments at scale you need a way to visualize applications at every stage of their development and deployment lifecycle. Our custom Environment resource allows you to do just this without the need for complex configuration and maintenance overhead.
4245

46+
Create Environments by defining one or more pairs of clusters and namespaces for it. Codefresh collates the data on these Environments, populates them with the applications deployed to the target clusters and namespaces. Visualize the environments and their applications in the GitOps Environments dashboard to track promotions and view version and details on the most recent commits that caused the change.
4347

44-
>**NOTE**:
45-
For information on creating and managing Application Groups, Argo CD applications and application resources, see [Creating Argo CD applications]({{site.baseurl}}/docs/deployments/gitops/create-application/) and [Managing Argo CD applications]({{site.baseurl}}/docs/deployments/gitops/manage-application/).
48+
Here's a visualization of Argo CD applications in the GitOps Environments dashboard.
4649

47-
50+
{% include
51+
image.html
52+
lightbox="true"
53+
file="/images/gitops-environments/argo-apps-organized-into-envs.png"
54+
url="/images/gitops-environments/argo-apps-organized-into-envs.png"
55+
alt="Argo CD applications organized in GitOps Environments"
56+
caption="Argo CD applications organized in GitOps Environments"
57+
max-width="70%"
58+
%}
59+
60+
For detailed information on how to work with Argo CD applications and Environments in Codefresh, see [GitOps Environments]({{site.baseurl}}/docs/dashboards/gitops-environments/).
61+
62+
## GitOps Products & Argo CD applications
63+
The Product is another custom resource from Codefresh, also enhancing application management at scale. As teams expand and applications and services multiply, keeping track of deployments across various environments can become challenging, if not unmanageable.
64+
65+
Instead of having to switch between applications, or switch across multiple tools to track and manage different aspects of deployments, Products allow you to group applications into cohesive units, simplifying viewing, tracking, and management.
66+
Codefresh seamlessly collates the Environments where each application in the Product is deployed, along with insights into commits, contributors, and features deployed across versions.
67+
68+
Here's a visualization of Argo CD applications grouped by Products in the GitOps Products dashboard.
69+
70+
{% include
71+
image.html
72+
lightbox="true"
73+
file="/images/gitops-products/apps-grouped-by-product.png"
74+
url="/images/gitops-products/apps-grouped-by-product.png"
75+
alt="Argo CD applications grouped by Products and organized by Environments"
76+
caption="Argo CD applications grouped by Products and organized by Environments"
77+
max-width="70%"
78+
%}
79+
80+
For detailed information on how to work with Argo CD applications and Products in Codefresh, see [GitOps Products]({{site.baseurl}}/docs/dashboards/gitops-products/).
4881

4982

5083
## Select view mode for the GitOps Apps dashboard

‎_docs/deployments/gitops/create-application.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,28 @@ toc: true
99

1010

1111
Codefresh provides all the options and functionality to create and manage Argo CD applications in the Codefresh UI.
12-
* Create Argo CD applications that are fully GitOps compliant, from generating the application configuration manifest, committing it to Git, and syncing and deploying to the cluster.
13-
Creating an Argo CDapplication in Codefresh includes defining:
12+
13+
Create Argo CD applications that are fully GitOps compliant, from generating the application configuration manifest, committing it to Git, and syncing and deploying to the cluster.
14+
15+
Creating an Argo CD application in Codefresh includes defining:
1416
* Application name and location
1517
* General configuration settings
1618
* Advanced configuration settings
1719

1820

19-
The Create application wizard guides you through the process of creating an application. For how-to information, see [Create an Argo CD application](#create-an-argo-cd-application).
20-
For example Argo CD applications, see this [repo](https://github.com/oleksandr-codefresh/argocd-example-apps){:target="_blank"}.
21-
22-
Remember you need a valid [Git Source]({{site.baseurl}}/docs/installation/gitops/git-sources/) to be able to create and commit an Argo CD application.
21+
The Create application wizard guides you through the process of creating an application. For how-to information, see [Create an Argo CD application](#create-an-argo-cd-application).
2322

23+
For example Argo CD applications, see this [repo](https://github.com/oleksandr-codefresh/argocd-example-apps){:target="_blank"}.
24+
25+
Remember you need a valid [Git Source]({{site.baseurl}}/docs/installation/gitops/git-sources/) to be able to create and commit an Argo CD application.
26+
27+
Once created and synced to clusters, Argo CD applications are displayed in the GitOps Apps dashboard. Here, you can [monitor]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/) and [manage]({{site.baseurl}}/docs/deployments/gitops/manage-application/) individual Argo CD applications.
2428

25-
* Monitor Argo CD applications
26-
After creating an application, and it is synced to the cluster, the application is displayed in the GitOps Apps dashboard. Here,
27-
Here you can monitor its health and sync status, deployments, and resources. See [Monitoring Argo CD applications]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/).
29+
After creating Argo CD applications in Codefresh, you can also monitor and manage them in the GitOps Environments and Products dashboards by creating Environment and Product resources. See [GitOps Environments dashboard]({{site.baseurl}}/docs/dashboards/gitops-environments/) and [GitOps Products dashboard]({{site.baseurl}}/docs/dashboards/gitops-products/).
2830

29-
* Manage Argo CD applications
30-
You can also select an application and update the application's configuration settings, or delete it. For all available options, see [Managing Argo CD applications]({{site.baseurl}}/docs/deployments/gitops/manage-application/).
3131

3232
## Application: Definitions
33-
Application definitions include the name, runtime, and the name of the YAML manifest. By default, the YAML manifest has the same name as that of the application.
33+
Application definitions include the application name, the GitOps Runtime, and the name of the YAML manifest. By default, the YAML manifest has the same name as that of the application.
3434

3535
{% include
3636
image.html
@@ -272,5 +272,7 @@ Monitor the application.
272272
## Related articles
273273
[Monitoring Argo CD applications]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard)
274274
[Managing Argo CD applications]({{site.baseurl}}/docs/deployments/gitops/manage-application)
275+
[GitOps Environments dashboard]({{site.baseurl}}/docs/dashboards/gitops-environments/)
276+
[GitOps Products dashboard]({{site.baseurl}}/docs/dashboards/gitops-products/)
275277
[Home Dashboard]({{site.baseurl}}/docs/dashboards/home-dashboard)
276278
[DORA metrics]({{site.baseurl}}/docs/dashboards/dora-metrics/)

‎_docs/deployments/gitops/gitops-app-groups.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ max-width="60%"
2828

2929
Assign an application to one or more Groups when you create the application, or through the Configuration settings for existing applications. Changes to the Group have no impact on its applications.
3030

31+
You can also monitor and manage them in the GitOps Environments and Products dashboards by creating Environment and Product custom resources. See [GitOps Environments dashboard]({{site.baseurl}}/docs/dashboards/gitops-environments/) and [GitOps Products dashboard]({{site.baseurl}}/docs/dashboards/gitops-products/).
3132

3233

3334

‎_docs/deployments/gitops/manage-application.md

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,21 @@ sub_group: gitops
66
toc: true
77
---
88

9-
Application creation and deployment is one part of the continuous deployment/delivery process. An equally important part is optimizing deployed applications when needed.
9+
Application creation and deployment is one part of the continuous deployment/delivery process. An equally important part is optimizing deployed applications as and when needed.
10+
11+
There are two aspects to managing and optimizing Argo CD applications in Codefresh:
12+
* Optimizing deployments through GitOps Environments and Products
13+
* Managing individual applications
14+
15+
**Optimizing application deployments**
16+
17+
* [GitOps Environments](#gitops-environments--argo-cd-applications)
18+
The GitOps Environments dashboard visualizes Argo CD applications within the context of their environments, allowing you to track their journey through the software development lifecycle.
19+
20+
* [GitOps Products](#gitops-products--argo-cd-applications)
21+
The GitOps Products dashboard displays applications grouped within a Product, with version, Git, and feature-tracking information.
22+
23+
**Managing individual applications**
1024

1125
>**NOTE**:
1226
The actions you can perform depend on the [permissions]({{site.baseurl}}/docs/administration/account-user-management/gitops-abac/) assigned to you.
@@ -40,6 +54,44 @@ The actions you can perform depend on the [permissions]({{site.baseurl}}/docs/ad
4054
To delete specific resources within an application, see [Delete application resources]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/#delete-application-resources).
4155

4256

57+
## GitOps Environments & Argo CD applications
58+
To track, optimize, and manage deployments at scale you need a way to visualize applications at every stage of their development and deployment lifecycle. Our custom Environment resource allows you to do just this without the need for complex configuration and maintenance overhead.
59+
60+
Create Environments by defining one or more pairs of clusters and namespaces for it. Codefresh collates the data on these Environments, populates them with the applications deployed to the target clusters and namespaces. Visualize the environments and their applications in the GitOps Environments dashboard to track promotions and view version and details on the most recent commits that caused the change.
61+
62+
Here's a visualization of Argo CD applications in the GitOps Environments dashboard.
63+
64+
{% include
65+
image.html
66+
lightbox="true"
67+
file="/images/gitops-environments/argo-apps-organized-into-envs.png"
68+
url="/images/gitops-environments/argo-apps-organized-into-envs.png"
69+
alt="Argo CD applications organized in GitOps Environments"
70+
caption="Argo CD applications organized in GitOps Environments"
71+
max-width="70%"
72+
%}
73+
74+
For detailed information on how to work with Argo CD applications and Environments in Codefresh, see [GitOps Environments]({{site.baseurl}}/docs/dashboards/gitops-environments/).
75+
76+
## GitOps Products & Argo CD applications
77+
The Product is another custom resource from Codefresh, also enhancing application management at scale. As teams expand and applications and services multiply, keeping track of deployments across various environments can become challenging, if not unmanageable.
78+
79+
Instead of having to switch between applications, or switch across multiple tools to track and manage different aspects of deployments, Products allow you to group applications into cohesive units, simplifying viewing, tracking, and management.
80+
Codefresh seamlessly collates the Environments where each application in the Product is deployed, along with insights into commits, contributors, and features deployed across versions.
81+
82+
Here's a visualization of Argo CD applications grouped by Products in the GitOps Products dashboard.
83+
84+
{% include
85+
image.html
86+
lightbox="true"
87+
file="/images/gitops-products/apps-grouped-by-product.png"
88+
url="/images/gitops-products/apps-grouped-by-product.png"
89+
alt="Argo CD applications grouped by Products and organized by Environments"
90+
caption="Argo CD applications grouped by Products and organized by Environments"
91+
max-width="70%"
92+
%}
93+
94+
For detailed information on how to work with Argo CD applications and Products in Codefresh, see [GitOps Products]({{site.baseurl}}/docs/dashboards/gitops-products/).
4395

4496

4597

‎_docs/deployments/gitops/troubleshooting-gitops-apps.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,4 @@ In Codefresh, this issue leads to a loop with the following behavior:
3232

3333

3434
### Possible Actions
35-
3635
To resolve this issue when using Istio with Argo Rollouts, configure the application following the best practices for [integration with GitOps](https://argoproj.github.io/argo-rollouts/features/traffic-management/istio/#integrating-with-gitops){:target="\_blank"} in the Argo Rollouts documentation.

‎images/gitops-products/apps-grouped-by-product.png

298 KB
Loading

0 commit comments

Comments
 (0)