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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
@@ -173,6 +173,8 @@ Adding labels to a product lets you create access control rules that govern manu
Automate and orchestrate promotions across different environments for the product by:
* Selecting one or more predefined Promotion Flows
* Customizing the conditions to trigger each Promotion Flow
Commit messages for trigger conditions are not restricted to single words. You can specify any commit message to trigger promotions.
For example, `update image tag to v1.1` would be a valid commit message.
* Defining the priority for each Flow when multiple Flows are configured
Expand All
@@ -186,9 +188,10 @@ Automate and orchestrate promotions across different environments for the produc
1. To add a Promotion Flow for the product, click **Add**.
1. From the list of Promotion Flows, select a predefined Flow for the product.
1. Define the conditions to match and trigger the Promotion Flow:
1. **Property**: The property to monitor for changes, based on either the text description associated with the commit message (`commitMessage`), or the commit hash generated by Git (`gitRevision`).
1. **Property**: The property to monitor for changes, based on either the text description associated with the commit message (`commitMessage`), or the commit hash generated by Git (`gitRevision`).
`commitMessage` can be a single or multiple words, or a set of words.
1. **Operator**: The operator to apply when matching the Property, based on inclusion or exclusion, with or without wildcards.
`In`: Checks if the commit message or Git revision <i>includes</i> the specified value or any value within a set of values.
`In`: Checks if the commit message or Git revision <i>includes</i> the specified value or any value within a set of values.Commit messages can include
`NotIn`: Checks if the commit message or Git revision <i>does not include</i> the specified value or any value within a set of values.
1. **Values**: Single or multiple values used to match or exclude Promotion Flows based on the Property and Operator configured.
1. To add more trigger conditions, click **Add** and repeat _steps 4.1 through 4.3_.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
@@ -19,6 +19,7 @@ By selecting Promotion Flows for a product you can choose the most relevant flow
* **Custom trigger conditions per flow**
Define specific trigger conditions for each Promotion Flow to tailor automated promotion based on the product’s unique deployment requirements.
For example, configure the trigger to launch the Hotfix flow whenever a commit message contains the phrase `hotfix`.
* **Prioritization**
Arrange the Promotion Flows in a prioritized order to control the sequence in which they are evaluated and executed.
Expand All
@@ -27,8 +28,18 @@ By selecting Promotion Flows for a product you can choose the most relevant flow
## Where to configure Promotion Flows and triggers
In **Product > Settings > Promotion Flows**.
Select one or more Promotion Flows for the product, and then configure custom conditions to trigger each of the flows.
See also [Promotion Flow CRD](#promotion-flow-yaml).
See also [Product CRD](#promotion-crd).
##### Commit messages & Git revisions
You can monitor changes based on the commit message (`commitMessage`) or the Git revision (`gitRevision`).
The commit message can include single words, multiple words, or phrases. For example, `hotfix` or `update image to v1.2`. There are no restrictions on commit messages.
##### Matching operators for filtering commits
Operators define how commit messages or Git revisions are matched:
* `In`: Includes the specified value or any value from a set.
* `NotIn`: Excludes the specified value or any value from a set.
{% include
image.html
Expand All
@@ -41,7 +52,7 @@ See also [Promotion Flow CRD](#promotion-flow-yaml).
%}
For how to instructions on selecting Promotion Flows for products, see [Select Promotion Flows forProducts]({{site.baseurl}}/docs/products/configure-product-settings/#select-promotion-flows-for-products).
For how to instructions on selecting Promotion Flows for products, see [Select Promotion Flows forproducts]({{site.baseurl}}/docs/products/configure-product-settings/#select-promotion-flows-for-products).
## Examples of trigger conditions for Promotion Flows
Expand All
@@ -63,20 +74,32 @@ The Hotfix flow is designed for urgent fixes that need to be deployed quickly, t
The Hotfix flow triggers when the `commit message` contains either `hotfix` or `patch`, ensuring that only critical changes labeled trigger the flow.
### Commit message-based Promotion Flow
The Commit message based Promotion Flow triggers the promotion when the message contains a specific phrase.
{: .table .table-bordered .table-hover}
| **Trigger condition** | **Setting** |
|----------------------|------------------|
| **Property** | `commitMessage` |
| **Operator** | `In` |
| **Values** | `bump Kubernetes version` |
This type of trigger monitors the commit message and triggers the promotion when the message contains a specific phrase. This is useful when you follow commit conventions like `bump version`, `update dependency` for example.
### Feature branch Promotion Flow
The Feature branch flow is designed for promoting new features from development to testing/staging environments.
{: .table .table-bordered .table-hover}
| **Trigger condition** | **Setting** |
|----------------------|------------------|
| **Property** | `gitRevision` |
| **Operator** | `In` |
| **Values** | `feature/*` |
The Feature branch flow triggers when the Git revision matches a feature branch pattern, such as `feature/*`. This ensures that only feature branches are promoted to the testing environment.
This Feature branch flow triggers when the commit message matches the phrase `Bump Kubernetes version`. Any commit message that includes Bump Kubernetes version (exact phrase match) will trigger the promotion.
### Multi-region Promotion Flow
The Multi-region flow is designed to first deploy to several regional environments for validation before final deployment to production.
Expand DownExpand Up
@@ -122,9 +145,10 @@ The Rollback flow is designed to revert changes when issue are detected in produ
The Rollback flow triggers when the commit message contains terms like `revert` or `rollback`, ensuring that the flow is triggered only for rollback operations.
## Promotion Flow YAML
<!---
## Product YAML
ConfigurePromotion Flow settings in either Form or YAML modes.
Configureproduct settings in either Form or YAML modes.
Once configured and committed, these settings are saved as the `promotion-flow` resource within the Shared Configuration Repository in the GitOps Runtime selected as the Configuration Runtime.
Expand All
@@ -133,11 +157,12 @@ See [Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/
To configure directly in YAML, refer to our [Promotion Flow YAML]({{site.baseurl}}/docs/promotions/yaml/promotion-flow-crd/) for the syntax requirements and descriptions.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.