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: _docs/dashboards/gitops-products.md
+17-24Lines changed: 17 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ toc: true
8
8
9
9
10
10
11
-
Explore the power ofproducts for Argo CD applications in Codefresh GitOps.
11
+
Explore the power ofProducts for Argo CD applications in Codefresh GitOps.
12
12
13
13
Managing complex applications across multiple environments is a common challenge faced by developers and platform engineers. The diverse nature of applications and the variety of environments they deploy to can lead to fragmented management and deployment processes.
14
14
@@ -31,7 +31,8 @@ This article focuses on the Product Dashboard and the insights you can gain from
31
31
32
32
For detailed information on creating products and how to work with them, see[About Products]({{site.baseurl}}/docs/products/about-products/) and[Creating products]({{site.baseurl}}/docs/products/create-product/).
33
33
34
-
34
+
>**NOTE**
35
+
In the documentation, both Product (capitalized) and product (lowercase) refer to the same entity in Codefresh GitOps. They are used interchangeably for readability and consistency.
35
36
36
37
##Products page
37
38
@@ -54,7 +55,7 @@ Here's an example of the Product page with the list of all the products.
54
55
Here are some key features of the Products page:
55
56
56
57
###Collapsed & expanded views
57
-
***Collapsed view**: The default view, displays the Product name alongside the Environments with the number of applications in eachEnvironment.<br> The options on the right allow you to manage products.
58
+
***Collapsed view**: The default view, displays the Product name alongside the Environments with the number of applications in eachenvironment.<br> The options on the right allow you to manage products.
58
59
***Expanded view**: The expanded view displays the applications in the product organized by their Environments.
59
60
60
61
###Product management options
@@ -65,38 +66,30 @@ Mouse over the row with the product to display possible actions:
65
66
66
67
67
68
##Product Dashboard
68
-
Clicking a Product name navigates you to the Product Dashboard with a detailed view of the product and its applications. It also includes integrated insights into Git and issue-tracking systems and how they relate to deployments.
69
+
Clicking a Product name navigates you to the Product Dashboardfor the selected productwith a detailed view of its applications. It also includes integrated insights into Git and issue-tracking systems and how they relate to deployments.
69
70
70
-
In addition, the application version and enriched image information are especially useful.
71
-
72
71
73
72
#####Application release version
74
-
* Version information, currently supported for Helm-based applications, identifies the specific release of the application in differentEnvironments.
73
+
* Version information, currently supported for Helm-based applications, identifies the specific release of the application in differentenvironments.
75
74
* Clicking the version displays the application's dependencies, enabling comparison across different applications.
76
75
77
-
See[View and compare deployed versions for dependencies](#view-and-compare-deployed-versions-for-dependencies).
78
-
79
76
#####Integrated Pod/Git/Feature information
80
77
* The Products dashboard correlates sync information with other parts of the software lifecycle, such as issue-tracking systems.
81
78
* Switch between Pods, Git, and Features views to gain insights beyond development, including source code commits, affected services, commit authorship, and incorporated features in releases.
Manage individual applications without navigating away from the Products dashboard. The actions available mirror those in the GitOps Apps dashboard.
88
-
89
-
84
+
Manage individual applications without navigating away from the Product Dashboard. The actions available mirror those in the GitOps Apps dashboard.
90
85
91
86
87
+
##Integrated insights with Pod, Git, Feature views
88
+
Navigate seamlessly between Kubernetes (Pods),[version] control (Git), and issue-tracking (Features) views for the Product to get consolidated data from the same location.
92
89
93
90
94
-
###Integrated insights with Pod, Git, Feature views
95
-
Navigate seamlessly between Kubernetes (Pods), version control (Git), and issue-tracking (Features) views for the Product to get consolidated data from the same location.
96
91
97
-
98
-
99
-
####Pods
92
+
###Pods
100
93
Deployment, Rollout, and Promotion information for the application.
101
94
* Deployments: Source image, new image and tag, replicas for each deployment
102
95
* Rollouts: The services rolled out, the type of rollout, the result of the rollout, promote/pause rollout action
@@ -123,7 +116,7 @@ Deployment, Rollout, and Promotion information for the application.
123
116
max-width="60%"
124
117
%}
125
118
126
-
####Git
119
+
###Git
127
120
Codefresh retrieves the data here directly_from the application repository_, not the GitOps repository. You can trace the complete commit history of the application’s repo, up to the commit that initiated the build and deployed the new version.
128
121
129
122
History of individual commits with deep links to source control.
@@ -144,7 +137,7 @@ Useful for project managers and developers to trace:
144
137
max-width="60%"
145
138
%}
146
139
147
-
####Features
140
+
###Features
148
141
Connect commits to the application repo to tickets in your issue-tracking tool or system. This integration enhances traceability and context, enabling you to monitor the deployment’s impact by tying deployed features to specific feature requests or bug fixes.
149
142
* Gain insights into deployment specifics
150
143
* Review all commits leading up to the latest one that triggered the deployment
@@ -160,7 +153,7 @@ Connect commits to the application repo to tickets in your issue-tracking tool o
160
153
max-width="60%"
161
154
%}
162
155
163
-
156
+
<!---
164
157
165
158
166
159
@@ -270,11 +263,11 @@ Either create an environment, or add the cluster-namespace defined for the appli
270
263
1. Add the namespace defined for the application to the Environment settings.
271
264
1. Go back to the Product Dashboard.
272
265
You will now see your application in the product and in the correct environment.
description:"Createproducts to group and deploy applications"
3
+
description:"CreateProducts to group and deploy applications"
4
4
group:products
5
5
toc:true
6
6
---
7
7
8
8
9
-
Harness the power of**products** to streamline the management and deployment of complex Argo CD applications in Codefresh GitOps. By grouping interconnected applications, products provide enhanced visibility and control as they progress across environments.
10
9
11
-
Managing diverse applications in dynamic environments often leads to fragmented processes. Products act as a strategic layer, grouping applications with shared dependencies and context to bridge these gaps effectively.
12
10
13
-
With products, you can enhance your environments in Codefresh GitOps, gaining a unified view of application management and deployment.
11
+
##Products in Codefresh GitOps
12
+
Harness the power of**Products** in Codefresh GitOps to streamline the management and deployment of Argo CD applications.
13
+
14
+
A Product groups related Argo CD applications, providing a unified perspective as the applications progress through different stages of development and deployment. By defining relationships between applications across multiple environments, Products introduce an organizational layer providing context that help manage application releases as a cohesive unit.\
14
15
15
16
{% include
16
17
image.html
@@ -22,18 +23,10 @@ caption="Products and Product Dashboard in GitOps"
22
23
max-width="70%"
23
24
%}
24
25
26
+
##Boosting application management with Products
27
+
Products enhance and simplify application management by enabling controlled promotions, version tracking, and environment-specific configurations.
28
+
Since an application can exist in multiple environments, grouping them within a Product helps compare versions, track changes, and maintain consistency.
Read more about it in this[blog](https://codefresh.io/blog/introducing-the-worlds-first-dashboard-for-gitops-environments/){:target="\_blank"}.
28
-
29
-
30
-
<!--- >>**NOTE**
31
-
In the documentation, both product (capitalized) and product (lowercase) refer to the same entity in Codefresh GitOps. They are used interchangeably for readability and consistency across the text.-->
32
-
33
-
##How products work
34
-
Products group related Argo CD applications, offering a unified perspective as they transition through stages of development and deployment.
35
-
36
-
For example, you can group multiple billing-related applications as a product, enabling streamlined management and deployment as a single entity.
37
30
38
31
{% include
39
32
image.html
@@ -45,45 +38,50 @@ caption="Argo CD applications grouped by products organized by environments"
45
38
max-width="60%"
46
39
%}
47
40
41
+
Explore the[Product Dashboard]({{site.baseurl}}/docs/dashboards/gitops-products/) for real-time visibility into deployments, Git changes, and environment status.
42
+
Read more about the dashboard in this[blog](https://codefresh.io/blog/introducing-the-worlds-first-dashboard-for-gitops-environments/){:target="\_blank"}.
48
43
49
44
50
-
##Benefits of products
51
-
52
-
45
+
###Key benefits
53
46
***Unified application management**
54
47
Grouping interconnected applications simplifies management and streamlines deployments across environments.
55
48
56
49
***Aapplication-environment linking**
57
50
Products bridge the gap between applications and environments, providing clarity and control over the deployment lifecyle.
58
51
59
52
***Deployment visibility**
60
-
Product promotions generate releasesthat visualizeshow promotions are orchestrated across environments. Releases also provide detailed insights into issue tracking, Git activity, and other actions that led to the promotion.
53
+
Product promotions generate releasesvisualizinghow promotions are orchestrated across environments, with insights into issue tracking, Git activity, and other actions that led to the promotion.
61
54
62
55
***Effortless creation**
63
-
As with environments,productsare easy to createthrough the UI, or declaratively using annotations in application manifests.
56
+
Createproducts through the UI orr declaratively using annotations in application manifests.
64
57
65
58
***Real-time insights with integrated views**
66
-
The Product Dashboard integrats views of Pods, Git changes, and feature activity, tailored to developers and other stakeholders.
59
+
The Product Dashboard consolidates information on Pods, Git changes, and feature activity, tailored to developers and other stakeholders.
60
+
61
+
62
+
##Creating and configuring Products
67
63
64
+
There are two ways to create a Product in Codefresh GitOps:
68
65
66
+
* From within an application
67
+
* From the Products page
69
68
70
-
##Working with products and applications
69
+
After[creating products]({{site.baseurl}}/docs/products/create-product/), assign applications, streamline their promotions, and gain visibility across environments.
70
+
See[Assigning applications to the product]({{site.baseurl}}/docs/products/assign-applications/).
71
71
72
-
After[creating products]({{site.baseurl}}/docs/products/create-product/), use its features to cohesively manage applications, streamline their promotions,andgain visibility across environments.
72
+
##Promotionsandpromotion settings for Products
73
73
74
-
***Basic settings for products**
75
-
* Annotations: Retrieve the annotation created automatically for the product to link applications.
76
-
* Applications: Assign applications to the product.
74
+
Promote a product manually to a specific environment or automate promotions across multiple environments using Promotion Flows.
See[Assigning applications to the product]({{site.baseurl}}/docs/products/assign-applications/).
77
+
**Promotion settings for Products** give you control over what and how changes are advanced, ensuring that each promotion aligns with your deployment strategy.
79
78
80
-
***Tailored promotion settings**
81
-
Customize promotion settings to meet product-specific needs:
82
-
* Specify the*version source for applications*, ensuring consistency across deployments.
83
-
* Define the*attributes in applications* to determine what gets promoted.
84
-
* Select the*promotion flows that match the product and customize the conditions to trigger each of these flows* to automate promotions.
79
+
Customize promotion settings to configure:
80
+
***Version source for applications**: Maintain consistency by specifying where application versions originate.
81
+
***Promotable attributes in applications**: Define which changes are promoted across different environments.
82
+
***Promotion Flows**: Select the Promotion Flows that match the Product, and tailor the conditions to trigger each of these flows.
85
83
86
-
See[Application version and promotable properties]({{site.baseurl}}/docs/products/promotion-version-properties/) and[Promotion flows and triggers for products]({{site.baseurl}}/docs/products/promotion-flow-triggers/).
84
+
See[Application version and promotable properties]({{site.baseurl}}/docs/products/promotion-version-properties/) and[Promotion flows and triggers for products]({{site.baseurl}}/docs/products/promotion-flow-triggers/).
87
85
88
86
89
87
{% include
@@ -97,15 +95,10 @@ max-width="60%"
97
95
%}
98
96
99
97
100
-
***Manually promote products**
101
-
When needed, manually promote the product to a specific environment, or to multiple environment through Promotion Flows.
102
-
See[Manually promote to specific environment]({{site.baseurl}}/docs/promotions/trigger-promotions#manually-promote-products-to-specific-environments) and[Manually promote to multiple environments by Promotion Flow]({{site.baseurl}}/docs/promotions/trigger-promotions#manually-promote-products-to-multiple-environments-by-promotion-flow).
103
98
104
-
***Track release activity**
105
-
Use the Releases tab to monitor ongoing and historical promotions.
106
-
Access detailed logs and insights, including Git activity and issue tracking, for complete visibility into the deployment process.
Whenever a Product is promoted, Codefresh GitOps generates a Release, capturing the promotion orchestration across environments. The Releases tab of the product lists both ongoing and completed releases, from where you can monitor specific releases.
@@ -117,6 +110,7 @@ caption="Monitoring product promotions in Releases tab"
117
110
max-width="60%"
118
111
%}
119
112
120
-
113
+
>**NOTE**
114
+
In the documentation, both Product (capitalized) and product (lowercase) refer to the same entity in Codefresh GitOps. They are used interchangeably for readability and consistency.