From d16ee65ecd3b7abfddaf7d7b6dc8d0da36093cbe Mon Sep 17 00:00:00 2001 From: Jordan Borean Date: Thu, 19 Sep 2019 05:53:16 +1000 Subject: [PATCH] Add link to become plugins in become docs (#62462) --- docs/docsite/rst/user_guide/become.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/docsite/rst/user_guide/become.rst b/docs/docsite/rst/user_guide/become.rst index 848cee62d72..26174594a2b 100644 --- a/docs/docsite/rst/user_guide/become.rst +++ b/docs/docsite/rst/user_guide/become.rst @@ -13,6 +13,8 @@ Become Ansible allows you to 'become' another user, different from the user that logged into the machine (remote user). This is done using existing privilege escalation tools such as `sudo`, `su`, `pfexec`, `doas`, `pbrun`, `dzdo`, `ksu`, `runas`, `machinectl` and others. +A full list of all become plugins that are included in Ansible can be found in the :ref:`become_plugin_list`. + .. note:: Prior to version 1.9, Ansible mostly allowed the use of `sudo` and a limited use of `su` to allow a login/remote user to become a different user and execute tasks and create resources with the second user's permissions. As of Ansible version 1.9, `become` supersedes the old sudo/su, while still being backwards compatible. This new implementation also makes it easier to add other privilege escalation tools, including `pbrun` (Powerbroker), `pfexec`, `dzdo` (Centrify), and others. @@ -80,6 +82,11 @@ For example, if you want to run all tasks as ``root`` on a server named ``webser webserver ansible_user=manager ansible_become=yes +.. note:: + The variables defined above are generic for all become plugins but plugin specific ones can also be set instead. + Please see the documentation for each plugin for a list of all options the plugin has and how they can be defined. + A full list of become plugins in Ansible can be found at :ref:`become_plugins`. + Command line options --------------------