summaryrefslogtreecommitdiffstats
path: root/docs/execution_environments.md
diff options
context:
space:
mode:
authorAlan Rominger <arominge@redhat.com>2021-06-16 20:24:48 +0200
committerAlan Rominger <arominge@redhat.com>2021-06-16 20:24:48 +0200
commit52d6f36b7ca5cb6572e3ea6266a99fd3b6887bd8 (patch)
treed0b7184bb02e4b8187338adf91ece40898214307 /docs/execution_environments.md
parentUpdate and expand docs/ folder for EEs (diff)
downloadawx-52d6f36b7ca5cb6572e3ea6266a99fd3b6887bd8.tar.xz
awx-52d6f36b7ca5cb6572e3ea6266a99fd3b6887bd8.zip
Incorporate review comments about EE docs
Diffstat (limited to 'docs/execution_environments.md')
-rw-r--r--docs/execution_environments.md24
1 files changed, 13 insertions, 11 deletions
diff --git a/docs/execution_environments.md b/docs/execution_environments.md
index 47a422f766..c6c2e032d2 100644
--- a/docs/execution_environments.md
+++ b/docs/execution_environments.md
@@ -11,10 +11,11 @@ The job details view will link to the execution environment that the job uses.
## Creating and using EEs
-Users with and organization's `execution_environment_admin_role` can create new EEs in that organization.
+Users with an organization's `execution_environment_admin_role` can create new EEs in that organization.
The RBAC rules follow standard rules for org-scoped resources.
-Only superusers can create global EEs (null organization).
+EEs without an organization (value is null in the API) are global EEs.
+Only superusers can create global EEs.
These can become the global job default in certain circumstances.
### Pre-created EEs
@@ -26,7 +27,7 @@ the system with some EEs defined in settings. This will create:
- global job EEs - all images enumerated in the `GLOBAL_JOB_EXECUTION_ENVIRONMENTS` setting
These EEs are critical for system function, so this command must be ran for AWX to be functional.
-All EEs created by this command are global (do not belong to an organization).
+All EEs created by this command are global EEs.
### Project Update EE Precedence
@@ -40,15 +41,11 @@ Jobs will use the first available execution environment in this list:
2. the `default_environment` defined on the project that the job uses
3. the `default_environment` defined on the organization of the job (a direct API field)
4. the `default_environment` defined on the organization of the inventory the job uses
-5. the global job default EE
+5. the current `DEFAULT_EXECUTION_ENVIRONMENT` setting
+6. Any images from the `GLOBAL_JOB_EXECUTION_ENVIRONMENTS` setting
+7. Any other global EEs (null organization)
-This global default job default EE will be the first available out of:
-
-1. the `DEFAULT_EXECUTION_ENVIRONMENT` setting
-2. Any images from the `GLOBAL_JOB_EXECUTION_ENVIRONMENTS` setting
-3. Any other global EEs (null organization)
-
-If more than 1 EE fits these criteria, then the most recently created one will be used.
+If more than one EE fits a criteria (applies for 5 and 6), then the most recently created one will be used.
## Migrating from Custom Virtual Environments
@@ -59,3 +56,8 @@ dependencies out of the venvs and into EEs.
- `awx-manage list_custom_venvs`
- `awx-manage custom_venv_associations`
- `awx-manage export_custom_venv`
+
+Follow those in order, and read the help text to see what arguments are necessary.
+
+You may wish to save the output from export_custom_venv command to a file with the `-q`
+option, and then this can be a starting point for writing `ansible-builder` definition files.