1
0

minion 37 KB

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