fefab89815
Revert the --force flags use the update id as metric for role caching Shift the movement of cache to job folder from rsync task to python Only install roles and collections if needed Deal with roles and collections for jobs without sync Skip local copy if roles or collections turned off update docs for content caching Design pivot - use empty cache dir to indicate lack of content Do not cache content if we did not install content Test changes to allay concerns about reliability of local_path Do not blow away cache for SCM inventory updates
4.4 KiB
Collections
AWX supports the use of Ansible Collections. This section will give ways to use Collections in job runs.
Project Collections Requirements
If you specify a collections requirements file in SCM at collections/requirements.yml,
then AWX will install collections from that file to a special cache folder in project updates.
Before a job runs, the roles and/or collections will be copied from the special
cache folder to the job temporary folder.
The invocation looks like:
ansible-galaxy collection install -r requirements.yml -p <project cache location>/requirements_collections
Example of the resultant job tmp directory where job is running:
├── project
│ ├── ansible.cfg
│ └── debug.yml
├── requirements_collections
│ └── ansible_collections
│ └── collection_namespace
│ └── collection_name
│ ├── FILES.json
│ ├── MANIFEST.json
│ ├── README.md
│ ├── roles
│ │ ├── role_in_collection_name
│ │ │ ├── defaults
│ │ │ │ └── main.yml
│ │ │ ├── tasks
│ │ │ │ └── main.yml
│ │ │ └── templates
│ │ │ └── stuff.j2
│ └── tests
│ └── main.yml
├── requirements_roles
│ └── username.role_name
│ ├── defaults
│ │ └── main.yml
│ ├── meta
│ │ └── main.yml
│ ├── README.md
│ ├── tasks
│ │ ├── main.yml
│ │ └── some_role.yml
│ ├── templates
│ │ └── stuff.j2
│ └── vars
│ └── Archlinux.yml
└── tmp_6wod58k
Cache Folder Mechanics
Every time a project is updated as a "check" job
(via /api/v2/projects/N/update/ or by a schedule, workflow, etc.),
the roles and collections are downloaded and saved to the project's content cache.
In other words, the cache is invalidated every time a project is updated.
That means that the ansible-galaxy commands are ran to download content
even if the project revision does not change in the course of the update.
Project updates all initially target a staging directory at a path like:
/var/lib/awx/projects/.__awx_cache/_42__project_name/stage
After the update finishes, the task logic will decide what id to associate with the content downloaded. Then the folder will be renamed from "stage" to the cache id. For instance, if the cache id is determined to be 63:
/var/lib/awx/projects/.__awx_cache/_42__project_name/63
The cache may be updated by project syncs (the "run" type) which happen before job runs. It will populate the cache id set by the last "check" type update.
Galaxy Server Selection
Ansible core default settings will download collections from the public
Galaxy server at https://galaxy.ansible.com. For details on
how Galaxy servers are configured in Ansible in general see:
https://docs.ansible.com/ansible/devel/user_guide/collections_using.html (if "devel" link goes stale in the future, it is for Ansible 2.9)
You can set a different server to be the primary Galaxy server to download
roles and collections from in AWX project updates.
This is done via the setting PRIMARY_GALAXY_URL and similar
PRIMARY_GALAXY_xxxx settings for authentication.
If the PRIMARY_GALAXY_URL setting is not blank, then the server list is defined
to be primary_galaxy,galaxy. The primary_galaxy server definition uses the URL
from those settings, as well as username, password, and/or token and auth_url if applicable.
the galaxy server definition uses public Galaxy (https://galaxy.ansible.com)
with no authentication.
This configuration causes requirements to be downloaded from the user-specified primary galaxy server if they are available there. If a requirement is not available from the primary galaxy server, then it will fallback to downloading it from the public Galaxy server.
Even when these settings are enabled, this can still be bypassed for a specific
requirement by using the source: option, as described in Ansible documentation.