diff options
| author | Brian Coca <bcoca@users.noreply.github.com> | 2022-10-27 21:30:38 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-27 21:30:38 +0300 |
| commit | 6ee089bc80dff30a9a01165bef4e88f87d91daad (patch) | |
| tree | 52c28e9ea379ec4b2027505d18ff823e33151af0 | |
| parent | bc83da9a1b0f0cd6575d45d575bd679039585a89 (diff) | |
collection roles dont support plugins (#79243)
| -rw-r--r-- | docs/docsite/rst/collections_guide/collections_using_playbooks.rst | 8 | ||||
| -rw-r--r-- | docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst | 3 |
2 files changed, 8 insertions, 3 deletions
diff --git a/docs/docsite/rst/collections_guide/collections_using_playbooks.rst b/docs/docsite/rst/collections_guide/collections_using_playbooks.rst index aa192525b2f..a7665edfe62 100644 --- a/docs/docsite/rst/collections_guide/collections_using_playbooks.rst +++ b/docs/docsite/rst/collections_guide/collections_using_playbooks.rst @@ -112,6 +112,8 @@ A few recommendations when creating such playbooks, ``hosts:`` should be generic This will have an implied entry in the ``collections:`` keyword of ``my_namespace.my_collection`` just as with roles. .. note:: - Playbook names, like other collection resources, have a restricted set of valid characters. - Names can contain only lowercase alphanumeric characters, plus _ and must start with an alpha character. The dash ``-`` character is not valid for playbook names in collections. - Playbooks whose names contain invalid characters are not addressable: this is a limitation of the Python importer that is used to load collection resources. + * Playbook names, like other collection resources, have a restricted set of valid characters. + Names can contain only lowercase alphanumeric characters, plus _ and must start with an alpha character. The dash ``-`` character is not valid for playbook names in collections. + Playbooks whose names contain invalid characters are not addressable: this is a limitation of the Python importer that is used to load collection resources. + + * Playbooks in collections do not support 'adjacent' plugins, all plugins must be in the collection specific directories. diff --git a/docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst b/docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst index dc230da2dab..99ca2bf1240 100644 --- a/docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst +++ b/docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst @@ -535,6 +535,9 @@ To use ``allow_duplicates: true`` with role dependencies, you must specify it fo Embedding modules and plugins in roles ====================================== +.. note:: + This applies only to standalone roles. Roles in collections do not support plugin embedding; they must use the collection's ``plugins`` structure to distribute plugins. + If you write a custom module (see :ref:`developing_modules`) or a plugin (see :ref:`developing_plugins`), you might wish to distribute it as part of a role. For example, if you write a module that helps configure your company's internal software, and you want other people in your organization to use this module, but you do not want to tell everyone how to configure their Ansible library path, you can include the module in your internal_config role. To add a module or a plugin to a role: |