Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commitb73d589

Browse files
authored
Move promotion entities up one level in toc (#1160)
* Move promotion entities up one level in tocMoved all promotion entities and YAMLs up one level for findability* Update links* Update home-content.yml* Update title* Remove tutorials
1 parentaacdc63 commitb73d589

File tree

27 files changed

+237
-99
lines changed

27 files changed

+237
-99
lines changed

‎_data/home-content.yml‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,6 @@
5656
localurl:/docs/promotions/create-promotion-sequence/
5757
-title:Promotion tutorials
5858
localurl:/docs/promotions/promotion-scenarios/
59-
-title:Entity configuration
60-
localurl:/docs/promotions/entities
61-
-title:YAML specs
62-
localurl:/docs/promotions/entities/yaml/
6359
-title:Trigger promotions
6460
localurl:/docs/promotions/trigger-promotions/
6561
-title:Tracking releases for products

‎_data/nav.yml‎

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -421,26 +421,21 @@
421421
url:"/promotions-overview"
422422
-title:Getting started
423423
url:"/getting-started"
424-
-title:Promotion tutorials
425-
url:"/promotion-scenarios"
426424
-title:Promotion building blocks
427425
url:"/promotion-components"
428426
-title:Promotion setup guidelines
429427
url:"/create-promotion-sequence"
430-
-title:Entity configuration
431-
url:"/entities"
432-
sub-pages:
433-
-title:Promotion Flows
434-
url:"/promotion-flow"
435-
-title:Promotion Policies
436-
url:"/promotion-policy"
437-
-title:Promotion Workflows
438-
url:"/promotion-workflow"
439-
-title:Product Settings
440-
url:"/product-promotion-props"
441-
-title:YAML specs
442-
url:"/yaml"
443-
sub-pages:
428+
-title:Promotion Flows
429+
url:"/promotion-flow"
430+
-title:Promotion Policies
431+
url:"/promotion-policy"
432+
-title:Promotion Workflows
433+
url:"/promotion-workflow"
434+
-title:Customize product promotion settings
435+
url:"/product-promotion-props"
436+
-title:Promotion entity YAMLs
437+
url:"/yaml"
438+
sub-pages:
444439
-title:Product YAML
445440
url:"/product-crd"
446441
-title:Promotion Template YAML
Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
---
2+
title:"Quick start: Advanced Promotion Flow with Promotion Workflows"
3+
description:"Promote product apps between multiple environments with promotion conditions"
4+
group:gitops-quick-start
5+
toc:true
6+
redirect_from:
7+
-/docs/promotions/promotion-scenarios/policy-multi-env-promotion/
8+
---
9+
10+
##Automated promotions: Advanced Promotion Flow with Promotion Workflows
11+
12+
With a Promotion Flow you can[automate promotions across multiple environments]({{site.baseurl}}/docs/gitops-quick-start/multi-env-sequential-flow/).
13+
14+
This quick start explores how to enhance Promotion Flows by configuring conditions for each environment in the flow, ensuring that changes are promoted to environments only on meeting the specific requirements for the environment.
15+
16+
You can automate and enforce gates throughout your promotion processes using Promotion Workflows.
17+
Promotion Workflows are essentially Argo Workflows customized for promoting changes through your environments.
18+
For detailed information, see[Configuring Promotion Workflows]({{site.baseurl}}/docs/promotions/promotion-workflow/).
19+
20+
##Promotion Workflows in Promotion Flows
21+
Promotion Workflows are designed to define the conditions under which changes are promoted to the next environment. They provide a way to automate testing, quality checks, validation, and any other requirements based on your deployment process, establishing gates that control the flow of changes between environments.
22+
23+
You can create workflows tailored to the specific tasks required during a promotion and categorize them based on the stage of the promotion process in which they are executed, as Pre- and Post-Action Workflows.
24+
25+
#####Pre-Action Workflow
26+
A Promotion Workflow that runs_before the promotion action is triggered_. These workflows can be used for tasks like smoke tests, unit tests, security scans, or any other validation that must pass before a change is promoted to the next environment.
27+
28+
The Pre-Action Workflow plays a critical role in ensuring that changes meet all necessary requirements before being promoted to the next environment. It acts as the gatekeeper, validating changes and stopping the promotion if any tests or validations fail.
29+
30+
31+
#####Post-Action Workflows
32+
A Promotion Workflow that runs_after the promotion action has completed_. These workflows can be used for tasks like performance monitoring, database migrations, or notifications to inform stakeholders that the promotion is complete.
33+
34+
The Post-Action Workflow allows you to monitor and verify the effects of the promotion after it has taken place. This workflow helps ensure the promoted changes behave as expected in the new environment.
35+
36+
##How to create Promotion Workflows
37+
38+
39+
40+
41+
42+
##Requirements
43+
44+
*[GitOps Runtime]({{site.baseurl}}/docs/quick-start/gitops-quick-start/runtime/)
45+
*[Git Source]({{site.baseurl}}/docs/gitops-quick-start/gitops-runtimes/create-git-source/) to store application manifests
46+
*[Environments]({{site.baseurl}}/docs/gitops-quick-start/products/quick-start-gitops-environments/)
47+
For a Promotion Flow, you need at least three environments.
48+
Here we use`dev`,`qa`, and`prod`.
49+
*[Products]({{site.baseurl}}/docs/gitops-quick-start/products/quick-start-product-create/)
50+
*[Applications]({{site.baseurl}}/docs/gitops-quick-start/products/create-app-ui/)
51+
Each environment must have an application for the product.
52+
For example,`demo-trioapp-dev`,`demo-trioapp-qa`, and`demo-trioapp-prod`representing the development, testing, and production versions.
53+
The structure of the repos with the resources accessed by the applications must be consistent across all the three applications.
54+
If it works for you, copy the corresponding subfolders in[demo-applications](https://github.com/codefresh-sandbox/codefresh-quickstart-demo/tree/main/demo-applications) with the resources.<!--- add a link to the repo?-->
55+
*[Promotion Workflows]({{site.baseurl}}/docs/promotions/entities/promotion-workflow/#create-promotion-workflows)
56+
57+
##Assign Pre- and Post-Action Workflows to environments in Promotion Flow
58+
To ensure each environment's specific requirements are met, assign Promotion Workflows to govern promotion behavior.
59+
In this quick start, we’ll define the Promotion Workflows to govern promotion behavior for the`qa` and`prod` environments.
60+
61+
1. From the Promotion Flow list, select the Promotion Flow you created,`multi-env-sequential-promotion` for the quick start.
62+
1. In the Settings panel, update the**Version** to indicate changes in the flow, for example,`2.0`.
63+
1. Assign the workflows by clicking the respective controls and selecting the Promotion Workflows and the Promotion Action from the list.
64+
The example below shows the Pre-Action Workflows available.
65+
66+
{% include
67+
image.html
68+
lightbox="true"
69+
file="/images/quick-start/promotions/quick-start-seq-promo-policy-settings.png"
70+
url="/images/quick-start/promotions/quick-start-seq-promo-policy-settings.png"
71+
alt="Promotions quick start: Pre-Action Workflow to govern promotion behavior for environment"
72+
caption="Promotions quick start: Pre-Action Workflow to govern promotion behavior for environment"
73+
max-width="60%"
74+
%}
75+
76+
{% include
77+
image.html
78+
lightbox="true"
79+
file="/images/quick-start/promotions/quick-start-seq-promo-policy-populated.png"
80+
url="/images/quick-start/promotions/quick-start-seq-promo-policy-populated.png"
81+
alt="Promotions quick start: Target environment configured with Promotion Workflows and Action"
82+
caption="Promotions quick start: Target environment configured with Promotion Workflows and Action"
83+
max-width="60%"
84+
%}
85+
86+
{:start="4"}
87+
1. Repeat_step 3_ to select the Promotion Workflows and Actions for the other target environments in the Promotion Flow.
88+
For this quick start, we'll select the same workflows and the same promotion action for`prod` as we did for`qa`.
89+
90+
91+
92+
Here's the YAML view of the flow with the workflows and promotion actions.
93+
94+
{% include
95+
image.html
96+
lightbox="true"
97+
file="/images/quick-start/promotions/quick-start-seq-promo-policy-yaml.png"
98+
url="/images/quick-start/promotions/quick-start-seq-promo-policy-yaml.png"
99+
alt="Promotions quick start: YAML view of Promotion Flow with Promotion Workflows"
100+
caption="Promotions quick start: YAML view of Promotion Flow with Promotion Workflows"
101+
max-width="60%"
102+
%}
103+
104+
{:start="5"}
105+
1. To save the changes, click**Save Promotion Flow**.
106+
1. Continue with[Trigger Promotion Flow and monitor product release](#trigger-promotion-flow-and-monitor-product-release).
107+
108+
109+
##Trigger Promotion Flow and monitor product release
110+
Trigger the Promotion Flow updated with the appropriate Pre- and Post-Action Workflows, and monitor its progress.
111+
112+
The difference between the previous release (without workflows), and this one (with workflows), for the same Promotion Flow (`multi-env-sequential-promotion`), is that changes will only be promoted to the next environment when all workflows associated with the previous environment are complete.
113+
114+
1. Open the Promotion Flow, for example,`multi-env-sequential-promotion` and click**Trigger**.
115+
1. Select the product, the application to promote, and then click**Trigger** once again.
116+
1. Click**View Release Details**.
117+
In the example below, the current release view shows the`qa` and`prod` environments with the Pre- and Post-Action Workflows defined for each environment.
118+
119+
{% include
120+
image.html
121+
lightbox="true"
122+
file="/images/quick-start/promotions/quick-start-seq-promo-policy-release.png"
123+
url="/images/quick-start/promotions/quick-start-seq-promo-policy-release.png"
124+
alt="Promotions quick start: Release view for gated Promotion Flow"
125+
caption="Promotions quick start: Release view for gated Promotion Flow"
126+
max-width="60%"
127+
%}
128+
129+
130+
131+
##What's next
132+
In the next quick start for promotions, we'll explore how to configure a Promotion Flow with parallel promotions, allowing changes to be promoted simultaneously across multiple environments.
133+
134+
[Quick start: Advanced Promotion Flow: Parallel promotions across environments]({{site.baseurl}}/docs/gitops-quick-start/parallel-multi-env-promotion/)
135+
136+
137+

‎_docs/gitops-quick-start/promotions/dependency-multi-env-promotion.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ By now, you’ve successfully created environments, your first product, added ap
9292
Now that you’ve mastered the basics, learn more on promotion settings for products and configuring promotion entities.
9393
[Configuring version and promotable properties for products]({{site.baseurl}}/docs/products/promotion-version-properties/)
9494
[Configuring promotion flows and triggers for products]({{site.baseurl}}/docs/products/promotion-flow-triggers/)
95-
[Configuring promotion entities]({{site.baseurl}}/docs/promotions/entities/)
95+
9696

9797

9898

‎_docs/gitops-quick-start/promotions/policy-multi-env-promotion.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Now that we have covered [Multi-environment sequential promotion]({{site.baseurl
1212

1313
Codefresh makes it easy to automate and enforce gates throughout your promotion processes using Promotion Workflows.
1414
Promotion Workflows are essentially Argo Workflows customized for promoting changes through your environments.
15-
For detailed information, see[Configuring Promotion Workflows]({{site.baseurl}}/docs/promotions/entities/promotion-workflow/).
15+
For detailed information, see[Configuring Promotion Workflows]({{site.baseurl}}/docs/promotions/promotion-workflow/).
1616

1717
##Promotion Workflows for promotion gates
1818
Promotion Workflows are designed to define the conditions under which changes are promoted to the next environment. They provide a way to automate testing, quality checks, validation, and any other requirements based on your deployment process, establishing gates that control the flow of changes between environments.
@@ -41,7 +41,7 @@ In this quick start, we’ll define the Promotion Workflows to govern promotion
4141

4242

4343
###Before you begin
44-
*[Create Promotion Workflows]({{site.baseurl}}/docs/promotions/entities/promotion-workflow/#create-promotion-workflows)
44+
*[Create Promotion Workflows]({{site.baseurl}}/docs/promotions/promotion-workflow/#create-promotion-workflows)
4545

4646
###Step-by-step
4747

‎_docs/installation/gitops/shared-configuration.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ Here are a few types of configuration definitions stored in the Shared Configura
4141
*[OAuth2]({{site.baseurl}}/docs/administration/account-user-management/oauth-setup/) authentication applications
4242
* Manifests for promotion entities:
4343
*[Products]({{site.baseurl}}/docs/products/configure-product-settings/)
44-
*[Promotion Workflows]({{site.baseurl}}/docs/promotions/entities/promotion-workflow)
45-
*[Promotion Policies]({{site.baseurl}}/docs/promotions/entities/promotion-policy/)
46-
*[Promotion Flows]({{site.baseurl}}/docs/promotions/entities/promotion-flow/)
44+
*[Promotion Workflows]({{site.baseurl}}/docs/promotions/promotion-workflow)
45+
*[Promotion Policies]({{site.baseurl}}/docs/promotions/promotion-policy/)
46+
*[Promotion Flows]({{site.baseurl}}/docs/promotions/promotion-flow/)
4747
*[Promotion Templates]({{site.baseurl}}/docs/products/configure-product-settings/#configure-promotion-settings)
4848

4949
See[Shared Configuration Repo structure](#shared-configuration-repo-structure).
@@ -149,14 +149,14 @@ The `resources` directory contains the resources shared by _all_ clusters manage
149149
| Shared Configuration Repo| Description|
150150
| ----------| --------|
151151
|`resources/all-runtimes-all-clusters`| Contains resource manifests applied to all the GitOps Runtimes in the account and to all the clusters managed by those Runtimes. In the above example,`manifest2.yaml` is applied to both`runtime1` and`runtime2`.|
152-
|`resources/all-runtimes-all-clusters/promotion-workflows`| Stores manifests of Promotion Workflows, available to all Runtimes in the account.<br>See[Promotion Workflows]({{site.baseurl}}/docs/promotions/entities/promotion-workflow).|
152+
|`resources/all-runtimes-all-clusters/promotion-workflows`| Stores manifests of Promotion Workflows, available to all Runtimes in the account.<br>See[Promotion Workflows]({{site.baseurl}}/docs/promotions/promotion-workflow).|
153153
|`resources/control-planes`| Optional. When defined, applies every resource manifest to each Runtime’s`in-cluster`. Config map resources for example, when committed to this subdirectory, are deployed to each Runtime’s`in-cluster`.|
154154
|`resources/app-projects`| Contains application project resources which control deployment destinations for applications.|
155155
|`resources/configurations`| Contains platform-level resources which are Runtime-agnostic, essential for functionality related to product and promotion entities in GitOps.|
156-
|`resources/configurations/products`|Contains manifests of product entities. All settings including source location for application version, promotable properties, promotion flows with trigger conditions if defined are saved. Note that applications assigned to products are not saved in the manifest. Product manifests are available to users with the required ABAC permissions. <br>See[Product Settings]({{site.baseurl}}/docs/products/configure-product-settings/) and[Product YAML]({{site.baseurl}}/docs/promotions/entities/yaml/product-crd/).|
157-
|`resources/configurations/promotion-flows`| Contains manifests of promotion flows with the trigger and target environments, and custom promotion policy settings, if any.<br>See[Promotion Flow configuration]({{site.baseurl}}/docs/promotions/entities/promotion-flow/) and[Promotion Flow YAML]({{site.baseurl}}/docs/promotions/entities/yaml/promotion-flow-crd/).|
158-
|`resources/configurations/promotion-policies`| Contains manifests of promotion policies with the Pre- and Post-Action Workflows if defined, the Promotion Action, and target products and environments.<br>See[Promotion Policy configuration]({{site.baseurl}}/docs/promotions/entities/promotion-policy/) and[Promotion Policy YAML]({{site.baseurl}}/docs/promotions/entities/yaml/product-crd/).|
159-
|`resources/configurations/promotion-templates`| Contains manifests of promotion templates defining the sources for the release version and the properties to be promoted. <br>See[Promotion Template configuration]({{site.baseurl}}/docs/products/configure-product-settings/#configure-promotion-settings) and[Promotion Template YAML]({{site.baseurl}}/docs/promotions/entities/yaml/promotion-template-crd/).|
156+
|`resources/configurations/products`|Contains manifests of product entities. All settings including source location for application version, promotable properties, promotion flows with trigger conditions if defined are saved. Note that applications assigned to products are not saved in the manifest. Product manifests are available to users with the required ABAC permissions. <br>See[Product Settings]({{site.baseurl}}/docs/products/configure-product-settings/) and[Product YAML]({{site.baseurl}}/docs/promotions/yaml/product-crd/).|
157+
|`resources/configurations/promotion-flows`| Contains manifests of promotion flows with the trigger and target environments, and custom promotion policy settings, if any.<br>See[Promotion Flow configuration]({{site.baseurl}}/docs/promotions/promotion-flow/) and[Promotion Flow YAML]({{site.baseurl}}/docs/promotions/yaml/promotion-flow-crd/).|
158+
|`resources/configurations/promotion-policies`| Contains manifests of promotion policies with the Pre- and Post-Action Workflows if defined, the Promotion Action, and target products and environments.<br>See[Promotion Policy configuration]({{site.baseurl}}/docs/promotions/promotion-policy/) and[Promotion Policy YAML]({{site.baseurl}}/docs/promotions/yaml/product-crd/).|
159+
|`resources/configurations/promotion-templates`| Contains manifests of promotion templates defining the sources for the release version and the properties to be promoted. <br>See[Promotion Template configuration]({{site.baseurl}}/docs/products/configure-product-settings/#configure-promotion-settings) and[Promotion Template YAML]({{site.baseurl}}/docs/promotions/yaml/promotion-template-crd/).|
160160
|`resources/runtimes/<runtime_name>`| Optional. Runtime-specific subdirectory. Every resource manifest in a runtime-specific subdirectory is applied to only the GitOps Runtime defined by`<runtime_name>`. In the above example,`manifest4.yaml` is applied only to`runtime1`, and`manifest5.yaml` is applied only to`runtime2`.|
161161

162162

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp