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

Gitops promotions round2#1094

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
NimRegev merged 33 commits intomasterfromgitops-promotions-round2
Nov 11, 2024
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
Show all changes
33 commits
Select commitHold shift + click to select a range
d438fd5
Update after review
NimRegevNov 10, 2024
56a3849
Update after review
NimRegevNov 10, 2024
59fe33a
Update after review
NimRegevNov 10, 2024
d483cd9
Update after review
NimRegevNov 10, 2024
f91a30d
Update after review
NimRegevNov 10, 2024
5491ec4
Add topic for getting started
NimRegevNov 10, 2024
ecd7791
Add submenu for promotion scenarios
NimRegevNov 10, 2024
0bbe7bd
Add submenu for promotion scenarios
NimRegevNov 10, 2024
20b7611
Add submenu for promotion scenarios
NimRegevNov 10, 2024
3498c2d
Add submenu for promotion scenarios
NimRegevNov 10, 2024
b573e70
Merge branch 'master' into gitops-promotions-round2
NimRegevNov 10, 2024
5ef29a6
Fix links
NimRegevNov 10, 2024
8b864ca
Merge branch 'master' into gitops-promotions-round2
NimRegevNov 10, 2024
9c908ac
Change titles for promotion scenario and sequence articles
NimRegevNov 10, 2024
8fd8939
Merge branch 'gitops-promotions-round2' of https://github.com/codefre…
NimRegevNov 10, 2024
26b1c0c
Merge branch 'master' into gitops-promotions-round2
NimRegevNov 10, 2024
b8e2dfa
Change title of policy tutorial
NimRegevNov 10, 2024
f5d16ba
Merge branch 'master' into gitops-promotions-round2
NimRegevNov 10, 2024
3fec35a
Add YAML spec examples
NimRegevNov 10, 2024
ad75828
Merge branch 'gitops-promotions-round2' of https://github.com/codefre…
NimRegevNov 10, 2024
82f92cf
Add links to YAML specs
NimRegevNov 11, 2024
b54a556
Update promotion-components.md
NimRegevNov 11, 2024
e6e53fe
Updates
NimRegevNov 11, 2024
e06d011
Update promotion-components.md
NimRegevNov 11, 2024
94a5e37
Update promotion-flow-triggers.md
NimRegevNov 11, 2024
b0d7e93
Update promotion-action.png
NimRegevNov 11, 2024
3416948
Update promotions-overview.md
NimRegevNov 11, 2024
27293f3
Merge branch 'master' into gitops-promotions-round2
NimRegevNov 11, 2024
907a169
Updates
NimRegevNov 11, 2024
800f3ca
Merge branch 'gitops-promotions-round2' of https://github.com/codefre…
NimRegevNov 11, 2024
2057ef2
Update promotion-success.png
NimRegevNov 11, 2024
cb80d3a
Fixes
NimRegevNov 11, 2024
f8af9ee
Update product-releases.md
NimRegevNov 11, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion_docs/products/assign-applications.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ There are two methods of assigning applications to a product:
Recommended for testing purposes and not as the preferred method.
For how-to instructions, see [Manually assign unassigned applications]({{site.baseurl}}/docs/products/configure-product-settings/#manually-assign-unassigned-applications).

You can always unassign an application from a product, for declaratively assigned applications by removing the annotation, and for manually assigned applications, by removing them through [Product Settings](products/configure-product-settings/#unassign-manually-assigned-applications).
You can always unassign an application from a product, for declaratively assigned applications by removing the annotation, and for manually assigned applications, by removing them through [Product Settings]({{site.baseurl}}/docs/products/configure-product-settings/#unassign-manually-assigned-applications).


## Related articles
Expand Down
8 changes: 4 additions & 4 deletions_docs/products/promotion-flow-triggers.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,8 +29,8 @@ You can select multiple Promotion Flows for a product, and customize the conditi


##### Where can you configure Promotion Flows and triggers?
In Product > Settings > Promotion Flows, you can select one or more Promotion Flows for theprodcut, and then configure custom conditions to trigger the flows.
See also [Promotion Flow CRD](#promotion-flow-crd).
In Product > Settings > Promotion Flows, you can select one or more Promotion Flows for theproduct, and then configure custom conditions to trigger the flows.
See also [Promotion Flow CRD]({{site.basurl}}/docs/promotions/configuration/yaml/promotion-flow-crd/).

{% include
image.html
Expand All@@ -43,7 +43,7 @@ See also [Promotion Flow CRD](#promotion-flow-crd).
%}


For how to instructions on configuring Promotion Flows, see [Configure Promotion Flows]({{site.baseurl}}docs/products/manage-products/configure-product-settings/#configure-promotion-flows).
For how to instructions on configuring Promotion Flows, see [Configure Promotion Flows]({{site.baseurl}}/docs/products/configure-product-settings.md/#configure-promotion-flows).


## Examples of trigger conditions for Promotion Flows
Expand DownExpand Up@@ -138,7 +138,7 @@ To configure directly in YAML, refer to our [Promotion Flow CRD](tbd) for the sy

## Related articles
[Assigning applications to products]({{site.baseurl}}/docs/products/assign-applications/)
[Configuring version and promotable properties for products]({{site.baseurl}}/docs/products/manage-products/promotion-version-properties/)
[Configuring version and promotable properties for products]({{site.baseurl}}/docs/products/promotion-version-properties/)
[Tracking product releases]({{site.baseurl}}/docs/promotions/releases/)
[Creating products]({{site.baseurl}}/docs/products/create-product/)

Expand Down
2 changes: 1 addition & 1 deletion_docs/products/promotion-version-properties.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,7 +46,7 @@ See also [Promotion Settings & Promotion Templates](#promotion-settings--promoti
%}


For how-to instructions, see [Configure Promotion Settings]({{site.baseurl}}/docs/products/manage-products/configure-product-settings/#configure-promotion-settings).
For how-to instructions, see [Configure Promotion Settings]({{site.baseurl}}/docs/products/configure-product-settings/#configure-promotion-settings).



Expand Down
2 changes: 1 addition & 1 deletion_docs/promotions/configuration/promotion-flow.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -194,7 +194,7 @@ max-width="60%"
Visually design and create the flow by selecting environments, Promotion Actions, and Workflows, and defining dependencies through the Flow Builder. If needed, create new environments and promotion workflows on-the-fly when doing so.

##### Before you begin
* Review [Create a promotion sequence]({{site.baseurl}}/docs/promotions/create-promotion-sequence/)
* Review [Promotion: End-to-end guide]({{site.baseurl}}/docs/promotions/create-promotion-sequence/)


##### How to
Expand Down
2 changes: 1 addition & 1 deletion_docs/promotions/configuration/promotion-policy.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,7 @@ Once configured and committed, Promotion Policy settings are saved as a CRD (Cus
The path in the Shared Configuration Repo is `<gitops-runtime>/<shared-configuration-repo>/resources/configurations/promotion-policies/`.
See [Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/) and [Designating Configuration Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#designating-configuration-runtimes).

For the YAML specifications, see [Promotion Policy YAML]({{site.baseurl}}/_docs/promotions/configuration/yaml/promotion-policy-crd/).
For the YAML specifications, see [Promotion Policy YAML]({{site.baseurl}}/docs/promotions/configuration/yaml/promotion-policy-crd/).



Expand Down
6 changes: 3 additions & 3 deletions_docs/promotions/configuration/yaml/product-crd.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,6 @@ spec:
|`spec.promotionFlows.gitTriggerSelectors.values` |Single or list of comma-separated values used to match or exclude Promotion Flows based on criteria defined by `gitTriggerSelectors.operator`. The values can be strings, numbers, or other data types depending on the context.|array |Required |

## Related articles
[Promotion Policy YAML]({{site.baseurl}}/docs/promotions/promotion-policy-crd/)
[Promotion Template YAML]({{site.baseurl}}/docs/promotions/promotion-template-crd/)
[Promotion Flow YAML]({{site.baseurl}}/docs/promotions/promotion-flow-crd/)
[Promotion Policy YAML]({{site.baseurl}}/docs/promotions/configuration/yaml/promotion-policy-crd/)
[Promotion Template YAML]({{site.baseurl}}/docs/promotions/configuration/yaml/promotion-template-crd/)
[Promotion Flow YAML]({{site.baseurl}}/docs/promotions/configuration/yaml/promotion-flow-crd/)
8 changes: 4 additions & 4 deletions_docs/promotions/configuration/yaml/promotion-flow-crd.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,12 +48,12 @@ spec:
|`spec.steps` | The step in the Promotion Flow that defines the list of target environments and their dependencies. <br>At least one target environment and dependency must be defined. | array | Required |
|`spec.steps.environment` | The name of the specific target environment for which to trigger the promotion. | string | Required |
|`spec.steps.environment.dependsOn`| One or more environments that must be successfully promoted before promotion can be triggered in the succeeding environments. | array | Required |
|`spec.steps.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>An `policy` attribute defined here overrides global Policies that match the product/environment. See [Promotion Policy implementation logic]({{site.baseurl}}/docs/promotions/promotion-policy/#promotion-policy-implementation-logic) for information on how they are applied. | object | Optional |
|`spec.steps.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>An `policy` attribute defined here overrides global Policies that match the product/environment. See [Promotion Policy implementation logic]({{site.baseurl}}/docs/promotions/configuration/promotion-policy/#promotion-policy-implementation-logic) for information on how they are applied. | object | Optional |
| `spec.steps.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.<br>In this case, the Post-Action workflow must include a step that is equivalent </li></ul>{:/}| string | Required |
| `spec.steps.policy.preAction` | The name of the Promotion Workflow to execute _before_ `spec.steps.policy.action`. | string | Optional |
| `spec.steps.policy.postAction` | The name of the Promotion Workflow to execute after `spec.steps.policy.action`. | string | Optional |

## Related articles
[ProductCRD]({{site.baseurl}}/docs/promotions/product-crd/)
[PromotionTemplate YAML]({{site.baseurl}}/docs/promotions/promotion-template-crd/)
[PromotionPolicy YAML]({{site.baseurl}}/docs/promotions/promotion-policy-crd/)
[ProductYAML]({{site.baseurl}}/docs/romotions/configuration/yaml/product-crd/)
[PromotionPolicy YAML]({{site.baseurl}}/docs/promotions/configuration/yaml/promotion-policy-crd/)
[PromotionTemplate YAML]({{site.baseurl}}/docs/promotions/configuration/yaml/promotion-template-crd/)
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,9 +63,9 @@ spec:


## Related articles
[ProductCRD]({{site.baseurl}}/docs/promotions/product-crd/)
[PromotionTemplate YAML]({{site.baseurl}}/docs/promotions/promotion-template-crd/)
[PromotionFlow YAML]({{site.baseurl}}/docs/promotions/promotion-flow-crd/)
[ProductYAML]({{site.baseurl}}/docs/romotions/configuration/yaml/product-crd/)
[PromotionFlow YAML]({{site.baseurl}}/docs/promotions/configuration/yaml/promotion-flow-crd/)
[PromotionTemplate YAML]({{site.baseurl}}/docs/promotions/configuration/yaml/promotion-template-crd/)



View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,9 +59,9 @@ spec:<!


## Related articles
[Product YAML]({{site.baseurl}}/docs/promotions/product-crd/)
[Promotion Policy YAML]({{site.baseurl}}/docs/promotions/promotion-policy-crd/)
[PromotionFlow YAML]({{site.baseurl}}/docs/promotions/promotion-flow-crd/)
[Product YAML]({{site.baseurl}}/docs/promotions/configuration/yaml/product-crd/)
[Promotion Policy YAML]({{site.baseurl}}/docs/promotions/configuration/yaml/promotion-policy-crd/)
[PromotionTemplate YAML]({{site.baseurl}}/docs/promotions/configuration/yaml/promotion-template-crd/)



Expand Down
6 changes: 3 additions & 3 deletions_docs/promotions/product-releases.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -87,7 +87,7 @@ The table describes important insights in the Releases page.
| **Release ID** | The Codefresh-assigned identifier uniquely identifying the release. Clicking the Release ID displays the ongoing or completed Promotion Flow for the release. |
| **Initiator** | The user who created the release. The initiator is displayed only for releases created through automated promotions. |
| **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). |
| **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).|
| **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.png?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></ul>{:/} See [Environment (deployment) status](#environment-deployment-status).|



Expand DownExpand Up@@ -194,7 +194,7 @@ The table describes the possible deployment statuses for environments.
{: .table .table-bordered .table-hover}
| Environment Status | Description |
|------------ |---------------------------------------|
| **Successful** | Promotion to an environment is considered successful when the following conditions are met, in the order listed. {::nomarkdown}<ol><li>Pre-Action Workflow completed successfully.</li><li>Promotion Action submitted successfully. For PRs, the PR was successfully merged.</li><li>Application synced to the cluster.</li><li><li>Application is healthy.</li><li>Post-Action Workflow completed successfully.</li></ol>{:/}. |
| **Successful** | Promotion to an environment is considered successful when the following conditions are met, in the order listed. {::nomarkdown}<ol><li>Pre-Action Workflow completed successfully.</li><li>Promotion Action submitted successfully. For PRs, the PR was successfully merged.</li><li>Application synced to the cluster.</li><li>Application is healthy.</li><li>Post-Action Workflow completed successfully.</li></ol>{:/} |
| **Running** | At least one step in a Pre- or Post-Action Workflow in the environment is currently in progress. |
| **Suspended** | One or both the Pre- and Post-Action Workflows or the Promotion Action is pending execution. This could be because of a condition in the Workflow or because a pull request is pending manual approval. |
| **Failed** | At least one step in a Workflow failed to execute, has a syntax error, was manually terminated, or the application is out of sync or degraded. |
Expand DownExpand Up@@ -393,7 +393,7 @@ max-width="60%"
## Related articles
[Promotion Flows]({{site.baseurl}}/docs/promotions/configuration/promotion-flow/)
[Trigger promotions]({{site.baseurl}}/docs/promotions/trigger-promotions/)
[Promotion sequences]({{site.baseurl}}/docs/promotions/create-promotion-sequence/)
[Promotions: End-to-end guide]({{site.baseurl}}/docs/promotions/create-promotion-sequence/)



Expand Down
4 changes: 2 additions & 2 deletions_docs/promotions/promotion-components.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ For a complete end-to-end continuous delivery with Codefresh GitOps promotions,

## Building blocks

A promotionsequencecomprises several building blocks, optional and required, each serving a specific role in the promotion and deployment process.
A promotion comprises several building blocks, optional and required, each serving a specific role in the promotion and deployment process.
The table describes the core and promotion-specific entities.


Expand DownExpand Up@@ -73,7 +73,7 @@ The table describes the core and promotion-specific entities.
<td><strong>Promotion Flows</strong></td>
<td>Promotion flows orchestrate the movement of applications through environments, ensuring a controlled and automated promotion process for applications within the same product.</td>
<td>Account administrators</td>
<td><a href="https://codefresh.io/docs/docs/promotions/promotion-flow/">Creating Promotion Flows</a></td>
<td><a href="https://codefresh.io/docs/docs/promotions/configuration/promotion-flow/">Creating Promotion Flows</a></td>
</tr>
<tr>
<td></td>
Expand Down
8 changes: 6 additions & 2 deletions_docs/promotions/promotions-overview.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,9 @@ caption="Environments, products, releases"
max-width="60%"
%}

>**NOTE**
Runtime version 0.13.4 or higher is required to support promotions. Ensure your runtime is updated to at least this version to access promotion features.

##### GitOps promotion entities
Codefresh's GitOps promotions include specialized entities that streamline and automate the promotion process. These entities provide you with the flexibility and control to model your delivery lifecycles with all the required checks built-in, and no custom scripting required. You get a predictable path to production that you can duplicate across projects, giving you ultimate control over your processes.
* **Promotion Templates**: Define which application properties to promote.
Expand All@@ -64,6 +67,7 @@ Codefresh's GitOps promotions include specialized entities that streamline and a
##### Getting started with promotions in GitOps

* To get started, explore [Promotion building blocks]({{site.baseurl}}/docs/promotions/promotion-components/) and understand the entities involved.
* For a step-by-step guide on implementing continuous delivery, see [Promotions: End-to-end guide]({{site.baseurl}}/docs/promotions/create-promotion-sequence/).
* For practical examples of setting up and managing promotions, see [Promotion tutorials]({{site.baseurl}}/docs/promotions/promotion-scenarios/).
* For a step-by-step guide on implementing promotions, see [Promotions: End-to-end guide]({{site.baseurl}}/docs/promotions/create-promotion-sequence/).
* For practical examples of setting up promotions, see [Promotion tutorials]({{site.baseurl}}/docs/promotions/promotion-scenarios/).


Binary file modifiedimages/icons/promotion-action.png
View file
Open in desktop
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modifiedimages/icons/promotion-success.png
View file
Open in desktop
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

[8]ページ先頭

©2009-2025 Movatter.jp