Skip to content

Update doc about Create Approval Permission #1797

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: PE
Choose a base branch
from
Open

Update doc about Create Approval Permission #1797

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 11 additions & 5 deletions en/developer-docs/docs/administer/configure-approvals-for-choreo-workflows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,16 @@ Choreo allows you to configure approval processes for specific workflows within

Choreo currently allows you to configure approvals for environment promotion and API subscription workflows.

Configuring approvals for environment promotion allows authorized users to control components being promoted to a critical/production environment.
Configuring approvals for environment promotion allows authorized users to control components being promoted to a critical/production environment.

Configuring approvals for the API subscription workflow allows you to create subscription plans that require approval before being activated. This feature allows you to control access to APIs by requiring administrative review and authorization of subscriptions before they become active.

## Permissions to create approval requests

=== "Environment promotion"

To submit an environment promotion approval request, a user must have required permissions to promote components or at least `WORKFLOW-MANAGEMENT >> Create approval requests` permission

## Permissions to review and respond to approval requests

Click the respective tab for details on permissions depending on the workflow for which you want to configure approvals:
Expand All @@ -16,7 +22,7 @@ Click the respective tab for details on permissions depending on the workflow fo

To review and respond to environment promotion approval requests, a user must have the following permissions. Administrators must ensure that users designated to review and respond to approval requests have these permissions:

- **WORKFLOW-MANAGEMENT**:
- **WORKFLOW-MANAGEMENT**:
- Approve component promotion requests: Grants access to review and approve the promotion of components to critical environments.
- **PROJECT-MANAGEMENT**: Grants access to view and approve workflow requests. This is the same permission used to update or delete projects.

Expand All @@ -26,7 +32,7 @@ Click the respective tab for details on permissions depending on the workflow fo

- **WORKFLOW-MANAGEMENT**:
- Approve API subscriptions: Grants access to review and approve API subscription workflow requests.
- **PROJECT-MANAGEMENT**:
- **PROJECT-MANAGEMENT**:
Grants access to view and approve workflow requests. This is the same permission used to update or delete projects.

## Set up an approval process for a workflow
Expand All @@ -49,10 +55,10 @@ To set up an approval process for a workflow, follow these steps:

!!! info "Important"
Currently, there is no validation to ensure that the specified roles and assignees have the necessary permissions to review and respond to requests. If the [required permissions](#permissions-to-review-and-respond-to-approval-requests) are not correctly configured, some users may receive email notifications but will be unable to review the requests.

7. Click **Save**. This configures and enables the approval process for the workflow.

Once you enable the approval process for a workflow, see the following details on how to submit a request for approval and the approval process. Click the respective tab depending on the workflow for which you enabled the approval process:
Once you enable the approval process for a workflow, see the following details on how to submit a request for approval and the approval process. Click the respective tab depending on the workflow for which you enabled the approval process:

=== "Environment promotion"

Expand Down
3 changes: 3 additions & 0 deletions en/developer-docs/docs/administer/review-workflow-approval-requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,6 @@ To approve or reject a request, follow these steps:
Alternatively, click the Choreo Console link in the approval request email notification you received. This takes you to the request details in the Choreo Console.
2. Review the request and click **Approve** or **Reject** based on your decision.

!!! note
- An email will be sent to requestor mentioning details about the details
- Currently, approver or other approvers will not receive an email, however action is recorded at Choreo databases.
5 changes: 3 additions & 2 deletions ...er-docs/docs/develop-components/submit-and-manage-workflow-approval-requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@ In Choreo, if an administrator [configures a workflow to require approval](../ad

Upon submitting a workflow approval request, Choreo notifies all authorized assignees via email about the [review request](../administer/review-workflow-approval-requests.md). When an authorized assignee approves or rejects the request, you will receive an email with details of the decision.

The approach to request approval can vary depending on the workflow.
The approach to request approval can vary depending on the workflow.

## Request approval for environment promotion

**Prerequisites**:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Prerequisites**:
###Prerequisites


- Ensure you have a component created, built, and deployed to the development environment.
- Ensure that an approval workflow is configured for environment promotion.
- Ensure you need to have required permissions to promote components or `WORKFLOW-MANAGEMENT >> Create approval requests` permission
- Ensure you are promoting the component to a critical environment, such as production.

To request approval to promote a component from the development environment to production, follow these steps:
Expand All @@ -29,6 +30,6 @@ When an authorized assignee approves the request, you will receive a confirmatio

## Cancel a workflow approval request

If you want to cancel a workflow approval request that is already submitted, you can do so before the request is approved or rejected.
If you want to cancel a workflow approval request that is already submitted, you can do so before the request is approved or rejected.

When you submit a workflow approval request, the **Request to Promote** button changes to **Cancel Request**. To cancel an approval request, click **Cancel Request**. Upon confirming the cancellation, all configured approvers are notified immediately, and the request will no longer be pending.