Fix docs about etcd config options and add pillar_opts doc

Fixes #33423
This commit is contained in:
rallytime 2016-05-24 13:19:20 -06:00
parent 00f9090928
commit 7fd3e8f361
3 changed files with 53 additions and 8 deletions

View file

@ -2208,6 +2208,26 @@ configuration is the same as :conf_master:`file_roots`:
prod:
- /srv/pillar/prod
.. conf_master:: pillar_opts
``pillar_opts``
---------------
Default: ``False``
The ``pillar_opts`` option adds the master configuration file data to a dict in
the pillar called ``master``. This can be used to set simple configurations in
the master config file that can then be used on minions.
Note that setting this option to ``True`` means the master config file will be
included in all minion's pillars. While this makes global configuration of services
and systems easy, it may not be desired if sensitive data is stored in the master
configuration.
.. code-block:: yaml
pillar_opts: False
.. _master-configuration-ext-pillar:
.. conf_master:: ext_pillar

View file

@ -4,8 +4,11 @@ Execution module to work with etcd
:depends: - python-etcd
In order to use an etcd server, a profile should be created in the master
configuration file:
Configuration
-------------
To work with an etcd server you must configure an etcd profile. The etcd config
can be set in either the Salt Minion configuration file or in pillar:
.. code-block:: yaml
@ -21,6 +24,17 @@ or clusters are available.
etcd.host: 127.0.0.1
etcd.port: 4001
.. note::
The etcd configuration can also be set in the Salt Master config file,
but in order to use any etcd configurations defined in the Salt Master
config, the :conf_master:`pillar_opts` must be set to ``True``.
Be aware that setting ``pillar_opts`` to ``True`` has security implications
as this makes all master configuration settings available in all minion's
pillars.
'''
from __future__ import absolute_import

View file

@ -10,11 +10,11 @@ Manage etcd Keys
This state module supports setting and removing keys from etcd.
Salt Master Configuration
-------------------------
Configuration
-------------
To work with an etcd server you must configure an etcd profile in the Salt
Master configuration, for example:
To work with an etcd server you must configure an etcd profile. The etcd config
can be set in either the Salt Minion configuration file or in pillar:
.. code-block:: yaml
@ -22,14 +22,25 @@ Master configuration, for example:
etcd.host: 127.0.0.1
etcd.port: 4001
You can also configure etcd without a profile however it is recommended that
you use profiles:
It is technically possible to configure etcd without using a profile, but this
is not considered to be a best practice, especially when multiple etcd servers
or clusters are available.
.. code-block:: yaml
etcd.host: 127.0.0.1
etcd.port: 4001
.. note::
The etcd configuration can also be set in the Salt Master config file,
but in order to use any etcd configurations defined in the Salt Master
config, the :conf_master:`pillar_opts` must be set to ``True``.
Be aware that setting ``pillar_opts`` to ``True`` has security implications
as this makes all master configuration settings available in all minion's
pillars.
Available Functions
-------------------