Skip to content

Commit 25541d9

Browse files
authored
Classic pipeline settings rewrite (#1315)
* Update content * Update pipeline settings Restructured and rewrote pipeline settings content * Update pipelines.md * Update pipelines.md * Update * Update on-prem-feature-management.md
1 parent 57755b6 commit 25541d9

File tree

3 files changed

+112
-147
lines changed

3 files changed

+112
-147
lines changed

_docs/installation/installation-options/on-premises/on-prem-feature-management.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: "Codefresh on-premises feature management"
33
description: "Enable/disable features for Codefresh accounts in your organization"
44
group: installation
5-
redirect_from:
6-
- /docs/installation/on-premises/on-prem-feature-management/
75
toc: true
86
---
97

@@ -82,19 +80,19 @@ The table describes in alphabetical order, the features you can open for Codefre
8280
| `delightedSurvey` | When enabled, displays Delighted CX surveys in the Codefresh UI. <br>If there are security concerns because of outbound requests from clients, disable this Feature Flag. | TRUE| |
8381
|`dindPodRequestsEqualLimits` | When enabled, sets both the resource requests and limits for the pod to the same values.|FALSE | |
8482
|`disableWelcomeScreen` | When enabled, bypasses the Codefresh Welcome screen that requires the user to enter additional information on first sign-in. <br>Required mostly in on-premises environments, especially for LDAP, which has all login info already configured. | FALSE| |
85-
|`disableRolloutActionsWithoutRBAC` |Relevant to GitOps application deployments. <br>When enabled, disables rollback and rollout controls in the Timeline's tab's Rollout Player for the application. {::nomarkdown}<ul><li>Rollback for the selected Rollout. The <b>Choose version to Rollback</b> dropdown is disabled.<br>See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#manually-rollback-completed-rollout-to-previous-revision">Manually rollback completed rollout to previous revision</a>. </li><li>The <b>Pause</b>, <b>Resume</b>, <b>Skip Step</b> and <b>Promote Full</b> controls in the Rollout Player are also disabled.<br>See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#manage-an-ongoing-rollout-with-the-rollout-player">Manage an ongoing rollout with Rollout Player</a>.</li></ul>{:/} | FALSE | |
83+
|`disableRolloutActionsWithoutRBAC` |Relevant to GitOps application deployments. <br>When enabled, disables rollback and rollout controls in the Timeline's tab's Rollout Player for the application. {::nomarkdown}<ul><li>Rollback for the selected Rollout. The <b>Choose version to Rollback</b> dropdown is disabled.<br>See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#manually-rollback-completed-rollout-to-previous-revision">Manually rollback completed rollout to previous revision</a>. </li><li>The <b>Pause</b>, <b>Resume</b>, <b>Skip Step</b> and <b>Promote Full</b> controls in the Rollout Player are also disabled.</li></ul>{:/} | FALSE | |
8684
| `disableInviteWelcomeMail` | When enabled, does not send the Welcome email to users invited to an account. | FALSE | |
87-
|`forbidDecrypt` |When enabled, prevents users from decrypting secrets when running the `codefresh get context --decrypt` command. <br>Users can bypass this by running `--decrypt` with the built-in `CF_API_KEY` command that is injected into every build. |FALSE| . |
85+
|`forbidDecrypt` |When enabled, prevents users from decrypting secrets when running the `codefresh get context --decrypt` command. <br>Users can bypass this by running `--decrypt` with the built-in `CF_API_KEY` command that is injected into every build. |FALSE| |
8886
| `fullstory` | When enabled, allows Codefresh to track user activity in the Codefresh UI through Fullstory.<br>**NOTE**: When enabled for air-gapped environments, client attempts to communicate with a Fullstory service may result in network errors.| FALSE | |
8987
| `genAICronExpression` | When enabled, supports generating Cron expressions in the Codefresh UI using Generative AI.| FALSE | |
9088
|`gerritIntegration` | When enabled, enables Gerrit integration in Account settings. See also `supportGerrit`. <br>See [Gerrit as Git provider for pipelines]({{site.baseurl}}/docs/integrations/git-providers/#gerrit). | FALSE | |
91-
|`gitopsArgoCdRollback` |Relevant to GitOps application deployments.<br>When enabled, allows you to rollback active GitOps applications to previously deployed versions.<br>See [Rollback GitOps applications]({{site.baseurl}}/docs/deployments/gitops/manage-application/#rollback-gitops-applications).| FALSE | |
92-
| `gitopsAppGroups` | When enabled, allows users to group GitOps applications by annotations, and view these applications in the Groups tab of the GitOps Apps dashboard. <br>See [Application Groups for GitOps applications]({{site.baseurl}}/docs/deployments/gitops/gitops-app-groups/). | TRUE | |
89+
|`gitopsArgoCdRollback` |Relevant to GitOps application deployments.<br>When enabled, allows you to rollback active GitOps applications to previously deployed versions.<br>See [Rollback GitOps applications]({{site.baseurl}}/docs/deployments/gitops/manage-application/#rollback-argo-cd-applications).| FALSE | |
90+
| `gitopsAppGroups` | When enabled, allows users to group GitOps applications by annotations, and view these applications in the Groups tab of the GitOps Apps dashboard. <br>See [Application Groups for Argo CD applications]({{site.baseurl}}/docs/deployments/gitops/gitops-app-groups/). | TRUE | |
9391
| `gitopsOnboarding` | When enabled, enhances the onboarding user-experience.| FALSE | _New in v2.6_ |
9492
| `gitopsGroupsPage` | When enabled, on selecting **GitOps Apps** from the sidebar, opens the **Groups** tab instead of the Applications tab.| TRUE | _New in v2.6_ |
9593
| `gitopsEnvironments` | When enabled (the default), displays the Environments dashboard option in the sidebar, and enables users to manage environments.| TRUE |_New in v2.6_ |
9694
| `gitopsDynamicBreadcrumbs` | When enabled (the default), supports rendering dynamic breadcrumbs for GitOps. | TRUE | |
97-
|`gitopsImageReporting` |Relevant to ProjectOne.<br>When enabled, reports images created with Codefresh Pipelines to the Images dashboard. <br>See [Images in Codefresh]({{site.baseurl}}/docs/dashboards/images/).| FALSE | |
95+
|`gitopsImageReporting` |When enabled, reports images created with Codefresh Pipelines to the Images dashboard. <br>See [Images in Codefresh]({{site.baseurl}}/docs/dashboards/images/).| FALSE | |
9896
| `hideCompositionsMenuItem` | When enabled, does not show Compositions within Artifacts & Insights in the sidebar of the Codefresh UI. | FALSE |
9997
|`injectClusterListFromPipelineSettings` | When enabled, turns on the pipeline setting **Kubernetes cluster context pipeline injection** for the account. Individual users can then selectively inject clusters for pipelines from those to which they they access.<br><br> This feature requires the users to have the Update Cluster permission. If not granted, then this feature has no impact when enabled. <br>See [Enabling cluster-contexts for pipelines]({{site.baseurl}}/docs/pipelines/configuration/pipeline-settings/#kubernetes-cluster-contexts-for-pipelines). | FALSE| |
10098
|`logMasking` |When enabled, secrets in build logs, both online and offline logs, are masked and replaced by asterisks. <br><br>This feature is currently available only for Enterprise customers. |FALSE| |
@@ -132,4 +130,4 @@ The table describes in alphabetical order, the features you can open for Codefre
132130
## Related articles
133131
[Codefresh on-premises installation]({{site.baseurl}}/docs/installation/on-premises/)
134132
[Codefresh on-premises upgrade]({{site.baseurl}}/docs/installation/on-premises/codefresh-on-prem-upgrade/)
135-
[Codefresh on-premises account & user setup]({{site.baseurl}}/docs/installation/on-premises/on-prem-configuration/)
133+
[Codefresh on-premises setup]({{site.baseurl}}/docs/installation/on-premises/on-prem-configuration/)

_docs/pipelines/configuration/pipeline-settings.md

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Account-level settings for pipelines"
3-
description: "Configure global pipeline settings for the account"
3+
description: "Configure settings pipelines at the account-level"
44
group: pipelines
55
sub_group: configuration
66
redirect_from:
@@ -26,9 +26,9 @@ Users can still override specific settings for individual pipelines.
2626
| |[Restarting from failed steps](#restarting-from-failed-steps) | Enable option to restart pipelines from failed steps instead of from the beginning.|
2727
| |[Memory usage warning for pipeline builds](#memory-usage-warning-for-pipeline-builds)| Enable alerts when pipelines reach/exceed the threshold. |
2828
| |[Default behavior for build step](#default-behavior-for-build-step)| Configure push image options for build steps. |
29-
| |[Default behavior for pending-approval step](#default-behavior-for-pending-approval-step) | Determine if `pending-approval` steps require manual action. |
30-
|Advanced options|[Advanced options for pipelines](#advanced-options-for-pipelines) | Configure the default behavior for volumes, concurrent builds, and authentication for Amazon ECR integrations, and more. |
31-
|Argo Workflows |[Enable pipelines with Argo Workflows]({{site.baseurl}}/docs/workflows/create-pipeline/) | Create pipelines based on Argo Workflows. |
29+
| |[Default behavior for pending-approval step](#default-behavior-for-pending-approval-step) | Determine if pending-approval steps require manual action. |
30+
|Other|[Advanced options for pipelines](#advanced-options-for-pipelines)| Configure options for build approval and pipeline volumes. |
31+
|Argo Workflows |Enable pipelines with Argo Workflows | Create pipelines based on Argo Workflows. |
3232

3333

3434

@@ -117,10 +117,12 @@ Define if users can create pipelines from pipeline templates or by cloning exist
117117

118118
If required, restrict the sources from which users can create or upload YAML files for a pipeline workflow.
119119

120+
The options are:
120121
* **Inline YAML**: Enable/disable the [inline editor]({{site.baseurl}}/docs/pipelines/pipelines/#using-the-inline-pipeline-editor) where YAML is stored in Codefresh SaaS
121122
* **YAML from repository**: Enable/disable pipeline uploading YAMLs from connected Git repositories
122123
* **YAML from external URLs**: Enable/disable loading YAMLs for pipelines from [external URLs]({{site.baseurl}}/docs/pipelines/pipelines/#loading-codefreshyml-from-version-control)
123124

125+
124126
>**NOTE**
125127
You must allow at least one of these options so that users can create new pipelines.
126128
We suggest selecting the **Inline YAML** option when users are still learning about Codefresh and want to experiment.
@@ -144,8 +146,7 @@ As a Codefresh administrator, you can override the account-level scopes for a sp
144146

145147

146148
## Kubernetes cluster-contexts for pipelines
147-
By default, all pipelines in the account can access all clusters integrated with Codefresh.
148-
Restrict pipeline access to clusters by enabling cluster-injection for pipelines in the account. When enabled, users are required to select the clusters for the pipeline build.
149+
By default, all pipelines in the account can access all clusters integrated with Codefresh. Restrict pipeline access to clusters by enabling cluster-injection for individual pipelines in the account.
149150

150151
Selectively restricting access to clusters for a pipeline:
151152
* Enhances security by restricting access to users from different teams.
@@ -188,23 +189,14 @@ max-width="60%"
188189
## Restarting from failed steps
189190
Enable or disable restarting pipelines directly from the failed step for all pipelines in the account. The setting affects the restart options displayed in the [Builds view]({{site.baseurl}}/docs/pipelines/monitoring-pipelines/#restart-pipeline-from-builds-view) and [step view]({{site.baseurl}}docs/pipelines/monitoring-pipelines/#restart-from-step-view).
190191

191-
{% include image.html
192-
lightbox="true"
193-
file="/images/pipeline/settings/account-permit-restart.png"
194-
url="/images/pipeline/settings/account-permit-restart.png"
195-
alt="Enable/disable restart from failed step"
196-
caption="Enable/disable restart from failed step"
197-
max-width="60%"
198-
%}
199-
200-
* When **enabled** (the default), allows users to restart the pipeline directly from the specific step that failed.
192+
* When **enabled**, allows users to restart the pipeline directly from the specific step that failed.
201193
* When **disabled**, allows users to restart the pipeline from the beginning.
202194

203-
Individual pipeline are set to use the account's setting by default, but users can override this setting to enable/disable failed step restart for the specific pipeline. See [Pipeline settings - Policies]({{site.baseurl}}/docs/pipelines/pipelines/#policies).
195+
Individual pipeline are set to use the account's setting by default, but users can override this setting to enable/disable failed step restart for the specific pipeline. See [Pipeline settings - Policies]({{site.baseurl}}/docs/docs/pipelines/pipelines/#policies).
204196

205197
## Memory usage warning for pipeline builds
206198
Select the memory-usage threshold for pipeline builds at which to display alerts. <br>
207-
Memory-usage thresholds for pipeline builds are useful get timely warnings and prevent build failures, while at the same time avoiding premature and unnecessary warnings.
199+
Memory-usage thresholds for pipeline builds are useful to both avoid premature and unnecessary warnings, and get timely warnings to avoid build failures, as needed.
208200

209201
Accounts with pipelines that do not consume a lot of memory can have higher thresholds, or even the maximum threshold, as they are unikely to hit available memory limits.
210202
Resource-intensive pipelines on the contrary require lower thresholds for timely warnings to prevent build failures. 90% is recommended for such pipelines.
@@ -240,7 +232,7 @@ This behavior is simply a convenience feature for legacy pipelines.
240232
Users can still use a [`push` step]({{site.baseurl}}/docs/pipelines/steps/push/) to always push an image to a registry regardless of what was chosen in the `build` step.
241233
{{site.data.callout.end}}
242234

243-
## Default behavior for `pending-approval` step
235+
## Default behavior for `pending-approval` step
244236
Configure if manual confirmation is required after clicking the Approve or Reject buttons for [pending-approval steps]({{site.baseurl}}/docs/pipelines/steps/approval/). When required, a confirmation prompt is displayed on clicking Approve or Reject.
245237
* **None**: No manual intervention required on clicking either Approve or Reject.
246238
* **All**: Require manual intervention for both Approve and Reject.

0 commit comments

Comments
 (0)