diff options
| author | Brian Coca <bcoca@users.noreply.github.com> | 2021-10-14 11:25:14 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-14 08:25:14 -0700 |
| commit | ff792d252e84ab0cbfa8d40d1ff8c2bf19adffe0 (patch) | |
| tree | 732079dcb0b409bd5325bf001e5c4e094aed3b39 | |
| parent | 9eeaf1c5b56b142c09967201dd3f2713a226f803 (diff) | |
| download | ansible-ff792d252e84ab0cbfa8d40d1ff8c2bf19adffe0.tar.gz | |
Docs: dash - character invalid in playbook names in collections(#75891)
* collection playbooks, note no -
fixes #75890
| -rw-r--r-- | docs/docsite/rst/user_guide/collections_using.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/docsite/rst/user_guide/collections_using.rst b/docs/docsite/rst/user_guide/collections_using.rst index d88c95c601..c045050114 100644 --- a/docs/docsite/rst/user_guide/collections_using.rst +++ b/docs/docsite/rst/user_guide/collections_using.rst @@ -371,6 +371,11 @@ 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. + .. seealso:: :ref:`developing_collections` |