|
|
|
@ -13,6 +13,8 @@ You can publish and use collections through `Ansible Galaxy <https://galaxy.ansi
|
|
|
|
|
:local:
|
|
|
|
|
:depth: 2
|
|
|
|
|
|
|
|
|
|
.. _collection_structure:
|
|
|
|
|
|
|
|
|
|
Collection structure
|
|
|
|
|
====================
|
|
|
|
|
|
|
|
|
@ -45,6 +47,7 @@ and other tools need in order to package, build and publish the collection::
|
|
|
|
|
* See the `draft collection <https://github.com/bcoca/collection>`_ for an example of a full collection structure.
|
|
|
|
|
* Not all directories are currently in use. Those are placeholders for future features.
|
|
|
|
|
|
|
|
|
|
.. _galaxy_yml:
|
|
|
|
|
|
|
|
|
|
galaxy.yml
|
|
|
|
|
----------
|
|
|
|
@ -52,6 +55,7 @@ galaxy.yml
|
|
|
|
|
A collection must have a ``galaxy.yml`` file that contains the necessary information to build a collection artifact.
|
|
|
|
|
See :ref:`collections_galaxy_meta` for details.
|
|
|
|
|
|
|
|
|
|
.. _collections_doc_dir:
|
|
|
|
|
|
|
|
|
|
docs directory
|
|
|
|
|
---------------
|
|
|
|
@ -68,6 +72,7 @@ The ``ansible-doc`` command requires the fully qualified collection name (FQCN)
|
|
|
|
|
|
|
|
|
|
.. note:: The Ansible collection namespace is defined in the ``galaxy.yml`` file and is not equivalent to the GitHub repository name.
|
|
|
|
|
|
|
|
|
|
.. _collections_plugin_dir:
|
|
|
|
|
|
|
|
|
|
plugins directory
|
|
|
|
|
------------------
|
|
|
|
@ -129,6 +134,7 @@ In the PowerShell example the ``module_util`` in question is called ``hyperv`` s
|
|
|
|
|
|
|
|
|
|
$module.ExitJson()
|
|
|
|
|
|
|
|
|
|
.. _collections_roles_dir:
|
|
|
|
|
|
|
|
|
|
roles directory
|
|
|
|
|
----------------
|
|
|
|
@ -251,6 +257,8 @@ You can publish collections to Galaxy using the ``ansible-galaxy collection publ
|
|
|
|
|
|
|
|
|
|
.. note:: Once you upload a version of a collection, you cannot delete or modify that version. Ensure that everything looks okay before you upload it.
|
|
|
|
|
|
|
|
|
|
.. _upload_collection_ansible_galaxy:
|
|
|
|
|
|
|
|
|
|
Upload using ansible-galaxy
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
@ -300,6 +308,8 @@ Collection versions use `Sematic Versioning <https://semver.org/>`_ for version
|
|
|
|
|
* Increment minor (for example: y in `x.y.z`) version number for new functionality in a backwards compatible manner.
|
|
|
|
|
* Increment patch (for example: z in `x.y.z`) version number for backwards compatible bug fixes.
|
|
|
|
|
|
|
|
|
|
.. _migrate_to_collection:
|
|
|
|
|
|
|
|
|
|
Migrating Ansible content to a collection
|
|
|
|
|
=========================================
|
|
|
|
|
|
|
|
|
|