mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
106 lines
2.7 KiB
ReStructuredText
106 lines
2.7 KiB
ReStructuredText
|
|
.. _collections:
|
|
|
|
*****************
|
|
Using collections
|
|
*****************
|
|
|
|
Collections are a distribution format for Ansible content that can include playbooks, roles, modules, and plugins.
|
|
You can install and use collections through `Ansible Galaxy <https://galaxy.ansible.com>`_.
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 2
|
|
|
|
.. _collections_installing:
|
|
|
|
Installing collections
|
|
======================
|
|
|
|
.. include:: ../shared_snippets/installing_collections.txt
|
|
|
|
.. _collections_older_version:
|
|
|
|
Installing an older version of a collection
|
|
-------------------------------------------
|
|
|
|
.. include:: ../shared_snippets/installing_older_collection.txt
|
|
|
|
.. _collection_requirements_file:
|
|
|
|
Install multiple collections with a requirements file
|
|
-----------------------------------------------------
|
|
|
|
.. include:: ../shared_snippets/installing_multiple_collections.txt
|
|
|
|
|
|
.. _galaxy_server_config:
|
|
|
|
Galaxy server configuration list
|
|
--------------------------------
|
|
|
|
.. include:: ../shared_snippets/galaxy_server_list.txt
|
|
|
|
|
|
.. _using_collections:
|
|
|
|
Using collections in a Playbook
|
|
===============================
|
|
|
|
Once installed, you can reference a collection content by its fully qualified collection name (FQCN):
|
|
|
|
.. code-block:: yaml
|
|
|
|
- hosts: all
|
|
tasks:
|
|
- my_namespace.my_collection.mymodule:
|
|
option1: value
|
|
|
|
This works for roles or any type of plugin distributed within the collection:
|
|
|
|
.. code-block:: yaml
|
|
|
|
- hosts: all
|
|
tasks:
|
|
- import_role:
|
|
name: my_namespace.my_collection.role1
|
|
|
|
- my_namespace.mycollection.mymodule:
|
|
option1: value
|
|
|
|
- debug:
|
|
msg: '{{ lookup("my_namespace.my_collection.lookup1", 'param1')| my_namespace.my_collection.filter1 }}'
|
|
|
|
|
|
To avoid a lot of typing, you can use the ``collections`` keyword added in Ansible 2.8:
|
|
|
|
|
|
.. code-block:: yaml
|
|
|
|
- hosts: all
|
|
collections:
|
|
- my_namespace.my_collection
|
|
tasks:
|
|
- import_role:
|
|
name: role1
|
|
|
|
- mymodule:
|
|
option1: value
|
|
|
|
- debug:
|
|
msg: '{{ lookup("my_namespace.my_collection.lookup1", 'param1')| my_namespace.my_collection.filter1 }}'
|
|
|
|
This keyword creates a 'search path' for non namespaced plugin references. It does not import roles or anything else.
|
|
Notice that you still need the FQCN for non-action or module plugins.
|
|
|
|
.. seealso::
|
|
|
|
:ref:`developing_collections`
|
|
Develop or modify a collection.
|
|
:ref:`collections_galaxy_meta`
|
|
Understand the collections metadata structure.
|
|
`Mailing List <https://groups.google.com/group/ansible-devel>`_
|
|
The development mailing list
|
|
`irc.freenode.net <http://irc.freenode.net>`_
|
|
#ansible IRC chat channel
|