Document new master and minion config opts for 2016.3.0

Docs were added for:
  - master_tries
  - mine_enabled
  - mine_return_job
  - syndic_failover
  - auth_tries: this is an old setting, but docs were not found
in the minion.rst docs. This change should be added to older branches.
This commit is contained in:
rallytime 2016-05-16 14:51:13 -06:00
parent 8387657d9a
commit fdc877b4dc
4 changed files with 111 additions and 6 deletions

View File

@ -781,6 +781,12 @@
# LOG file of the syndic daemon:
#syndic_log_file: syndic.log
# The behaviour of the multi-syndic when connection to a master of masters failed.
# Can specify ``random`` (default) or ``ordered``. If set to ``random``, masters
# will be iterated in random order. If ``ordered`` is specified, the configured
# order will be used.
#syndic_failover: random
##### Peer Publish settings #####
##########################################

View File

@ -310,6 +310,15 @@
# is not enabled.
# grains_cache_expiration: 300
# Determines whether or not the salt minion should run scheduled mine updates.
# Defaults to "True". Set to "False" to disable the scheduled mine updates.
#mine_enabled: True
# Determines whether or not scheduled mine updates should be accompanied by a job
# return for the job cache. Defaults to "False". Set to "True" to include job
# returns in the job cache for mine updates.
#mine_return_job: False
# Windows platforms lack posix IPC and must rely on slower TCP based inter-
# process communications. Set ipc_mode to 'tcp' on such systems
#ipc_mode: ipc

View File

@ -2749,9 +2749,7 @@ master, specify the higher level master port with this configuration value.
syndic_master_port: 4506
.. conf_master:: syndic_log_file
.. conf_master:: syndic_master_log_file
.. conf_master:: syndic_pidfile
``syndic_pidfile``
------------------
@ -2765,6 +2763,8 @@ master, specify the pidfile of the syndic daemon.
syndic_pidfile: syndic.pid
.. conf_master:: syndic_log_file
``syndic_log_file``
-------------------
@ -2777,6 +2777,24 @@ master, specify the log_file of the syndic daemon.
syndic_log_file: salt-syndic.log
.. master_conf:: syndic_failover
``syndic_failover``
-------------------
.. versionadded:: 2016.3.0
Default: ``random``
The behaviour of the multi-syndic when connection to a master of masters failed.
Can specify ``random`` (default) or ``ordered``. If set to ``random``, masters
will be iterated in random order. If ``ordered`` is specified, the configured
order will be used.
.. code-block:: yaml
syndic_failover: random
Peer Publish Settings
=====================

View File

@ -496,6 +496,36 @@ With ``grains_deep_merge``, the result will be:
k1: v1
k2: v2
.. conf_minion:: mine_enabled
``mine_enabled``
----------------
.. versionadded:: 2016.3.0
Default: ``True``
Determines whether or not the salt minion should run scheduled mine updates.
.. code-block:: yaml
mine_enabled: True
.. conf_minion:: mine_return_job
``mine_return_job``
-------------------
.. versionadded:: 2016.3.0
Default: ``False``
Determines whether or not scheduled mine updates should be accompanied by a job
return for the job cache.
.. code-block:: yaml
mine_return_job: False
.. conf_minion:: sock_dir
@ -555,6 +585,49 @@ parameter. The wait-time will be a random number of seconds between
random_reauth_delay: 60
.. conf_minion:: auth_tries
``auth_tries``
--------------
.. versionadded:: 2014.7.0
Default: ``7``
The number of attempts to authenticate to a master before giving up. Or, more
technically, the number of consecutive SaltReqTimeoutErrors that are acceptable
when trying to authenticate to the master.
.. code-block:: yaml
auth_tries: 7
.. conf_minion:: master_tries
``master_tries``
----------------
.. versionadded:: 2016.3.0
Default: ``1``
The number of attempts to connect to a master before giving up. Set this to
``-1`` for unlimited attempts. This allows for a master to have downtime and the
minion to reconnect to it later when it comes back up. In 'failover' mode, which
is set in the :conf_minion:`master_type` configuration, this value is the number
of attempts for each set of masters. In this mode, it will cycle through the list
of masters for each attempt.
``master_tries`` is different than :conf_minion:`auth_tries` because ``auth_tries``
attempts to retry auth attempts with a single master. ``auth_tries`` is under the
assumption that you can connect to the master but not gain authorization from it.
``master_tries`` will still cycle through all of the masters in a given try, so it
is appropriate if you expect occasional downtime from the master(s).
.. code-block:: yaml
master_tries: 1
.. conf_minion:: acceptance_wait_time_max
``acceptance_wait_time_max``
@ -976,7 +1049,6 @@ environments is to isolate via the top file.
environment: None
File Directory Settings
=======================
@ -1105,6 +1177,7 @@ sha512 are also supported.
hash_type: md5
Pillar Settings
===============
@ -1251,6 +1324,7 @@ this can be set to ``True``.
always_verify_signature: True
Thread Settings
===============
@ -1269,8 +1343,6 @@ executed in a thread.
multiprocessing: True
.. _minion-logging-settings:
Minion Logging Settings