mirror of
https://github.com/valitydev/salt.git
synced 2024-11-06 16:45:27 +00:00
Assorted doc issues
Fixes #10330 Fixes #31216 Fixes #30464 Fixes #29520 Fixes #30261 Fixes #29636 Fixes #29528
This commit is contained in:
parent
987dd89979
commit
a72dc15720
@ -372,6 +372,10 @@
|
||||
# environments is to isolate via the top file.
|
||||
#environment: None
|
||||
#
|
||||
# Isolates the pillar environment on the minion side. This functions the same
|
||||
# as the environment setting, but for pillar instead of states.
|
||||
#pillarenv: None
|
||||
#
|
||||
# If using the local file directory, then the state top file name needs to be
|
||||
# defined, by default this is top.sls.
|
||||
#state_top: top.sls
|
||||
|
@ -479,7 +479,7 @@ performance of max_minions.
|
||||
.. conf_master:: presence_events
|
||||
|
||||
``presence_events``
|
||||
----------------------
|
||||
-------------------
|
||||
|
||||
Default: False
|
||||
|
||||
@ -494,6 +494,23 @@ that connect to a master via localhost.
|
||||
|
||||
presence_events: False
|
||||
|
||||
.. conf_master:: transport
|
||||
|
||||
``transport``
|
||||
-------------
|
||||
|
||||
Default: ``zeromq``
|
||||
|
||||
Changes the underlying transport layer. Zeromq is the recommended transport
|
||||
while additional transport layers are under development. Supported values are
|
||||
``zeromq``, ``raet`` (experimental), and ``tcp`` (experimental). This settings has
|
||||
a significant impact on performance and should not be changed unless you know
|
||||
what you are doing! Transports are explained in :ref:`Salt Transports
|
||||
<transports>`.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
transport: zeromq
|
||||
|
||||
Salt-SSH Configuration
|
||||
======================
|
||||
@ -503,7 +520,7 @@ Salt-SSH Configuration
|
||||
``roster_file``
|
||||
---------------
|
||||
|
||||
Default: '/etc/salt/roster'
|
||||
Default: ``/etc/salt/roster``
|
||||
|
||||
Pass in an alternative location for the salt-ssh roster file.
|
||||
|
||||
|
@ -578,6 +578,23 @@ Pull port used when :conf_minion:`ipc_mode` is set to ``tcp``.
|
||||
|
||||
tcp_pull_port: 4511
|
||||
|
||||
.. conf_minion:: transport
|
||||
|
||||
``transport``
|
||||
-------------
|
||||
|
||||
Default: ``zeromq``
|
||||
|
||||
Changes the underlying transport layer. Zeromq is the recommended transport
|
||||
while additional transport layers are under development. Supported values are
|
||||
``zeromq``, ``raet`` (experimental), and ``tcp`` (experimental). This settings has
|
||||
a significant impact on performance and should not be changed unless you know
|
||||
what you are doing! Transports are explained in :ref:`Salt Transports
|
||||
<transports>`.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
transport: zeromq
|
||||
|
||||
|
||||
Minion Module Management
|
||||
@ -905,6 +922,9 @@ sha512 are also supported.
|
||||
|
||||
hash_type: md5
|
||||
|
||||
Pillar Settings
|
||||
===============
|
||||
|
||||
.. conf_minion:: pillar_roots
|
||||
|
||||
``pillar_roots``
|
||||
@ -930,7 +950,19 @@ the pillar environments.
|
||||
prod:
|
||||
- /srv/pillar/prod
|
||||
|
||||
.. conf_minion:: pillarenv
|
||||
|
||||
``pillarenv``
|
||||
-------------
|
||||
|
||||
Default: ``None``
|
||||
|
||||
Isolates the pillar environment on the minion side. This functions the same as
|
||||
the environment setting, but for pillar instead of states.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
pillarenv: None
|
||||
|
||||
Security Settings
|
||||
=================
|
||||
|
@ -84,3 +84,8 @@ look like this:
|
||||
exclude:
|
||||
- sls: http
|
||||
- id: /etc/vimrc
|
||||
|
||||
.. note::
|
||||
The current state processing flow checks for duplicate IDs before
|
||||
processing excludes. An error occurs if duplicate IDs are present even if
|
||||
one of the IDs is targeted by an ``exclude``.
|
||||
|
@ -271,3 +271,10 @@ preferred means of executing complicated routines in Salt not all of the
|
||||
execution modules have been written with beacons in mind. Watch out for
|
||||
execution modules that may be CPU intense or IO bound. Please feel free to
|
||||
add new execution modules and functions to back specific beacons.
|
||||
|
||||
Distributing Custom Beacons
|
||||
---------------------------
|
||||
|
||||
Custom beacons can be distributed to minions using ``saltutil``, see
|
||||
:ref:`Dynamic Module Distribution <dynamic-module-distribution>`.
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
.. _transports:
|
||||
|
||||
==============
|
||||
Salt Transport
|
||||
==============
|
||||
|
@ -172,7 +172,7 @@ once with
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ salt * test.ping
|
||||
$ salt * disk.usage
|
||||
|
||||
it may cause thousands of minions trying to return their data to the Salt Master
|
||||
open port 4506. Also causing a flood of syn-flood if the Master can't handle that many
|
||||
@ -182,7 +182,7 @@ This can be easily avoided with Salt's batch mode:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ salt * test.ping -b 50
|
||||
$ salt * disk.usage -b 50
|
||||
|
||||
This will only address 50 minions at once while looping through all addressed
|
||||
minions.
|
||||
|
@ -600,7 +600,7 @@ def installed(
|
||||
|
||||
:param str version:
|
||||
Install a specific version of a package. This option is ignored if
|
||||
either "pkgs" or "sources" is used. Currently, this option is supported
|
||||
"sources" is used. Currently, this option is supported
|
||||
for the following pkg providers: :mod:`apt <salt.modules.aptpkg>`,
|
||||
:mod:`ebuild <salt.modules.ebuild>`,
|
||||
:mod:`pacman <salt.modules.pacman>`,
|
||||
@ -641,6 +641,18 @@ def installed(
|
||||
The version strings returned by either of these functions can be used
|
||||
as version specifiers in pkg states.
|
||||
|
||||
You can install a specific version when using the ``pkgs`` argument by
|
||||
including the version after the package:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
common_packages:
|
||||
pkg.installed:
|
||||
- pkgs:
|
||||
- unzip
|
||||
- dos2unix
|
||||
- salt-minion: 2015.8.5-1.el6
|
||||
|
||||
:param bool refresh:
|
||||
Update the repo database of available packages prior to installing the
|
||||
requested package.
|
||||
|
@ -99,7 +99,7 @@ def present(name,
|
||||
Boolean attribute to specify whether to password comparison check
|
||||
should be performed.
|
||||
|
||||
If refresh_password is None or False, the password will be automatically
|
||||
If refresh_password is ``True``, the password will be automatically
|
||||
updated without extra password change check.
|
||||
|
||||
This behaviour makes it possible to execute in environments without
|
||||
|
@ -98,7 +98,7 @@ def present(name,
|
||||
Boolean attribute to specify whether to password comparison check
|
||||
should be performed.
|
||||
|
||||
If refresh_password is None or False, the password will be automatically
|
||||
If refresh_password is ``True``, the password will be automatically
|
||||
updated without extra password change check.
|
||||
|
||||
This behaviour makes it possible to execute in environments without
|
||||
|
Loading…
Reference in New Issue
Block a user