valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-07 00:55:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add docs for new config option

Browse Source
This commit is contained in:
Erik Johnson 2018-06-17 21:10:50 -05:00
parent 04c55a9178
commit de05097b20
No known key found for this signature in database
GPG Key ID: 5E5583C437808F3F
1 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
doc/ref/configuration/minion.rst
View File

@ -1162,6 +1162,40 @@ The password used for HTTP proxy access.
proxy_password: obolus
Docker Configuration
====================
.. conf_minion:: docker.update_mine
``docker.update_mine``
----------------------
.. versionadded:: 2017.7.7,2018.3.3
.. versionchanged:: Fluorine
The default value is now ``False``
Default: ``True``
If enabled, when containers are added or removed the :ref:`mine <salt-mine>`
will be updated with the results of :py:func:`docker.ps verbose=True all=True
host=True <salt.modules.dockermod.ps>`. This mine data is used by
:py:func:`mine.get_docker <salt.modules.mine.get_docker>`. Set this option to
``False`` to keep Salt from updating the mine with this information.
.. note::
This option can also be set in Grains or Pillar data, with Grains
overriding Pillar and the minion config file overriding Grains.
.. note::
Disabling this will of course keep :py:func:`mine.get_docker
<salt.modules.mine.get_docker>` from returning any information for a given
minion.
.. code-block:: yaml
docker.update_mine: False
Minion Module Management
========================