1
0

minion 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932
  1. ##### Primary configuration settings #####
  2. ##########################################
  3. # This configuration file is used to manage the behavior of the Salt Minion.
  4. # With the exception of the location of the Salt Master Server, values that are
  5. # commented out but have an empty line after the comment are defaults that need
  6. # not be set in the config. If there is no blank line after the comment, the
  7. # value is presented as an example and is not the default.
  8. # Per default the minion will automatically include all config files
  9. # from minion.d/*.conf (minion.d is a directory in the same directory
  10. # as the main minion config file).
  11. #default_include: minion.d/*.conf
  12. # Set the location of the salt master server. If the master server cannot be
  13. # resolved, then the minion will fail to start.
  14. #master: salt
  15. # Set http proxy information for the minion when doing requests
  16. #proxy_host:
  17. #proxy_port:
  18. #proxy_username:
  19. #proxy_password:
  20. # List of hosts to bypass HTTP proxy. This key does nothing unless proxy_host etc is
  21. # configured, it does not support any kind of wildcards.
  22. #no_proxy: []
  23. # If multiple masters are specified in the 'master' setting, the default behavior
  24. # is to always try to connect to them in the order they are listed. If random_master
  25. # is set to True, the order will be randomized upon Minion startup instead. This can
  26. # be helpful in distributing the load of many minions executing salt-call requests,
  27. # for example, from a cron job. If only one master is listed, this setting is ignored
  28. # and a warning will be logged.
  29. #random_master: False
  30. # NOTE: Deprecated in Salt 2019.2.0. Use 'random_master' instead.
  31. #master_shuffle: False
  32. # Minions can connect to multiple masters simultaneously (all masters
  33. # are "hot"), or can be configured to failover if a master becomes
  34. # unavailable. Multiple hot masters are configured by setting this
  35. # value to "str". Failover masters can be requested by setting
  36. # to "failover". MAKE SURE TO SET master_alive_interval if you are
  37. # using failover.
  38. # Setting master_type to 'disable' lets you have a running minion (with engines and
  39. # beacons) without a master connection
  40. # master_type: str
  41. # Poll interval in seconds for checking if the master is still there. Only
  42. # respected if master_type above is "failover". To disable the interval entirely,
  43. # set the value to -1. (This may be necessary on machines which have high numbers
  44. # of TCP connections, such as load balancers.)
  45. # master_alive_interval: 30
  46. # If the minion is in multi-master mode and the master_type configuration option
  47. # is set to "failover", this setting can be set to "True" to force the minion
  48. # to fail back to the first master in the list if the first master is back online.
  49. #master_failback: False
  50. # If the minion is in multi-master mode, the "master_type" configuration is set to
  51. # "failover", and the "master_failback" option is enabled, the master failback
  52. # interval can be set to ping the top master with this interval, in seconds.
  53. #master_failback_interval: 0
  54. # Set whether the minion should connect to the master via IPv6:
  55. #ipv6: False
  56. # Set the number of seconds to wait before attempting to resolve
  57. # the master hostname if name resolution fails. Defaults to 30 seconds.
  58. # Set to zero if the minion should shutdown and not retry.
  59. # retry_dns: 30
  60. # Set the number of times to attempt to resolve
  61. # the master hostname if name resolution fails. Defaults to None,
  62. # which will attempt the resolution indefinitely.
  63. # retry_dns_count: 3
  64. # Set the port used by the master reply and authentication server.
  65. #master_port: 4506
  66. # The user to run salt.
  67. #user: root
  68. # The user to run salt remote execution commands as via sudo. If this option is
  69. # enabled then sudo will be used to change the active user executing the remote
  70. # command. If enabled the user will need to be allowed access via the sudoers
  71. # file for the user that the salt minion is configured to run as. The most
  72. # common option would be to use the root user. If this option is set the user
  73. # option should also be set to a non-root user. If migrating from a root minion
  74. # to a non root minion the minion cache should be cleared and the minion pki
  75. # directory will need to be changed to the ownership of the new user.
  76. #sudo_user: root
  77. # Specify the location of the daemon process ID file.
  78. #pidfile: /var/run/salt-minion.pid
  79. # The root directory prepended to these options: pki_dir, cachedir, log_file,
  80. # sock_dir, pidfile.
  81. #root_dir: /
  82. # The path to the minion's configuration file.
  83. #conf_file: /etc/salt/minion
  84. # The directory to store the pki information in
  85. #pki_dir: /etc/salt/pki/minion
  86. # Explicitly declare the id for this minion to use, if left commented the id
  87. # will be the hostname as returned by the python call: socket.getfqdn()
  88. # Since salt uses detached ids it is possible to run multiple minions on the
  89. # same machine but with different ids, this can be useful for salt compute
  90. # clusters.
  91. #id:
  92. # Cache the minion id to a file when the minion's id is not statically defined
  93. # in the minion config. Defaults to "True". This setting prevents potential
  94. # problems when automatic minion id resolution changes, which can cause the
  95. # minion to lose connection with the master. To turn off minion id caching,
  96. # set this config to ``False``.
  97. #minion_id_caching: True
  98. # Convert minion id to lowercase when it is being generated. Helpful when some
  99. # hosts get the minion id in uppercase. Cached ids will remain the same and
  100. # not converted. For example, Windows minions often have uppercase minion
  101. # names when they are set up but not always. To turn on, set this config to
  102. # ``True``.
  103. #minion_id_lowercase: False
  104. # Append a domain to a hostname in the event that it does not exist. This is
  105. # useful for systems where socket.getfqdn() does not actually result in a
  106. # FQDN (for instance, Solaris).
  107. #append_domain:
  108. # Custom static grains for this minion can be specified here and used in SLS
  109. # files just like all other grains. This example sets 4 custom grains, with
  110. # the 'roles' grain having two values that can be matched against.
  111. #grains:
  112. # roles:
  113. # - webserver
  114. # - memcache
  115. # deployment: datacenter4
  116. # cabinet: 13
  117. # cab_u: 14-15
  118. #
  119. # Where cache data goes.
  120. # This data may contain sensitive data and should be protected accordingly.
  121. #cachedir: /var/cache/salt/minion
  122. # Append minion_id to these directories. Helps with
  123. # multiple proxies and minions running on the same machine.
  124. # Allowed elements in the list: pki_dir, cachedir, extension_modules
  125. # Normally not needed unless running several proxies and/or minions on the same machine
  126. # Defaults to ['cachedir'] for proxies, [] (empty list) for regular minions
  127. #append_minionid_config_dirs:
  128. # Verify and set permissions on configuration directories at startup.
  129. #verify_env: True
  130. # The minion can locally cache the return data from jobs sent to it, this
  131. # can be a good way to keep track of jobs the minion has executed
  132. # (on the minion side). By default this feature is disabled, to enable, set
  133. # cache_jobs to True.
  134. #cache_jobs: False
  135. # Set the directory used to hold unix sockets.
  136. #sock_dir: /var/run/salt/minion
  137. # In order to calculate the fqdns grain, all the IP addresses from the minion
  138. # are processed with underlying calls to `socket.gethostbyaddr` which can take
  139. # 5 seconds to be released (after reaching `socket.timeout`) when there is no
  140. # fqdn for that IP. These calls to `socket.gethostbyaddr` are processed
  141. # asynchronously, however, it still adds 5 seconds every time grains are
  142. # generated if an IP does not resolve. In Windows grains are regenerated each
  143. # time a new process is spawned. Therefore, the default for Windows is `False`.
  144. # All other OSes default to `True`
  145. # enable_fqdn_grains: True
  146. # The minion can take a while to start up when lspci and/or dmidecode is used
  147. # to populate the grains for the minion. Set this to False if you do not need
  148. # GPU hardware grains for your minion.
  149. # enable_gpu_grains: True
  150. # Set the default outputter used by the salt-call command. The default is
  151. # "nested".
  152. #output: nested
  153. # To set a list of additional directories to search for salt outputters, set the
  154. # outputter_dirs option.
  155. #outputter_dirs: []
  156. # By default output is colored. To disable colored output, set the color value
  157. # to False.
  158. #color: True
  159. # Do not strip off the colored output from nested results and state outputs
  160. # (true by default).
  161. # strip_colors: False
  162. # Backup files that are replaced by file.managed and file.recurse under
  163. # 'cachedir'/file_backup relative to their original location and appended
  164. # with a timestamp. The only valid setting is "minion". Disabled by default.
  165. #
  166. # Alternatively this can be specified for each file in state files:
  167. # /etc/ssh/sshd_config:
  168. # file.managed:
  169. # - source: salt://ssh/sshd_config
  170. # - backup: minion
  171. #
  172. #backup_mode: minion
  173. # When waiting for a master to accept the minion's public key, salt will
  174. # continuously attempt to reconnect until successful. This is the time, in
  175. # seconds, between those reconnection attempts.
  176. #acceptance_wait_time: 10
  177. # If this is nonzero, the time between reconnection attempts will increase by
  178. # acceptance_wait_time seconds per iteration, up to this maximum. If this is
  179. # set to zero, the time between reconnection attempts will stay constant.
  180. #acceptance_wait_time_max: 0
  181. # If the master rejects the minion's public key, retry instead of exiting.
  182. # Rejected keys will be handled the same as waiting on acceptance.
  183. #rejected_retry: False
  184. # When the master key changes, the minion will try to re-auth itself to receive
  185. # the new master key. In larger environments this can cause a SYN flood on the
  186. # master because all minions try to re-auth immediately. To prevent this and
  187. # have a minion wait for a random amount of time, use this optional parameter.
  188. # The wait-time will be a random number of seconds between 0 and the defined value.
  189. #random_reauth_delay: 60
  190. # To avoid overloading a master when many minions startup at once, a randomized
  191. # delay may be set to tell the minions to wait before connecting to the master.
  192. # This value is the number of seconds to choose from for a random number. For
  193. # example, setting this value to 60 will choose a random number of seconds to delay
  194. # on startup between zero seconds and sixty seconds. Setting to '0' will disable
  195. # this feature.
  196. #random_startup_delay: 0
  197. # When waiting for a master to accept the minion's public key, salt will
  198. # continuously attempt to reconnect until successful. This is the timeout value,
  199. # in seconds, for each individual attempt. After this timeout expires, the minion
  200. # will wait for acceptance_wait_time seconds before trying again. Unless your master
  201. # is under unusually heavy load, this should be left at the default.
  202. #auth_timeout: 60
  203. # Number of consecutive SaltReqTimeoutError that are acceptable when trying to
  204. # authenticate.
  205. #auth_tries: 7
  206. # The number of attempts to connect to a master before giving up.
  207. # Set this to -1 for unlimited attempts. This allows for a master to have
  208. # downtime and the minion to reconnect to it later when it comes back up.
  209. # In 'failover' mode, it is the number of attempts for each set of masters.
  210. # In this mode, it will cycle through the list of masters for each attempt.
  211. #
  212. # This is different than auth_tries because auth_tries attempts to
  213. # retry auth attempts with a single master. auth_tries is under the
  214. # assumption that you can connect to the master but not gain
  215. # authorization from it. master_tries will still cycle through all
  216. # the masters in a given try, so it is appropriate if you expect
  217. # occasional downtime from the master(s).
  218. #master_tries: 1
  219. # If authentication fails due to SaltReqTimeoutError during a ping_interval,
  220. # cause sub minion process to restart.
  221. #auth_safemode: False
  222. # Ping Master to ensure connection is alive (minutes).
  223. #ping_interval: 0
  224. # To auto recover minions if master changes IP address (DDNS)
  225. # auth_tries: 10
  226. # auth_safemode: False
  227. # ping_interval: 2
  228. #
  229. # Minions won't know master is missing until a ping fails. After the ping fail,
  230. # the minion will attempt authentication and likely fails out and cause a restart.
  231. # When the minion restarts it will resolve the masters IP and attempt to reconnect.
  232. # If you don't have any problems with syn-floods, don't bother with the
  233. # three recon_* settings described below, just leave the defaults!
  234. #
  235. # The ZeroMQ pull-socket that binds to the masters publishing interface tries
  236. # to reconnect immediately, if the socket is disconnected (for example if
  237. # the master processes are restarted). In large setups this will have all
  238. # minions reconnect immediately which might flood the master (the ZeroMQ-default
  239. # is usually a 100ms delay). To prevent this, these three recon_* settings
  240. # can be used.
  241. # recon_default: the interval in milliseconds that the socket should wait before
  242. # trying to reconnect to the master (1000ms = 1 second)
  243. #
  244. # recon_max: the maximum time a socket should wait. each interval the time to wait
  245. # is calculated by doubling the previous time. if recon_max is reached,
  246. # it starts again at recon_default. Short example:
  247. #
  248. # reconnect 1: the socket will wait 'recon_default' milliseconds
  249. # reconnect 2: 'recon_default' * 2
  250. # reconnect 3: ('recon_default' * 2) * 2
  251. # reconnect 4: value from previous interval * 2
  252. # reconnect 5: value from previous interval * 2
  253. # reconnect x: if value >= recon_max, it starts again with recon_default
  254. #
  255. # recon_randomize: generate a random wait time on minion start. The wait time will
  256. # be a random value between recon_default and recon_default +
  257. # recon_max. Having all minions reconnect with the same recon_default
  258. # and recon_max value kind of defeats the purpose of being able to
  259. # change these settings. If all minions have the same values and your
  260. # setup is quite large (several thousand minions), they will still
  261. # flood the master. The desired behavior is to have timeframe within
  262. # all minions try to reconnect.
  263. #
  264. # Example on how to use these settings. The goal: have all minions reconnect within a
  265. # 60 second timeframe on a disconnect.
  266. # recon_default: 1000
  267. # recon_max: 59000
  268. # recon_randomize: True
  269. #
  270. # Each minion will have a randomized reconnect value between 'recon_default'
  271. # and 'recon_default + recon_max', which in this example means between 1000ms
  272. # 60000ms (or between 1 and 60 seconds). The generated random-value will be
  273. # doubled after each attempt to reconnect. Lets say the generated random
  274. # value is 11 seconds (or 11000ms).
  275. # reconnect 1: wait 11 seconds
  276. # reconnect 2: wait 22 seconds
  277. # reconnect 3: wait 33 seconds
  278. # reconnect 4: wait 44 seconds
  279. # reconnect 5: wait 55 seconds
  280. # reconnect 6: wait time is bigger than 60 seconds (recon_default + recon_max)
  281. # reconnect 7: wait 11 seconds
  282. # reconnect 8: wait 22 seconds
  283. # reconnect 9: wait 33 seconds
  284. # reconnect x: etc.
  285. #
  286. # In a setup with ~6000 thousand hosts these settings would average the reconnects
  287. # to about 100 per second and all hosts would be reconnected within 60 seconds.
  288. # recon_default: 100
  289. # recon_max: 5000
  290. # recon_randomize: False
  291. #
  292. #
  293. # The loop_interval sets how long in seconds the minion will wait between
  294. # evaluating the scheduler and running cleanup tasks. This defaults to 1
  295. # second on the minion scheduler.
  296. #loop_interval: 1
  297. # Some installations choose to start all job returns in a cache or a returner
  298. # and forgo sending the results back to a master. In this workflow, jobs
  299. # are most often executed with --async from the Salt CLI and then results
  300. # are evaluated by examining job caches on the minions or any configured returners.
  301. # WARNING: Setting this to False will **disable** returns back to the master.
  302. #pub_ret: True
  303. # The grains can be merged, instead of overridden, using this option.
  304. # This allows custom grains to defined different subvalues of a dictionary
  305. # grain. By default this feature is disabled, to enable set grains_deep_merge
  306. # to ``True``.
  307. #grains_deep_merge: False
  308. # The grains_refresh_every setting allows for a minion to periodically check
  309. # its grains to see if they have changed and, if so, to inform the master
  310. # of the new grains. This operation is moderately expensive, therefore
  311. # care should be taken not to set this value too low.
  312. #
  313. # Note: This value is expressed in __minutes__!
  314. #
  315. # A value of 10 minutes is a reasonable default.
  316. #
  317. # If the value is set to zero, this check is disabled.
  318. #grains_refresh_every: 1
  319. # Cache grains on the minion. Default is False.
  320. #grains_cache: False
  321. # Cache rendered pillar data on the minion. Default is False.
  322. # This may cause 'cachedir'/pillar to contain sensitive data that should be
  323. # protected accordingly.
  324. #minion_pillar_cache: False
  325. # Grains cache expiration, in seconds. If the cache file is older than this
  326. # number of seconds then the grains cache will be dumped and fully re-populated
  327. # with fresh data. Defaults to 5 minutes. Will have no effect if 'grains_cache'
  328. # is not enabled.
  329. # grains_cache_expiration: 300
  330. # Determines whether or not the salt minion should run scheduled mine updates.
  331. # Defaults to "True". Set to "False" to disable the scheduled mine updates
  332. # (this essentially just does not add the mine update function to the minion's
  333. # scheduler).
  334. #mine_enabled: True
  335. # Determines whether or not scheduled mine updates should be accompanied by a job
  336. # return for the job cache. Defaults to "False". Set to "True" to include job
  337. # returns in the job cache for mine updates.
  338. #mine_return_job: False
  339. # Example functions that can be run via the mine facility
  340. # NO mine functions are established by default.
  341. # Note these can be defined in the minion's pillar as well.
  342. #mine_functions:
  343. # test.ping: []
  344. # network.ip_addrs:
  345. # interface: eth0
  346. # cidr: '10.0.0.0/8'
  347. # The number of minutes between mine updates.
  348. #mine_interval: 60
  349. # Windows platforms lack posix IPC and must rely on slower TCP based inter-
  350. # process communications. ipc_mode is set to 'tcp' on such systems.
  351. #ipc_mode: ipc
  352. # Overwrite the default tcp ports used by the minion when ipc_mode is set to 'tcp'
  353. #tcp_pub_port: 4510
  354. #tcp_pull_port: 4511
  355. # Passing very large events can cause the minion to consume large amounts of
  356. # memory. This value tunes the maximum size of a message allowed onto the
  357. # minion event bus. The value is expressed in bytes.
  358. #max_event_size: 1048576
  359. # When a minion starts up it sends a notification on the event bus with a tag
  360. # that looks like this: `salt/minion/<minion_id>/start`. For historical reasons
  361. # the minion also sends a similar event with an event tag like this:
  362. # `minion_start`. This duplication can cause a lot of clutter on the event bus
  363. # when there are many minions. Set `enable_legacy_startup_events: False` in the
  364. # minion config to ensure only the `salt/minion/<minion_id>/start` events are
  365. # sent. Beginning with the `Sodium` Salt release this option will default to
  366. # `False`
  367. #enable_legacy_startup_events: True
  368. # To detect failed master(s) and fire events on connect/disconnect, set
  369. # master_alive_interval to the number of seconds to poll the masters for
  370. # connection events.
  371. #
  372. #master_alive_interval: 30
  373. # The minion can include configuration from other files. To enable this,
  374. # pass a list of paths to this option. The paths can be either relative or
  375. # absolute; if relative, they are considered to be relative to the directory
  376. # the main minion configuration file lives in (this file). Paths can make use
  377. # of shell-style globbing. If no files are matched by a path passed to this
  378. # option then the minion will log a warning message.
  379. #
  380. # Include a config file from some other path:
  381. # include: /etc/salt/extra_config
  382. #
  383. # Include config from several files and directories:
  384. #include:
  385. # - /etc/salt/extra_config
  386. # - /etc/roles/webserver
  387. # The syndic minion can verify that it is talking to the correct master via the
  388. # key fingerprint of the higher-level master with the "syndic_finger" config.
  389. #syndic_finger: ''
  390. #
  391. #
  392. #
  393. ##### Minion module management #####
  394. ##########################################
  395. # Disable specific modules. This allows the admin to limit the level of
  396. # access the master has to the minion. The default here is the empty list,
  397. # below is an example of how this needs to be formatted in the config file
  398. #disable_modules:
  399. # - cmdmod
  400. # - test
  401. #disable_returners: []
  402. # This is the reverse of disable_modules. The default, like disable_modules, is the empty list,
  403. # but if this option is set to *anything* then *only* those modules will load.
  404. # Note that this is a very large hammer and it can be quite difficult to keep the minion working
  405. # the way you think it should since Salt uses many modules internally itself. At a bare minimum
  406. # you need the following enabled or else the minion won't start.
  407. #whitelist_modules:
  408. # - cmdmod
  409. # - test
  410. # - config
  411. # Modules can be loaded from arbitrary paths. This enables the easy deployment
  412. # of third party modules. Modules for returners and minions can be loaded.
  413. # Specify a list of extra directories to search for minion modules and
  414. # returners. These paths must be fully qualified!
  415. #module_dirs: []
  416. #returner_dirs: []
  417. #states_dirs: []
  418. #render_dirs: []
  419. #utils_dirs: []
  420. #
  421. # A module provider can be statically overwritten or extended for the minion
  422. # via the providers option, in this case the default module will be
  423. # overwritten by the specified module. In this example the pkg module will
  424. # be provided by the yumpkg5 module instead of the system default.
  425. #providers:
  426. # pkg: yumpkg5
  427. #
  428. # Enable Cython modules searching and loading. (Default: False)
  429. #cython_enable: False
  430. #
  431. # Specify a max size (in bytes) for modules on import. This feature is currently
  432. # only supported on *nix operating systems and requires psutil.
  433. # modules_max_memory: -1
  434. ##### State Management Settings #####
  435. ###########################################
  436. # The default renderer to use in SLS files. This is configured as a
  437. # pipe-delimited expression. For example, jinja|yaml will first run jinja
  438. # templating on the SLS file, and then load the result as YAML. This syntax is
  439. # documented in further depth at the following URL:
  440. #
  441. # https://docs.saltstack.com/en/latest/ref/renderers/#composing-renderers
  442. #
  443. # NOTE: The "shebang" prefix (e.g. "#!jinja|yaml") described in the
  444. # documentation linked above is for use in an SLS file to override the default
  445. # renderer, it should not be used when configuring the renderer here.
  446. #
  447. #renderer: jinja|yaml
  448. #
  449. # The failhard option tells the minions to stop immediately after the first
  450. # failure detected in the state execution. Defaults to False.
  451. #failhard: False
  452. #
  453. # Reload the modules prior to a highstate run.
  454. #autoload_dynamic_modules: True
  455. #
  456. # clean_dynamic_modules keeps the dynamic modules on the minion in sync with
  457. # the dynamic modules on the master, this means that if a dynamic module is
  458. # not on the master it will be deleted from the minion. By default, this is
  459. # enabled and can be disabled by changing this value to False.
  460. #clean_dynamic_modules: True
  461. #
  462. # Normally, the minion is not isolated to any single environment on the master
  463. # when running states, but the environment can be isolated on the minion side
  464. # by statically setting it. Remember that the recommended way to manage
  465. # environments is to isolate via the top file.
  466. #environment: None
  467. #
  468. # Isolates the pillar environment on the minion side. This functions the same
  469. # as the environment setting, but for pillar instead of states.
  470. #pillarenv: None
  471. #
  472. # Set this option to True to force the pillarenv to be the same as the
  473. # effective saltenv when running states. Note that if pillarenv is specified,
  474. # this option will be ignored.
  475. #pillarenv_from_saltenv: False
  476. #
  477. # Set this option to 'True' to force a 'KeyError' to be raised whenever an
  478. # attempt to retrieve a named value from pillar fails. When this option is set
  479. # to 'False', the failed attempt returns an empty string. Default is 'False'.
  480. #pillar_raise_on_missing: False
  481. #
  482. # If using the local file directory, then the state top file name needs to be
  483. # defined, by default this is top.sls.
  484. #state_top: top.sls
  485. #
  486. # Run states when the minion daemon starts. To enable, set startup_states to:
  487. # 'highstate' -- Execute state.highstate
  488. # 'sls' -- Read in the sls_list option and execute the named sls files
  489. # 'top' -- Read top_file option and execute based on that file on the Master
  490. #startup_states: ''
  491. #
  492. # List of states to run when the minion starts up if startup_states is 'sls':
  493. #sls_list:
  494. # - edit.vim
  495. # - hyper
  496. #
  497. # List of grains to pass in start event when minion starts up:
  498. #start_event_grains:
  499. # - machine_id
  500. # - uuid
  501. #
  502. # Top file to execute if startup_states is 'top':
  503. #top_file: ''
  504. # Automatically aggregate all states that have support for mod_aggregate by
  505. # setting to True. Or pass a list of state module names to automatically
  506. # aggregate just those types.
  507. #
  508. # state_aggregate:
  509. # - pkg
  510. #
  511. #state_aggregate: False
  512. # Disable requisites during state runs by specifying a single requisite
  513. # or a list of requisites to disable.
  514. #
  515. # disabled_requisites: require_in
  516. #
  517. # disabled_requisites:
  518. # - require
  519. # - require_in
  520. ##### File Directory Settings #####
  521. ##########################################
  522. # The Salt Minion can redirect all file server operations to a local directory,
  523. # this allows for the same state tree that is on the master to be used if
  524. # copied completely onto the minion. This is a literal copy of the settings on
  525. # the master but used to reference a local directory on the minion.
  526. # Set the file client. The client defaults to looking on the master server for
  527. # files, but can be directed to look at the local file directory setting
  528. # defined below by setting it to "local". Setting a local file_client runs the
  529. # minion in masterless mode.
  530. #file_client: remote
  531. # The file directory works on environments passed to the minion, each environment
  532. # can have multiple root directories, the subdirectories in the multiple file
  533. # roots cannot match, otherwise the downloaded files will not be able to be
  534. # reliably ensured. A base environment is required to house the top file.
  535. # Example:
  536. # file_roots:
  537. # base:
  538. # - /srv/salt/
  539. # dev:
  540. # - /srv/salt/dev/services
  541. # - /srv/salt/dev/states
  542. # prod:
  543. # - /srv/salt/prod/services
  544. # - /srv/salt/prod/states
  545. #
  546. #file_roots:
  547. # base:
  548. # - /srv/salt
  549. # Uncomment the line below if you do not want the file_server to follow
  550. # symlinks when walking the filesystem tree. This is set to True
  551. # by default. Currently this only applies to the default roots
  552. # fileserver_backend.
  553. #fileserver_followsymlinks: False
  554. #
  555. # Uncomment the line below if you do not want symlinks to be
  556. # treated as the files they are pointing to. By default this is set to
  557. # False. By uncommenting the line below, any detected symlink while listing
  558. # files on the Master will not be returned to the Minion.
  559. #fileserver_ignoresymlinks: True
  560. #
  561. # By default, the Salt fileserver recurses fully into all defined environments
  562. # to attempt to find files. To limit this behavior so that the fileserver only
  563. # traverses directories with SLS files and special Salt directories like _modules,
  564. # enable the option below. This might be useful for installations where a file root
  565. # has a very large number of files and performance is negatively impacted. Default
  566. # is False.
  567. #fileserver_limit_traversal: False
  568. # The hash_type is the hash to use when discovering the hash of a file on
  569. # the local fileserver. The default is sha256, but md5, sha1, sha224, sha384
  570. # and sha512 are also supported.
  571. #
  572. # WARNING: While md5 and sha1 are also supported, do not use them due to the
  573. # high chance of possible collisions and thus security breach.
  574. #
  575. # Warning: Prior to changing this value, the minion should be stopped and all
  576. # Salt caches should be cleared.
  577. #hash_type: sha256
  578. # The Salt pillar is searched for locally if file_client is set to local. If
  579. # this is the case, and pillar data is defined, then the pillar_roots need to
  580. # also be configured on the minion:
  581. #pillar_roots:
  582. # base:
  583. # - /srv/pillar
  584. # Set a hard-limit on the size of the files that can be pushed to the master.
  585. # It will be interpreted as megabytes. Default: 100
  586. #file_recv_max_size: 100
  587. #
  588. #
  589. ###### Security settings #####
  590. ###########################################
  591. # Enable "open mode", this mode still maintains encryption, but turns off
  592. # authentication, this is only intended for highly secure environments or for
  593. # the situation where your keys end up in a bad state. If you run in open mode
  594. # you do so at your own risk!
  595. #open_mode: False
  596. # The size of key that should be generated when creating new keys.
  597. #keysize: 2048
  598. # Enable permissive access to the salt keys. This allows you to run the
  599. # master or minion as root, but have a non-root group be given access to
  600. # your pki_dir. To make the access explicit, root must belong to the group
  601. # you've given access to. This is potentially quite insecure.
  602. #permissive_pki_access: False
  603. # The state_verbose and state_output settings can be used to change the way
  604. # state system data is printed to the display. By default all data is printed.
  605. # The state_verbose setting can be set to True or False, when set to False
  606. # all data that has a result of True and no changes will be suppressed.
  607. #state_verbose: True
  608. # The state_output setting controls which results will be output full multi line
  609. # full, terse - each state will be full/terse
  610. # mixed - only states with errors will be full
  611. # changes - states with changes and errors will be full
  612. # full_id, mixed_id, changes_id and terse_id are also allowed;
  613. # when set, the state ID will be used as name in the output
  614. #state_output: full
  615. # The state_output_diff setting changes whether or not the output from
  616. # successful states is returned. Useful when even the terse output of these
  617. # states is cluttering the logs. Set it to True to ignore them.
  618. #state_output_diff: False
  619. # The state_output_profile setting changes whether profile information
  620. # will be shown for each state run.
  621. #state_output_profile: True
  622. # Fingerprint of the master public key to validate the identity of your Salt master
  623. # before the initial key exchange. The master fingerprint can be found by running
  624. # "salt-key -f master.pub" on the Salt master.
  625. #master_finger: ''
  626. # Use TLS/SSL encrypted connection between master and minion.
  627. # Can be set to a dictionary containing keyword arguments corresponding to Python's
  628. # 'ssl.wrap_socket' method.
  629. # Default is None.
  630. #ssl:
  631. # keyfile: <path_to_keyfile>
  632. # certfile: <path_to_certfile>
  633. # ssl_version: PROTOCOL_TLSv1_2
  634. # Grains to be sent to the master on authentication to check if the minion's key
  635. # will be accepted automatically. Needs to be configured on the master.
  636. #autosign_grains:
  637. # - uuid
  638. # - server_id
  639. ###### Reactor Settings #####
  640. ###########################################
  641. # Define a salt reactor. See https://docs.saltstack.com/en/latest/topics/reactor/
  642. #reactor: []
  643. #Set the TTL for the cache of the reactor configuration.
  644. #reactor_refresh_interval: 60
  645. #Configure the number of workers for the runner/wheel in the reactor.
  646. #reactor_worker_threads: 10
  647. #Define the queue size for workers in the reactor.
  648. #reactor_worker_hwm: 10000
  649. ###### Thread settings #####
  650. ###########################################
  651. # Disable multiprocessing support, by default when a minion receives a
  652. # publication a new process is spawned and the command is executed therein.
  653. #
  654. # WARNING: Disabling multiprocessing may result in substantial slowdowns
  655. # when processing large pillars. See https://github.com/saltstack/salt/issues/38758
  656. # for a full explanation.
  657. #multiprocessing: True
  658. # Limit the maximum amount of processes or threads created by salt-minion.
  659. # This is useful to avoid resource exhaustion in case the minion receives more
  660. # publications than it is able to handle, as it limits the number of spawned
  661. # processes or threads. -1 is the default and disables the limit.
  662. #process_count_max: -1
  663. ##### Logging settings #####
  664. ##########################################
  665. # The location of the minion log file
  666. # The minion log can be sent to a regular file, local path name, or network
  667. # location. Remote logging works best when configured to use rsyslogd(8) (e.g.:
  668. # ``file:///dev/log``), with rsyslogd(8) configured for network logging. The URI
  669. # format is: <file|udp|tcp>://<host|socketpath>:<port-if-required>/<log-facility>
  670. #log_file: /var/log/salt/minion
  671. #log_file: file:///dev/log
  672. #log_file: udp://loghost:10514
  673. #
  674. #log_file: /var/log/salt/minion
  675. #key_logfile: /var/log/salt/key
  676. # The level of messages to send to the console.
  677. # One of 'garbage', 'trace', 'debug', 'info', 'warning', 'error', 'critical'.
  678. #
  679. # The following log levels are considered INSECURE and may log sensitive data:
  680. # ['garbage', 'trace', 'debug']
  681. #
  682. # Default: 'warning'
  683. #log_level: warning
  684. # The level of messages to send to the log file.
  685. # One of 'garbage', 'trace', 'debug', info', 'warning', 'error', 'critical'.
  686. # If using 'log_granular_levels' this must be set to the highest desired level.
  687. # Default: 'warning'
  688. #log_level_logfile:
  689. # The date and time format used in log messages. Allowed date/time formatting
  690. # can be seen here: http://docs.python.org/library/time.html#time.strftime
  691. #log_datefmt: '%H:%M:%S'
  692. #log_datefmt_logfile: '%Y-%m-%d %H:%M:%S'
  693. # The format of the console logging messages. Allowed formatting options can
  694. # be seen here: http://docs.python.org/library/logging.html#logrecord-attributes
  695. #
  696. # Console log colors are specified by these additional formatters:
  697. #
  698. # %(colorlevel)s
  699. # %(colorname)s
  700. # %(colorprocess)s
  701. # %(colormsg)s
  702. #
  703. # Since it is desirable to include the surrounding brackets, '[' and ']', in
  704. # the coloring of the messages, these color formatters also include padding as
  705. # well. Color LogRecord attributes are only available for console logging.
  706. #
  707. #log_fmt_console: '%(colorlevel)s %(colormsg)s'
  708. #log_fmt_console: '[%(levelname)-8s] %(message)s'
  709. #
  710. #log_fmt_logfile: '%(asctime)s,%(msecs)03d [%(name)-17s][%(levelname)-8s] %(message)s'
  711. # This can be used to control logging levels more specificically. This
  712. # example sets the main salt library at the 'warning' level, but sets
  713. # 'salt.modules' to log at the 'debug' level:
  714. # log_granular_levels:
  715. # 'salt': 'warning'
  716. # 'salt.modules': 'debug'
  717. #
  718. #log_granular_levels: {}
  719. # To diagnose issues with minions disconnecting or missing returns, ZeroMQ
  720. # supports the use of monitor sockets to log connection events. This
  721. # feature requires ZeroMQ 4.0 or higher.
  722. #
  723. # To enable ZeroMQ monitor sockets, set 'zmq_monitor' to 'True' and log at a
  724. # debug level or higher.
  725. #
  726. # A sample log event is as follows:
  727. #
  728. # [DEBUG ] ZeroMQ event: {'endpoint': 'tcp://127.0.0.1:4505', 'event': 512,
  729. # 'value': 27, 'description': 'EVENT_DISCONNECTED'}
  730. #
  731. # All events logged will include the string 'ZeroMQ event'. A connection event
  732. # should be logged as the minion starts up and initially connects to the
  733. # master. If not, check for debug log level and that the necessary version of
  734. # ZeroMQ is installed.
  735. #
  736. #zmq_monitor: False
  737. # Number of times to try to authenticate with the salt master when reconnecting
  738. # to the master
  739. #tcp_authentication_retries: 5
  740. ###### Module configuration #####
  741. ###########################################
  742. # Salt allows for modules to be passed arbitrary configuration data, any data
  743. # passed here in valid yaml format will be passed on to the salt minion modules
  744. # for use. It is STRONGLY recommended that a naming convention be used in which
  745. # the module name is followed by a . and then the value. Also, all top level
  746. # data must be applied via the yaml dict construct, some examples:
  747. #
  748. # You can specify that all modules should run in test mode:
  749. #test: True
  750. #
  751. # A simple value for the test module:
  752. #test.foo: foo
  753. #
  754. # A list for the test module:
  755. #test.bar: [baz,quo]
  756. #
  757. # A dict for the test module:
  758. #test.baz: {spam: sausage, cheese: bread}
  759. #
  760. #
  761. ###### Update settings ######
  762. ###########################################
  763. # Using the features in Esky, a salt minion can both run as a frozen app and
  764. # be updated on the fly. These options control how the update process
  765. # (saltutil.update()) behaves.
  766. #
  767. # The url for finding and downloading updates. Disabled by default.
  768. #update_url: False
  769. #
  770. # The list of services to restart after a successful update. Empty by default.
  771. #update_restart_services: []
  772. ###### Keepalive settings ######
  773. ############################################
  774. # ZeroMQ now includes support for configuring SO_KEEPALIVE if supported by
  775. # the OS. If connections between the minion and the master pass through
  776. # a state tracking device such as a firewall or VPN gateway, there is
  777. # the risk that it could tear down the connection the master and minion
  778. # without informing either party that their connection has been taken away.
  779. # Enabling TCP Keepalives prevents this from happening.
  780. # Overall state of TCP Keepalives, enable (1 or True), disable (0 or False)
  781. # or leave to the OS defaults (-1), on Linux, typically disabled. Default True, enabled.
  782. #tcp_keepalive: True
  783. # How long before the first keepalive should be sent in seconds. Default 300
  784. # to send the first keepalive after 5 minutes, OS default (-1) is typically 7200 seconds
  785. # on Linux see /proc/sys/net/ipv4/tcp_keepalive_time.
  786. #tcp_keepalive_idle: 300
  787. # How many lost probes are needed to consider the connection lost. Default -1
  788. # to use OS defaults, typically 9 on Linux, see /proc/sys/net/ipv4/tcp_keepalive_probes.
  789. #tcp_keepalive_cnt: -1
  790. # How often, in seconds, to send keepalives after the first one. Default -1 to
  791. # use OS defaults, typically 75 seconds on Linux, see
  792. # /proc/sys/net/ipv4/tcp_keepalive_intvl.
  793. #tcp_keepalive_intvl: -1
  794. ###### Windows Software settings ######
  795. ############################################
  796. # Location of the repository cache file on the master:
  797. #win_repo_cachefile: 'salt://win/repo/winrepo.p'
  798. ###### Returner settings ######
  799. ############################################
  800. # Default Minion returners. Can be a comma delimited string or a list:
  801. #
  802. #return: mysql
  803. #
  804. #return: mysql,slack,redis
  805. #
  806. #return:
  807. # - mysql
  808. # - hipchat
  809. # - slack
  810. ###### Miscellaneous settings ######
  811. ############################################
  812. # Default match type for filtering events tags: startswith, endswith, find, regex, fnmatch
  813. #event_match_type: startswith