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/installation/gitops/monitor-runtimes.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,7 +92,7 @@ Here is a description of the information and options in the Topology view.
92
92
{: .table .table-bordered .table-hover}
93
93
| Topology View Item| Description|
94
94
| ------------------------| ----------------|
95
-
|**Runtime**|!{::nomarkdown}{% if page.collection != site.gitops_collection %}<imgsrc="../../../../images/icons/runtime-topology-name.png"display=inline-block/>{% endif %}{% if page.collection == site.gitops_collection %}<imgsrc="../../../images/icons/runtime-topology-name.png"display=inline-block/>{% endif %} the provisioned Runtime. {:/}<br>Hybrid Runtimes display the name of the K8s API server endpoint with the cluster.<!--- <br>Hosted Runtimes display 'Codefresh hosted'.-->|
95
+
|**Runtime**| {::nomarkdown}{% if page.collection != site.gitops_collection %}<imgsrc="../../../../images/icons/runtime-topology-name.png"display=inline-block/>{% endif %}{% if page.collection == site.gitops_collection %}<imgsrc="../../../images/icons/runtime-topology-name.png"display=inline-block/>{% endif %} the provisioned Runtime. {:/}<br>Hybrid Runtimes display the name of the K8s API server endpoint with the cluster.<!--- <br>Hosted Runtimes display 'Codefresh hosted'.-->|
96
96
|**Cluster** | The local, and managed clusters if any, for the Runtime. {::nomarkdown}<ul><li>{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/runtime-topology-in-cluster.png" display=inline-block/>{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/runtime-topology-in-cluster.png" display=inline-block/>{% endif %}indicates the local cluster, always displayed as `in-cluster`. The in-cluster server URL is always set to `https://kubernetes.default.svc/`.</li><li>{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/runtime-topology-managed-cluster.png" display=inline-block/>{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/runtime-topology-managed-cluster.png" display=inline-block/>{% endif %} indicates a managed cluster.</li> <li>{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/runtime-topology-add-cluster.png" display=inline-block/>{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/runtime-topology-add-cluster.png" display=inline-block/>{% endif %} select to add a new managed cluster.</li></ul> {:/} To view cluster components, select the cluster. To add and work with managed clusters, see [Managing external clusters in GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/managed-cluster/). |
97
97
|**Health/Sync status**|The health and sync status of the Runtime or cluster. {::nomarkdown}<ul><li>{% if page.collection != site.gitops_collection %}<imgsrc="../../../../images/icons/error.png"display="inline-block">{% endif %}{% if page.collection == site.gitops_collection %}<imgsrc="../../../images/icons/error.png"display="inline-block">{% endif %} indicates health or sync errors in the Runtime, or a managed cluster if one was added to the runtime.</br> The runtime or cluster node is bordered in red and the name is colored red.</li> <li>{% if page.collection != site.gitops_collection %}<imgsrc="../../../../images/icons/cf-sync-status.png"display=inline-block/>{% endif %}{% if page.collection == site.gitops_collection %}<imgsrc="../../../images/icons/cf-sync-status.png"display=inline-block/>{% endif %}indicates that the Runtime is being synced to the cluster on which it is provisioned.</li></ul> {:/}|
98
98
|**Search and View options**| {::nomarkdown}<ul><li>Find a Runtime or its clusters by typing part of the Runtime/cluster name, and then navigate to the entries found. </li> <li>Topology view options: Resize to window, zoom in, zoom out, full screen view.</li></ul> {:/}|
Copy file name to clipboardExpand all lines: _docs/promotions/create-promotion-sequence.md
+42-67Lines changed: 42 additions & 67 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,99 +5,74 @@ group: promotions
5
5
toc:true
6
6
---
7
7
8
-
This article outlines the tasks required to configure, activate, and monitor GitOps promotions in Codefresh.
9
-
10
-
Promotions are a critical part of continuous delivery, enabling you to move changes through environments while meeting deployment and compliance requirements. A successful promotion sequence depends on key components that govern and orchestrate the promotion flow across environments. To review these components, see[Promotion building blocks]({{site.baseurl}}/docs/promotions/promotion-components/).
11
-
12
-
13
-
14
-
<!--- For step-by-step walkthroughs, review and follow along with our quick starts.-->
15
-
16
-
17
-
<!--- This guide covers the end-to-end flow of creating a promotion sequence, from initial setup to execution. Promotion sequences in Codefresh provide a structured way to move changes through different environments, integrating checks and policies to ensure stability, compliance, and predictable deployments.
18
-
19
-
A successful promotion sequence relies on several key components that together govern and orchestrate the promotion flow across environments. In the sections that follow, you’ll configure each of these components step-by-step, tailoring them to your specific deployment and compliance needs.
20
-
21
-
## From basic to complex promotions
22
-
The promotion process begins with foundational elements that enable simple deployments and gradually evolves into more complex flows, as additional requirements arise. Here’s how you move from basic to advanced promotion sequences:
23
-
24
-
Applications, Products, and Environments: These are core deployment entities, required for all types of promotions. Products allow you to group and configure related applications, and environments define where changes to these applications are promoted.
25
-
These entities allow for quick drag-and-drop promotions across two environments and an option to select the target to promote to.
26
-
27
-
Promotion Flow: Once the basics are in place, you can establish orchestration in your promotion sequence. Promotion Flow allows you to define how changes move through multiple environments, to accommodate more complex, multi-environment deployment strategies.
28
-
29
-
Promotion Workflows: Introducing Argo Workflows adds validations and checks ensures that each environment in the sequence meets your standards and is ready for changes, transitioning from basic deployments to rigorous testing and verification processes.
30
-
31
-
Promotion Policies: With a structured promotion flow and workflows established, you can implement policies that define rules for your promotions. These can range from global to environment-specific policies, ensuring that promotions comply with operational requirements and maintain consistency across environments and products.
32
-
33
-
Promotion Templates: Finally, Promotion Templates serve to further streamline your processes by allowing you to define precisely the changes Templates simplify the configuration of promotion attributes for product groups, allowing you to quickly adapt standard settings to multiple products without redundant configuration.
34
-
enhance consistency, create reusable templates that apply across products.
35
-
36
-
-->
37
-
8
+
##Promotion setup guidelines
9
+
This article outlines the tasks required to configure, trigger, and monitor promotions in Codefresh GitOps.
38
10
11
+
Promotions are a critical part of continuous delivery, enabling you to move changes through environments while meeting deployment and compliance requirements. A successful promotion sequence depends on key components that define and orchestrate the promotion flow. To review these components, see[Promotion building blocks]({{site.baseurl}}/docs/promotions/promotion-components/).
Environments define the starting and the end points of promotions.
57
-
For a promotion sequence, you need at least two environments: the trigger environment, which is the source of the changes to promote, and the target environment, to which the changes need to be promoted.
29
+
Environments define the starting point and destination of promotions.
30
+
A promotion requires at least two environments:
31
+
* Trigger environment, the source of the changes being promoted
32
+
* Target environment, to which to promote the changes
Applications represent the components or services to be promoted and deployed, and are the smallest unit of deployment within a promotion sequence. To promote across an application across environments, you need an application for each target environment.
61
-
Create Argo CD applications in our user interface. For seamless promotions, group related applications within a product to manage them collectively.
Products connect related applications and group them as a single entity. Applications represent instances of products within each environment.
65
-
Being able to apply promotion settings at the level of the product, and being able to promote applications belonging to the same product, simplifies promotion management.
66
-
Create a product and connect related applications to it, either manually or declaratively.
35
+
Applications represent the components or services to be promoted and deployed.
36
+
To promote across an application across environments:
37
+
* Create an instance of the application for each target environment
38
+
* Group related applications within a product to manage them collectively
As part of promoting changes across environments, it's customary to run tests and validations that match the requirements of the target environments in the promotion sequence. For example, create workflows that run smoke tests to verify basic functionality or database validation checks to ensure data integrity.
71
-
Create Promotion Workflows (Argo Workflows) to implement any type of tests, validations, and custom requirements.
72
-
73
-
1.[Create policies to govern environment promotions]({{site.baseurl}}/docs/promotions/promotion-policy/)
74
-
Govern promotion behavior for environments by setting rules, checks, and validations that environments must meet before and after changes are promoted.
75
-
Promotion Policies allow you to define these rules by combining Promotion Workflows and the promotion action based on environment type, product, or other criteria. When a promotion is triggered for an environment, the policy mechanism merges settings from all relevant global policies according to priority, providing automated governance for consistent and reliable promotion behavior.
76
-
77
-
1.[Create Promotion Flows to orchestrate promotions]({{site.baseurl}}/docs/promotions/promotion-flow/)
78
-
Orchestrate the sequence of actions to move and deploy changes through the required environments, from the trigger environment to the final target environment.
79
-
Promotion Flows ensure that changes are promoted in a controlled and predictable manner by integrating environments, products and applications, promotion workflows, and policies.
46
+
Promotion Workflows (Argo Workflows) automate environment-specific tests and validations before and after promotion.
47
+
* Create and use Promotion Workflows to run smoke tests, database validation, and other requirements to verify readiness.
Promotion Flows orchestrate the sequence of actions required to move and deploy changes through multiple environments.
56
+
* Automatically integrate environments, products, Promotion Workflows, and Promotion Policies into a structured promotion process
57
+
* Reuse Promotion Flows across products for consistent and reliable promotions
80
58
81
-
1. Configure[promotion settings]({{site.baseurl}}/docs/products/configure-product-settings/#configure-promotion-settings) and[flows]({{site.baseurl}}/docs/products/configure-product-settings/#configure-promotion-flows) for product
82
-
After setting up the core and promotion-specific entities, configure additional promotion-specific settings for your product.
83
-
These settings include the attributes to be promoted across the product's applications (Product Promotion Templates), the promotion flows valid for the product and flow-specific trigger conditions (Promotion Flows).
59
+
1.[Customize promotions for products]({{site.baseurl}}/docs/promotions/product-promotion-props/)
60
+
After setting up promotion entities, configure additional promotion settings at the product level.
61
+
* Promotion Templates to define attributes to be promoted across the product's applications
62
+
* Promotion Flows valid for the product and trigger conditions for each flow
Trigger the promotion, either manually or automatically.
65
+
Trigger the promotion manually or automatically.
87
66
88
-
1.[Track releases for products]({{site.baseurl}}/docs/promotions/product-releases/)
89
-
Monitor the deployment progress for the product as it moves through the promotion sequence.
90
-
Use the Releases feature to track and ensure successful deployments across environments.
91
-
67
+
1.[Monitor promotion releases for products]({{site.baseurl}}/docs/promotions/product-releases/)
68
+
Monitor deployment progress as applications move through the promotion sequence.
69
+
* Use the Releases feature for products to monitor deployments
92
70
93
-
<!--- 1. [Configure properties to be promoted]
94
-
Instead of doing a manual diff and deciding which changes to promote, or promoting entire applications, configure the precise changes to promote, ensuring consistency and reducing errors.
95
-
Promotion Templates define which files and attributes within those files to promote across the applications in the product.-->