summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlanCoding <arominge@redhat.com>2019-07-23 22:01:42 +0200
committerAlanCoding <arominge@redhat.com>2019-09-16 20:51:53 +0200
commite8581f6892118e28b3a7483fc6a717a8ba53bf26 (patch)
treebe27b5730f2e52db2d957e306efee2f8c565cf55 /docs
parentMerge pull request #4752 from shanemcd/drop-pg-scl (diff)
downloadawx-e8581f6892118e28b3a7483fc6a717a8ba53bf26.tar.xz
awx-e8581f6892118e28b3a7483fc6a717a8ba53bf26.zip
Implement WFJT prompting for limit & scm_branch
add feature to UI and awxkit restructure some details of create_unified_job for workflows to allow use of char_prompts hidden field avoid conflict with sliced jobs in char_prompts copy logic update developer docs update migration reference bump migration
Diffstat (limited to 'docs')
-rw-r--r--docs/prompting.md7
-rw-r--r--docs/workflow.md9
2 files changed, 10 insertions, 6 deletions
diff --git a/docs/prompting.md b/docs/prompting.md
index ebb9c89d8f..926788dcea 100644
--- a/docs/prompting.md
+++ b/docs/prompting.md
@@ -59,7 +59,7 @@ actions in the API.
- POST to `/api/v2/job_templates/N/launch/`
- can accept all prompt-able fields
- POST to `/api/v2/workflow_job_templates/N/launch/`
- - can accept extra_vars and inventory
+ - can accept certain fields, see `workflow.md`
- POST to `/api/v2/system_job_templates/N/launch/`
- can accept certain fields, with no user configuration
@@ -174,7 +174,7 @@ job. If a user creates a node that would do this, a 400 response will be returne
Workflow JTs are different than other cases, because they do not have a
template directly linked, so their prompts are a form of action-at-a-distance.
-When the node's prompts are gathered, any prompts from the workflow job
+When the node's prompts are gathered to spawn its job, any prompts from the workflow job
will take precedence over the node's value.
As a special exception, `extra_vars` from a workflow will not obey JT survey
@@ -182,8 +182,7 @@ and prompting rules, both both historical and ease-of-understanding reasons.
This behavior may change in the future.
Other than that exception, JT prompting rules are still adhered to when
-a job is spawned, although so far this only applies to the workflow job's
-`inventory` field.
+a job is spawned.
#### Job Relaunch and Re-scheduling
diff --git a/docs/workflow.md b/docs/workflow.md
index 3ccfb7d367..e01acf2e76 100644
--- a/docs/workflow.md
+++ b/docs/workflow.md
@@ -8,7 +8,7 @@ A workflow has an associated tree-graph that is composed of multiple nodes. Each
### Workflow Create-Read-Update-Delete (CRUD)
Like other job resources, workflow jobs are created from workflow job templates. The API exposes common fields similar to job templates, including labels, schedules, notification templates, extra variables and survey specifications. Other than that, in the API, the related workflow graph nodes can be gotten to via the related workflow_nodes field.
-The CRUD operations against a workflow job template and its corresponding workflow jobs are almost identical to those of normal job templates and related jobs. However, from an RBAC perspective, CRUD on workflow job templates/jobs are limited to super users.
+The CRUD operations against a workflow job template and its corresponding workflow jobs are almost identical to those of normal job templates and related jobs.
By default, organization administrators have full control over all workflow job templates under the same organization, and they share these abilities with users who have the `workflow_admin_role` in that organization. Permissions can be further delegated to other users via the workflow job template roles.
@@ -20,7 +20,12 @@ Workflow job template nodes are listed and created under endpoint `/workflow_job
#### Workflow Launch Configuration
Workflow job templates can contain launch configuration items. So far, these only include
-`extra_vars` and `inventory`, and the `extra_vars` may have specifications via
+ - `extra_vars`
+ - `inventory`
+ - `limit`
+ - `scm_branch`
+
+The `extra_vars` field may have specifications via
a survey, in the same way that job templates work.
Workflow nodes may also contain the launch-time configuration for the job it will spawn.