Skip to content

Content qa #1247

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 22 commits into from
Mar 27, 2025
Merged
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions _data/argohub-nav.yml
Original file line number Diff line number Diff line change
@@ -48,10 +48,10 @@
url: "/images"


- title: Platform Installation
- title: GitOps Cloud platform
url: "/platform-installation"
pages:
- title: Installation options
- title: Platform architecture
url: "/installation-options"

- title: GitOps Runtimes
@@ -208,9 +208,9 @@
- title: Products
url: "/products"
pages:
- title: About Products
- title: About products
url: "/about-products"
- title: Create Products
- title: Create products
url: "/create-product"
- title: Configure Product Settings
url: "/configure-product-settings"
@@ -220,7 +220,7 @@
url: "/promotion-version-properties"
- title: Selecting Promotion Flows
url: "/promotion-flow-triggers"
- title: Tracking Releases for Products
- title: Tracking Releases for products
url: "/releases-in-products"

- title: Applications
Original file line number Diff line number Diff line change
@@ -146,11 +146,11 @@ Only account owners can delete the account.
## Related articles
[Adding users and teams]({{site.baseurl}}/docs/administration/account-user-management/add-users/)
[Single sign-on]({{site.baseurl}}/docs/administration/single-sign-on/)
[Codefresh IP addresses]({{site.baseurl}}/docs/administration/platform-ip-addresses/)
[Configuring access control for GitOps]({{site.baseurl}}/docs/administration/account-user-management/gitops-abac/)
{% if page.collection != site.gitops_collection %}
[Configuring access control for pipelines]({{site.baseurl}}/docs/administration/account-user-management/access-control/)
{% endif %}
[Codefresh IP addresses]({{site.baseurl}}/docs/administration/platform-ip-addresses/)
[Configuring access control for GitOps]({{site.baseurl}}/docs/administration/account-user-management/gitops-abac/)



10 changes: 5 additions & 5 deletions _docs/administration/account-user-management/gitops-abac.md
Original file line number Diff line number Diff line change
@@ -46,7 +46,7 @@ For each rule, you must select or define the:
##### How to

1. In the Codefresh UI, on the toolbar, click the **Settings** icon.
1. On the sidebar, from Access & Collaboration, select [**GitOps Permissions**](https://g.codefresh.io/account-admin/permissions/teams){:target="\_blank"}.
1. On the sidebar, from Access & Collaboration, select **GitOps Permissions**.
1. To create a rule, click **Add** and define the following:
* **Entity**: One of the following: {::nomarkdown} <ul><li>GitOps Applications</li><li>Promotion Flows</li><li>Products</li><li>Environments</li></ul>{:/}
* **Team**: The team or teams to which to give access to the selected entity.
@@ -79,7 +79,7 @@ See the documentation for [codefresh_abac_rules](https://registry.terraform.io/p
{: .table .table-bordered .table-hover}
| Applications | Description |
|----------------------------|-----------------------|
|**Actions** | {::nomarkdown}<ul><li><b>Refresh</b>: Allow users to manually regular refresh or hard refresh. The Refresh action is automatically disabled on selecting the Sync action which takes precedence. See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#refreshhard-refresh-applications">Refresh/Hard Refresh applications</a>.</li><li><b>Sync</b>: Allow users to manually sync an application on-demand, and define the options for manual sync.<br>Selecting Sync automatically disables the Refresh action as Sync takes precedence over it. <br> See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#manually-synchronize-an-application">Manually synchronize an application</a>.</li><li><b>Terminate Sync</b>: Allow users to manually stop an ongoing sync for an application. See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#terminate-on-going-application-sync">Terminate on-going application sync</a></li><li><b>Perform application rollback</b>: Allow users to rollback the current release of an application to a previous deployment version or release in Codefresh. See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#rollback-argo-cd-applications">Rollback Argo CD applications</a>.</li><li><b>View pod logs</b>: Allow users to view logs for pod resources of an application in the Current State tab. <br>See <a href="https://codefresh.io/docs/docs/deployments/gitops/monitor-applications/#logs-for-application-resources">Logs for application resources</a>.</li><li><b>Pause rollout</b> and <b>Resume rollout</b>: Allow users to pause an ongoing rollout and resume a paused rollout either directly from the Timeline tab of the application, or through the controls in the Rollout Player. <br>See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#pauseresume-ongoing-rollouts">Pause/resume ongoing rollouts</a> and <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#manage-an-ongoing-rollout-with-the-rollout-player">Managing an ongoing rollout with the Rollout Player</a>.</li><li><b>Promote full rollout</b>: Allow users to use the Promote Full button in the Rollout Player to skip the remaining steps in the rollout and promote to deployment. See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#manage-an-ongoing-rollout-with-the-rollout-player">Managing an ongoing rollout with the Rollout Player</a>.</li><li><b>Skip current step in rollout</b>: Allow users to use the Skip Step button in the Rollout Player to skip executing the current step in the rollout. <br>See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#manage-an-ongoing-rollout-with-the-rollout-player">Managing an ongoing rollout with the Rollout Player</a>.</li><li><b>Abort rollout</b>: Allow users to use the Abort button in the Rollout Player to terminate the current rollout. See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#manage-an-ongoing-rollout-with-the-rollout-player">Managing an ongoing rollout with the Rollout Player</a>.</li><li><b>Retry rollout</b>: Allow users to use the Retry button in the Rollout Player to restart an aborted rollout from the beginning. Available only when a rollout was aborted. See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#manage-an-ongoing-rollout-with-the-rollout-player">Managing an ongoing rollout with the Rollout Player</a>.</li><li><b>Delete resource</b>: Allow users to delete an application resource from the Current State tab. See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#delete-an-application">Delete an application</a>.</li></ul>{:/} |
|**Actions** | {::nomarkdown}<ul><li><b>Refresh</b>: Allow users to manually regular refresh or hard refresh. The Refresh action is automatically disabled on selecting the Sync action which takes precedence. See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#refreshhard-refresh-argo-cd-applications">Refresh/Hard Refresh applications</a>.</li><li><b>Sync</b>: Allow users to manually sync an application on-demand, and define the options for manual sync.<br>Selecting Sync automatically disables the Refresh action as Sync takes precedence over it. <br> See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#manually-sync-an-argo-cd-application">Manually synchronize an application</a>.</li><li><b>Terminate Sync</b>: Allow users to manually stop an ongoing sync for an application. See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#terminate-on-going-sync-for-argo-cd-applications">Terminate on-going application sync</a></li><li><b>Perform application rollback</b>: Allow users to rollback the current release of an application to a previous deployment version or release in Codefresh. See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#rollback-argo-cd-applications">Rollback Argo CD applications</a>.</li><li><b>View pod logs</b>: Allow users to view logs for pod resources of an application in the Current State tab. <br>See <a href="https://codefresh.io/docs/docs/deployments/gitops/monitor-applications/#manifests-logs-and-events-for-application-resources">Logs for application resources</a>.</li><li><b>Pause rollout</b> and <b>Resume rollout</b>: Allow users to pause an ongoing rollout and resume a paused rollout either directly from the Timeline tab of the application, or through the controls in the Rollout Player. <br>See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#pauseresume-ongoing-rollouts">Pause/resume ongoing rollouts</a> and <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#manage-an-ongoing-rollout-with-the-rollout-player">Managing an ongoing rollout with the Rollout Player</a>.</li><li><b>Promote full rollout</b>: Allow users to use the Promote Full button in the Rollout Player to skip the remaining steps in the rollout and promote to deployment. See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#manage-an-ongoing-rollout-with-the-rollout-player">Managing an ongoing rollout with the Rollout Player</a>.</li><li><b>Skip current step in rollout</b>: Allow users to use the Skip Step button in the Rollout Player to skip executing the current step in the rollout. <br>See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#manage-an-ongoing-rollout-with-the-rollout-player">Managing an ongoing rollout with the Rollout Player</a>.</li><li><b>Abort rollout</b>: Allow users to use the Abort button in the Rollout Player to terminate the current rollout. See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#manage-an-ongoing-rollout-with-the-rollout-player">Managing an ongoing rollout with the Rollout Player</a>.</li><li><b>Retry rollout</b>: Allow users to use the Retry button in the Rollout Player to restart an aborted rollout from the beginning. Available only when a rollout was aborted. See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#manage-an-ongoing-rollout-with-the-rollout-player">Managing an ongoing rollout with the Rollout Player</a>.</li><li><b>Delete resource</b>: Allow users to delete an application resource from the Current State tab. See <a href="https://codefresh.io/docs/docs/deployments/gitops/manage-application/#delete-argo-cd-applications">Delete an application</a>.</li></ul>{:/} |
|**Attributes** |Allow access to application entities on a cluster or within a namespace through a single attribute or a combination of attributes.<br>You can also add multiple instances of the same attribute with different values. {::nomarkdown} <ul><li><b>Cluster</b>: Allow access to all application entities in the cluster, regardless of the namespace, Runtime, and Git Sources of specific applications.</li><li><b>Namespace</b>: Allow access to application entities only within the namespace. If users have multiple accounts on different clusters with the same namespace, they can access applications in all those namespaces.</li><li><b>Runtime</b>: Allow access to application entities associated with the defined Runtime.</li><li><b>Git Source</b>: Allow access to application entities only in the defined Git Source. A Git Source is always associated with a Runtime.</li><li><b>Label</b>: Allow access only to application entities that share the same label. For example, add multiple Label attributes with different values to sync application entities.</li></ul>{:/} |

### Examples of rules for application entities
@@ -122,7 +122,7 @@ This rule grants the Support team permission to manually sync application entiti
{: .table .table-bordered .table-hover}
| Environments | Description |
|----------------------------|-----------------------|
| **Actions** |**Promote to this environment**: Allows the following actions: {::nomarkdown}<ul><li>Manually trigger a Promotion Flow. See <a href="https://codefresh.io/docs/docs/promotions/trigger-promotions/#manually-promote-products-to-multiple-environments-by-promotion-flow">Manually trigger a Promotion Flow</a>.</li><li>Use the Promote option in the Product or Environments dashboard to manually promote an application to the desired environment through the desired Promotion Flow. See <a href="https://codefresh.io/docs/docs/promotions/trigger-promotions/#manually-promote-products-to-specific-environments">Manually promote to specific environments</a>.</li><li>Drag-and-drop an application from one environment to another and trigger promotion. See <a href="https://codefresh.io/docs/docs/promotions/trigger-promotions/#manually-trigger-promotions-through-drag-n-drop">Manually trigger promotions through drag-n-drop</a>.</li></ul>{:/} |
| **Actions** |**Promote to this environment**: Allows the following actions: {::nomarkdown}<ul><li>Manually trigger a Promotion Flow. See <a href="https://codefresh.io/docs/docs/promotions/trigger-promotions/#manually-trigger-promotion-flows">Manually trigger a Promotion Flow</a>.</li><li>Use the Promote option in the Product or Environments dashboard to manually promote an application to the desired environment through the desired Promotion Flow. See <a href="https://codefresh.io/docs/docs/promotions/trigger-promotions/#manually-promote-products-to-specific-environments">Manually promote to specific environments</a>.</li><li>Drag-and-drop an application from one environment to another and trigger promotion. See <a href="https://codefresh.io/docs/docs/promotions/trigger-promotions/#manually-trigger-promotions-through-drag-n-drop">Manually trigger promotions through drag-n-drop</a>.</li></ul>{:/} |
|**Attributes** |{::nomarkdown} <ul><li><b>Environment Name</b>: Allow users to promote to all environments that match the name or names. For example, allows users in team <code class="highlighter-rouge">Dev</code> to promote to <code class="highlighter-rouge">dev</code> and <code class="highlighter-rouge">staging</code> environments only.</li><li><b>Environment Kind</b>: Allow users to promote to only the specified type of environment, either <code class="highlighter-rouge">production</code> or <code class="highlighter-rouge">non-production</code>. </li></ul>{:/} |

### Examples of rules for environment entities
@@ -165,7 +165,7 @@ This rule grants broader manual promotion privileges to specific non-production
{: .table .table-bordered .table-hover}
| Products | Description |
|----------------------------|-----------------------|
|**Actions** |{::nomarkdown}<ul><li><b>Trigger promotion</b>: Allow users to manually trigger a Promotion Flow. See <a href="https://codefresh.io/docs/docs/promotions/trigger-promotions/#manually-promote-products-to-multiple-environments-by-promotion-flow">Manually trigger a Promotion Flow</a>.</li><li><b>Retry failed release</b>: Allow users to restart a failed release from the point of failure. See <a href="https://codefresh.io/docs/docs/promotions/product-releases/#retry-a-failed-release">Retry a failed release</a>.</li></ul>{:/} |
|**Actions** |{::nomarkdown}<ul><li><b>Trigger promotion</b>: Allow users to manually trigger a Promotion Flow. See <a href="https://codefresh.io/docs/docs/promotions/trigger-promotions/#manually-trigger-promotion-flows">Manually trigger a Promotion Flow</a>.</li><li><b>Retry failed release</b>: Allow users to restart a failed release from the point of failure. See <a href="https://codefresh.io/docs/docs/promotions/product-releases/#retry-a-failed-release">Retry a failed release</a>.</li></ul>{:/} |
|**Attributes** |{::nomarkdown} <ul><li><b>Label</b>: Allow users to trigger promotions or to retry failed releases only for products that match the specified labels. For example, allow users in team <code class="highlighter-rouge">DevOps</code> to promote products with the label <code class="highlighter-rouge">hotfix</code>. See <a href="https://codefresh.io/docs/docs/products/configure-product-settings/#configure-labels">Configuring labels in Product Settings</a> </li><li><b>Product Name</b>: Allow users to trigger promotions or to retry failed releases only for products that match the specified names. For example, allow users in team <code class="highlighter-rouge">Dev</code> to promote products with the name <code class="highlighter-rouge">Marvel</code>. </li></ul>{:/} |


@@ -219,7 +219,7 @@ This rule grants manual promotion privileges to specific products that match a s
{: .table .table-bordered .table-hover}
| Promotion Flows | Description |
|----------------------------|-----------------------|
|**Actions** | **Trigger promotion flow**: Allow users to manually trigger a Promotion Flow. See <a href="https://codefresh.io/docs/docs/promotions/trigger-promotions/#manually-promote-products-to-multiple-environments-by-promotion-flow">Manually trigger a Promotion Flow</a>.</li>|
|**Actions** | **Trigger promotion flow**: Allow users to manually trigger a Promotion Flow. See <a href="https://codefresh.io/docs/docs/promotions/trigger-promotions/#manually-promote-products-to-multiple-environments-by-promotion-flow">Manually trigger a Promotion Flow</a>.|
|**Attributes** | **Label**: Allow users to trigger promotions for Promotion Flows that match the specified label in the YAML manifest. |


Original file line number Diff line number Diff line change
@@ -29,4 +29,4 @@ max-width="70%"
%}

## Related articles
[Connect Git provider]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/#2-connect-git-provider)
[Setting up OAuth2 for GitOps]({{site.baseurl}}/docs/administration/account-user-management/oauth-setup/)
Loading