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

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

Merged
merged 1 commit into from
Mar 4, 2019
Merged

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

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
24 changes: 18 additions & 6 deletions docs/docsite/rst/plugins/become.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
.. contents:: Topics

.. 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
commands to work with the target machine as well as the modules required to execute the tasks specified in
Expand All @@ -16,7 +20,7 @@ with the permissions of that user.
.. _enabling_become:

Enabling Become Plugins
+++++++++++++++++++++++
-----------------------

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
Expand All @@ -26,7 +30,7 @@ the become plugin directory sources configured in :ref:`ansible.cfg <ansible_con
.. _using_become:

Using Become Plugins
++++++++++++++++++++
--------------------

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
Expand All @@ -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
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
:glob:

Expand Down