From 457ec179ae69d05cb23aaa1e8ecd0bf074d6bc01 Mon Sep 17 00:00:00 2001 From: Thomas S Hatch Date: Wed, 8 Apr 2015 14:41:05 -0600 Subject: [PATCH] Add sudo user docs into salt --- doc/ref/configuration/minion.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/ref/configuration/minion.rst b/doc/ref/configuration/minion.rst index 76266f8883..efc7ca31cf 100644 --- a/doc/ref/configuration/minion.rst +++ b/doc/ref/configuration/minion.rst @@ -149,8 +149,30 @@ The user to run the Salt processes user: root +.. conf_minion:: sudo_runas + +``sudo_runas`` +-------------- + +Default: None + +The user to run salt remote execution commands as via sudo. If this option is +enabled then sudo will be used to change the active user executing the remote +command. If enabled the user will need to be allowed access via the sudoers file +for the user that the salt minion is configured to run as. The most common +option would be to use the root user. If this option is set the ``user`` option +should also be set to a non-root user. If migrating from a root minion to a non +root minion the minion cache should be cleared and the minion pki directory will +need to be changed to the ownership of the new user. + +.. code-block:: yaml + + sudo_user: root + + .. conf_minion:: pidfile + ``pidfile`` -----------