Merge pull request #16514 from cachedout/master_doc_fix

Small doc fixes
This commit is contained in:
Nicole Thomas 2014-10-09 15:07:17 -06:00
commit 2901e9439b

View File

@ -55,7 +55,7 @@ the interface option must be adjusted too (for example: "interface: '::'")
Default: ``4505``
The network port to set up the publication interface
The network port to set up the publication interface.
.. code-block:: yaml
@ -69,8 +69,11 @@ The network port to set up the publication interface
Default: ``None``
The id to be passed in the publish job to minions. This is used for MultiSyndics
to return the job to the requesting master. Note, this must be the same string
as the syndic is configured with.
to return the job to the requesting master.
.. note::
This must be the same string as the syndic is configured with.
.. code-block:: yaml
@ -168,7 +171,7 @@ execution returns and command executions.
Default: ``/var/run/salt-master.pid``
Specify the location of the master pidfile
Specify the location of the master pidfile.
.. code-block:: yaml
@ -255,7 +258,7 @@ Verify and set permissions on configuration directories at startup.
Default: ``24``
Set the number of hours to keep old job information
Set the number of hours to keep old job information.
.. conf_master:: timeout
@ -294,7 +297,7 @@ Set the default outputter used by the salt command.
Default: ``True``
By default output is colored, to disable colored output set the color value
to False
to False.
.. code-block:: yaml
@ -308,7 +311,7 @@ to False
Default: :file:`/var/run/salt/master`
Set the location to use for creating Unix sockets for master process
communication
communication.
.. code-block:: yaml
@ -337,7 +340,7 @@ a burden on the master for larger deployments (over 5000 minions).
Disabling the job cache will make previously executed jobs unavailable to
the jobs system and is not generally recommended. Normally it is wise to make
sure the master has access to a faster IO system or a tmpfs is mounted to the
jobs dir
jobs dir.
.. conf_master:: minion_data_cache
@ -365,7 +368,7 @@ Default: ``''``
Used to specify a default returner for all minions, when this option is set
the specified returner needs to be properly configured and the minions will
always default to sending returns to this returner. This will also disable the
local job cache on the master
local job cache on the master.
.. code-block:: yaml
@ -455,7 +458,7 @@ and newly connected minions on the eventbus.
Default: '/etc/salt/roster'
Pass in an alternative location for the salt-ssh roster file
Pass in an alternative location for the salt-ssh roster file.
.. code-block:: yaml
@ -549,7 +552,7 @@ membership in the :conf_master:`autosign_file` and the
Default: ``{}``
Enable user accounts on the master to execute specific modules. These modules
can be expressed as regular expressions
can be expressed as regular expressions.
.. code-block:: yaml
@ -606,7 +609,9 @@ validate users to access areas of the Salt system.
Default: ``43200``
Time (in seconds) for a newly generated token to live. Default: 12 hours
Time (in seconds) for a newly generated token to live.
Default: 12 hours
.. code-block:: yaml
@ -710,7 +715,7 @@ Master Module Management
Default: ``[]``
Set additional directories to search for runner modules
Set additional directories to search for runner modules.
.. conf_master:: cython_enable
@ -720,7 +725,7 @@ Set additional directories to search for runner modules
Default: ``False``
Set to true to enable Cython modules (.pyx files) to be compiled on the fly on
the Salt master
the Salt master.
.. code-block:: yaml
@ -739,7 +744,7 @@ Default: ``top.sls``
The state system uses a "top" file to tell the minions what environment to
use and what modules to use. The state_top file is defined relative to the
root of the base environment
root of the base environment.
.. code-block:: yaml
@ -787,7 +792,7 @@ are enabled and available!
Default: ``yaml_jinja``
The renderer to use on the minions to render the state data
The renderer to use on the minions to render the state data.
.. code-block:: yaml
@ -801,7 +806,7 @@ The renderer to use on the minions to render the state data
Default: ``False``
Set the global failhard flag, this informs all states to stop running states
at the moment a single state fails
at the moment a single state fails.
.. code-block:: yaml
@ -847,7 +852,7 @@ If set to 'changes', the output will be full unless the state didn't change.
Default: ``False``
Enable extra routines for yaml renderer used states containing UTF characters
Enable extra routines for YAML renderer used states containing UTF characters.
.. code-block:: yaml
@ -861,7 +866,7 @@ Enable extra routines for yaml renderer used states containing UTF characters
Default: ``False``
Set all state calls to only test if they are going to actually make changes
or just post what changes are going to be made
or just post what changes are going to be made.
.. code-block:: yaml
@ -914,7 +919,7 @@ and sha512 are also supported.
Default: ``1048576``
The buffer size in the file server in bytes
The buffer size in the file server in bytes.
.. code-block:: yaml
@ -982,6 +987,7 @@ The file server works on environments passed to the master. Each environment
can have multiple root directories. The subdirectories in the multiple file
roots cannot match, otherwise the downloaded files will not be able to be
reliably ensured. A base environment is required to house the top file.
Example:
.. code-block:: yaml
@ -1916,11 +1922,13 @@ Syndic Server Settings
A Salt syndic is a Salt master used to pass commands from a higher Salt master to
minions below the syndic. Using the syndic is simple. If this is a master that
will have syndic servers(s) below it, set the "order_masters" setting to True. If this
is a master that will be running a syndic daemon for passthrough the
"syndic_master" setting needs to be set to the location of the master server
will have syndic servers(s) below it, set the "order_masters" setting to True.
Do not not forget that in other word it means that it shares with the local minion it's ID and PKI_DIR.
If this is a master that will be running a syndic daemon for passthrough the
"syndic_master" setting needs to be set to the location of the master server.
Do not not forget that, in other words, it means that it shares with the local minion
its ID and PKI_DIR.
.. conf_master:: order_masters
@ -1945,7 +1953,7 @@ value must be set to True
Default: ``None``
If this master will be running a salt-syndic to connect to a higher level
master, specify the higher level master with this configuration value
master, specify the higher level master with this configuration value.
.. code-block:: yaml
@ -1959,7 +1967,7 @@ master, specify the higher level master with this configuration value
Default: ``4506``
If this master will be running a salt-syndic to connect to a higher level
master, specify the higher level master port with this configuration value
master, specify the higher level master port with this configuration value.
.. code-block:: yaml
@ -2012,7 +2020,7 @@ Default: ``{}``
The configuration uses regular expressions to match minions and then a list
of regular expressions to match functions. The following will allow the
minion authenticated as foo.example.com to execute functions from the test
and pkg modules
and pkg modules.
.. code-block:: yaml
@ -2320,7 +2328,7 @@ Default: ``/srv/salt/win/repo/winrepo.p``
Default: ``''``
List of git repositories to include with the local repo
List of git repositories to include with the local repo.
.. code-block:: yaml