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.

f_defaults.conf 43KB

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