Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add module_utils example next to library examples #25390

Merged
merged 1 commit into from
Jul 19, 2017
Merged

Add module_utils example next to library examples #25390

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/docsite/rst/playbooks_best_practices.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ The top level of the directory would contain files and directories like so::
hostname2 # ""

library/ # if any custom modules, put them here (optional)
module_utils/ # if any custom module_utils to support modules, put them here (optional)
filter_plugins/ # if any custom filter plugins, put them here (optional)

site.yml # master playbook
Expand All @@ -62,6 +63,7 @@ The top level of the directory would contain files and directories like so::
meta/ #
main.yml # <-- role dependencies
library/ # roles can also include custom modules
module_utils/ # roles can also include custom module_utils
lookup_plugins/ # or other types of plugins, like lookup in this case

webtier/ # same kind of structure as "common" was above, done for the webtier role
Expand Down Expand Up @@ -97,6 +99,7 @@ Alternatively you can put each inventory file with its ``group_vars``/``host_var
stagehost2 # ""

library/
module_utils/
filter_plugins/

site.yml
Expand Down Expand Up @@ -422,7 +425,7 @@ This will pull in variables based on the OS name.
Bundling Ansible Modules With Playbooks
+++++++++++++++++++++++++++++++++++++++

If a playbook has a "./library" directory relative to its YAML file, this directory can be used to add ansible modules that will
If a playbook has a :file:`./library` directory relative to its YAML file, this directory can be used to add ansible modules that will
automatically be in the ansible module path. This is a great way to keep modules that go with a playbook together. This is shown
in the directory structure example at the start of this section.

Expand Down