ecea15c508
* Unify ansible-galaxy install -r * Minor nit fixes for docs * Re-align warnings * Fix up integration test * Fix up test where no roles/collections were in file
47 lines
1.6 KiB
Text
47 lines
1.6 KiB
Text
|
|
You can also setup a ``requirements.yml`` file to install multiple collections in one command. This file is a YAML file in the format:
|
|
|
|
.. code-block:: yaml+jinja
|
|
|
|
---
|
|
collections:
|
|
# With just the collection name
|
|
- my_namespace.my_collection
|
|
|
|
# With the collection name, version, and source options
|
|
- name: my_namespace.my_other_collection
|
|
version: 'version range identifiers (default: ``*``)'
|
|
source: 'The Galaxy URL to pull the collection from (default: ``--api-server`` from cmdline)'
|
|
|
|
The ``version`` key can take in the same range identifier format documented above.
|
|
|
|
Roles can also be specified and placed under the ``roles`` key. The values follow the same format as a requirements
|
|
file used in older Ansible releases.
|
|
|
|
.. code-block:: yaml
|
|
|
|
---
|
|
roles:
|
|
# Install a role from Ansible Galaxy.
|
|
- name: geerlingguy.java
|
|
version: 1.9.6
|
|
|
|
collections:
|
|
# Install a collection from Ansible Galaxy.
|
|
- name: geerlingguy.php_roles
|
|
version: 0.9.3
|
|
source: https://galaxy.ansible.com
|
|
|
|
To install both roles and collections at the same time with one command, run the following:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ ansible-galaxy install -r requirements.yml
|
|
|
|
Running ``ansible-galaxy collection install -r`` or ``ansible-galaxy role install -r`` will only install collections,
|
|
or roles respectively.
|
|
|
|
.. note::
|
|
Installing both roles and collections from the same requirements file will not work when specifying a custom
|
|
collection or role install path. In this scenario the collections will be skipped and the command will process
|
|
each like ``ansible-galaxy role install`` would.
|