awx/docs/collections.md
Bill Nottingham 0fb7c859f4 Revert 9b95cc27c4840140996a036223e2909a30953b95.
We do not want to create a new setting for a on-Tower-host global
collection path at this time.
2019-09-04 11:43:33 -04:00

56 lines
1.8 KiB
Markdown

## Collections
AWX supports using 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 in that file in the implicit project sync
before a job run. The invocation is:
```
ansible-galaxy collection install -r requirements.yml -p <job tmp location>
```
Example of tmp directory where job is running:
```
├── project
│   ├── ansible.cfg
│   └── debug.yml
├── requirements_collections
│   └── ansible_collections
│   └── username
│   └── 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
```