.. _configuration-salt-minion: =========================== Configuring the Salt Minion =========================== The Salt system is amazingly simple and easy to configure. The two components of the Salt system each have a respective configuration file. The :command:`salt-master` is configured via the master configuration file, and the :command:`salt-minion` is configured via the minion configuration file. .. seealso:: :ref:`example minion configuration file ` The Salt Minion configuration is very simple. Typically, the only value that needs to be set is the master value so the minion knows where to locate its master. By default, the salt-minion configuration will be in :file:`/etc/salt/minion`. A notable exception is FreeBSD, where the configuration will be in :file:`/usr/local/etc/salt/minion`. Minion Primary Configuration ============================ .. conf_minion:: master ``master`` ---------- Default: ``salt`` The hostname or ipv4 of the master. Default: ``salt`` .. code-block:: yaml master: salt The option can can also be set to a list of masters, enabling :doc:`multi-master ` mode. .. code-block:: yaml master: - address1 - address2 .. versionchanged:: 2014.7.0 The master can be dynamically configured. The :conf_minion:`master` value can be set to an module function which will be executed and will assume that the returning value is the ip or hostname of the desired master. If a function is being specified, then the :conf_minion:`master_type` option must be set to ``func``, to tell the minion that the value is a function to be run and not a fully-qualified domain name. .. code-block:: yaml master: module.function master_type: func In addition, instead of using multi-master mode, the minion can be configured to use the list of master addresses as a failover list, trying the first address, then the second, etc. until the minion successfully connects. To enable this behavior, set :conf_minion:`master_type` to ``failover``: .. code-block:: yaml master: - address1 - address2 master_type: failover .. conf_minion:: master_type ``master_type`` --------------- .. versionadded:: 2014.7.0 Default: ``str`` The type of the :conf_minion:`master` variable. Can be ``str``, ``failover`` or ``func``. .. code-block:: yaml master_type: failover If this option is set to ``failover``, :conf_minion:`master` must be a list of master addresses. The minion will then try each master in the order specified in the list until it successfully connects. :conf_minion:`master_alive_interval` must also be set, this determines how often the minion will verify the presence of the master. .. code-block:: yaml master_type: func If the master needs to be dynamically assigned by executing a function instead of reading in the static master value, set this to ``func``. This can be used to manage the minion's master setting from an execution module. By simply changing the algorithm in the module to return a new master ip/fqdn, restart the minion and it will connect to the new master. .. conf_minion:: max_event_size ``max_event_size`` ------------------ .. versionadded:: 2014.7.0 Default: ``1048576`` Passing very large events can cause the minion to consume large amounts of memory. This value tunes the maximum size of a message allowed onto the minion event bus. The value is expressed in bytes. .. code-block:: yaml max_event_size: 1048576 .. conf_minion:: master_failback ``master_failback`` ------------------- .. versionadded:: 2016.3.0 Default: ``False`` If the minion is in multi-master mode and the :conf_minion`master_type` configuration option is set to ``failover``, this setting can be set to ``True`` to force the minion to fail back to the first master in the list if the first master is back online. .. code-block:: yaml master_failback: False .. conf_minion:: master_failback_interval ``master_failback_interval`` ---------------------------- .. versionadded:: 2016.3.0 Default: ``0`` If the minion is in multi-master mode, the :conf_minion`master_type` configuration is set to ``failover``, and the ``master_failback`` option is enabled, the master failback interval can be set to ping the top master with this interval, in seconds. .. code-block:: yaml master_failback_interval: 0 .. conf_minion:: master_alive_interval ``master_alive_interval`` ------------------------- Default: ``0`` Configures how often, in seconds, the minion will verify that the current master is alive and responding. The minion will try to establish a connection to the next master in the list if it finds the existing one is dead. .. code-block:: yaml master_alive_interval: 30 .. conf_minion:: master_shuffle ``master_shuffle`` ------------------ .. versionadded:: 2014.7.0 Default: ``False`` If :conf_minion:`master` is a list of addresses and :conf_minion`master_type` is ``failover``, shuffle them before trying to connect to distribute the minions over all available masters. This uses Python's :func:`random.shuffle ` method. .. code-block:: yaml master_shuffle: True .. conf_minion:: random_master ``random_master`` ----------------- Default: ``False`` If :conf_minion:`master` is a list of addresses, shuffle them before trying to connect to distribute the minions over all available masters. This uses Python's :func:`random.randint ` method. .. code-block:: yaml random_master: True .. conf_minion:: retry_dns ``retry_dns`` ------------- Default: ``30`` Set the number of seconds to wait before attempting to resolve the master hostname if name resolution fails. Defaults to 30 seconds. Set to zero if the minion should shutdown and not retry. .. code-block:: yaml retry_dns: 30 .. conf_minion:: master_port ``master_port`` --------------- Default: ``4506`` The port of the master ret server, this needs to coincide with the ret_port option on the Salt master. .. code-block:: yaml master_port: 4506 .. conf_minion:: user ``user`` -------- Default: ``root`` The user to run the Salt processes .. code-block:: yaml user: root .. conf_minion:: sudo_user ``sudo_user`` -------------- Default: ``''`` The user to run salt remote execution commands as via sudo. If this option is enabled then sudo will be used to change the active user executing the remote command. If enabled the user will need to be allowed access via the sudoers file for the user that the salt minion is configured to run as. The most common option would be to use the root user. If this option is set the ``user`` option should also be set to a non-root user. If migrating from a root minion to a non root minion the minion cache should be cleared and the minion pki directory will need to be changed to the ownership of the new user. .. code-block:: yaml sudo_user: root ``pidfile`` ----------- Default: ``/var/run/salt-minion.pid`` The location of the daemon's process ID file .. code-block:: yaml pidfile: /var/run/salt-minion.pid .. conf_minion:: root_dir ``root_dir`` ------------ Default: ``/`` This directory is prepended to the following options: :conf_minion:`pki_dir`, :conf_minion:`cachedir`, :conf_minion:`log_file`, :conf_minion:`sock_dir`, and :conf_minion:`pidfile`. .. code-block:: yaml root_dir: / .. conf_minion:: conf_file ``conf_file`` ------------- Default: ``/etc/salt/minion`` The path to the minion's configuration file. .. code-block:: yaml conf_file: /etc/salt/minion .. conf_minion:: pki_dir ``pki_dir`` ----------- Default: ``/etc/salt/pki/minion`` The directory used to store the minion's public and private keys. .. code-block:: yaml pki_dir: /etc/salt/pki/minion .. conf_minion:: id ``id`` ------ Default: the system's hostname .. seealso:: :ref:`Salt Walkthrough ` The :strong:`Setting up a Salt Minion` section contains detailed information on how the hostname is determined. Explicitly declare the id for this minion to use. Since Salt uses detached ids it is possible to run multiple minions on the same machine but with different ids. .. code-block:: yaml id: foo.bar.com .. conf_minion:: minion_id_caching ``minion_id_caching`` --------------------- .. versionadded:: 0.17.2 Default: ``True`` Caches the minion id to a file when the minion's :minion_conf:`id` is not statically defined in the minion config. This setting prevents potential problems when automatic minion id resolution changes, which can cause the minion to lose connection with the master. To turn off minion id caching, set this config to ``False``. For more information, please see `Issue #7558`_ and `Pull Request #8488`_. .. code-block:: yaml minion_id_caching: True .. _Issue #7558: https://github.com/saltstack/salt/issues/7558 .. _Pull Request #8488: https://github.com/saltstack/salt/pull/8488 .. conf_minion:: append_domain ``append_domain`` ----------------- Default: ``None`` Append a domain to a hostname in the event that it does not exist. This is useful for systems where ``socket.getfqdn()`` does not actually result in a FQDN (for instance, Solaris). .. code-block:: yaml append_domain: foo.org .. conf_minion:: cachedir ``cachedir`` ------------ Default: ``/var/cache/salt/minion`` The location for minion cache data. This directory may contain sensitive data and should be protected accordingly. .. code-block:: yaml cachedir: /var/cache/salt/minion .. conf_minion:: verify_env ``verify_env`` -------------- Default: ``True`` Verify and set permissions on configuration directories at startup. .. code-block:: yaml verify_env: True .. note:: When set to ``True`` the verify_env option requires WRITE access to the configuration directory (/etc/salt/). In certain situations such as mounting /etc/salt/ as read-only for templating this will create a stack trace when :py:func:`state.apply ` is called. .. conf_minion:: cache_jobs ``cache_jobs`` -------------- Default: ``False`` The minion can locally cache the return data from jobs sent to it, this can be a good way to keep track of the minion side of the jobs the minion has executed. By default this feature is disabled, to enable set cache_jobs to ``True``. .. code-block:: yaml cache_jobs: False .. conf_minion:: minion_pillar_cache ``minion_pillar_cache`` ----------------------- Default: ``False`` The minion can locally cache rendered pillar data under :conf_minion:`cachedir`/pillar. This allows a temporarily disconnected minion to access previously cached pillar data by invoking salt-call with the --local and --pillar_root=:conf_minion:`cachedir`/pillar options. Before enabling this setting consider that the rendered pillar may contain security sensitive data. Appropriate access restrictions should be in place. By default the saved pillar data will be readable only by the user account running salt. By default this feature is disabled, to enable set minion_pillar_cache to ``True``. .. code-block:: yaml minion_pillar_cache: False .. conf_minion:: grains ``grains`` ---------- Default: (empty) .. seealso:: :ref:`static-custom-grains` Statically assigns grains to the minion. .. code-block:: yaml grains: roles: - webserver - memcache deployment: datacenter4 cabinet: 13 cab_u: 14-15 .. conf_minion:: grains_cache ``grains_cache`` ---------------- Default: ``False`` The minion can locally cache grain data instead of refreshing the data each time the grain is referenced. By default this feature is disabled, to enable set grains_cache to ``True``. .. code-block:: yaml grains_cache: False .. conf_minion:: grains_deep_merge ``grains_deep_merge`` --------------------- .. versionadded:: 2016.3.0 Default: ``False`` The grains can be merged, instead of overridden, using this option. This allows custom grains to defined different subvalues of a dictionary grain. By default this feature is disabled, to enable set grains_deep_merge to ``True``. .. code-block:: yaml grains_deep_merge: False For example, with these custom grains functions: .. code-block:: python def custom1_k1(): return {'custom1': {'k1': 'v1'}} def custom1_k2(): return {'custom1': {'k2': 'v2'}} Without ``grains_deep_merge``, the result would be: .. code-block:: yaml custom1: k1: v1 With ``grains_deep_merge``, the result will be: .. code-block:: yaml custom1: k1: v1 k2: v2 .. conf_minion:: mine_enabled ``mine_enabled`` ---------------- .. versionadded:: 2015.8.10 Default: ``True`` Determines whether or not the salt minion should run scheduled mine updates. If this is set to False then the mine update function will not get added to the scheduler for the minion. .. code-block:: yaml mine_enabled: True .. conf_minion:: mine_return_job ``mine_return_job`` ------------------- .. versionadded:: 2015.8.10 Default: ``False`` Determines whether or not scheduled mine updates should be accompanied by a job return for the job cache. .. code-block:: yaml mine_return_job: False ``mine_functions`` ------------------- Default: Empty Designate which functions should be executed at mine_interval intervals on each minion. :ref:`See this documentation on the Salt Mine ` for more information. Note these can be defined in the pillar for a minion as well. :ref:`example minion configuration file ` .. code-block:: yaml mine_functions: test.ping: [] network.ip_addrs: interface: eth0 cidr: '10.0.0.0/8' .. conf_minion:: sock_dir ``sock_dir`` ------------ Default: ``/var/run/salt/minion`` The directory where Unix sockets will be kept. .. code-block:: yaml sock_dir: /var/run/salt/minion .. conf_minion:: backup_mode ``backup_mode`` --------------- Default: ``''`` Backup files replaced by file.managed and file.recurse under cachedir. .. code-block:: yaml backup_mode: minion .. conf_minion:: acceptance_wait_time ``acceptance_wait_time`` ------------------------ Default: ``10`` The number of seconds to wait until attempting to re-authenticate with the master. .. code-block:: yaml acceptance_wait_time: 10 .. conf_minion:: acceptance_wait_time_max ``acceptance_wait_time_max`` ---------------------------- Default: ``0`` The maximum number of seconds to wait until attempting to re-authenticate with the master. If set, the wait will increase by :conf_minion:`acceptance_wait_time` seconds each iteration. .. code-block:: yaml acceptance_wait_time_max: 0 .. conf_minion:: random_reauth_delay ``random_reauth_delay`` ----------------------- Default: ``10`` When the master key changes, the minion will try to re-auth itself to receive the new master key. In larger environments this can cause a syn-flood on the master because all minions try to re-auth immediately. To prevent this and have a minion wait for a random amount of time, use this optional parameter. The wait-time will be a random number of seconds between 0 and the defined value. .. code-block:: yaml random_reauth_delay: 60 .. conf_minion:: auth_tries ``auth_tries`` -------------- .. versionadded:: 2014.7.0 Default: ``7`` The number of attempts to authenticate to a master before giving up. Or, more technically, the number of consecutive SaltReqTimeoutErrors that are acceptable when trying to authenticate to the master. .. code-block:: yaml auth_tries: 7 .. conf_minion:: master_tries ``master_tries`` ---------------- .. versionadded:: 2016.3.0 Default: ``1`` The number of attempts to connect to a master before giving up. Set this to ``-1`` for unlimited attempts. This allows for a master to have downtime and the minion to reconnect to it later when it comes back up. In 'failover' mode, which is set in the :conf_minion:`master_type` configuration, this value is the number of attempts for each set of masters. In this mode, it will cycle through the list of masters for each attempt. ``master_tries`` is different than :conf_minion:`auth_tries` because ``auth_tries`` attempts to retry auth attempts with a single master. ``auth_tries`` is under the assumption that you can connect to the master but not gain authorization from it. ``master_tries`` will still cycle through all of the masters in a given try, so it is appropriate if you expect occasional downtime from the master(s). .. code-block:: yaml master_tries: 1 .. conf_minion:: acceptance_wait_time_max ``auth_tries`` -------------- .. versionadded:: 2014.7.0 Default: ``7`` The number of attempts to authenticate to a master before giving up. Or, more technically, the number of consecutive SaltReqTimeoutErrors that are acceptable when trying to authenticate to the master. .. code-block:: yaml auth_tries: 7 .. conf_minion:: auth_timeout ``auth_timeout`` ---------------- .. versionadded:: 2014.7.0 Default: ``60`` When waiting for a master to accept the minion's public key, salt will continuously attempt to reconnect until successful. This is the timeout value, in seconds, for each individual attempt. After this timeout expires, the minion will wait for :conf_minion:`acceptance_wait_time` seconds before trying again. Unless your master is under unusually heavy load, this should be left at the default. .. code-block:: yaml auth_timeout: 60 .. conf_minion:: auth_safemode ``auth_safemode`` ----------------- .. versionadded:: 2014.7.0 Default: ``False`` If authentication fails due to SaltReqTimeoutError during a ping_interval, this setting, when set to ``True``, will cause a sub-minion process to restart. .. code-block:: yaml auth_safemode: False .. conf_minion:: recon_default ``recon_default`` ----------------- Default: ``1000`` The interval in milliseconds that the socket should wait before trying to reconnect to the master (1000ms = 1 second). .. code-block:: yaml recon_default: 1000 .. conf_minion:: recon_max ``recon_max`` ------------- Default: ``10000`` The maximum time a socket should wait. Each interval the time to wait is calculated by doubling the previous time. If recon_max is reached, it starts again at the recon_default. Short example: - reconnect 1: the socket will wait 'recon_default' milliseconds - reconnect 2: 'recon_default' * 2 - reconnect 3: ('recon_default' * 2) * 2 - reconnect 4: value from previous interval * 2 - reconnect 5: value from previous interval * 2 - reconnect x: if value >= recon_max, it starts again with recon_default .. code-block:: yaml recon_max: 10000 .. conf_minion:: recon_randomize ``recon_randomize`` ------------------- Default: ``True`` Generate a random wait time on minion start. The wait time will be a random value between recon_default and recon_default + recon_max. Having all minions reconnect with the same recon_default and recon_max value kind of defeats the purpose of being able to change these settings. If all minions have the same values and the setup is quite large (several thousand minions), they will still flood the master. The desired behavior is to have time-frame within all minions try to reconnect. .. code-block:: yaml recon_randomize: True .. conf_minion:: return_retry_timer ``return_retry_timer`` ---------------------- Default: ``5`` The default timeout for a minion return attempt. .. code-block:: yaml return_retry_timer: 5 .. conf_minion:: return_retry_timer_max ``return_retry_timer_max`` -------------------------- Default: ``10`` The maximum timeout for a minion return attempt. If non-zero the minion return retry timeout will be a random int between ``return_retry_timer`` and ``return_retry_timer_max`` .. code-block:: yaml return_retry_timer_max: 10 .. conf_minion:: cache_sreqs ``cache_sreqs`` --------------- Default: ``True`` The connection to the master ret_port is kept open. When set to False, the minion creates a new connection for every return to the master. .. code-block:: yaml cache_sreqs: True .. conf_minion:: ipc_mode ``ipc_mode`` ------------ Default: ``ipc`` Windows platforms lack POSIX IPC and must rely on slower TCP based inter- process communications. Set ipc_mode to ``tcp`` on such systems. .. code-block:: yaml ipc_mode: ipc .. conf_minion:: tcp_pub_port ``tcp_pub_port`` ---------------- Default: ``4510`` Publish port used when :conf_minion:`ipc_mode` is set to ``tcp``. .. code-block:: yaml tcp_pub_port: 4510 .. conf_minion:: tcp_pull_port ``tcp_pull_port`` ----------------- Default: ``4511`` Pull port used when :conf_minion:`ipc_mode` is set to ``tcp``. .. code-block:: yaml tcp_pull_port: 4511 .. conf_minion:: transport ``transport`` ------------- Default: ``zeromq`` Changes the underlying transport layer. ZeroMQ is the recommended transport while additional transport layers are under development. Supported values are ``zeromq``, ``raet`` (experimental), and ``tcp`` (experimental). This setting has a significant impact on performance and should not be changed unless you know what you are doing! Transports are explained in :ref:`Salt Transports `. .. code-block:: yaml transport: zeromq .. conf_minion:: syndic_finger ``syndic_finger`` ----------------- Default: ``''`` The key fingerprint of the higher-level master for the syndic to verify it is talking to the intended master. .. code-block:: yaml syndic_finger: 'ab:30:65:2a:d6:9e:20:4f:d8:b2:f3:a7:d4:65:50:10' Minion Module Management ======================== .. conf_minion:: disable_modules ``disable_modules`` ------------------- Default: ``[]`` (all modules are enabled by default) The event may occur in which the administrator desires that a minion should not be able to execute a certain module. The ``sys`` module is built into the minion and cannot be disabled. This setting can also tune the minion. Because all modules are loaded into system memory, disabling modules will lover the minion's memory footprint. Modules should be specified according to their file name on the system and not by their virtual name. For example, to disable ``cmd``, use the string ``cmdmod`` which corresponds to ``salt.modules.cmdmod``. .. code-block:: yaml disable_modules: - test - solr .. conf_minion:: disable_returners ``disable_returners`` --------------------- Default: ``[]`` (all returners are enabled by default) If certain returners should be disabled, this is the place .. code-block:: yaml disable_returners: - mongo_return .. conf_minion:: module_dirs ``module_dirs`` --------------- Default: ``[]`` A list of extra directories to search for Salt modules .. code-block:: yaml module_dirs: - /var/lib/salt/modules .. conf_minion:: returner_dirs ``returner_dirs`` ----------------- Default: ``[]`` A list of extra directories to search for Salt returners .. code-block:: yaml returner_dirs: - /var/lib/salt/returners .. conf_minion:: states_dirs ``states_dirs`` --------------- Default: ``[]`` A list of extra directories to search for Salt states .. code-block:: yaml states_dirs: - /var/lib/salt/states .. conf_minion:: grains_dirs ``grains_dirs`` --------------- Default: ``[]`` A list of extra directories to search for Salt grains .. code-block:: yaml grains_dirs: - /var/lib/salt/grains .. conf_minion:: render_dirs ``render_dirs`` --------------- Default: ``[]`` A list of extra directories to search for Salt renderers .. code-block:: yaml render_dirs: - /var/lib/salt/renderers .. conf_minion:: cython_enable ``cython_enable`` ----------------- Default: ``False`` Set this value to true to enable auto-loading and compiling of ``.pyx`` modules, This setting requires that ``gcc`` and ``cython`` are installed on the minion. .. code-block:: yaml cython_enable: False .. conf_minion:: enable_zip_modules ``enable_zip_modules`` ---------------------- .. versionadded:: 2015.8.0 Default: ``False`` Set this value to true to enable loading of zip archives as extension modules. This allows for packing module code with specific dependencies to avoid conflicts and/or having to install specific modules' dependencies in system libraries. .. code-block:: yaml enable_zip_modules: False .. conf_minion:: providers ``providers`` ------------- Default: (empty) A module provider can be statically overwritten or extended for the minion via the ``providers`` option. This can be done :doc:`on an individual basis in an SLS file <../states/providers>`, or globally here in the minion config, like below. .. code-block:: yaml providers: service: systemd State Management Settings ========================= .. conf_minion:: renderer ``renderer`` ------------ Default: ``yaml_jinja`` The default renderer used for local state executions .. code-block:: yaml renderer: yaml_jinja .. conf_minion:: state_verbose ``state_verbose`` ----------------- Default: ``True`` Controls the verbosity of state runs. By default, the results of all states are returned, but setting this value to ``False`` will cause salt to only display output for states that failed or states that have changes. .. code-block:: yaml state_verbose: True .. conf_minion:: state_output ``state_output`` ---------------- Default: ``full`` The state_output setting changes if the output is the full multi line output for each changed state if set to 'full', but if set to 'terse' the output will be shortened to a single line. .. code-block:: yaml state_output: full .. conf_minion:: autoload_dynamic_modules ``autoload_dynamic_modules`` ---------------------------- Default: ``True`` autoload_dynamic_modules turns on automatic loading of modules found in the environments on the master. This is turned on by default. To turn off auto-loading modules when states run, set this value to ``False``. .. code-block:: yaml autoload_dynamic_modules: True .. conf_minion:: clean_dynamic_modules Default: ``True`` clean_dynamic_modules keeps the dynamic modules on the minion in sync with the dynamic modules on the master. This means that if a dynamic module is not on the master it will be deleted from the minion. By default this is enabled and can be disabled by changing this value to ``False``. .. code-block:: yaml clean_dynamic_modules: True .. conf_minion:: environment ``environment`` --------------- Default: ``None`` Normally the minion is not isolated to any single environment on the master when running states, but the environment can be isolated on the minion side by statically setting it. Remember that the recommended way to manage environments is to isolate via the top file. .. code-block:: yaml environment: None File Directory Settings ======================= .. conf_minion:: file_client ``file_client`` --------------- Default: ``remote`` The client defaults to looking on the master server for files, but can be directed to look on the minion by setting this parameter to ``local``. .. code-block:: yaml file_client: remote .. conf_minion:: use_master_when_local ``use_master_when_local`` ------------------------- Default: ``False`` When using a local :conf_minion:`file_client`, this parameter is used to allow the client to connect to a master for remote execution. .. code-block:: yaml use_master_when_local: False .. conf_minion:: file_roots ``file_roots`` -------------- Default: .. code-block:: yaml base: - /srv/salt When using a local :conf_minion:`file_client`, this parameter is used to setup the fileserver's environments. This parameter operates identically to the :conf_master:`master config parameter ` of the same name. .. code-block:: yaml file_roots: base: - /srv/salt dev: - /srv/salt/dev/services - /srv/salt/dev/states prod: - /srv/salt/prod/services - /srv/salt/prod/states .. conf_minion:: fileserver_followsymlinks ``fileserver_followsymlinks`` ----------------------------- .. versionadded:: 2014.1.0 Default: ``True`` By default, the file_server follows symlinks when walking the filesystem tree. Currently this only applies to the default roots fileserver_backend. .. code-block:: yaml fileserver_followsymlinks: True .. conf_minion:: fileserver_ignoresymlinks ``fileserver_ignoresymlinks`` ----------------------------- .. versionadded:: 2014.1.0 Default: ``False`` If you do not want symlinks to be treated as the files they are pointing to, set ``fileserver_ignoresymlinks`` to ``True``. By default this is set to False. When set to ``True``, any detected symlink while listing files on the Master will not be returned to the Minion. .. code-block:: yaml fileserver_ignoresymlinks: False .. conf_minion:: fileserver_limit_traversal ``fileserver_limit_traversal`` ------------------------------ .. versionadded:: 2014.1.0 Default: ``False`` By default, the Salt fileserver recurses fully into all defined environments to attempt to find files. To limit this behavior so that the fileserver only traverses directories with SLS files and special Salt directories like _modules, set ``fileserver_limit_traversal`` to ``True``. This might be useful for installations where a file root has a very large number of files and performance is impacted. .. code-block:: yaml fileserver_limit_traversal: False .. conf_minion:: hash_type ``hash_type`` ------------- Default: ``md5`` The hash_type is the hash to use when discovering the hash of a file on the local fileserver. The default is md5, but sha1, sha224, sha256, sha384, and sha512 are also supported. .. code-block:: yaml hash_type: md5 Pillar Settings =============== .. conf_minion:: pillar_roots ``pillar_roots`` ---------------- Default: .. code-block:: yaml base: - /srv/pillar When using a local :conf_minion:`file_client`, this parameter is used to setup the pillar environments. .. code-block:: yaml pillar_roots: base: - /srv/pillar dev: - /srv/pillar/dev prod: - /srv/pillar/prod .. conf_minion:: pillarenv ``pillarenv`` ------------- Default: ``None`` Isolates the pillar environment on the minion side. This functions the same as the environment setting, but for pillar instead of states. .. code-block:: yaml pillarenv: None .. conf_minion:: file_recv_max_size ``file_recv_max_size`` ---------------------- .. versionadded:: 2014.7.0 Default: ``100`` Set a hard-limit on the size of the files that can be pushed to the master. It will be interpreted as megabytes. .. code-block:: yaml file_recv_max_size: 100 Security Settings ================= .. conf_minion:: open_mode ``open_mode`` ------------- Default: ``False`` Open mode can be used to clean out the PKI key received from the Salt master, turn on open mode, restart the minion, then turn off open mode and restart the minion to clean the keys. .. code-block:: yaml open_mode: False .. conf_minion:: master_finger ``master_finger`` ----------------- Default: ``''`` Fingerprint of the master public key to validate the identity of your Salt master before the initial key exchange. The master fingerprint can be found by running "salt-key -F master" on the Salt master. .. code-block:: yaml master_finger: 'ba:30:65:2a:d6:9e:20:4f:d8:b2:f3:a7:d4:65:11:13' .. conf_minion:: verify_master_pubkey_sign ``verify_master_pubkey_sign`` ----------------------------- Default: ``False`` Enables verification of the master-public-signature returned by the master in auth-replies. Please see the tutorial on how to configure this properly `Multimaster-PKI with Failover Tutorial `_ .. versionadded:: 2014.7.0 .. code-block:: yaml verify_master_pubkey_sign: True If this is set to ``True``, :conf_master:`master_sign_pubkey` must be also set to ``True`` in the master configuration file. .. conf_minion:: master_sign_key_name ``master_sign_key_name`` ------------------------ Default: ``master_sign`` The filename without the *.pub* suffix of the public key that should be used for verifying the signature from the master. The file must be located in the minion's pki directory. .. versionadded:: 2014.7.0 .. code-block:: yaml master_sign_key_name: .. conf_minion:: always_verify_signature ``always_verify_signature`` --------------------------- Default: ``False`` If :conf_minion:`verify_master_pubkey_sign` is enabled, the signature is only verified if the public-key of the master changes. If the signature should always be verified, this can be set to ``True``. .. versionadded:: 2014.7.0 .. code-block:: yaml always_verify_signature: True Thread Settings =============== .. conf_minion:: multiprocessing Default: ``True`` If `multiprocessing` is enabled when a minion receives a publication a new process is spawned and the command is executed therein. Conversely, if `multiprocessing` is disabled the new publication will be run executed in a thread. .. code-block:: yaml multiprocessing: True .. _minion-logging-settings: Minion Logging Settings ======================= .. conf_minion:: log_file ``log_file`` ------------ Default: ``/var/log/salt/minion`` The minion log can be sent to a regular file, local path name, or network location. See also :conf_log:`log_file`. Examples: .. code-block:: yaml log_file: /var/log/salt/minion .. code-block:: yaml log_file: file:///dev/log .. code-block:: yaml log_file: udp://loghost:10514 .. conf_minion:: log_level ``log_level`` ------------- Default: ``warning`` The level of messages to send to the console. See also :conf_log:`log_level`. .. code-block:: yaml log_level: warning .. conf_minion:: log_level_logfile ``log_level_logfile`` --------------------- Default: ``info`` The level of messages to send to the log file. See also :conf_log:`log_level_logfile`. When it is not set explicitly it will inherit the level set by :conf_log:`log_level` option. .. code-block:: yaml log_level_logfile: warning .. conf_minion:: log_datefmt ``log_datefmt`` --------------- Default: ``%H:%M:%S`` The date and time format used in console log messages. See also :conf_log:`log_datefmt`. .. code-block:: yaml log_datefmt: '%H:%M:%S' .. conf_minion:: log_datefmt_logfile ``log_datefmt_logfile`` ----------------------- Default: ``%Y-%m-%d %H:%M:%S`` The date and time format used in log file messages. See also :conf_log:`log_datefmt_logfile`. .. code-block:: yaml log_datefmt_logfile: '%Y-%m-%d %H:%M:%S' .. conf_minion:: log_fmt_console ``log_fmt_console`` ------------------- Default: ``[%(levelname)-8s] %(message)s`` The format of the console logging messages. See also :conf_log:`log_fmt_console`. .. note:: Log colors are enabled in ``log_fmt_console`` rather than the :conf_minion:`color` config since the logging system is loaded before the minion config. Console log colors are specified by these additional formatters: %(colorlevel)s %(colorname)s %(colorprocess)s %(colormsg)s Since it is desirable to include the surrounding brackets, '[' and ']', in the coloring of the messages, these color formatters also include padding as well. Color LogRecord attributes are only available for console logging. .. code-block:: yaml log_fmt_console: '%(colorlevel)s %(colormsg)s' log_fmt_console: '[%(levelname)-8s] %(message)s' .. conf_minion:: log_fmt_logfile ``log_fmt_logfile`` ------------------- Default: ``%(asctime)s,%(msecs)03.0f [%(name)-17s][%(levelname)-8s] %(message)s`` The format of the log file logging messages. See also :conf_log:`log_fmt_logfile`. .. code-block:: yaml log_fmt_logfile: '%(asctime)s,%(msecs)03.0f [%(name)-17s][%(levelname)-8s] %(message)s' .. conf_minion:: log_granular_levels ``log_granular_levels`` ----------------------- Default: ``{}`` This can be used to control logging levels more specifically. See also :conf_log:`log_granular_levels`. .. conf_minion:: zmq_monitor ``zmq_monitor`` --------------- Default: ``False`` To diagnose issues with minions disconnecting or missing returns, ZeroMQ supports the use of monitor sockets to log connection events. This feature requires ZeroMQ 4.0 or higher. To enable ZeroMQ monitor sockets, set 'zmq_monitor' to 'True' and log at a debug level or higher. A sample log event is as follows: .. code-block:: yaml [DEBUG ] ZeroMQ event: {'endpoint': 'tcp://127.0.0.1:4505', 'event': 512, 'value': 27, 'description': 'EVENT_DISCONNECTED'} All events logged will include the string ``ZeroMQ event``. A connection event should be logged as the minion starts up and initially connects to the master. If not, check for debug log level and that the necessary version of ZeroMQ is installed. .. conf_minion:: failhard ``failhard`` ------------ Default: ``False`` Set the global failhard flag. This informs all states to stop running states at the moment a single state fails .. code-block:: yaml failhard: False Include Configuration ===================== .. conf_minion:: include ``default_include`` ------------------- Default: ``minion.d/*.conf`` The minion can include configuration from other files. Per default the minion will automatically include all config files from `minion.d/*.conf` where minion.d is relative to the directory of the minion configuration file. .. note:: Salt creates files in the ``minion.d`` directory for its own use. These files are prefixed with an underscore. A common example of this is the ``_schedule.conf`` file. ``include`` ----------- Default: ``not defined`` The minion can include configuration from other files. To enable this, pass a list of paths to this option. The paths can be either relative or absolute; if relative, they are considered to be relative to the directory the main minion configuration file lives in. Paths can make use of shell-style globbing. If no files are matched by a path passed to this option then the minion will log a warning message. .. code-block:: yaml # Include files from a minion.d directory in the same # directory as the minion config file include: minion.d/*.conf # Include a single extra file into the configuration include: /etc/roles/webserver # Include several files and the minion.d directory include: - extra_config - minion.d/* - /etc/roles/webserver Frozen Build Update Settings ============================ These options control how :py:func:`salt.modules.saltutil.update` works with esky frozen apps. For more information look at ``_. .. conf_minion:: update_url ``update_url`` -------------- Default: ``False`` (Update feature is disabled) The url to use when looking for application updates. Esky depends on directory listings to search for new versions. A webserver running on your Master is a good starting point for most setups. .. code-block:: yaml update_url: 'http://salt.example.com/minion-updates' .. conf_minion:: update_restart_services ``update_restart_services`` --------------------------- Default: ``[]`` (service restarting on update is disabled) A list of services to restart when the minion software is updated. This would typically just be a list containing the minion's service name, but you may have other services that need to go with it. .. code-block:: yaml update_restart_services: ['salt-minion'] .. _winrepo-minion-config-opts: Standalone Minion Windows Software Repo Settings ================================================ .. important:: To use these config options, the minion must be running in masterless mode (set :conf_minion:`file_client` to ``local``). .. conf_minion:: winrepo_dir .. conf_minion:: win_repo ``winrepo_dir`` --------------- .. versionchanged:: 2015.8.0 Renamed from ``win_repo`` to ``winrepo_dir``. Also, this option did not have a default value until this version. Default: ``C:\salt\srv\salt\win\repo`` Location on the minion where the :conf_minion:`winrepo_remotes` are checked out. .. code-block:: yaml winrepo_dir: 'D:\winrepo' .. conf_minion:: winrepo_cachefile .. conf_minion:: win_repo_cachefile ``winrepo_cachefile`` --------------------- .. versionchanged:: 2015.8.0 Renamed from ``win_repo_cachefile`` to ``winrepo_cachefile``. Also, this option did not have a default value until this version. Default: ``winrepo.p`` Path relative to :conf_minion:`winrepo_dir` where the winrepo cache should be created. .. code-block:: yaml winrepo_cachefile: winrepo.p .. conf_minion:: winrepo_remotes .. conf_minion:: win_gitrepos ``winrepo_remotes`` ------------------- .. versionchanged:: 2015.8.0 Renamed from ``win_gitrepos`` to ``winrepo_remotes``. Also, this option did not have a default value until this version. .. versionadded:: 2015.8.0 Default: ``['https://github.com/saltstack/salt-winrepo.git']`` List of git repositories to checkout and include in the winrepo .. code-block:: yaml winrepo_remotes: - https://github.com/saltstack/salt-winrepo.git To specify a specific revision of the repository, prepend a commit ID to the URL of the the repository: .. code-block:: yaml winrepo_remotes: - ' https://github.com/saltstack/salt-winrepo.git' Replace ```` with the SHA1 hash of a commit ID. Specifying a commit ID is useful in that it allows one to revert back to a previous version in the event that an error is introduced in the latest revision of the repo.