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/whats-new/on-prem-release-notes.md
+267Lines changed: 267 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,273 @@ toc: true
6
6
7
7
Welcome to the release notes for our on-premises releases.
8
8
9
+
##On-premises version ???
10
+
11
+
###Features & enhancements
12
+
Features and enhancements are divided into those in general availability and those currently in Beta.
13
+
14
+
####Pipelines: New`strict_fail_fast` to control pipelines
15
+
You’re probably familiar with the`fail_fast` flag available for steps in Codefresh pipelines. The flag determines the pipeline’s behavior when there is a step failure. Accordingly, when set to`false`, the pipeline continues execution and returns a Build status of`Build completed successfully`.
16
+
But what if you want to indicate that a step failed in the Build status even when the pipeline completes execution? Enter our new`strict_fail_fast` flag! Now, you can indicate that the step failed execution by simply adding`strict_fail_fast` to the step and setting it to`true`. After the pipeline completes execution, the Build status is designated as Failed.
17
+
18
+
```yaml
19
+
step_name:
20
+
type:git-clone
21
+
title:Step Title
22
+
description:Step description
23
+
...
24
+
credentials:
25
+
...
26
+
fail_fast:false
27
+
strict_fail_fast:true
28
+
when:
29
+
branch:
30
+
ignore:[ develop ]
31
+
on_success:
32
+
...
33
+
on_fail:
34
+
...
35
+
on_finish:
36
+
...
37
+
retry:
38
+
...
39
+
...
40
+
```
41
+
For details, check out the**Fields** table in the documentation for the different step types, as in the[`git-clone` step]({{site.baseurl}}/docs/pipelines/steps/git-clone/) for example.
42
+
43
+
####Pipelines: Empty variables
44
+
We are happy to announce a highly-requested feature: the ability to use_empty variables_ in Codefresh pipelines.
45
+
Now, you can add variables without any values to entities in Codefresh, whether it's a project, pipeline, or trigger. The enhancement unlocks a myriad of possibilities that were previously unavailable.
Remember that encryption is not supported for empty variables. The priority for variable overrides remains unchanged.
59
+
60
+
For details, see[User-defined variables in pipelines]({{site.baseurl}}/docs/pipelines/variables/#user-defined-variables).
61
+
62
+
####Pipelines: Share build run settings
63
+
Our newest enhancement to pipeline builds is designed to increase collaboration and productivity! How? Instead of redefining build settings manually, you can effortlessly share pipeline build settings with colleagues who have access to the same account.
64
+
65
+
**How does it work?**
66
+
By sharing build settings, you enable colleagues to pre-populate build configurations without the need for redundant manual input. This feature is useful for various scenarios, whether it's for testing automation integration with third-party tools or triggering pipelines in specific situations.
67
+
68
+
**Customizing build settings**
69
+
You can override any existing setting - simulate a different trigger, select a different branch, modify existing or add new build variables, and even modify the build behavior.
70
+
71
+
With a click of the**Share build settings** button, Codefresh generates a unique URL. The URL includes modified and new settings as query parameters. Encrypted variables are excluded to ensure data protection.
For details, see[Share build run settings]({{site.baseurl}}/docs/pipelines/run-pipeline/#share-build-run-settings).
84
+
85
+
####Pipelines: Restart from failed step
86
+
At Codefresh, we highly value your feedback and are committed to continually enhancing your experience. In response to your feedback, we introduced the ability to configure the default restart behavior for failed steps in a pipeline at the account level.
alt="Restart from failed step in Pipeline Settings"
94
+
caption="Restart from failed step in Pipeline Settings"
95
+
max-width="50%"
96
+
%}
97
+
98
+
When enabled (the default), the user can restart the pipeline directly from the failed step. Otherwise, users can only restart the pipeline from the beginning.
99
+
By default, individual pipelines are configured to inherit the account setting.
100
+
Note that this does not impact existing pipelines.
101
+
102
+
Being able to configure the restart behavior for failed steps centrally simplifies management and ensures consistency across pipelines, without the need for individual adjustments.
103
+
Imagine a scenario where you’re onboarding a large team of developers. You can disable failed-step restart for the account, and have the pipelines use the account-level setting, saving valuable time and promoting a consistent experience.
104
+
105
+
You can always change the behavior at any time based on evolving requirements. And users have the flexibility to override the account-level behavior for individual pipelines based on specific needs.
106
+
107
+
For details, see[Restarting from failed steps]({{site.baseurl}}/docs/pipelines/configuration/pipeline-settings/#restarting-from-failed-steps).
108
+
109
+
110
+
111
+
####Pipelines: Explicit versions for typed steps
112
+
As you're aware, Codefresh is continually enhancing our typed step library in the Marketplace.
113
+
114
+
When typed steps in pipelines lack a specified version, Codefresh automatically associates them with the latest version of the step. To avoid potential issues with breaking changes in typed steps, we now provide a warning if there are steps in your pipelines without an explicit version number.
alt="Warning for typed steps without version numbers"
122
+
caption="Warning for typed steps without version numbers"
123
+
max-width="60%"
124
+
%}
125
+
126
+
For details, see[Versioning for typed steps]({{site.baseurl}}/docs/pipelines/steps/#versioning-for-typed-steps).
127
+
128
+
####Pipelines: Blobless Git clone
129
+
130
+
Here's an enhancement which contributes to workflow optimization - a new field in our`git_clone` step: the`exclude_blob` field.
131
+
Filter out blob files from the Git repository and further streamline your development process. Fewer unnecessary files to clone and faster cloning times!
132
+
133
+
For blobless cloning, simply set`exclude_blob` to`true`. To always include blob files, you can retain the default value of`false`.
134
+
135
+
For details, see[Fields in git-clone step]({{site.baseurl}}/docs/pipelines/steps/git-clone/#fields).
136
+
137
+
####Pipelines: Add tags during pipeline creation
138
+
With this update, you can effortlessly add tags when you create a pipeline, further streamlining the pipeline creation process. Add tags as you usually do, and they are instantly available in both the General Settings and the Permissions panel.
####GitOps: Diff View for out-of-sync applications
152
+
We’re thrilled to introduce a significant enhancement simplifying troubleshooting Argo CD applications within Codefresh.
153
+
With our new Diff View feature, you can instantly view the differences between the current and the desired states of out-of-sync applications.
154
+
The Diff View option displays all the updated resources within the application, allowing you to easily pinpoint changes and swiftly identify the root cause of the sync failure.
155
+
156
+
If you have selected an application, the Diff View option is available in the context menu at the top right of the page. The option is enabled whenever the application is out-of-sync.
157
+
158
+
>**NOTE**
159
+
Diff View for application resources is supported from Runtime v1.0.38 and higher. <!--- To enable this feature, you need to turn on the `appDiffView` feature flag. -->
160
+
161
+
For details, see[Analyze out-of-sync applications with Diff View]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/#analyze-out-of-sync-applications-with-diff-view).
162
+
163
+
164
+
165
+
####GitOps: Tailored sync timeouts for Argo CD applications
166
+
167
+
Tailor the timeout thresholds for sync operations for different applications, and receive instant alerts when the sync duration exceeds the threshold defined.
168
+
Instead of waiting indefinitely for syncs to complete and then navigating through the GitOps Apps dashboard, Codefresh provides you with timely warnings to proactively investigate and resolve sync issues.
169
+
170
+
Just include an annotation in the application's YAML, and either retain the default timeout of 30 minutes (also Argo CD's default for sync operations), or change it as needed.
171
+
Codefresh will display a warning in the**Warnings/Errors** panel for the app when the sync operation exceeds the timeout.
alt="Sync timeout warning for Argo CD applications"
179
+
caption="Sync timeout warning for Argo CD applications"
180
+
max-width="70%"
181
+
%}
182
+
183
+
For details, see[Configure sync-timeout for Argo CD applications]({{site.baseurl}}/docs/deployments/gitops/manage-application/#configure-sync-timeout-for-argo-cd-applications).
184
+
185
+
####GitOps: Argo CD application enhancements
186
+
187
+
We introduced a couple of usability enhancements for Argo CD applications in Codefresh.
188
+
189
+
#####Deployment record for Current Release
190
+
To more accurately represent the live deployment status of the selected application in the Timeline tab, we now clearly differentiate between current and historical deployments.
191
+
192
+
The Current Release is prominently displayed as a dedicated deployment record at the top of the Timelines tab, tagged as the Current Version. It is followed by the list of Previous Releases.
alt="Current Release deployment record in Timeline tab"
200
+
caption="Current Release deployment record in Timeline tab"
201
+
max-width="70%"
202
+
%}
203
+
204
+
* To prevent confusion with duplicate statuses, the application's health and sync statuses are now exclusively displayed and tracked within the Application Header.
205
+
206
+
* To validate that the current release as the live state, the release revision in the deployment record mirrors the sync revision displayed in Last Sync Result.
207
+
208
+
For details, see[Monitoring deployments for selected Argo CD application]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/#monitoring-deployments-for-selected-argo-cd-application).
209
+
210
+
#####Quick links
211
+
The Configuration tab displays handy links to the application's GitOps Runtime, Git Source, and YAML manifest in the Git repo.
alt="Quick links for application in Configuration tab"
219
+
caption="Quick links for application in Configuration tab"
220
+
max-width="70%"
221
+
%}
222
+
223
+
224
+
####GitOps: View/download logs for GitOps Runtime components
225
+
We are glad to announce that you can now view and download logs for individual GitOps Runtime components!
226
+
Previously available for legacy CLI Runtimes, this functionality is now back for Helm GitOps Runtimes, with online viewing in our smart terminal and offline downloads as you need.
227
+
228
+
As a reminder, here's where you can find the**View logs** option:
For details, see[View/download logs for GitOps Runtime components]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#viewdownload-logs-for-runtime-components).
241
+
242
+
243
+
####GitOps: Argo Events upgrade
244
+
We've recently upgraded Argo Events to its latest version, v1.9.0, ensuring you can leverage all enhancements. For detailed information about the changes in this version, please refer to the[Argo documentation](https://github.com/argoproj/argo-events/releases){:target="\_blank"}.
245
+
246
+
Please be aware that this upgrade may introduce a potential breaking change for existing event sources that have defined`githubBaseUrl` without defining`githubUploadURL` which is required. In such cases, event sources will fail to sync, and the Git Source application will return a`..githubUploadURL is required when githubBaseURL is set` error.
247
+
248
+
To address this, you'll need to edit the event source YAMLs and add`githubUploadURL` where required.
249
+
250
+
####GitOps: Deprecation of GitOps CLI for Runtime installation
251
+
252
+
As we have transitioned to Helm-based Runtimes for GitOps, we have permanently deprecated the CLI-based installation for GitOps Runtimes.
253
+
254
+
###Feature Flags
255
+
Feature Flags are divided into new Feature Flags released in the current version, and changes to existing Feature Flags which are now enabled by default.
256
+
257
+
**New Feature Flags in v???**
258
+
The table below describes the_new_ Feature Flags in the Codefresh On-Premises release v???.
|`abacAndRule`| When enabled, supports creating ABAC rules for entities in Codefresh pipelines using "AND". <br>See[Pipelines: Enhanced RBAC with AND logic for tags](#pipelines-enhanced-rbac-with-and-logic-for-tags) in this article.| TRUE|
264
+
265
+
**Updated Feature Flags in v???**
266
+
The table below lists existing Feature Flags which have been updated by default to be either enabled (set to_TRUE_), or disabled (set to_FALSE_).
|`accountInfoCopyButton`| When enabled, the account ID is added to the URL. When sharing the URL with the account information, recipients can seamlessly switch accounts.|_FALSE_|