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.

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

Update local module options #57553

Merged
merged 4 commits into from Jun 17, 2019

Conversation

Projects
None yet
5 participants
@itdependsnetworks
Copy link
Contributor

commented Jun 7, 2019

SUMMARY

Update local module options

Update local module options to include ansible.cfg file.

ISSUE TYPE
  • Docs Pull Request

+label: docsite_pr

SUMMARY
ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

Docs

ADDITIONAL INFORMATION

Update local module options
##### SUMMARY
<!--- Your description here -->

Update local module options to include ansible.cfg file.
##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jun 7, 2019

@@ -75,6 +75,7 @@ Ansible loads plugins automatically too, loading each type of plugin separately
You can create or add a local plugin in any of these locations:

* any directory added to the relevant ``ANSIBLE_plugin_type_PLUGINS`` environment variable (these variables, such as ``$ANSIBLE_INVENTORY_PLUGINS`` and ``$ANSIBLE_VARS_PLUGINS`` take colon-separated lists like ``$PATH``)
* Adding or adjusting the ``library`` parameter to the ``ansible.cfg`` file

This comment has been minimized.

Copy link
@bcoca

bcoca Jun 11, 2019

Member

I would point to the actual config setting DEFAULT_MODULE_PATH, which then details the different ways of setting it, not just the ini key w/o section information.

@ansibot ansibot added needs_revision and removed core_review labels Jun 11, 2019


* any directory added to the relevant ``ANSIBLE_plugin_type_PLUGINS`` environment variable (these variables, such as ``$ANSIBLE_INVENTORY_PLUGINS`` and ``$ANSIBLE_VARS_PLUGINS`` take colon-separated lists like ``$PATH``)
* the directory named for the correct ``plugin_type`` within ``~/.ansible/plugins/`` - for example, ``~/.ansible/plugins/callback``
* the directory named for the correct ``plugin_type`` within ``/usr/share/ansible/plugins/`` - for example, ``/usr/share/ansible/plugins/action``

Once your plugin file is in one of these locations, Ansible will load it and you can use it in a any local module, task, playbook, or role.

Alternatively, you can point a ``DEFAULT_MODULE_PATH`` in your ``ansible.cfg`` file to any directory that contains your local plugins.

This comment has been minimized.

Copy link
@bcoca

bcoca Jun 17, 2019

Member

this is conflating the 'setting name' with the ini section/key, I would just point to the link to the config page that explains the different ways of setting it.

This comment has been minimized.

Copy link
@bcoca

bcoca Jun 17, 2019

Member

also that is only for modules, you might want to point out that each plugin type has it's own config setting

acozine added some commits Jun 17, 2019

@bcoca

bcoca approved these changes Jun 17, 2019

@itdependsnetworks

This comment has been minimized.

Copy link
Contributor Author

commented Jun 17, 2019

Thanks, I wasn’t following, and meant I circle back and ask

@acozine

This comment has been minimized.

Copy link
Contributor

commented Jun 17, 2019

Thanks @itdependsnetworks for suggesting updates to the ansible documentation. I hope the updated version of your changes still addresses your use case.

@acozine acozine merged commit 1a63f86 into ansible:devel Jun 17, 2019

1 check passed

Shippable Run 128038 status is SUCCESS.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.