e40889e711
* Enable installing collections from git repositories * Add tests for installing individual and multiple collections from git repositories * Test to make sure recursive dependencies with different syntax are deduplicated * Add documentation * add a changelog * Skip Python 2.6 * Only fail if no collections are located in a git repository Add support for a 'type' key for collections in requirement.yml files. Update the changelog and document the supported keys and allowed values for the type. Add a note that the collection(s) in the repo must contain a galaxy.yml * Add a warning about embedding credentials in SCM URLs * Update with review suggestions * suppress sanity compile failure for Python 2.6
51 lines
2.1 KiB
Text
51 lines
2.1 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 supported keys for collection requirement entries are ``name``, ``version``, ``source``, and ``type``.
|
|
|
|
The ``version`` key can take in the same range identifier format documented above. If you're installing a collection from a git repository instead of a built collection artifact, the ``version`` key refers to a `git commit-ish <https://git-scm.com/docs/gitglossary#def_commit-ish>`_.
|
|
|
|
The ``type`` key can be set to ``galaxy``, ``url``, ``file``, and ``git``. If ``type`` is omitted, the ``name`` key is used to implicitly determine the source of the collection.
|
|
|
|
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.
|