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/promotions/promotion-flow.md
+43-42
Original file line number
Diff line number
Diff line change
@@ -110,69 +110,55 @@ max-width="60%"
110
110
Here are a few useful factors to be aware of when creating Promotion Flows.
111
111
112
112
113
-
### Trigger and target environments
114
-
Creating and assigning environments in a Promotion Flow starts with the Trigger Environment, where the change to the application initiates the flow, and continues with one or more target environments to which the changes are promoted. You need at least one target environment in a Promotion Flow.
113
+
### Environments in Promotion Flows
115
114
115
+
#### Trigger and target environments
116
+
Promotion Flows start with a Trigger Environment, where the change to the application initiates the flow, and continue with one or more target environments where changes are promoted.
117
+
You need at least one target environment in a Promotion Flow.
116
118
117
-
##### Adding environments
118
-
When adding an environment, you can select from the list of available environments, or create a new one that takes you to the Environments page for defining settings. At this point, the Promotion Flow remains unsaved. A notification alerts you that there are unsaved changes to the Promotion Flow. This notification remains as long as you have unsaved changes in the Promotion Flow.
119
119
120
-
##### Removing environments
121
-
Removing an environment from the Promotion Flow requires you to reconnect next environments if any, to previous environments.
120
+
#### Adding and removing environments
121
+
* Adding environments
122
+
When adding an environment to the Promotion Flow, you can select from the list of existing environments, or create a new one which redirects you to the Environments page for defining settings. The Flow remains unsaved until you complete these changes.
122
123
123
-
Reconnecting environments is only relevant when there are one or more environments in the flow _following_ the one being removed. If the environment you’re removing, for example `staging` is the final environment in the flow, you can remove it directly without needing to reconnect.
124
+
* Removing environments
125
+
Removing an environment from the Promotion Flow may require you to reconnect subsequent environments if any, to preceding ones.
126
+
You need to reconnect environments only if the environment you are removing is not the final environment in the Promotion Flow. If it's the final environment, you can remove it directly without needing to reconnect.
124
127
125
128
See [Remove environments from Promotion Flows](#remove-environments-from-promotion-flows).
126
129
127
-
### Applications in environments
130
+
### Application behavior in Promotion Flows
128
131
129
-
#####Applications in Trigger Environment
130
-
It is recommended to have a single application for a product in the Trigger Environment. If the product has multiple applications with changes, changes are promoted only for a single application. <!--- NIMA: which app is selected? the one with the most recent change? -->
132
+
#### Applications in Trigger Environment
133
+
It is recommended to have a single application for a product in the Trigger Environment. If there are multiple applications within the product, changes are promoted only for a single application, typically the one with the most recent changes. <!--- NIMA: which app is selected? the one with the most recent change? -->
131
134
132
-
#####Applications per defined environment
135
+
#### Applications per defined environment
133
136
To ensure a successful promotion, the product must include an application in each environment defined in the Promotion Flow.
134
137
135
-
#####Multiple applications in a target environment
136
-
If a target environment, such as staging or production, includes multiple applications for the same product—segmented for example by region, tenant, or other criteria—each application in that environment is updated with changes from the source environment.
138
+
#### Multiple applications in a target environment
139
+
If a target environment includes multiple applications for the same product—segmented for example by region, tenant, or other criteria—each application in that environment is updated with changes from the source environment.
137
140
138
141
Although this behavior may seem intuitive, it’s crucial to recognize that each set of Promotion Policy settings that govern the environment's promotion, _also applies individually to each application_.
139
142
140
-
For example, if there are three applications with Pre-Action Workflows, the Pre-Action Workflow will execute three times—once for each application.
141
-
Steps within the Pre-Action Workflow that create resources or perform actions are also executed multiple times.
142
-
Consider a step within the Pre-Action Workflow which creates a Jira ticket when initiating promotion, will run three times, creating three separate Jira tickets.
143
+
#### Deleting/adding files in applications
143
144
144
-
##### Deleting/adding files in applications
145
+
Adding or deleting files from applications in target environments does not affect the Promotion Flow. The promotion mechanism simply retains the added/deleted files as they are in the target environments.
145
146
146
-
Adding or deleting files from applications in target environments does not impact the success of the Promotion Flow. The promotion mechanism simply retains the added/deleted files as they are in the target environments.
147
-
148
-
149
-
150
-
151
-
152
-
153
-
### Flow timeouts
154
-
155
-
When you create a Promotion Flow, you can define a timeout to automatically terminate the flow if it exceeds the allowed time.
156
-
If not configured, the Flow inherits the default timeout of 24 hours.
157
-
158
-
Timeouts are useful in scenarios such as:
159
-
* Manual approval delays: Terminates the flow if approval isn’t provided within the defined time frame for PR-driven flows for example.
160
-
* Long-running tests: Terminate flows running indefinitely due to misconfigured tests, preventing resource waste and pipeline delays.
161
147
162
148
### Promotion Policy settings
163
149
164
-
For each environment, you can explicitly set the Promotion Policy that defines governs promotion behavior for the environment through the Promotion Action (required), and the optional Pre- and Post-Action Workflows.
150
+
For each environment, you can explicitly set the Promotion Policy that defines governs promotion behavior for the environment through the Promotion Action (required), and Pre- and Post-Action Workflows.
165
151
You can also preview Policy settings by product before the flow is triggered.
166
152
167
-
#####Inline vs. global Promotion Policy settings
153
+
#### Inline vs. global Promotion Policy settings
168
154
169
-
When you create or edit a Promotion Flow, the Flow Builder displays available policy settings.
155
+
When you create or edit a Promotion Flow, the Flow Builder displays the Pre- and Post-Action Workflows, and the Promotion Action available for selection.
170
156
171
157
***Inline policy settings**
172
-
If you manually select policy settings for an environment, these _inline_selections override any global Promotion Policy settings that match the product/environment when the flow is triggered.
158
+
Inline policy settings are those that you explicitly select for an environment. When the Promotion Flow is triggered, _inline_Policy settings always override any global Promotion Policy settings that may match the product/environment.
173
159
174
160
***Global Promotion Policy settings**
175
-
If no inline settings are selected, the system applies global Promotion Policy settings based on predefined priorities. <!-- See TBD -->
161
+
When inline policy settings are not defined, the promotion mechanism applies global Promotion Policy settings based on predefined priorities. <!-- See TBD -->
176
162
177
163
{% include
178
164
image.html
@@ -184,12 +170,10 @@ caption="Inline vs. global Promotion Policy settings"
184
170
max-width="60%"
185
171
%}
186
172
187
-
##### Promotion Workflows
188
-
Both Pre- and Post-Action Workflows are optional in a Promotion Flow, unless defined in the Policy.
189
173
190
-
#####Previewing Promotion Policies by Product
191
-
Instead of waiting for a Promotion Flow to be triggered to see policy settings applied to environments, you can preview which global Promotion Policy settings are applied to a product within the flow.
192
-
Policy evaluation by product is useful to verify if the environment and product have the desired policies, or to identify environments with missing policies, or required settings such as the Promotion Action.
174
+
#### Previewing Promotion Policies by Product
175
+
Before triggering a Promotion Flow, you can preview the global Promotion Policy settings that apply to a product.
176
+
Policy evaluation by product is useful to verify if the environment and product have the desired policies in place, or identify those with missing policies, or missing settings such as the Promotion Action.
193
177
194
178
{% include
195
179
image.html
@@ -202,7 +186,24 @@ max-width="60%"
202
186
%}
203
187
204
188
189
+
### Releases and Promotion Flows
190
+
191
+
***Manually triggered Promotion Flows**
192
+
When a Promotion Flow is triggered manually, a release is immediately created for the product.
193
+
194
+
***Automatically triggered Promotion Flows**
195
+
When a Promotion Flow is triggered automatically, the release is created only after the application in the Trigger Environment is Synced and Healthy.
205
196
197
+
### Timeout behavior in Promotion Flows
198
+
199
+
You can define a timeout for a Promotion Flow to automatically terminate it if the Flow exceeds the allowed time.
200
+
If not configured, the default timeout is 24 hours.
201
+
202
+
Timeouts are useful in scenarios such as:
203
+
* Manual approval delays
204
+
Terminates the flow if manual approval isn’t provided within the defined time frame, for PR-driven flows for example.
205
+
* Long-running tests
206
+
Terminates flows running indefinitely preventing unnecessary resource consumption and delays, for misconfigured tests for example.
206
207
207
208
## Create a Promotion Flow
208
209
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.
0 commit comments