External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-05-12 11:57:37 -02:30
Code Issues Packages Projects Releases Wiki Activity

Update AWX docs to include info about wf approvals

Browse Source
This commit is contained in:
beeankha
2019-08-19 14:45:26 -04:00
committed by Ryan Petrello
parent aab04bcbb1
commit 9bbc14c5a1
2 changed files with 28 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
awx/main/access.py
View File

@@ -2781,7 +2781,7 @@ class RoleAccess(BaseAccess):
class WorkflowApprovalAccess(BaseAccess): class WorkflowApprovalAccess(BaseAccess):
''' '''
A user can create an workflow approval if they are a superuser, an org admin A user can create a workflow approval if they are a superuser, an org admin
of the org connected to the workflow, or if they are assigned as admins to of the org connected to the workflow, or if they are assigned as admins to
the workflow. the workflow.
@@ -2817,7 +2817,7 @@ class WorkflowApprovalAccess(BaseAccess):
class WorkflowApprovalTemplateAccess(BaseAccess): class WorkflowApprovalTemplateAccess(BaseAccess):
''' '''
A user can create an approval template if they are a superuser, an org admin A user can create a workflow approval if they are a superuser, an org admin
of the org connected to the workflow, or if they are assigned as admins to of the org connected to the workflow, or if they are assigned as admins to
the workflow. the workflow.

26
docs/workflow.md
View File

@@ -54,6 +54,32 @@ In the event that spawning the workflow would result in recursion, the child wor
will be marked as failed with a message explaining that recursion was detected. will be marked as failed with a message explaining that recursion was detected.
This is to prevent saturation of the task system with an infinite chain of workflows. This is to prevent saturation of the task system with an infinite chain of workflows.
#### Workflow Approval Nodes
The workflow approval node feature enables users to add steps in a workflow in between nodes within workflows so that a user (as long as they have approval permissions, explained in further detail below) can give the "yes" or "no" to continue on to the next step in the workflow.
**RBAC Setup for Workflow Approval Nodes**
A user can _create_ a workflow approval if they are:
- a Superuser
- an Org Admin of the organization connected to the workflow
- a Workflow Admin in the organization connected to the workflow
- assigned as admins to a particular workflow
A user can _approve_ a workflow when they are:
- a Superuser
- a Workflow Admin
- an Organization Admin
- any user who has explicitly been assigned the "approver" role
A user can _view_ approvals if they:
- have Read access to the associated Workflow Job Template
**Other Workflow Approval Node Features**
A timeout can be set for each approval node. This field defaults to `0` for no expiration.
### DAG Formation and Restrictions ### DAG Formation and Restrictions
The DAG structure of a workflow is enforced by associating workflow job template nodes via endpoints `/workflow_job_template_nodes/\d+/*_nodes/`, where `*` has options `success`, `failure` and `always`. There is one restriction that is enforced when setting up new connections and that is the cycle restriction, since it's a DAG. The DAG structure of a workflow is enforced by associating workflow job template nodes via endpoints `/workflow_job_template_nodes/\d+/*_nodes/`, where `*` has options `success`, `failure` and `always`. There is one restriction that is enforced when setting up new connections and that is the cycle restriction, since it's a DAG.