From bfaa29303bd15973a1537a24a9e5c9da0d83fc8a Mon Sep 17 00:00:00 2001 From: anshulbehl Date: Tue, 3 Sep 2019 11:33:32 -0400 Subject: [PATCH] adding a collection local try section (#61626) --- .../rst/dev_guide/collections_tech_preview.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/docsite/rst/dev_guide/collections_tech_preview.rst b/docs/docsite/rst/dev_guide/collections_tech_preview.rst index f5e67167b27..44b57df3699 100644 --- a/docs/docsite/rst/dev_guide/collections_tech_preview.rst +++ b/docs/docsite/rst/dev_guide/collections_tech_preview.rst @@ -238,6 +238,21 @@ a tarball of the built collection in the current directory which can be uploaded This tarball is mainly intended to upload to Galaxy as a distribution method, but you can use it directly to install the collection on target systems. +.. _trying_collection_locally: + +Trying collection locally +------------------------- + +You can try your collection locally by installing it from the tarball. + +.. code-block:: bash + + ansible-galaxy collection install my_namespace-my_collection-1.0.0.tar.gz -p ./collections/ansible_collections + +You should use one of the values configured in :ref:`COLLECTIONS_PATHS` for your path. This is also where Ansible itself will expect to find collections when attempting to use them. + +Then try to use the local collection inside a playbook, for more details see :ref:`Using collections ` + .. _publishing_collections: Publishing collections @@ -470,6 +485,8 @@ For operations where only one Galaxy server is used, i.e. ``publish``, ``info``, collection. The install process will not search for a collection requirement in a different Galaxy instance. +.. _using_collections: + Using collections =================