a-c-m
/
community.general
mirror of https://github.com/ansible-collections/community.general.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Become plugin: Update documentation to match other plugin doc (#53266)

pull/4420/head
Yanis Guenane 2019-03-04 14:13:52 +01:00 committed by Alicia Cozine
parent 718a591fb2
commit fcec3d0600
1 changed files with 18 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/docsite/rst/plugins/become.rst
View File

@ -1,9 +1,13 @@
.. contents:: Topics .. _become_plugins:
.. versionadded:: 2.8
Become Plugins Become Plugins
-------------- ==============
.. contents::
:local:
:depth: 2
.. versionadded:: 2.8
Become plugins work to ensure that Ansible can use certain privilege escalation systems when running the basic Become plugins work to ensure that Ansible can use certain privilege escalation systems when running the basic
commands to work with the target machine as well as the modules required to execute the tasks specified in commands to work with the target machine as well as the modules required to execute the tasks specified in
@ -16,7 +20,7 @@ with the permissions of that user.
.. _enabling_become: .. _enabling_become:
Enabling Become Plugins Enabling Become Plugins
+++++++++++++++++++++++ -----------------------
The become plugins shipped with Ansible are already enabled. Custom plugins can be added by placing The become plugins shipped with Ansible are already enabled. Custom plugins can be added by placing
them into a ``become_plugins`` directory adjacent to your play, inside a role, or by placing them in one of them into a ``become_plugins`` directory adjacent to your play, inside a role, or by placing them in one of
@ -26,7 +30,7 @@ the become plugin directory sources configured in :ref:`ansible.cfg <ansible_con
.. _using_become: .. _using_become:
Using Become Plugins Using Become Plugins
++++++++++++++++++++ --------------------
In addition to the default configuration settings in :ref:`ansible_configuration_settings` or the In addition to the default configuration settings in :ref:`ansible_configuration_settings` or the
``--become-method`` command line option, you can use the ``become_method`` keyword in a play or, if you need ``--become-method`` command line option, you can use the ``become_method`` keyword in a play or, if you need
@ -35,6 +39,14 @@ to be 'host specific', the connection variable ``ansible_become_method`` to sele
You can further control the settings for each plugin via other configuration options detailed in the plugin You can further control the settings for each plugin via other configuration options detailed in the plugin
themselves (linked below). themselves (linked below).
.. _become_plugin_list:
Plugin List
-----------
You can use ``ansible-doc -t become -l`` to see the list of available plugins.
Use ``ansible-doc -t become <plugin name>`` to see specific documentation and examples.
.. toctree:: :maxdepth: 1 .. toctree:: :maxdepth: 1
:glob: :glob: