Skip to content

Commit dfd2955

Browse files
authored
Feature flag bug update (#869)
* Update on-prem-feature-management.md * Update on-prem-feature-management.md Added section on system features * Update on-prem-feature-management.md Added section on System Featues and xref to section in on-prem config tasks * Update on-prem-feature-management.md * Update on-prem-feature-management.md
1 parent 0653de1 commit dfd2955

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

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

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,14 @@ Review the [feature list](#on-premises-feature-list) to understand the implicati
3434
max-width="60%"
3535
%}
3636

37+
## System Features
38+
System Features are generally only for internal use, and should not be changed. For more information, see [Enable System Features]({{site.baseurl}}/docs/installation/on-premises/on-prem-configuration/#enable-system-features).
39+
40+
>**IMPORTANT:**
41+
>Codefresh _strongly recommends against enabling System Features_ unless you are familiar with the implications of turning on a System Feature.
42+
>If you need to turn on a System Feature, we recommend to first contact Codefresh support.
43+
44+
3745

3846
## On-premises feature list
3947

@@ -53,28 +61,33 @@ The table describes the features you can open for Codefresh accounts, in alphabe
5361
{: .table .table-bordered .table-hover}
5462
| Feature | Description | Default |
5563
| -------------- | -------------- | ------- |
56-
| `abacHermesTriggers` | When enabled, restricts access to the legacy version of Cron triggers for users without permissions to edit pipelines.| FALSE |
64+
| `abacAndRule` | When enabled, supports creating ABAC rules for entities in Codefresh pipelines using "AND". <br>See [Configuring rules for access control in pipelines]({{site.baseurl}}/docs/administration/account-user-management/access-control/#rules-for-access-control).| TRUE |
65+
|`abacHermesTriggers` | When enabled, restricts access to the legacy version of Cron triggers for users without permissions to edit pipelines.| FALSE |
5766
| `accountInfoCopyButton` | When enabled (the default), the account ID is added to the URL. When sharing the URL with the account information, recipients can seamlessly switch accounts. | TRUE |
5867
| `accessibilityContrast` | When enabled, displays an icon in the Codefresh toolbar allowing you to control the contrast by selecting the option that best suits the logged in user:{::nomarkdown}<ul><li><b>Invert colors</b> and <b>Bold colors (saturate)</b>: Optimized for visually impaired users.</li><li><b>Smart Contrast</b>: Increases the contrast between the text and the background to the maximum possible.</li></ul>{:/}| FALSE |
5968
|`allowUserUpdateBoards`| When enabled, allows users without admin roles to update Helm boards. Users can install, promote, create, and update sections.<br>See [Promoting Helm environments]({{site.baseurl}}/docs/deployments/helm/helm-environment-promotion/). |FALSE |
60-
| `cronTriggersInPipelineSpec` | When enabled, allows users to define Cron triggers in the pipeline YAMLs as a `spec.cronTriggers` array, instead of using a separate API.<br>See [Cron trigger specifications]({{site.baseurl}}/docs/integrations/codefresh-api/#cron-triggers). | FALSE |
69+
| `cronTriggersInPipelineSpec` | When enabled, allows users to define Cron triggers in the pipeline YAMLs as a `spec.cronTriggers` array, instead of using a separate API.<br>See [Cron trigger specifications]({{site.baseurl}}/docs/integrations/codefresh-api/#cron-triggers). | TRUE |
70+
|`csdpFilterAppsByGitPermissions` | When enabled (the default), does not display the Git Sources and the Argo CD applications committed to these Git Sources for users without Git permissions or Git credentials for the same. <!--- add ref --> | FALSE |
6171
|`dindPodRequestsEqualLimits` | When enabled, sets both the resource requests and limits for the pod to the same values.|FALSE |
6272
|`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|
6373
|`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 |
6474
| `disableInviteWelcomeMail` | When enabled, does not send the Welcome email to users invited to an account. | FALSE |
6575
|`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|
76+
| `genAICronExpression` | When enabled, supports generating Cron expressions in the Codefresh UI using Generative AI.| FALSE |
6677
|`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 |
6778
|`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 |
68-
| `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/). | FALSE |
79+
| `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 |
6980
|`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 |
81+
| `hideCompositionsMenuItem` | When enabled, does not show Compositions within Artifacts & Insights in the sidebar of the Codefresh UI. | FALSE |
7082
|`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/#enabling-cluster-contexts-for-pipelines). | FALSE|
7183
|`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|
72-
|`nextGenTerminal`| When enabled, uses the new terminal emulator for improved performance, online rendering for large logs (up to 100,000 lines), search functionality, and Screen Reader support for accessibility.| FALSE|
7384
|`parallelKubectlOperations` |When enabled, allows running parallel steps that includes `kubectl`. Especially Helm `install` and `deploy` steps that deploy to multiple clusters with `kubectl` in parallel. |FALSE|
74-
| `pipelineScopes` | When enabled, enables Codefresh administrators to configure the API scopes for pipelines at account level. All pipelines in the account inherit these scopes. Codefresh administrators can also override these scopes for individual pipelines.<br>See [Configure pipeline scopes]({{site.baseurl}}/docs/pipelines/configuration/pipeline-settings/#configure-pipeline-scopes). | FALSE |
85+
| `pipelineScopes` | When enabled, enables Codefresh administrators to configure the API scopes for pipelines at account level. All pipelines in the account inherit these scopes. Codefresh administrators can also override these scopes for individual pipelines.<br>See [Configure pipeline scopes]({{site.baseurl}}/docs/pipelines/configuration/pipeline-settings/#configure-pipeline-scopes). | TRUE |
7586
|`supportGerrit` | When enabled, adds the capability to connect to Gerrit as a Git provider. <br>See [Gerrit as Git provider for pipelines]({{site.baseurl}}/docs/integrations/git-providers/#gerrit). | FALSE |
7687
|`supportOpenIdConnectInBuilds`| When enabled (the default), supports OIDC in pipeline builds, including obtaining and using ID tokens to authenticate and authorize pipeline actions on cloud providers.<br>See [OpenID Connect for pipeline integrations]({{site.baseurl}}/docs/integrations/oidc-pipelines/). |TRUE|
77-
|`useLogsTimestamps` |When enabled, prepends the date and time to every line in the log. <br><br>When enabled, and you have build automation, you may need to adjust the regex for search as the line does not start with the log text.| FALSE|
88+
| `stepTimeout` | When enabled (the default), allows you to add the `timeout` flag with the `<duration>` and `<units>` to steps in pipelines. When added, the step terminates execution automatically if the step exceeds the duration of the specified timeout.<br> See [Steps in pipelines]({{site.baseurl}}/docs/pipelines/steps/) and browse the Field descriptions for any step type that is supported, [git-clone]({{site.baseurl}}/docs/pipelines/steps/git-clone/#fields) for example. | TRUE |
89+
|`useLogsTimestamps` |When enabled, prepends the date and time to every line in the log. <br>This flag must be enabled to share URL for build logs.<br>When enabled, and you have build automation, you may need to adjust the regex for search as the line does not start with the log text.| FALSE|
90+
| `useRepoAndBranchesNextPagination` | When enabled, when adding Triggers to pipeline workflows, the **Repository** dropdown displays repositories and branches in paginated format, with the Next button for navigating between pages. | FALSE |
7891

7992

8093

0 commit comments

Comments
 (0)