Saltstack Official Salt Formula
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1029 line
42KB

  1. # This file managed by Salt, do not edit by hand!!
  2. # Based on salt version 2015.8.7 default config
  3. #
  4. {% set reserved_keys = ['master', 'minion', 'cloud', 'salt_cloud_certs', 'engines'] -%}
  5. {% set cfg_salt = pillar.get('salt', {}) -%}
  6. {% set cfg_minion = cfg_salt.get('minion', {}) -%}
  7. {% set default_keys = [] -%}
  8. {%- macro get_config(configname, default_value) -%}
  9. {%- do default_keys.append(configname) %}
  10. {%- if configname in cfg_minion -%}
  11. {{ configname }}: {{ cfg_minion[configname]|json }}
  12. {%- elif configname in cfg_salt and configname not in reserved_keys -%}
  13. {{ configname }}: {{ cfg_salt[configname]|json }}
  14. {%- else -%}
  15. #{{ configname }}: {{ default_value|json }}
  16. {%- endif -%}
  17. {%- endmacro -%}
  18. {%- from 'salt/formulas.jinja' import file_roots, formulas with context -%}
  19. ##### Primary configuration settings #####
  20. ##########################################
  21. # This configuration file is used to manage the behavior of the Salt Minion.
  22. # With the exception of the location of the Salt Master Server, values that are
  23. # commented out but have an empty line after the comment are defaults that need
  24. # not be set in the config. If there is no blank line after the comment, the
  25. # value is presented as an example and is not the default.
  26. # Per default the minion will automatically include all config files
  27. # from minion.d/*.conf (minion.d is a directory in the same directory
  28. # as the main minion config file).
  29. {{ get_config('default_include', 'minion.d/*.conf') }}
  30. # Set the location of the salt master server. If the master server cannot be
  31. # resolved, then the minion will fail to start.
  32. {%- if 'master' in cfg_minion and cfg_minion['master'] is not string %}
  33. master:
  34. {% for name in cfg_minion['master'] -%}
  35. - {{ name }}
  36. {% endfor -%}
  37. {%- else %}
  38. {{ get_config('master', 'salt') }}
  39. {%- endif %}
  40. # If multiple masters are specified in the 'master' setting, the default behavior
  41. # is to always try to connect to them in the order they are listed. If random_master is
  42. # set to True, the order will be randomized instead. This can be helpful in distributing
  43. # the load of many minions executing salt-call requests, for example, from a cron job.
  44. # If only one master is listed, this setting is ignored and a warning will be logged.
  45. # NOTE: If master_type is set to failover, use master_shuffle instead.
  46. {{ get_config('random_master', 'False') }}
  47. # Use if master_type is set to failover.
  48. {{ get_config('master_shuffle', 'False') }}
  49. # Minions can connect to multiple masters simultaneously (all masters
  50. # are "hot"), or can be configured to failover if a master becomes
  51. # unavailable. Multiple hot masters are configured by setting this
  52. # value to "str". Failover masters can be requested by setting
  53. # to "failover". MAKE SURE TO SET master_alive_interval if you are
  54. # using failover.
  55. {{ get_config('master_type', 'str') }}
  56. # verify_master_pubkey_sign
  57. {{ get_config('verify_master_pubkey_sign', 'False') }}
  58. # Poll interval in seconds for checking if the master is still there. Only
  59. # respected if master_type above is "failover". To disable the interval entirely,
  60. # set the value to -1. (This may be necessary on machines which have high numbers
  61. # of TCP connections, such as load balancers.)
  62. {{ get_config('master_alive_interval', '30') }}
  63. # Set whether the minion should connect to the master via IPv6:
  64. {{ get_config('ipv6', 'False') }}
  65. # Set the number of seconds to wait before attempting to resolve
  66. # the master hostname if name resolution fails. Defaults to 30 seconds.
  67. # Set to zero if the minion should shutdown and not retry.
  68. {{ get_config('retry_dns', '30') }}
  69. # Set the port used by the master reply and authentication server.
  70. {{ get_config('master_port', '4506') }}
  71. # The user to run salt.
  72. {{ get_config('user', 'root') }}
  73. # Setting sudo_user will cause salt to run all execution modules under an sudo
  74. # to the user given in sudo_user. The user under which the salt minion process
  75. # itself runs will still be that provided in the user config above, but all
  76. # execution modules run by the minion will be rerouted through sudo.
  77. {{ get_config('sudo_user', 'saltdev') }}
  78. # Specify the location of the daemon process ID file.
  79. {{ get_config('pidfile', '/var/run/salt-minion.pid') }}
  80. # The root directory prepended to these options: pki_dir, cachedir, log_file,
  81. # sock_dir, pidfile.
  82. {{ get_config('root_dir', '/') }}
  83. # The directory to store the pki information in
  84. {{ get_config('pki_dir', '/etc/salt/pki/minion') }}
  85. # Explicitly declare the id for this minion to use, if left commented the id
  86. # will be the hostname as returned by the python call: socket.getfqdn()
  87. # Since salt uses detached ids it is possible to run multiple minions on the
  88. # same machine but with different ids, this can be useful for salt compute
  89. # clusters.
  90. {% if 'id' in cfg_minion -%}
  91. {%- do default_keys.append('id') %}
  92. id: {{ cfg_minion['id'] }}
  93. {% else -%}
  94. #id:
  95. {%- endif %}
  96. # Append a domain to a hostname in the event that it does not exist. This is
  97. # useful for systems where socket.getfqdn() does not actually result in a
  98. # FQDN (for instance, Solaris).
  99. {{ get_config('append_domain', '') }}
  100. # Custom static grains for this minion can be specified here and used in SLS
  101. # files just like all other grains. This example sets 4 custom grains, with
  102. # the 'roles' grain having two values that can be matched against.
  103. #grains:
  104. # roles:
  105. # - webserver
  106. # - memcache
  107. # deployment: datacenter4
  108. # cabinet: 13
  109. # cab_u: 14-15
  110. {{ get_config('grains', '{}') }}
  111. # Where cache data goes.
  112. # This data may contain sensitive data and should be protected accordingly.
  113. {{ get_config('cachedir', '/var/cache/salt/minion') }}
  114. # Verify and set permissions on configuration directories at startup.
  115. {{ get_config('verify_env', 'True') }}
  116. # The minion can locally cache the return data from jobs sent to it, this
  117. # can be a good way to keep track of jobs the minion has executed
  118. # (on the minion side). By default this feature is disabled, to enable, set
  119. # cache_jobs to True.
  120. {{ get_config('cache_jobs', 'False') }}
  121. # Set the directory used to hold unix sockets.
  122. {{ get_config('sock_dir', '/var/run/salt/minion') }}
  123. # Set the default outputter used by the salt-call command. The default is
  124. # "nested".
  125. {{ get_config('output', 'nested') }}
  126. # By default output is colored. To disable colored output, set the color value
  127. # to False.
  128. {{ get_config('color', 'True') }}
  129. # Do not strip off the colored output from nested results and state outputs
  130. # (true by default).
  131. {{ get_config('strip_colors', 'False') }}
  132. # Backup files that are replaced by file.managed and file.recurse under
  133. # 'cachedir'/file_backups relative to their original location and appended
  134. # with a timestamp. The only valid setting is "minion". Disabled by default.
  135. #
  136. # Alternatively this can be specified for each file in state files:
  137. # /etc/ssh/sshd_config:
  138. # file.managed:
  139. # - source: salt://ssh/sshd_config
  140. # - backup: minion
  141. #
  142. {{ get_config('backup_mode', 'minion') }}
  143. # When waiting for a master to accept the minion's public key, salt will
  144. # continuously attempt to reconnect until successful. This is the time, in
  145. # seconds, between those reconnection attempts.
  146. {{ get_config('acceptance_wait_time', '10') }}
  147. # If this is nonzero, the time between reconnection attempts will increase by
  148. # acceptance_wait_time seconds per iteration, up to this maximum. If this is
  149. # set to zero, the time between reconnection attempts will stay constant.
  150. {{ get_config('acceptance_wait_time_max', '0') }}
  151. # If the master rejects the minion's public key, retry instead of exiting.
  152. # Rejected keys will be handled the same as waiting on acceptance.
  153. {{ get_config('rejected_retry', 'False') }}
  154. # When the master key changes, the minion will try to re-auth itself to receive
  155. # the new master key. In larger environments this can cause a SYN flood on the
  156. # master because all minions try to re-auth immediately. To prevent this and
  157. # have a minion wait for a random amount of time, use this optional parameter.
  158. # The wait-time will be a random number of seconds between 0 and the defined value.
  159. {{ get_config('random_reauth_delay', '60') }}
  160. # When waiting for a master to accept the minion's public key, salt will
  161. # continuously attempt to reconnect until successful. This is the timeout value,
  162. # in seconds, for each individual attempt. After this timeout expires, the minion
  163. # will wait for acceptance_wait_time seconds before trying again. Unless your master
  164. # is under unusually heavy load, this should be left at the default.
  165. {{ get_config('auth_timeout', '60') }}
  166. # Number of consecutive SaltReqTimeoutError that are acceptable when trying to
  167. # authenticate.
  168. {{ get_config('auth_tries', '7') }}
  169. # If authentication fails due to SaltReqTimeoutError during a ping_interval,
  170. # cause sub minion process to restart.
  171. {{ get_config('auth_safemode', 'False') }}
  172. # Ping Master to ensure connection is alive (minutes).
  173. {{ get_config('ping_interval', '0') }}
  174. {%- if 'mine_functions' in cfg_minion %}
  175. {%- do default_keys.append('mine_functions') %}
  176. mine_functions:
  177. {%- for func, args in cfg_minion['mine_functions'].items() %}
  178. {{ func }}: {{ args }}
  179. {%- endfor %}
  180. {%- endif %}
  181. # To auto recover minions if master changes IP address (DDNS)
  182. # auth_tries: 10
  183. # auth_safemode: False
  184. # ping_interval: 90
  185. #
  186. # Minions won't know master is missing until a ping fails. After the ping fail,
  187. # the minion will attempt authentication and likely fails out and cause a restart.
  188. # When the minion restarts it will resolve the masters IP and attempt to reconnect.
  189. # If you don't have any problems with syn-floods, don't bother with the
  190. # three recon_* settings described below, just leave the defaults!
  191. #
  192. # The ZeroMQ pull-socket that binds to the masters publishing interface tries
  193. # to reconnect immediately, if the socket is disconnected (for example if
  194. # the master processes are restarted). In large setups this will have all
  195. # minions reconnect immediately which might flood the master (the ZeroMQ-default
  196. # is usually a 100ms delay). To prevent this, these three recon_* settings
  197. # can be used.
  198. # recon_default: the interval in milliseconds that the socket should wait before
  199. # trying to reconnect to the master (1000ms = 1 second)
  200. #
  201. # recon_max: the maximum time a socket should wait. each interval the time to wait
  202. # is calculated by doubling the previous time. if recon_max is reached,
  203. # it starts again at recon_default. Short example:
  204. #
  205. # reconnect 1: the socket will wait 'recon_default' milliseconds
  206. # reconnect 2: 'recon_default' * 2
  207. # reconnect 3: ('recon_default' * 2) * 2
  208. # reconnect 4: value from previous interval * 2
  209. # reconnect 5: value from previous interval * 2
  210. # reconnect x: if value >= recon_max, it starts again with recon_default
  211. #
  212. # recon_randomize: generate a random wait time on minion start. The wait time will
  213. # be a random value between recon_default and recon_default +
  214. # recon_max. Having all minions reconnect with the same recon_default
  215. # and recon_max value kind of defeats the purpose of being able to
  216. # change these settings. If all minions have the same values and your
  217. # setup is quite large (several thousand minions), they will still
  218. # flood the master. The desired behavior is to have timeframe within
  219. # all minions try to reconnect.
  220. #
  221. # Example on how to use these settings. The goal: have all minions reconnect within a
  222. # 60 second timeframe on a disconnect.
  223. # recon_default: 1000
  224. # recon_max: 59000
  225. # recon_randomize: True
  226. #
  227. # Each minion will have a randomized reconnect value between 'recon_default'
  228. # and 'recon_default + recon_max', which in this example means between 1000ms
  229. # 60000ms (or between 1 and 60 seconds). The generated random-value will be
  230. # doubled after each attempt to reconnect. Lets say the generated random
  231. # value is 11 seconds (or 11000ms).
  232. # reconnect 1: wait 11 seconds
  233. # reconnect 2: wait 22 seconds
  234. # reconnect 3: wait 33 seconds
  235. # reconnect 4: wait 44 seconds
  236. # reconnect 5: wait 55 seconds
  237. # reconnect 6: wait time is bigger than 60 seconds (recon_default + recon_max)
  238. # reconnect 7: wait 11 seconds
  239. # reconnect 8: wait 22 seconds
  240. # reconnect 9: wait 33 seconds
  241. # reconnect x: etc.
  242. #
  243. # In a setup with ~6000 thousand hosts these settings would average the reconnects
  244. # to about 100 per second and all hosts would be reconnected within 60 seconds.
  245. {{ get_config('recon_default', '100') }}
  246. {{ get_config('recon_max', '5000') }}
  247. {{ get_config('recon_randomize', 'False') }}
  248. # The loop_interval sets how long in seconds the minion will wait between
  249. # evaluating the scheduler and running cleanup tasks. This defaults to a
  250. # sane 60 seconds, but if the minion scheduler needs to be evaluated more
  251. # often lower this value
  252. {{ get_config('loop_interval', '60') }}
  253. # The grains_refresh_every setting allows for a minion to periodically check
  254. # its grains to see if they have changed and, if so, to inform the master
  255. # of the new grains. This operation is moderately expensive, therefore
  256. # care should be taken not to set this value too low.
  257. #
  258. # Note: This value is expressed in __minutes__!
  259. #
  260. # A value of 10 minutes is a reasonable default.
  261. #
  262. # If the value is set to zero, this check is disabled.
  263. {{ get_config('grains_refresh_every', '1') }}
  264. # Cache grains on the minion. Default is False.
  265. {{ get_config('grains_cache', 'False') }}
  266. # Grains cache expiration, in seconds. If the cache file is older than this
  267. # number of seconds then the grains cache will be dumped and fully re-populated
  268. # with fresh data. Defaults to 5 minutes. Will have no effect if 'grains_cache'
  269. # is not enabled.
  270. {{ get_config('grains_cache_expiration', '300') }}
  271. # Windows platforms lack posix IPC and must rely on slower TCP based inter-
  272. # process communications. Set ipc_mode to 'tcp' on such systems
  273. {{ get_config('ipc_mode', 'ipc') }}
  274. # Overwrite the default tcp ports used by the minion when in tcp mode
  275. {{ get_config('tcp_pub_port', '4510') }}
  276. {{ get_config('tcp_pull_port', '4511') }}
  277. # Passing very large events can cause the minion to consume large amounts of
  278. # memory. This value tunes the maximum size of a message allowed onto the
  279. # minion event bus. The value is expressed in bytes.
  280. {{ get_config('max_event_size', '1048576') }}
  281. # To detect failed master(s) and fire events on connect/disconnect, set
  282. # master_alive_interval to the number of seconds to poll the masters for
  283. # connection events.
  284. #
  285. {{ get_config('master_alive_interval', '30') }}
  286. # The minion can include configuration from other files. To enable this,
  287. # pass a list of paths to this option. The paths can be either relative or
  288. # absolute; if relative, they are considered to be relative to the directory
  289. # the main minion configuration file lives in (this file). Paths can make use
  290. # of shell-style globbing. If no files are matched by a path passed to this
  291. # option then the minion will log a warning message.
  292. #
  293. # Include a config file from some other path:
  294. {% if 'include' in cfg_minion -%}
  295. {%- do default_keys.append('include') %}
  296. {% if isinstance(cfg_minion['include'], list) -%}
  297. include:
  298. {% for include in cfg_minion['include'] -%}
  299. - {{ include }}
  300. {% endfor -%}
  301. {% else -%}
  302. include: cfg_minion['include']
  303. {% endif -%}
  304. {% elif 'include' in cfg_salt -%}
  305. {% if isinstance(cfg_salt['include'], list) -%}
  306. include:
  307. {% for include in cfg_salt['include'] -%}
  308. - {{ include }}
  309. {% endfor -%}
  310. {% else -%}
  311. include: cfg_salt['include']
  312. {% endif -%}
  313. {% endif -%}
  314. ##### Minion module management #####
  315. ##########################################
  316. # Disable specific modules. This allows the admin to limit the level of
  317. # access the master has to the minion.
  318. {{ get_config('disable_modules', '[cmd,test]') }}
  319. {{ get_config('disable_returners', '[]') }}
  320. # Modules can be loaded from arbitrary paths. This enables the easy deployment
  321. # of third party modules. Modules for returners and minions can be loaded.
  322. # Specify a list of extra directories to search for minion modules and
  323. # returners. These paths must be fully qualified!
  324. {{ get_config('module_dirs', '[]') }}
  325. {{ get_config('returner_dirs', '[]') }}
  326. {{ get_config('states_dirs', '[]') }}
  327. {{ get_config('render_dirs', '[]') }}
  328. {{ get_config('utils_dirs', '[]') }}
  329. # A module provider can be statically overwritten or extended for the minion
  330. # via the providers option, in this case the default module will be
  331. # overwritten by the specified module. In this example the pkg module will
  332. # be provided by the yumpkg5 module instead of the system default.
  333. #providers:
  334. # pkg: yumpkg5
  335. {{ get_config('providers', '{}') }}
  336. # Enable Cython modules searching and loading. (Default: False)
  337. {{ get_config('cython_enable', 'False') }}
  338. # Specify a max size (in bytes) for modules on import. This feature is currently
  339. # only supported on *nix operating systems and requires psutil.
  340. {{ get_config('modules_max_memory', '-1') }}
  341. ##### State Management Settings #####
  342. ###########################################
  343. # The state management system executes all of the state templates on the minion
  344. # to enable more granular control of system state management. The type of
  345. # template and serialization used for state management needs to be configured
  346. # on the minion, the default renderer is yaml_jinja. This is a yaml file
  347. # rendered from a jinja template, the available options are:
  348. # yaml_jinja
  349. # yaml_mako
  350. # yaml_wempy
  351. # json_jinja
  352. # json_mako
  353. # json_wempy
  354. #
  355. {{ get_config('renderer', 'yaml_jinja') }}
  356. # The failhard option tells the minions to stop immediately after the first
  357. # failure detected in the state execution. Defaults to False.
  358. {{ get_config('failhard', 'False') }}
  359. # Reload the modules prior to a highstate run.
  360. {{ get_config('autoload_dynamic_modules', 'True') }}
  361. # clean_dynamic_modules keeps the dynamic modules on the minion in sync with
  362. # the dynamic modules on the master, this means that if a dynamic module is
  363. # not on the master it will be deleted from the minion. By default, this is
  364. # enabled and can be disabled by changing this value to False.
  365. {{ get_config('clean_dynamic_modules', 'True') }}
  366. # Normally, the minion is not isolated to any single environment on the master
  367. # when running states, but the environment can be isolated on the minion side
  368. # by statically setting it. Remember that the recommended way to manage
  369. # environments is to isolate via the top file.
  370. {{ get_config('environment', 'None') }}
  371. # If using the local file directory, then the state top file name needs to be
  372. # defined, by default this is top.sls.
  373. {{ get_config('state_top', 'top.sls') }}
  374. # Run states when the minion daemon starts. To enable, set startup_states to:
  375. # 'highstate' -- Execute state.highstate
  376. # 'sls' -- Read in the sls_list option and execute the named sls files
  377. # 'top' -- Read top_file option and execute based on that file on the Master
  378. {{ get_config('startup_states', "''") }}
  379. # List of states to run when the minion starts up if startup_states is 'sls':
  380. #sls_list:
  381. # - edit.vim
  382. # - hyper
  383. {{ get_config('sls_list', '[]') }}
  384. # Top file to execute if startup_states is 'top':
  385. {{ get_config('top_file', "''") }}
  386. # Automatically aggregate all states that have support for mod_aggregate by
  387. # setting to True. Or pass a list of state module names to automatically
  388. # aggregate just those types.
  389. #
  390. # state_aggregate:
  391. # - pkg
  392. #
  393. #state_aggregate: False
  394. {{ get_config('state_aggregate', '{}') }}
  395. ##### File Directory Settings #####
  396. ##########################################
  397. # The Salt Minion can redirect all file server operations to a local directory,
  398. # this allows for the same state tree that is on the master to be used if
  399. # copied completely onto the minion. This is a literal copy of the settings on
  400. # the master but used to reference a local directory on the minion.
  401. # Set the file client. The client defaults to looking on the master server for
  402. # files, but can be directed to look at the local file directory setting
  403. # defined below by setting it to "local". Setting a local file_client runs the
  404. # minion in masterless mode.
  405. {%- if standalone %}
  406. file_client: local
  407. {%- else %}
  408. {{ get_config('file_client', 'remote') }}
  409. {%- endif %}
  410. # The file directory works on environments passed to the minion, each environment
  411. # can have multiple root directories, the subdirectories in the multiple file
  412. # roots cannot match, otherwise the downloaded files will not be able to be
  413. # reliably ensured. A base environment is required to house the top file.
  414. # Example:
  415. # file_roots:
  416. # base:
  417. # - /srv/salt/
  418. # dev:
  419. # - /srv/salt/dev/services
  420. # - /srv/salt/dev/states
  421. # prod:
  422. # - /srv/salt/prod/services
  423. # - /srv/salt/prod/states
  424. {% if 'file_roots' in cfg_minion -%}
  425. {%- do default_keys.append('file_roots') %}
  426. {{ file_roots(cfg_minion['file_roots']) }}
  427. {%- elif 'file_roots' in cfg_salt -%}
  428. {{ file_roots(cfg_salt['file_roots']) }}
  429. {%- elif formulas|length -%}
  430. {{ file_roots({'base': ['/srv/salt']}) }}
  431. {%- else -%}
  432. #file_roots:
  433. # base:
  434. # - /srv/salt
  435. {%- endif %}
  436. # File Server Backend
  437. #
  438. # Salt supports a modular fileserver backend system, this system allows
  439. # the salt minion to link directly to third party systems to gather and
  440. # manage the files available to minions. Multiple backends can be
  441. # configured and will be searched for the requested file in the order in which
  442. # they are defined here. The default setting only enables the standard backend
  443. # "roots" which uses the "file_roots" option.
  444. #fileserver_backend:
  445. # - roots
  446. #
  447. # To use multiple backends list them in the order they are searched:
  448. #fileserver_backend:
  449. # - git
  450. # - roots
  451. {% if 'fileserver_backend' in cfg_minion -%}
  452. {%- do default_keys.append('fileserver_backend') %}
  453. fileserver_backend:
  454. {%- for backend in cfg_minion['fileserver_backend'] %}
  455. - {{ backend }}
  456. {%- endfor -%}
  457. {%- endif %}
  458. # By default, the Salt fileserver recurses fully into all defined environments
  459. # to attempt to find files. To limit this behavior so that the fileserver only
  460. # traverses directories with SLS files and special Salt directories like _modules,
  461. # enable the option below. This might be useful for installations where a file root
  462. # has a very large number of files and performance is negatively impacted. Default
  463. # is False.
  464. {{ get_config('fileserver_limit_traversal', 'False') }}
  465. # The hash_type is the hash to use when discovering the hash of a file in
  466. # the local fileserver. The default is md5, but sha1, sha224, sha256, sha384
  467. # and sha512 are also supported.
  468. #
  469. # Warning: Prior to changing this value, the minion should be stopped and all
  470. # Salt caches should be cleared.
  471. {{ get_config('hash_type', 'md5') }}
  472. # gitfs provider
  473. {{ get_config('gitfs_provider', 'pygit2') }}
  474. # Along with gitfs_password, is used to authenticate to HTTPS remotes.
  475. {{ get_config('gitfs_user', 'git') }}
  476. # Along with gitfs_user, is used to authenticate to HTTPS remotes.
  477. # This parameter is not required if the repository does not use authentication.
  478. {{ get_config('gitfs_password', '') }}
  479. # By default, Salt will not authenticate to an HTTP (non-HTTPS) remote.
  480. # This parameter enables authentication over HTTP. Enable this at your own risk.
  481. {{ get_config('gitfs_insecure_auth', 'False') }}
  482. # Along with gitfs_privkey (and optionally gitfs_passphrase), is used to
  483. # authenticate to SSH remotes. This parameter (or its per-remote counterpart)
  484. # is required for SSH remotes.
  485. {{ get_config('gitfs_pubkey', '') }}
  486. # Along with gitfs_pubkey (and optionally gitfs_passphrase), is used to
  487. # authenticate to SSH remotes. This parameter (or its per-remote counterpart)
  488. # is required for SSH remotes.
  489. {{ get_config('gitfs_privkey', '') }}
  490. # This parameter is optional, required only when the SSH key being used to
  491. # authenticate is protected by a passphrase.
  492. {{ get_config('gitfs_passphrase', '') }}
  493. # When using the git fileserver backend at least one git remote needs to be
  494. # defined. The user running the salt master will need read access to the repo.
  495. #
  496. # The repos will be searched in order to find the file requested by a client
  497. # and the first repo to have the file will return it.
  498. # When using the git backend branches and tags are translated into salt
  499. # environments.
  500. # Note: file:// repos will be treated as a remote, so refs you want used must
  501. # exist in that repo as *local* refs.
  502. {% if 'gitfs_remotes' in cfg_minion -%}
  503. {%- do default_keys.append('gitfs_remotes') %}
  504. gitfs_remotes:
  505. {%- for remote in cfg_minion['gitfs_remotes'] %}
  506. {%- if remote is iterable and remote is not string %}
  507. {%- for repo, children in remote.items() %}
  508. - {{ repo }}:
  509. {%- for child in children %}
  510. {%- for key, value in child.items() %}
  511. - {{ key }}: {{ value }}
  512. {%- endfor -%}
  513. {%- endfor -%}
  514. {%- endfor -%}
  515. {%- else %}
  516. - {{ remote }}
  517. {%- endif -%}
  518. {%- endfor -%}
  519. {%- endif %}
  520. # The gitfs_ssl_verify option specifies whether to ignore ssl certificate
  521. # errors when contacting the gitfs backend. You might want to set this to
  522. # false if you're using a git backend that uses a self-signed certificate but
  523. # keep in mind that setting this flag to anything other than the default of True
  524. # is a security concern, you may want to try using the ssh transport.
  525. {{ get_config('gitfs_ssl_verify', 'True') }}
  526. # The gitfs_root option gives the ability to serve files from a subdirectory
  527. # within the repository. The path is defined relative to the root of the
  528. # repository and defaults to the repository root.
  529. {{ get_config('gitfs_root', 'somefolder/otherfolder') }}
  530. # The gitfs_env_whitelist and gitfs_env_blacklist parameters allow for greater
  531. # control over which branches/tags are exposed as fileserver environments.
  532. {% if 'gitfs_env_whitelist' in cfg_minion -%}
  533. {%- do default_keys.append('gitfs_env_whitelist') %}
  534. gitfs_env_whitelist:
  535. {%- for git_env in cfg_minion['gitfs_env_whitelist'] %}
  536. - {{ git_env }}
  537. {%- endfor -%}
  538. {% else -%}
  539. # gitfs_env_whitelist:
  540. # - base
  541. # - v1.*
  542. {% endif %}
  543. {% if 'gitfs_env_blacklist' in cfg_minion -%}
  544. {%- do default_keys.append('gitfs_env_blacklist') %}
  545. gitfs_env_blacklist:
  546. {%- for git_env in cfg_minion['gitfs_env_blacklist'] %}
  547. - {{ git_env }}
  548. {%- endfor -%}
  549. {% else -%}
  550. # gitfs_env_blacklist:
  551. # - bug/*
  552. # - feature/*
  553. {% endif %}
  554. ##### Pillar settings #####
  555. ##########################################
  556. # The Salt pillar is searched for locally if file_client is set to local. If
  557. # this is the case, and pillar data is defined, then the pillar_roots need to
  558. # also be configured on the minion:
  559. {% if 'pillar_roots' in cfg_minion -%}
  560. {%- do default_keys.append('pillar_roots') %}
  561. pillar_roots:
  562. {%- for name, roots in cfg_minion['pillar_roots']|dictsort %}
  563. {{ name }}:
  564. {%- for dir in roots %}
  565. - {{ dir }}
  566. {%- endfor -%}
  567. {%- endfor -%}
  568. {% elif 'pillar_roots' in cfg_salt -%}
  569. pillar_roots:
  570. {%- for name, roots in cfg_salt['pillar_roots']|dictsort %}
  571. {{ name }}:
  572. {%- for dir in roots %}
  573. - {{ dir }}
  574. {%- endfor -%}
  575. {%- endfor -%}
  576. {%- else -%}
  577. #pillar_roots:
  578. # base:
  579. # - /srv/pillar
  580. {%- endif %}
  581. {% if 'ext_pillar' in cfg_minion %}
  582. {%- do default_keys.append('ext_pillar') %}
  583. ext_pillar:
  584. {%- for pillar in cfg_minion['ext_pillar'] -%}
  585. {%- for key in pillar -%}
  586. {%- if pillar[key] is string %}
  587. - {{ key }}: {{ pillar[key] }}
  588. {%- elif pillar[key] is iterable and pillar[key] is not mapping %}
  589. - {{ key }}:
  590. {%- for parameter in pillar[key] %}
  591. - {{ parameter }}
  592. {%- endfor -%}
  593. {%- elif pillar[key] is mapping and pillar[key] is not string %}
  594. - {{ key }}:
  595. {%- for parameter in pillar[key] %}
  596. {{ parameter }}: {{pillar[key][parameter]}}
  597. {%- endfor %}
  598. {%- else %}
  599. # Error in rendering {{ key }}, please read https://docs.saltstack.com/en/latest/topics/development/external_pillars.html#configuration
  600. {% endif %}
  601. {%- endfor -%}
  602. {%- endfor %}
  603. {% elif 'ext_pillar' in cfg_salt %}
  604. ext_pillar:
  605. {% for pillar in cfg_salt['ext_pillar'] %}
  606. - {{ pillar.items()[0][0] }}: {{ pillar.items()[0][1] }}
  607. {% endfor %}
  608. {% else %}
  609. #ext_pillar:
  610. # - hiera: /etc/hiera.yaml
  611. # - cmd_yaml: cat /etc/salt/yaml
  612. {% endif %}
  613. # The ext_pillar_first option allows for external pillar sources to populate
  614. # before file system pillar. This allows for targeting file system pillar from
  615. # ext_pillar.
  616. {{ get_config('ext_pillar_first', 'False') }}
  617. # The pillar_gitfs_ssl_verify option specifies whether to ignore ssl certificate
  618. # errors when contacting the pillar gitfs backend. You might want to set this to
  619. # false if you're using a git backend that uses a self-signed certificate but
  620. # keep in mind that setting this flag to anything other than the default of True
  621. # is a security concern, you may want to try using the ssh transport.
  622. {{ get_config('pillar_gitfs_ssl_verify', 'True') }}
  623. # The pillar_opts option adds the master configuration file data to a dict in
  624. # the pillar called "master". This is used to set simple configurations in the
  625. # master config file that can then be used on minions.
  626. {{ get_config('pillar_opts', 'True') }}
  627. # The pillar_safe_render_error option prevents the master from passing pillar
  628. # render errors to the minion. This is set on by default because the error could
  629. # contain templating data which would give that minion information it shouldn't
  630. # have, like a password! When set true the error message will only show:
  631. # Rendering SLS 'my.sls' failed. Please see master log for details.
  632. {{ get_config('pillar_safe_render_error', 'True') }}
  633. # The pillar_source_merging_strategy option allows you to configure merging strategy
  634. # between different sources. It accepts four values: recurse, aggregate, overwrite,
  635. # or smart. Recurse will merge recursively mapping of data. Aggregate instructs
  636. # aggregation of elements between sources that use the #!yamlex renderer. Overwrite
  637. # will verwrite elements according the order in which they are processed. This is
  638. # behavior of the 2014.1 branch and earlier. Smart guesses the best strategy based
  639. # on the "renderer" setting and is the default value.
  640. {{ get_config('pillar_source_merging_strategy', 'smart') }}
  641. # Recursively merge lists by aggregating them instead of replacing them.
  642. {{ get_config('pillar_merge_lists', False) }}
  643. # Git External Pillar (git_pillar) Configuration Options
  644. #
  645. # Specify the provider to be used for git_pillar. Must be either pygit2 or
  646. # gitpython. If unset, then both will be tried in that same order, and the
  647. # first one with a compatible version installed will be the provider that
  648. # is used.
  649. {{ get_config('git_pillar_provider', 'pygit2') }}
  650. # If the desired branch matches this value, and the environment is omitted
  651. # from the git_pillar configuration, then the environment for that git_pillar
  652. # remote will be base.
  653. {{ get_config('git_pillar_base', 'master') }}
  654. # If the branch is omitted from a git_pillar remote, then this branch will
  655. # be used instead.
  656. {{ get_config('git_pillar_branch', 'master') }}
  657. # Environment to use for git_pillar remotes. This is normally derived from
  658. # the branch/tag (or from a per-remote env parameter), but if set this will
  659. # override the process of deriving the env from the branch/tag name.
  660. {{ get_config('git_pillar_env', '') }}
  661. # Path relative to the root of the repository where the git_pillar top file
  662. # and SLS files are located.
  663. {{ get_config('git_pillar_root', 'pillar') }}
  664. # Specifies whether or not to ignore SSL certificate errors when contacting
  665. # the remote repository.
  666. {{ get_config('git_pillar_ssl_verify', True) }}
  667. # When set to False, if there is an update/checkout lock for a git_pillar
  668. # remote and the pid written to it is not running on the master, the lock
  669. # file will be automatically cleared and a new lock will be obtained.
  670. {{ get_config('git_pillar_global_lock', False) }}
  671. # Git External Pillar Authentication Options
  672. #
  673. # Along with git_pillar_password, is used to authenticate to HTTPS remotes.
  674. {{ get_config('git_pillar_user', '') }}
  675. # Along with git_pillar_user, is used to authenticate to HTTPS remotes.
  676. # This parameter is not required if the repository does not use authentication.
  677. {{ get_config('git_pillar_password', '') }}
  678. # By default, Salt will not authenticate to an HTTP (non-HTTPS) remote.
  679. # This parameter enables authentication over HTTP.
  680. {{ get_config('git_pillar_insecure_auth', False) }}
  681. # Along with git_pillar_privkey (and optionally git_pillar_passphrase),
  682. # is used to authenticate to SSH remotes.
  683. {{ get_config('git_pillar_pubkey', '') }}
  684. # Along with git_pillar_pubkey (and optionally git_pillar_passphrase),
  685. # is used to authenticate to SSH remotes.
  686. {{ get_config('git_pillar_privkey', '') }}
  687. # This parameter is optional, required only when the SSH key being used
  688. # to authenticate is protected by a passphrase.
  689. {{ get_config('git_pillar_passphrase', '') }}
  690. ###### Security settings #####
  691. ###########################################
  692. # Enable "open mode", this mode still maintains encryption, but turns off
  693. # authentication, this is only intended for highly secure environments or for
  694. # the situation where your keys end up in a bad state. If you run in open mode
  695. # you do so at your own risk!
  696. {{ get_config('open_mode', 'False') }}
  697. # Enable permissive access to the salt keys. This allows you to run the
  698. # master or minion as root, but have a non-root group be given access to
  699. # your pki_dir. To make the access explicit, root must belong to the group
  700. # you've given access to. This is potentially quite insecure.
  701. {{ get_config('permissive_pki_access', 'False') }}
  702. # The state_verbose and state_output settings can be used to change the way
  703. # state system data is printed to the display. By default all data is printed.
  704. # The state_verbose setting can be set to True or False, when set to False
  705. # all data that has a result of True and no changes will be suppressed.
  706. {{ get_config('state_verbose', 'True') }}
  707. # The state_output setting changes if the output is the full multi line
  708. # output for each changed state if set to 'full', but if set to 'terse'
  709. # the output will be shortened to a single line.
  710. {{ get_config('state_output', 'full') }}
  711. # The state_output_diff setting changes whether or not the output from
  712. # successful states is returned. Useful when even the terse output of these
  713. # states is cluttering the logs. Set it to True to ignore them.
  714. {{ get_config('state_output_diff', 'False') }}
  715. # The state_output_profile setting changes whether profile information
  716. # will be shown for each state run.
  717. {{ get_config('state_output_profile', 'True') }}
  718. # Fingerprint of the master public key to validate the identity of your Salt master
  719. # before the initial key exchange. The master fingerprint can be found by running
  720. # "salt-key -F master" on the Salt master.
  721. {{ get_config('master_finger', "''") }}
  722. ###### Thread settings #####
  723. ###########################################
  724. # Disable multiprocessing support, by default when a minion receives a
  725. # publication a new process is spawned and the command is executed therein.
  726. {{ get_config('multiprocessing', 'True') }}
  727. ##### Logging settings #####
  728. ##########################################
  729. # The location of the minion log file
  730. # The minion log can be sent to a regular file, local path name, or network
  731. # location. Remote logging works best when configured to use rsyslogd(8) (e.g.:
  732. # ``file:///dev/log``), with rsyslogd(8) configured for network logging. The URI
  733. # format is: <file|udp|tcp>://<host|socketpath>:<port-if-required>/<log-facility>
  734. #log_file: /var/log/salt/minion
  735. #log_file: file:///dev/log
  736. #log_file: udp://loghost:10514
  737. #
  738. {{ get_config('log_file', '/var/log/salt/minion') }}
  739. {{ get_config('key_logfile', ' /var/log/salt/key') }}
  740. # The level of messages to send to the console.
  741. # One of 'garbage', 'trace', 'debug', info', 'warning', 'error', 'critical'.
  742. #
  743. # The following log levels are considered INSECURE and may log sensitive data:
  744. # ['garbage', 'trace', 'debug']
  745. #
  746. # Default: 'warning'
  747. {{ get_config('log_level', 'warning') }}
  748. # The level of messages to send to the log file.
  749. # One of 'garbage', 'trace', 'debug', info', 'warning', 'error', 'critical'.
  750. # If using 'log_granular_levels' this must be set to the highest desired level.
  751. # Default: 'warning'
  752. {{ get_config('log_level_logfile', '') }}
  753. # The date and time format used in log messages. Allowed date/time formating
  754. # can be seen here: http://docs.python.org/library/time.html#time.strftime
  755. {{ get_config('log_datefmt', "'%H:%M:%S'") }}
  756. {{ get_config('log_datefmt_logfile', "'%Y-%m-%d %H:%M:%S'") }}
  757. # The format of the console logging messages. Allowed formatting options can
  758. # be seen here: http://docs.python.org/library/logging.html#logrecord-attributes
  759. #
  760. # Console log colors are specified by these additional formatters:
  761. #
  762. # %(colorlevel)s
  763. # %(colorname)s
  764. # %(colorprocess)s
  765. # %(colormsg)s
  766. #
  767. # Since it is desirable to include the surrounding brackets, '[' and ']', in
  768. # the coloring of the messages, these color formatters also include padding as
  769. # well. Color LogRecord attributes are only available for console logging.
  770. #
  771. {{ get_config('log_fmt_console', "'%(colorlevel)s %(colormsg)s'") }}
  772. {{ get_config('log_fmt_console', "'[%(levelname)-8s] %(message)s'") }}
  773. #
  774. {{ get_config('log_fmt_logfile', "'%(asctime)s,%(msecs)03.0f [%(name)-17s][%(levelname)-8s] %(message)s'") }}
  775. # This can be used to control logging levels more specificically. This
  776. # example sets the main salt library at the 'warning' level, but sets
  777. # 'salt.modules' to log at the 'debug' level:
  778. # log_granular_levels:
  779. # 'salt': 'warning'
  780. # 'salt.modules': 'debug'
  781. #
  782. {{ get_config('log_granular_levels', '{}') }}
  783. # To diagnose issues with minions disconnecting or missing returns, ZeroMQ
  784. # supports the use of monitor sockets to log connection events. This
  785. # feature requires ZeroMQ 4.0 or higher.
  786. #
  787. # To enable ZeroMQ monitor sockets, set 'zmq_monitor' to 'True' and log at a
  788. # debug level or higher.
  789. #
  790. # A sample log event is as follows:
  791. #
  792. # [DEBUG ] ZeroMQ event: {'endpoint': 'tcp://127.0.0.1:4505', 'event': 512,
  793. # 'value': 27, 'description': 'EVENT_DISCONNECTED'}
  794. #
  795. # All events logged will include the string 'ZeroMQ event'. A connection event
  796. # should be logged as the minion starts up and initially connects to the
  797. # master. If not, check for debug log level and that the necessary version of
  798. # ZeroMQ is installed.
  799. #
  800. {{ get_config('zmq_monitor', 'False') }}
  801. ###### Module configuration #####
  802. ###########################################
  803. # Salt allows for modules to be passed arbitrary configuration data, any data
  804. # passed here in valid yaml format will be passed on to the salt minion modules
  805. # for use. It is STRONGLY recommended that a naming convention be used in which
  806. # the module name is followed by a . and then the value. Also, all top level
  807. # data must be applied via the yaml dict construct, some examples:
  808. #
  809. # You can specify that all modules should run in test mode:
  810. {{ get_config('test', 'True') }}
  811. # A simple value for the test module:
  812. #test.foo: foo
  813. #
  814. # A list for the test module:
  815. #test.bar: [baz,quo]
  816. #
  817. # A dict for the test module:
  818. #test.baz: {spam: sausage, cheese: bread}
  819. #
  820. {%- if 'module_config' in cfg_minion %}
  821. {%- do default_keys.append('module_config') %}
  822. {%- for modkey, modval in cfg_minion.module_config.items() %}
  823. {{ modkey }}: {{ modval }}
  824. {%- endfor %}
  825. {%- endif %}
  826. #
  827. ###### Update settings ######
  828. ###########################################
  829. # Using the features in Esky, a salt minion can both run as a frozen app and
  830. # be updated on the fly. These options control how the update process
  831. # (saltutil.update()) behaves.
  832. #
  833. # The url for finding and downloading updates. Disabled by default.
  834. {{ get_config('update_url', 'False') }}
  835. #
  836. # The list of services to restart after a successful update. Empty by default.
  837. {{ get_config('update_restart_services', '[]') }}
  838. ###### Keepalive settings ######
  839. ############################################
  840. # ZeroMQ now includes support for configuring SO_KEEPALIVE if supported by
  841. # the OS. If connections between the minion and the master pass through
  842. # a state tracking device such as a firewall or VPN gateway, there is
  843. # the risk that it could tear down the connection the master and minion
  844. # without informing either party that their connection has been taken away.
  845. # Enabling TCP Keepalives prevents this from happening.
  846. # Overall state of TCP Keepalives, enable (1 or True), disable (0 or False)
  847. # or leave to the OS defaults (-1), on Linux, typically disabled. Default True, enabled.
  848. {{ get_config('tcp_keepalive', 'True') }}
  849. # How long before the first keepalive should be sent in seconds. Default 300
  850. # to send the first keepalive after 5 minutes, OS default (-1) is typically 7200 seconds
  851. # on Linux see /proc/sys/net/ipv4/tcp_keepalive_time.
  852. {{ get_config('tcp_keepalive_idle', '300') }}
  853. # How many lost probes are needed to consider the connection lost. Default -1
  854. # to use OS defaults, typically 9 on Linux, see /proc/sys/net/ipv4/tcp_keepalive_probes.
  855. {{ get_config('tcp_keepalive_cnt', '-1') }}
  856. # How often, in seconds, to send keepalives after the first one. Default -1 to
  857. # use OS defaults, typically 75 seconds on Linux, see
  858. # /proc/sys/net/ipv4/tcp_keepalive_intvl.
  859. {{ get_config('tcp_keepalive_intvl', '-1') }}
  860. ###### Windows Software settings ######
  861. ############################################
  862. # Location of the repository cache file on the master:
  863. {{ get_config('win_repo_cachefile', 'salt://win/repo/winrepo.p') }}
  864. ###### Returner settings ######
  865. ############################################
  866. # Which returner(s) will be used for minion's result:
  867. {{ get_config('return', '') }}
  868. ###### Miscellaneous settings ######
  869. ############################################
  870. # Default match type for filtering events tags: startswith, endswith, find, regex, fnmatch
  871. #event_match_type: startswith
  872. {{ get_config('event_match_type', 'startswith') }}
  873. {% if 'mongo' in cfg_minion -%}
  874. {%- do default_keys.append('mongo') %}
  875. ##### mongodb connection settings #####
  876. ##########################################
  877. {%- for name, value in cfg_minion['mongo'].items() %}
  878. mongo.{{ name }}: {{ value }}
  879. {%- endfor %}
  880. {% if 'alternative.mongo' in cfg_minion -%}
  881. {%- do default_keys.append('alternative.mongo') %}
  882. {%- for name, value in cfg_minion['alternative.mongo'].items() %}
  883. alternative.mongo.{{ name }}: {{ value }}
  884. {%- endfor %}
  885. {% endif %}
  886. {%- endif %}
  887. {%- for configname in cfg_minion %}
  888. {%- if configname not in reserved_keys and configname not in default_keys %}
  889. {{ configname }}: {{ cfg_minion[configname]|json }}
  890. {%- endif %}
  891. {%- endfor %}