diff --git a/doc/topics/blackout/index.rst b/doc/topics/blackout/index.rst new file mode 100644 index 0000000000..8efb977953 --- /dev/null +++ b/doc/topics/blackout/index.rst @@ -0,0 +1,16 @@ +.. _blackout: + +============================= +Minion Blackout Configuration +============================= + +.. versionadded:: 2016.3.0 + +Salt supports minion blackouts. When a minion is in blackout mode, all remote +execution commands are disabled. This allows production minions to be put +"on hold", eliminating the risk of an untimely configuration change. + +Minion blackouts are configured via a special pillar key, ``minion_blackout``. +If this key is set to ``True``, then the minion will reject all incoming +commands, except for ``saltutil.refresh_pillar``. (The exception is important, +so minions can be brought out of blackout mode) diff --git a/doc/topics/configuration/index.rst b/doc/topics/configuration/index.rst index 469b77d255..363bffb21e 100644 --- a/doc/topics/configuration/index.rst +++ b/doc/topics/configuration/index.rst @@ -11,6 +11,7 @@ secure and troubleshoot, and how to perform many other administrative tasks. ../../ref/configuration/master ../../ref/configuration/minion ../../ref/configuration/examples + ../blackout/index ../eauth/access_control ../jobs/index ../jobs/job_cache