From a4c5b4f322054fa396c40c994fb52ae9cc532af8 Mon Sep 17 00:00:00 2001 From: Niels Abspoel Date: Sat, 20 Feb 2016 23:25:06 +0100 Subject: [PATCH] update 2015.8.7 version config for the minion --- salt/files/minion.d/f_defaults.conf | 606 +++++++++++++++++++++++----- 1 file changed, 495 insertions(+), 111 deletions(-) diff --git a/salt/files/minion.d/f_defaults.conf b/salt/files/minion.d/f_defaults.conf index b435690..f09ebca 100644 --- a/salt/files/minion.d/f_defaults.conf +++ b/salt/files/minion.d/f_defaults.conf @@ -1,5 +1,6 @@ # This file managed by Salt, do not edit by hand!! -# Based on salt version 0.17.4 default config +# Based on salt version 2015.8.7 default config +# {% set reserved_keys = ['master', 'minion', 'cloud', 'salt_cloud_certs'] -%} {% set cfg_salt = pillar.get('salt', {}) -%} {% set cfg_minion = cfg_salt.get('minion', {}) -%} @@ -13,13 +14,22 @@ {%- endif -%} {%- endmacro -%} {%- from 'salt/formulas.jinja' import file_roots, formulas with context -%} + ##### Primary configuration settings ##### ########################################## +# This configuration file is used to manage the behavior of the Salt Minion. +# With the exception of the location of the Salt Master Server, values that are +# commented out but have an empty line after the comment are defaults that need +# not be set in the config. If there is no blank line after the comment, the +# value is presented as an example and is not the default. -# minion includes +# Per default the minion will automatically include all config files +# from minion.d/*.conf (minion.d is a directory in the same directory +# as the main minion config file). {{ get_config('default_include', 'minion.d/*.conf') }} -# master configs +# Set the location of the salt master server. If the master server cannot be +# resolved, then the minion will fail to start. {%- if 'master' in cfg_minion and cfg_minion['master'] is not string %} master: {% for name in cfg_minion['master'] -%} @@ -29,126 +39,294 @@ master: {{ get_config('master', 'salt') }} {%- endif %} -# choose a random master +# If multiple masters are specified in the 'master' setting, the default behavior +# is to always try to connect to them in the order they are listed. If random_master is +# set to True, the order will be randomized instead. This can be helpful in distributing +# the load of many minions executing salt-call requests, for example, from a cron job. +# If only one master is listed, this setting is ignored and a warning will be logged. +# NOTE: If master_type is set to failover, use master_shuffle instead. {{ get_config('random_master', 'False') }} -# use IPv6 +# Use if master_type is set to failover. +{{ get_config('master_shuffle', 'False') }} + +# Minions can connect to multiple masters simultaneously (all masters +# are "hot"), or can be configured to failover if a master becomes +# unavailable. Multiple hot masters are configured by setting this +# value to "str". Failover masters can be requested by setting +# to "failover". MAKE SURE TO SET master_alive_interval if you are +# using failover. +{{ get_config('master_type', 'str') }} + +# verify_master_pubkey_sign +{{ get_config('verify_master_pubkey_sign', 'False') }} + +# Poll interval in seconds for checking if the master is still there. Only +# respected if master_type above is "failover". To disable the interval entirely, +# set the value to -1. (This may be necessary on machines which have high numbers +# of TCP connections, such as load balancers.) +{{ get_config('master_alive_interval', '30') }} + +# Set whether the minion should connect to the master via IPv6: {{ get_config('ipv6', 'False') }} -# name resolution retries +# Set the number of seconds to wait before attempting to resolve +# the master hostname if name resolution fails. Defaults to 30 seconds. +# Set to zero if the minion should shutdown and not retry. {{ get_config('retry_dns', '30') }} -# master port +# Set the port used by the master reply and authentication server. {{ get_config('master_port', '4506') }} -# user to run salt. +# The user to run salt. {{ get_config('user', 'root') }} -# PID file +# Setting sudo_user will cause salt to run all execution modules under an sudo +# to the user given in sudo_user. The user under which the salt minion process +# itself runs will still be that provided in the user config above, but all +# execution modules run by the minion will be rerouted through sudo. +{{ get_config('sudo_user', 'saltdev') }} + +# Specify the location of the daemon process ID file. {{ get_config('pidfile', '/var/run/salt-minion.pid') }} -# root dir +# The root directory prepended to these options: pki_dir, cachedir, log_file, +# sock_dir, pidfile. {{ get_config('root_dir', '/') }} -# pki dir +# The directory to store the pki information in {{ get_config('pki_dir', '/etc/salt/pki/minion') }} -# minion id +# Explicitly declare the id for this minion to use, if left commented the id +# will be the hostname as returned by the python call: socket.getfqdn() +# Since salt uses detached ids it is possible to run multiple minions on the +# same machine but with different ids, this can be useful for salt compute +# clusters. {% if 'id' in cfg_minion -%} id: {{ cfg_minion['id'] }} {% else -%} #id: {%- endif %} -# domain name for hostnames +# Append a domain to a hostname in the event that it does not exist. This is +# useful for systems where socket.getfqdn() does not actually result in a +# FQDN (for instance, Solaris). {{ get_config('append_domain', '') }} -# custom grains +# Custom static grains for this minion can be specified here and used in SLS +# files just like all other grains. This example sets 4 custom grains, with +# the 'roles' grain having two values that can be matched against. +#grains: +# roles: +# - webserver +# - memcache +# deployment: datacenter4 +# cabinet: 13 +# cab_u: 14-15 {{ get_config('grains', '{}') }} -# cache location +# Where cache data goes. +# This data may contain sensitive data and should be protected accordingly. {{ get_config('cachedir', '/var/cache/salt/minion') }} -# environment verification +# Verify and set permissions on configuration directories at startup. {{ get_config('verify_env', 'True') }} -# cache executed jobs +# The minion can locally cache the return data from jobs sent to it, this +# can be a good way to keep track of jobs the minion has executed +# (on the minion side). By default this feature is disabled, to enable, set +# cache_jobs to True. {{ get_config('cache_jobs', 'False') }} -# unix socket location +# Set the directory used to hold unix sockets. {{ get_config('sock_dir', '/var/run/salt/minion') }} -# output formatter +# Set the default outputter used by the salt-call command. The default is +# "nested". {{ get_config('output', 'nested') }} -# output color + +# By default output is colored. To disable colored output, set the color value +# to False. {{ get_config('color', 'True') }} -# remove nested color + +# Do not strip off the colored output from nested results and state outputs +# (true by default). {{ get_config('strip_colors', 'False') }} -# backup modified files +# Backup files that are replaced by file.managed and file.recurse under +# 'cachedir'/file_backups relative to their original location and appended +# with a timestamp. The only valid setting is "minion". Disabled by default. +# +# Alternatively this can be specified for each file in state files: +# /etc/ssh/sshd_config: +# file.managed: +# - source: salt://ssh/sshd_config +# - backup: minion +# {{ get_config('backup_mode', 'minion') }} -# key acceptance time +# When waiting for a master to accept the minion's public key, salt will +# continuously attempt to reconnect until successful. This is the time, in +# seconds, between those reconnection attempts. {{ get_config('acceptance_wait_time', '10') }} -# maximum acceptance wait + +# If this is nonzero, the time between reconnection attempts will increase by +# acceptance_wait_time seconds per iteration, up to this maximum. If this is +# set to zero, the time between reconnection attempts will stay constant. {{ get_config('acceptance_wait_time_max', '0') }} -# retry key + +# If the master rejects the minion's public key, retry instead of exiting. +# Rejected keys will be handled the same as waiting on acceptance. {{ get_config('rejected_retry', 'False') }} -# time to wait for trying reauth + +# When the master key changes, the minion will try to re-auth itself to receive +# the new master key. In larger environments this can cause a SYN flood on the +# master because all minions try to re-auth immediately. To prevent this and +# have a minion wait for a random amount of time, use this optional parameter. +# The wait-time will be a random number of seconds between 0 and the defined value. {{ get_config('random_reauth_delay', '60') }} -# auth wait timeout + +# When waiting for a master to accept the minion's public key, salt will +# continuously attempt to reconnect until successful. This is the timeout value, +# in seconds, for each individual attempt. After this timeout expires, the minion +# will wait for acceptance_wait_time seconds before trying again. Unless your master +# is under unusually heavy load, this should be left at the default. {{ get_config('auth_timeout', '60') }} -# auth retries + +# Number of consecutive SaltReqTimeoutError that are acceptable when trying to +# authenticate. {{ get_config('auth_tries', '7') }} -# retry auth if ping failed + +# If authentication fails due to SaltReqTimeoutError during a ping_interval, +# cause sub minion process to restart. {{ get_config('auth_safemode', 'False') }} -# master ping interval +# Ping Master to ensure connection is alive (minutes). {{ get_config('ping_interval', '0') }} -# salt mine functions execution interval -{{ get_config('mine_interval', '60') }} +# To auto recover minions if master changes IP address (DDNS) +# auth_tries: 10 +# auth_safemode: False +# ping_interval: 90 +# +# Minions won't know master is missing until a ping fails. After the ping fail, +# the minion will attempt authentication and likely fails out and cause a restart. +# When the minion restarts it will resolve the masters IP and attempt to reconnect. -# mine functions -{%- if 'mine_functions' in cfg_minion %} -mine_functions: -{%- for func, args in cfg_minion['mine_functions'].items() %} - {{ func }}: {{ args }} -{%- endfor %} -{%- endif %} - -# reconnection parameters +# If you don't have any problems with syn-floods, don't bother with the +# three recon_* settings described below, just leave the defaults! +# +# The ZeroMQ pull-socket that binds to the masters publishing interface tries +# to reconnect immediately, if the socket is disconnected (for example if +# the master processes are restarted). In large setups this will have all +# minions reconnect immediately which might flood the master (the ZeroMQ-default +# is usually a 100ms delay). To prevent this, these three recon_* settings +# can be used. +# recon_default: the interval in milliseconds that the socket should wait before +# trying to reconnect to the master (1000ms = 1 second) +# +# recon_max: the maximum time a socket should wait. each interval the time to wait +# is calculated by doubling the previous time. if recon_max is reached, +# it starts again at recon_default. Short example: +# +# reconnect 1: the socket will wait 'recon_default' milliseconds +# reconnect 2: 'recon_default' * 2 +# reconnect 3: ('recon_default' * 2) * 2 +# reconnect 4: value from previous interval * 2 +# reconnect 5: value from previous interval * 2 +# reconnect x: if value >= recon_max, it starts again with recon_default +# +# recon_randomize: generate a random wait time on minion start. The wait time will +# be a random value between recon_default and recon_default + +# recon_max. Having all minions reconnect with the same recon_default +# and recon_max value kind of defeats the purpose of being able to +# change these settings. If all minions have the same values and your +# setup is quite large (several thousand minions), they will still +# flood the master. The desired behavior is to have timeframe within +# all minions try to reconnect. +# +# Example on how to use these settings. The goal: have all minions reconnect within a +# 60 second timeframe on a disconnect. +# recon_default: 1000 +# recon_max: 59000 +# recon_randomize: True +# +# Each minion will have a randomized reconnect value between 'recon_default' +# and 'recon_default + recon_max', which in this example means between 1000ms +# 60000ms (or between 1 and 60 seconds). The generated random-value will be +# doubled after each attempt to reconnect. Lets say the generated random +# value is 11 seconds (or 11000ms). +# reconnect 1: wait 11 seconds +# reconnect 2: wait 22 seconds +# reconnect 3: wait 33 seconds +# reconnect 4: wait 44 seconds +# reconnect 5: wait 55 seconds +# reconnect 6: wait time is bigger than 60 seconds (recon_default + recon_max) +# reconnect 7: wait 11 seconds +# reconnect 8: wait 22 seconds +# reconnect 9: wait 33 seconds +# reconnect x: etc. +# +# In a setup with ~6000 thousand hosts these settings would average the reconnects +# to about 100 per second and all hosts would be reconnected within 60 seconds. {{ get_config('recon_default', '100') }} {{ get_config('recon_max', '5000') }} {{ get_config('recon_randomize', 'False') }} -# minion scheduler interval +# The loop_interval sets how long in seconds the minion will wait between +# evaluating the scheduler and running cleanup tasks. This defaults to a +# sane 60 seconds, but if the minion scheduler needs to be evaluated more +# often lower this value {{ get_config('loop_interval', '60') }} -# grain refresh interval +# The grains_refresh_every setting allows for a minion to periodically check +# its grains to see if they have changed and, if so, to inform the master +# of the new grains. This operation is moderately expensive, therefore +# care should be taken not to set this value too low. +# +# Note: This value is expressed in __minutes__! +# +# A value of 10 minutes is a reasonable default. +# +# If the value is set to zero, this check is disabled. {{ get_config('grains_refresh_every', '1') }} -# cache grains in minion + +# Cache grains on the minion. Default is False. {{ get_config('grains_cache', 'False') }} -# grains cache expiration interval + +# Grains cache expiration, in seconds. If the cache file is older than this +# number of seconds then the grains cache will be dumped and fully re-populated +# with fresh data. Defaults to 5 minutes. Will have no effect if 'grains_cache' +# is not enabled. {{ get_config('grains_cache_expiration', '300') }} -# ipc method +# Windows platforms lack posix IPC and must rely on slower TCP based inter- +# process communications. Set ipc_mode to 'tcp' on such systems {{ get_config('ipc_mode', 'ipc') }} -# ipc tcp ports + +# Overwrite the default tcp ports used by the minion when in tcp mode {{ get_config('tcp_pub_port', '4510') }} {{ get_config('tcp_pull_port', '4511') }} -# max event size in minion bus +# Passing very large events can cause the minion to consume large amounts of +# memory. This value tunes the maximum size of a message allowed onto the +# minion event bus. The value is expressed in bytes. {{ get_config('max_event_size', '1048576') }} -# master check alive interval +# To detect failed master(s) and fire events on connect/disconnect, set +# master_alive_interval to the number of seconds to poll the masters for +# connection events. +# {{ get_config('master_alive_interval', '30') }} -# verify_master_pubkey_sign -{{ get_config('verify_master_pubkey_sign', 'False') }} -{{ get_config('master_type', 'str') }} - -# include extra config +# The minion can include configuration from other files. To enable this, +# pass a list of paths to this option. The paths can be either relative or +# absolute; if relative, they are considered to be relative to the directory +# the main minion configuration file lives in (this file). Paths can make use +# of shell-style globbing. If no files are matched by a path passed to this +# option then the minion will log a warning message. +# +# Include a config file from some other path: {% if 'include' in cfg_minion -%} {% if isinstance(cfg_minion['include'], list) -%} include: @@ -169,58 +347,133 @@ mine_functions: {% endif -%} {% endif -%} - ##### Minion module management ##### ########################################## -# disable modules +# Disable specific modules. This allows the admin to limit the level of +# access the master has to the minion. {{ get_config('disable_modules', '[cmd,test]') }} {{ get_config('disable_returners', '[]') }} -# -# minion modules search paths + +# Modules can be loaded from arbitrary paths. This enables the easy deployment +# of third party modules. Modules for returners and minions can be loaded. +# Specify a list of extra directories to search for minion modules and +# returners. These paths must be fully qualified! {{ get_config('module_dirs', '[]') }} {{ get_config('returner_dirs', '[]') }} {{ get_config('states_dirs', '[]') }} {{ get_config('render_dirs', '[]') }} {{ get_config('utils_dirs', '[]') }} -# module overrides -{{ get_config('providers', '{}') }} -# enable cython modules -{{ get_config('cython_enable', 'False') }} -# max module size -{{ get_config('modules_max_memory', '-1') }} +# A module provider can be statically overwritten or extended for the minion +# via the providers option, in this case the default module will be +# overwritten by the specified module. In this example the pkg module will +# be provided by the yumpkg5 module instead of the system default. +#providers: +# pkg: yumpkg5 +{{ get_config('providers', '{}') }} + +# Enable Cython modules searching and loading. (Default: False) +{{ get_config('cython_enable', 'False') }} + +# Specify a max size (in bytes) for modules on import. This feature is currently +# only supported on *nix operating systems and requires psutil. +{{ get_config('modules_max_memory', '-1') }} ##### State Management Settings ##### ########################################### -# renderer selection +# The state management system executes all of the state templates on the minion +# to enable more granular control of system state management. The type of +# template and serialization used for state management needs to be configured +# on the minion, the default renderer is yaml_jinja. This is a yaml file +# rendered from a jinja template, the available options are: +# yaml_jinja +# yaml_mako +# yaml_wempy +# json_jinja +# json_mako +# json_wempy +# {{ get_config('renderer', 'yaml_jinja') }} -# fail on first failure + +# The failhard option tells the minions to stop immediately after the first +# failure detected in the state execution. Defaults to False. {{ get_config('failhard', 'False') }} -# auto reload dynamic modules + +# Reload the modules prior to a highstate run. {{ get_config('autoload_dynamic_modules', 'True') }} -# sync dynamic modules with deletion + +# clean_dynamic_modules keeps the dynamic modules on the minion in sync with +# the dynamic modules on the master, this means that if a dynamic module is +# not on the master it will be deleted from the minion. By default, this is +# enabled and can be disabled by changing this value to False. {{ get_config('clean_dynamic_modules', 'True') }} -# minion accepted environment + +# Normally, the minion is not isolated to any single environment on the master +# when running states, but the environment can be isolated on the minion side +# by statically setting it. Remember that the recommended way to manage +# environments is to isolate via the top file. {{ get_config('environment', 'None') }} -# top state file + +# If using the local file directory, then the state top file name needs to be +# defined, by default this is top.sls. {{ get_config('state_top', 'top.sls') }} -# states to run in minion daemon + +# Run states when the minion daemon starts. To enable, set startup_states to: +# 'highstate' -- Execute state.highstate +# 'sls' -- Read in the sls_list option and execute the named sls files +# 'top' -- Read top_file option and execute based on that file on the Master {{ get_config('startup_states', "''") }} -# sls states to run + +# List of states to run when the minion starts up if startup_states is 'sls': +#sls_list: +# - edit.vim +# - hyper {{ get_config('sls_list', '[]') }} -# top file to run + +# Top file to execute if startup_states is 'top': {{ get_config('top_file', "''") }} +# Automatically aggregate all states that have support for mod_aggregate by +# setting to True. Or pass a list of state module names to automatically +# aggregate just those types. +# +# state_aggregate: +# - pkg +# +#state_aggregate: False +{{ get_config('state_aggregate', '{}') }} + ##### File Directory Settings ##### ########################################## -# file client location +# The Salt Minion can redirect all file server operations to a local directory, +# this allows for the same state tree that is on the master to be used if +# copied completely onto the minion. This is a literal copy of the settings on +# the master but used to reference a local directory on the minion. + +# Set the file client. The client defaults to looking on the master server for +# files, but can be directed to look at the local file directory setting +# defined below by setting it to "local". Setting a local file_client runs the +# minion in masterless mode. {%- if standalone %} file_client: local {%- else %} {{ get_config('file_client', 'remote') }} {%- endif %} -# environment file roots +# The file directory works on environments passed to the minion, 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: +# file_roots: +# base: +# - /srv/salt/ +# dev: +# - /srv/salt/dev/services +# - /srv/salt/dev/states +# prod: +# - /srv/salt/prod/services +# - /srv/salt/prod/states {% if 'file_roots' in cfg_minion -%} {{ file_roots(cfg_minion['file_roots']) }} {%- elif 'file_roots' in cfg_salt -%} @@ -229,9 +482,22 @@ file_client: local {{ file_roots({'base': ['/srv/salt']}) }} {%- endif %} -# limit fileserver traversal +# By default, the Salt fileserver recurses fully into all defined environments +# to attempt to find files. To limit this behavior so that the fileserver only +# traverses directories with SLS files and special Salt directories like _modules, +# enable the option below. This might be useful for installations where a file root +# has a very large number of files and performance is negatively impacted. Default +# is False. {{ get_config('fileserver_limit_traversal', 'False') }} +# The hash_type is the hash to use when discovering the hash of a file in +# the local fileserver. The default is md5, but sha1, sha224, sha256, sha384 +# and sha512 are also supported. +# +# Warning: Prior to changing this value, the minion should be stopped and all +# Salt caches should be cleared. +{{ get_config('hash_type', 'md5') }} + # gitfs provider {{ get_config('gitfs_provider', 'pygit2') }} # gitfs remotes @@ -257,10 +523,9 @@ gitfs_remotes: # gitfs root dir {{ get_config('gitfs_root', 'somefolder/otherfolder') }} -# file hash method -{{ get_config('hash_type', 'md5') }} - -# pillar roots +# The Salt pillar is searched for locally if file_client is set to local. If +# this is the case, and pillar data is defined, then the pillar_roots need to +# also be configured on the minion: {% if 'pillar_roots' in cfg_minion -%} pillar_roots: {%- for name, roots in cfg_minion['pillar_roots']|dictsort %} @@ -282,86 +547,205 @@ pillar_roots: ###### Security settings ##### ########################################### -# disable authentication +# Enable "open mode", this mode still maintains encryption, but turns off +# authentication, this is only intended for highly secure environments or for +# the situation where your keys end up in a bad state. If you run in open mode +# you do so at your own risk! {{ get_config('open_mode', 'False') }} -# allow access to pki dir + +# Enable permissive access to the salt keys. This allows you to run the +# master or minion as root, but have a non-root group be given access to +# your pki_dir. To make the access explicit, root must belong to the group +# you've given access to. This is potentially quite insecure. {{ get_config('permissive_pki_access', 'False') }} -# print verbose changes +# The state_verbose and state_output settings can be used to change the way +# state system data is printed to the display. By default all data is printed. +# The state_verbose setting can be set to True or False, when set to False +# all data that has a result of True and no changes will be suppressed. {{ get_config('state_verbose', 'True') }} -# multi line output + +# The state_output setting changes if the output is the full multi line +# output for each changed state if set to 'full', but if set to 'terse' +# the output will be shortened to a single line. {{ get_config('state_output', 'full') }} -# output diff + +# The state_output_diff setting changes whether or not the output from +# successful states is returned. Useful when even the terse output of these +# states is cluttering the logs. Set it to True to ignore them. {{ get_config('state_output_diff', 'False') }} -# master fingerprint +# The state_output_profile setting changes whether profile information +# will be shown for each state run. +{{ get_config('state_output_profile', 'True') }} + +# Fingerprint of the master public key to validate the identity of your Salt master +# before the initial key exchange. The master fingerprint can be found by running +# "salt-key -F master" on the Salt master. {{ get_config('master_finger', "''") }} + ###### Thread settings ##### ########################################### -# enable multiprocessing +# Disable multiprocessing support, by default when a minion receives a +# publication a new process is spawned and the command is executed therein. {{ get_config('multiprocessing', 'True') }} ##### Logging settings ##### ########################################## -# log file and log lock file location +# The location of the minion log file +# The minion log can be sent to a regular file, local path name, or network +# location. Remote logging works best when configured to use rsyslogd(8) (e.g.: +# ``file:///dev/log``), with rsyslogd(8) configured for network logging. The URI +# format is: ://:/ +#log_file: /var/log/salt/minion +#log_file: file:///dev/log +#log_file: udp://loghost:10514 +# {{ get_config('log_file', '/var/log/salt/minion') }} {{ get_config('key_logfile', ' /var/log/salt/key') }} -# console log level +# The level of messages to send to the console. +# One of 'garbage', 'trace', 'debug', info', 'warning', 'error', 'critical'. +# +# The following log levels are considered INSECURE and may log sensitive data: +# ['garbage', 'trace', 'debug'] +# +# Default: 'warning' {{ get_config('log_level', 'warning') }} -# logfile log level + +# The level of messages to send to the log file. +# One of 'garbage', 'trace', 'debug', info', 'warning', 'error', 'critical'. +# If using 'log_granular_levels' this must be set to the highest desired level. +# Default: 'warning' {{ get_config('log_level_logfile', '') }} -# datetime format for console and logfile +# The date and time format used in log messages. Allowed date/time formating +# can be seen here: http://docs.python.org/library/time.html#time.strftime {{ get_config('log_datefmt', "'%H:%M:%S'") }} {{ get_config('log_datefmt_logfile', "'%Y-%m-%d %H:%M:%S'") }} -# log format for console and logfiles +# The format of the console logging messages. Allowed formatting options can +# be seen here: http://docs.python.org/library/logging.html#logrecord-attributes +# +# Console log colors are specified by these additional formatters: +# +# %(colorlevel)s +# %(colorname)s +# %(colorprocess)s +# %(colormsg)s +# +# Since it is desirable to include the surrounding brackets, '[' and ']', in +# the coloring of the messages, these color formatters also include padding as +# well. Color LogRecord attributes are only available for console logging. +# +{{ get_config('log_fmt_console', "'%(colorlevel)s %(colormsg)s'") }} {{ get_config('log_fmt_console', "'[%(levelname)-8s] %(message)s'") }} +# {{ get_config('log_fmt_logfile', "'%(asctime)s,%(msecs)03.0f [%(name)-17s][%(levelname)-8s] %(message)s'") }} -# log particular modules +# This can be used to control logging levels more specificically. This +# example sets the main salt library at the 'warning' level, but sets +# 'salt.modules' to log at the 'debug' level: +# log_granular_levels: +# 'salt': 'warning' +# 'salt.modules': 'debug' +# {{ get_config('log_granular_levels', '{}') }} +# To diagnose issues with minions disconnecting or missing returns, ZeroMQ +# supports the use of monitor sockets to log connection events. This +# feature requires ZeroMQ 4.0 or higher. +# +# To enable ZeroMQ monitor sockets, set 'zmq_monitor' to 'True' and log at a +# debug level or higher. +# +# A sample log event is as follows: +# +# [DEBUG ] ZeroMQ event: {'endpoint': 'tcp://127.0.0.1:4505', 'event': 512, +# 'value': 27, 'description': 'EVENT_DISCONNECTED'} +# +# All events logged will include the string 'ZeroMQ event'. A connection event +# should be logged as the minion starts up and initially connects to the +# master. If not, check for debug log level and that the necessary version of +# ZeroMQ is installed. +# +{{ get_config('zmq_monitor', 'False') }} ###### Module configuration ##### ########################################### -# module parameters -{%- if 'module_config' in cfg_minion %} -{%- for modkey, modval in cfg_minion.module_config.items() %} -{{ modkey }}: {{ modval }} -{%- endfor %} -{%- endif %} - +# Salt allows for modules to be passed arbitrary configuration data, any data +# passed here in valid yaml format will be passed on to the salt minion modules +# for use. It is STRONGLY recommended that a naming convention be used in which +# the module name is followed by a . and then the value. Also, all top level +# data must be applied via the yaml dict construct, some examples: +# +# You can specify that all modules should run in test mode: +{{ get_config('test', 'True') }} +# A simple value for the test module: +#test.foo: foo +# +# A list for the test module: +#test.bar: [baz,quo] +# +# A dict for the test module: +#test.baz: {spam: sausage, cheese: bread} +# +# ###### Update settings ###### ########################################### -# update url +# Using the features in Esky, a salt minion can both run as a frozen app and +# be updated on the fly. These options control how the update process +# (saltutil.update()) behaves. +# +# The url for finding and downloading updates. Disabled by default. {{ get_config('update_url', 'False') }} -# services to restart after update +# +# The list of services to restart after a successful update. Empty by default. {{ get_config('update_restart_services', '[]') }} ###### Keepalive settings ###### ############################################ -# use tcp keepalive +# ZeroMQ now includes support for configuring SO_KEEPALIVE if supported by +# the OS. If connections between the minion and the master pass through +# a state tracking device such as a firewall or VPN gateway, there is +# the risk that it could tear down the connection the master and minion +# without informing either party that their connection has been taken away. +# Enabling TCP Keepalives prevents this from happening. + +# Overall state of TCP Keepalives, enable (1 or True), disable (0 or False) +# or leave to the OS defaults (-1), on Linux, typically disabled. Default True, enabled. {{ get_config('tcp_keepalive', 'True') }} -# first keepalive from idle + +# How long before the first keepalive should be sent in seconds. Default 300 +# to send the first keepalive after 5 minutes, OS default (-1) is typically 7200 seconds +# on Linux see /proc/sys/net/ipv4/tcp_keepalive_time. {{ get_config('tcp_keepalive_idle', '300') }} -# keepalive number for connection lost + +# How many lost probes are needed to consider the connection lost. Default -1 +# to use OS defaults, typically 9 on Linux, see /proc/sys/net/ipv4/tcp_keepalive_probes. {{ get_config('tcp_keepalive_cnt', '-1') }} -# keepalive interval + +# How often, in seconds, to send keepalives after the first one. Default -1 to +# use OS defaults, typically 75 seconds on Linux, see +# /proc/sys/net/ipv4/tcp_keepalive_intvl. {{ get_config('tcp_keepalive_intvl', '-1') }} - -###### Windows Software settings ###### +###### Windows Software settings ###### ############################################ -# windows repo cache +# Location of the repository cache file on the master: {{ get_config('win_repo_cachefile', 'salt://win/repo/winrepo.p') }} -###### Returner settings ###### +###### Returner settings ###### ############################################ -# default returner +# Which returner(s) will be used for minion's result: {{ get_config('return', '') }} + +###### Miscellaneous settings ###### +############################################ +# Default match type for filtering events tags: startswith, endswith, find, regex, fnmatch +#event_match_type: startswith +{{ get_config('event_match_type', 'startswith') }}