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
@@ -149,14 +149,14 @@ The `resources` directory contains the resources shared by _all_ clusters manage
149
149
| Shared Configuration Repo| Description|
150
150
| ----------| --------|
151
151
|`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/configuration/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/entities/promotion-workflow).|
153
153
|`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`.|
154
154
|`resources/app-projects`| Contains application project resources which control deployment destinations for applications.|
155
155
|`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/configuration/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/configuration/promotion-flow/) and[Promotion Flow YAML]({{site.baseurl}}/docs/promotions/configuration/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/configuration/promotion-policy/) and[Promotion Policy YAML]({{site.baseurl}}/docs/promotions/configuration/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/configuration/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/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/).|
160
160
|`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`.|
For the YAML specifications, see[Product YAML]({{site.baseurl}}/docs/promotions/configuration/yaml/product-crd/) and[Promotion Template YAML]({{site.baseurl}}/docs/promotions/configuration/yaml/promotion-template-crd/).
39
+
For the YAML specifications, see[Product YAML]({{site.baseurl}}/docs/promotions/entities/yaml/product-crd/) and[Promotion Template YAML]({{site.baseurl}}/docs/promotions/entities/yaml/promotion-template-crd/).
Copy file name to clipboardExpand all lines: _docs/products/promotion-flow-triggers.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
@@ -30,7 +30,7 @@ You can select multiple Promotion Flows for a product, and customize the conditi
30
30
31
31
#####Where can you configure Promotion Flows and triggers?
32
32
In Product > Settings > Promotion Flows, you can select one or more Promotion Flows for the product, and then configure custom conditions to trigger the flows.
33
-
See also[Promotion Flow CRD]({{site.baseurl}}/docs/promotions/configuration/yaml/promotion-flow-crd/).
33
+
See also[Promotion Flow CRD]({{site.baseurl}}/docs/promotions/entities/yaml/promotion-flow-crd/).
|`metadata.name` | The name of the Promotion Policy, which must conform to the naming conventions for Kubernetes resources. Useful if the name indicates the purpose of this Promotion Policy - where and how it is intended to be used. For example, `productionDeployments`. | string | Required |
51
-
| `spec.priority` | The priority of the Promotion Policy, determining which Pre-Action Workflow, Action, and Post-Action Workflow are applied when [evaluating policies]({{site.baseurl}}/docs/promotions/configuration/promotion-policy/#evaluate-promotion-settings-for-products-and-environments) and [implementing policies]({{site.baseurl}}/docs/promotions/configuration/promotion-policy/#promotion-policy-implementation-logic) when multiple Promotion Policies match the same product or environment. <br>The priority is ranked in ascending order, ranging from 0 or a negative number to higher values. | integer | Required |
51
+
| `spec.priority` | The priority of the Promotion Policy, determining which Pre-Action Workflow, Action, and Post-Action Workflow are applied when [evaluating policies]({{site.baseurl}}/docs/promotions/entities/promotion-policy/#evaluate-promotion-settings-for-products-and-environments) and [implementing policies]({{site.baseurl}}/docs/promotions/entities/promotion-policy/#promotion-policy-implementation-logic) when multiple Promotion Policies match the same product or environment. <br>The priority is ranked in ascending order, ranging from 0 or a negative number to higher values. | integer | Required |
52
52
| `spec.selector` | The products and target environments to which to apply the Promotion Policy.<br>You can define multiple products, or environments.<br>If neither a product nor an environment is defined for a policy, it is considered a global policy that matches all products and environments. | object | Optional |
53
53
| `spec.selector.product` | The product or products to which to apply or match this Promotion Policy by `names`. <br>When not defined, matches all products. | object | Optional |
54
54
| `spec.selector.product.names` | The name of a single product or a list of multiple products to which to apply the Promotion Policy. <!-- Required if `spec.selector.product.tags` are not used to match the Promotion Policy to the product. For example, `billing` or `- billing - guestbook-helm, - demo-trioapp`. --> | array | Optional |
55
55
| `spec.selector.targetEnvironment` | The target environments to which to apply the Promotion Policy based on the `name` or `type`. <!-- or `tag` --> <br>If more than one criteria are provided, all criteria must be matched. | object | Optional |
56
56
| `spec.selector.targetEnvironment.name` | The name of the target environment, or the list of target environments to which to apply the Promotion Policy. <br>When empty, applies to all environments. | array | Optional |
57
57
| `spec.selector.targetEnvironment.type` | The type of target environments to which to apply the Promotion Policy. Can be one of these:`PROD`for production environments, or `NON_PROD` for any other environment such as `dev`, `qa`. | array | Optional |
58
-
| `spec.properties.policy` | The Pre-Action Workflow, Action, and Post-Action Workflow to implement for the Promotion Policy through the `action`, `preAction`, and `postAction` attributes. <br>The Action attribute is required.<br>See [Promotion Policy implementation logic]({{site.baseurl}}/docs/promotions/configuration/promotion-policy/#promotion-policy-implementation-logic) for information on how promotion settings are used. | object | Optional |
58
+
| `spec.properties.policy` | The Pre-Action Workflow, Action, and Post-Action Workflow to implement for the Promotion Policy through the `action`, `preAction`, and `postAction` attributes. <br>The Action attribute is required.<br>See [Promotion Policy implementation logic]({{site.baseurl}}/docs/promotions/entities/promotion-policy/#promotion-policy-implementation-logic) for information on how promotion settings are used. | object | Optional |
59
59
| `spec.policy.action` | The action that should trigger the promotion in the target environment for this Promotion Policy.<br>Can be one of the following:{::nomarkdown}<ul><li><code class="highlighter-rouge">commit</code>:Executes a commit operation on the target application.</li><li><code class="highlighter-rouge">pr</code>: Executes a commit and opens a pull request for the target application.<br>Useful when you need manual approval before commit.</li><li><code class="highlighter-rouge">none</code>: Does not execute any action on the target application. </li></ul>{:/}| enum | Required |
60
60
| `spec.policy.preAction` | The name of the Promotion Workflow to execute _before_ `spec.policy.action`. | string | Optional |
61
61
| `spec.policy.postAction` | The name of the Promotion Workflow to execute _after_ `spec.policy.action`. | string | Optional |
Copy file name to clipboardExpand all lines: _docs/promotions/promotion-components.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,7 +73,7 @@ The table describes the core and promotion-specific entities.
73
73
<td><strong>Promotion Flows</strong></td>
74
74
<td>Promotion flows orchestrate the movement of applications through environments, ensuring a controlled and automated promotion process for applications within the same product.</td>
@@ -89,13 +89,13 @@ The table describes the core and promotion-specific entities.
89
89
<td><strong>Promotion Workflows</strong></td>
90
90
<td>A Promotion Workflow is an Argo Workflow which runs tests and validations that match the requirements of the promotion lifecycle. They can run smoke tests, rollback mechanisms, database validation checks, or performance tests.</td>
<td>A Promotion Policy outlines the actions taken when changes are promoted. It combines workflows that test and validate the environment, with the promotion action, like commits or pull requests.</td>
Copy file name to clipboardExpand all lines: _docs/promotions/releases.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,7 +86,7 @@ The table describes important insights in the Releases page.
86
86
|-------------|---------------------|
87
87
|**Release ID**| The Codefresh-assigned identifier uniquely identifying the release. Clicking the Release ID displays the ongoing or completed Promotion Flow for the release.|
88
88
|**Initiator**| The user who created the release. The initiator is displayed only for releases created through automated promotions.|
89
-
|**Promotion Flow**| The name of the flow orchestrating the promotion for the specific release. Clicking the link takes you to the Promotion Flow page with a graphical representation of the flow. For details, see[Promotion Flows]({{site.baseurl}}/docs/promotions/configuration/promotion-flow/).<br>**Manual** indicates that the release was created for manually triggered single-environment promotions, from the trigger to a single target environment. See[Manual promotion triggers]({{site.baseurl}}/docs/promotions/trigger-promotions/#manual-promotion-triggers-quick-reference).|
89
+
|**Promotion Flow**| The name of the flow orchestrating the promotion for the specific release. Clicking the link takes you to the Promotion Flow page with a graphical representation of the flow. For details, see[Promotion Flows]({{site.baseurl}}/docs/promotions/entities/promotion-flow/).<br>**Manual** indicates that the release was created for manually triggered single-environment promotions, from the trigger to a single target environment. See[Manual promotion triggers]({{site.baseurl}}/docs/promotions/trigger-promotions/#manual-promotion-triggers-quick-reference).|
90
90
| **Environments** | The environments promoted for the release and their deployment statuses, which can be one of the following:{::nomarkdown}<ul><li><img src="../../../images/icons/promotion-success.png?display=inline-block">: Successful</li><li><img src="../../../images/icons/promotion-running.png?display=inline-block">: Running</li><li><img src="../../../images/icons/promotion-suspended.png?display=inline-block"> <!--- or <img src="../../../images/icons/promotion-suspending-pending-pr?display=inline-block">-->: Suspended or suspended pending PR approval/merge.</li><li><img src="../../../images/icons/promotion-pending.png?display=inline-block">: Pending</li><li><img src="../../../images/icons/promotion-terminated.png?display=inline-block">: Terminated.</li><li><img src="../../../images/icons/promotion-failed.png?display=inline-block">: Failed</li><li><img src="../../../images/icons/promotion-failed.png?display=inline-block">: Failed</li></ul>{:/} See [Environment (deployment) status](#environment-deployment-status).|