Add Windows Master config information

This commit is contained in:
twangboy 2017-06-14 15:15:46 -06:00
parent 10b68e9375
commit 80ac6381c2

View File

@ -17,6 +17,9 @@ The configuration file for the salt-master is located at
configuration file is located at :file:`/usr/local/etc/salt`. The available
options are as follows:
.. _primary-master-configuration:
Primary Master Configuration
============================
@ -246,7 +249,7 @@ each of Salt's module types such as ``runners``, ``output``, ``wheel``,
extension_modules: /root/salt_extmods
``extmod_whitelist/extmod_blacklist``
--------------------
-------------------------------------
.. versionadded:: Nitrogen
@ -852,6 +855,9 @@ what you are doing! Transports are explained in :ref:`Salt Transports
ret_port: 4606
zeromq: []
.. _salt-ssh-configuration:
Salt-SSH Configuration
======================
@ -929,6 +935,8 @@ Default: None
Identical as `thin_extra_mods`, only applied to the Salt Minimal.
.. _master-security-settings:
Master Security Settings
========================
@ -1122,7 +1130,7 @@ from the eauth driver each time.
.. conf_master:: eauth_acl_module
``eauth_acl_module``
---------------------
--------------------
Default: ``''``
@ -1219,7 +1227,6 @@ signature. The :conf_master:`master_pubkey_signature` must also be set for this.
master_use_pubkey_signature: True
.. conf_master:: rotate_aes_key
``rotate_aes_key``
@ -1236,7 +1243,6 @@ Do not disable this unless it is absolutely clear what this does.
rotate_aes_key: True
.. conf_master:: ssl
``ssl``
@ -1265,7 +1271,7 @@ constant names without ssl module prefix: ``CERT_REQUIRED`` or ``PROTOCOL_SSLv23
.. conf_master:: allow_minion_key_revoke
``allow_minion_key_revoke``
------------------
---------------------------
Default: ``True``
@ -1278,6 +1284,9 @@ the master will drop the request and the minion's key will remain accepted.
rotate_aes_key: True
.. _master-module-management:
Master Module Management
========================
@ -1310,6 +1319,8 @@ the Salt master.
cython_enable: False
.. _master-state-system-settings:
Master State System Settings
============================
@ -1626,6 +1637,9 @@ If set to ``True``, runner jobs will be saved to job cache (defined by
runner_returns: True
.. _master-file-server-settings:
Master File Server Settings
===========================
@ -1742,7 +1756,7 @@ on a large number of minions.
.. conf_master:: fileserver_verify_config
``fileserver_verify_config``
------------------------------
----------------------------
.. versionadded:: Nitrogen
@ -3587,6 +3601,9 @@ can be utilized:
pillar_cache_backend: disk
.. _syndic-server-settings:
Syndic Server Settings
======================
@ -3722,7 +3739,7 @@ check in with their lists of expected minions before giving up.
.. conf_master:: syndic_forward_all_events
``syndic_forward_all_events``
-------------------
-----------------------------
.. versionadded:: Nitrogen
@ -3736,6 +3753,8 @@ send events to all connected masters.
syndic_forward_all_events: False
.. _peer-publish-settings:
Peer Publish Settings
=====================
@ -3850,7 +3869,6 @@ The level of messages to send to the console. See also :conf_log:`log_level`.
log_level: warning
.. conf_master:: log_level_logfile
``log_level_logfile``
@ -3866,7 +3884,6 @@ it will inherit the level set by :conf_log:`log_level` option.
log_level_logfile: warning
.. conf_master:: log_datefmt
``log_datefmt``
@ -3881,7 +3898,6 @@ The date and time format used in console log messages. See also
log_datefmt: '%H:%M:%S'
.. conf_master:: log_datefmt_logfile
``log_datefmt_logfile``
@ -3896,7 +3912,6 @@ The date and time format used in log file messages. See also
log_datefmt_logfile: '%Y-%m-%d %H:%M:%S'
.. conf_master:: log_fmt_console
``log_fmt_console``
@ -3929,7 +3944,6 @@ The format of the console logging messages. See also
log_fmt_console: '%(colorlevel)s %(colormsg)s'
log_fmt_console: '[%(levelname)-8s] %(message)s'
.. conf_master:: log_fmt_logfile
``log_fmt_logfile``
@ -3944,7 +3958,6 @@ The format of the log file logging messages. See also
log_fmt_logfile: '%(asctime)s,%(msecs)03d [%(name)-17s][%(levelname)-8s] %(message)s'
.. conf_master:: log_granular_levels
``log_granular_levels``
@ -3955,6 +3968,9 @@ Default: ``{}``
This can be used to control logging levels more specifically. See also
:conf_log:`log_granular_levels`.
.. _node-groups:
Node Groups
===========
@ -3972,13 +3988,15 @@ A group consists of a group name and a compound target.
group2: 'G@os:Debian and foo.domain.com'
group3: 'G@os:Debian and N@group1'
group4:
- 'G@foo:bar'
- 'or'
- 'G@foo:baz'
- 'G@foo:bar'
- 'or'
- 'G@foo:baz'
More information on using nodegroups can be found :ref:`here <targeting-nodegroups>`.
.. _range-cluster-settings:
Range Cluster Settings
======================
@ -3994,9 +4012,11 @@ https://github.com/ytoolshed/range/wiki/%22yamlfile%22-module-file-spec
.. code-block:: yaml
range_server: range:80
range_server: range:80
.. _include-configuration:
Include Configuration
=====================
@ -4018,7 +4038,6 @@ file.
files are prefixed with an underscore. A common example of this is the
``_schedule.conf`` file.
.. conf_master:: include
``include``
@ -4048,6 +4067,7 @@ option then the master will log a warning message.
- master.d/*
- /etc/roles/webserver
.. _winrepo-master-config-opts:
Windows Software Repo Settings
@ -4368,3 +4388,82 @@ configured both globally and for individual remotes.
- '+refs/tags/*:refs/tags/*'
- '+refs/pull/*/head:refs/remotes/origin/pr/*'
- '+refs/pull/*/merge:refs/remotes/origin/merge/*'
.. _configure-master-on-windows:
Configure Master on Windows
===========================
The master on Windows requires no additional configuration. You can modify the
master configuration by creating/editing the master config file located at
``c:\salt\conf\master``. The same configuration options available on Linux are
available in Windows, as long as they apply. For example, SSH options wouldn't
apply in Windows. The main differences are the file paths. If you are familiar
with common salt paths, the following table may be useful:
============= ========= =================
linux Paths Windows Paths
============= ========= =================
``/etc/salt`` ``<--->`` ``c:\salt\conf``
``/`` ``<--->`` ``c:\salt``
============= ========= =================
So, for example, the master config file in Linux is ``/etc/salt/master``. In
Windows the master config file is ``c:\salt\conf\master``. The Linux path
``/etc/salt`` becomes ``c:\salt\conf`` in Windows.
Common File Locations
---------------------
====================================== =============================================
Linux Paths Windows Paths
====================================== =============================================
``conf_file: /etc/salt/master`` ``conf_file: c:\salt\conf\master``
``log_file: /var/log/salt/master`` ``log_file: c:\salt\var\log\salt\master``
``pidfile: /var/run/salt-master.pid`` ``pidfile: c:\salt\var\run\salt-master.pid``
====================================== =============================================
Common Directories
------------------
====================================================== ============================================
Linux Paths Windows Paths
====================================================== ============================================
``cachedir: /var/cache/salt/master`` ``cachedir: c:\salt\var\cache\salt\master``
``extension_modules: /var/cache/salt/master/extmods`` ``c:\salt\var\cache\salt\master\extmods``
``pki_dir: /etc/salt/pki/master`` ``pki_dir: c:\salt\conf\pki\master``
``root_dir: /`` ``root_dir: c:\salt``
``sock_dir: /var/run/salt/master`` ``sock_dir: c:\salt\var\run\salt\master``
====================================================== ============================================
Roots
-----
**file_roots**
================== =========================
Linux Paths Windows Paths
================== =========================
``/srv/salt`` ``c:\salt\srv\salt``
``/srv/spm/salt`` ``c:\salt\srv\spm\salt``
================== =========================
**pillar_roots**
==================== ===========================
Linux Paths Windows Paths
==================== ===========================
``/srv/pillar`` ``c:\salt\srv\pillar``
``/srv/spm/pillar`` ``c:\salt\srv\spm\pillar``
==================== ===========================
Win Repo Settings
-----------------
========================================== =================================================
Linux Paths Windows Paths
========================================== =================================================
``winrepo_dir: /srv/salt/win/repo`` ``winrepo_dir: c:\salt\srv\salt\win\repo``
``winrepo_dir_ng: /srv/salt/win/repo-ng`` ``winrepo_dir_ng: c:\salt\srv\salt\win\repo-ng``
========================================== =================================================