From 992c70dc6ab34944b686b178d4ec2b494cceb4d9 Mon Sep 17 00:00:00 2001 From: Nicole Thomas Date: Mon, 18 Apr 2016 10:51:01 -0600 Subject: [PATCH] Update the minion.rst file with the new pub_ret option (#32654) Also added the loop_interval docs to minion.rst and corrected the default documented (this value is 1 second for the minion schedule maintenance process, not 60 seconds - the master is 60). --- conf/minion | 7 +++---- doc/ref/configuration/minion.rst | 33 ++++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+), 4 deletions(-) diff --git a/conf/minion b/conf/minion index d7acf1ec13..ae8579e1bb 100644 --- a/conf/minion +++ b/conf/minion @@ -265,10 +265,9 @@ # # # The loop_interval sets how long in seconds the minion will wait between -# evaluating the scheduler and running cleanup tasks. This defaults to a -# sane 60 seconds, but if the minion scheduler needs to be evaluated more -# often lower this value -#loop_interval: 60 +# evaluating the scheduler and running cleanup tasks. This defaults to 1 +# second on the minion scheduler. +#loop_interval: 1 # Some installations choose to start all job returns in a cache or a returner # and forgo sending the results back to a master. In this workflow, jobs diff --git a/doc/ref/configuration/minion.rst b/doc/ref/configuration/minion.rst index 713029c92a..ac48287395 100644 --- a/doc/ref/configuration/minion.rst +++ b/doc/ref/configuration/minion.rst @@ -590,6 +590,39 @@ behavior is to have time-frame within all minions try to reconnect. recon_randomize: True +.. conf_minion:: loop_interval + +``loop_interval`` +----------------- + +Default: ``1`` + +The loop_interval sets how long in seconds the minion will wait between +evaluating the scheduler and running cleanup tasks. This defaults to 1 +second on the minion scheduler. + +.. code-block:: yaml + + loop_interval: 1 + + +.. conf_minion:: pub_ret + +``pub_ret`` +----------- + +Default: True + +Some installations choose to start all job returns in a cache or a returner +and forgo sending the results back to a master. In this workflow, jobs +are most often executed with --async from the Salt CLI and then results +are evaluated by examining job caches on the minions or any configured returners. +WARNING: Setting this to False will **disable** returns back to the master. + +.. code-block:: yaml + + pub_ret: True + .. conf_minion:: return_retry_timer ``return_retry_timer``