|
- # This file managed by Salt, do not edit by hand!!
- # Based on salt version 2016.11 default config
- {% set reserved_keys = ['master', 'minion', 'cloud', 'salt_cloud_certs', 'engines', 'lxc.network_profile', 'lxc.container_profile', 'reactors'] -%}
- {% set cfg_salt = pillar.get('salt', {}) -%}
- {% set cfg_master = cfg_salt.get('master', {}) -%}
- {% set default_keys = [] -%}
- {%- macro get_config(configname, default_value) -%}
- {%- do default_keys.append(configname) %}
- {%- if configname in cfg_master -%}
- {{ configname }}: {{ cfg_master[configname]|json }}
- {%- elif configname in cfg_salt and configname not in reserved_keys -%}
- {{ configname }}: {{ cfg_salt[configname]|json }}
- {%- else -%}
- #{{ configname }}: {{ default_value|json }}
- {%- endif -%}
- {%- endmacro -%}
- {%- from 'salt/formulas.jinja' import file_roots, formulas with context -%}
- ##### Primary configuration settings #####
- ##########################################
- # This configuration file is used to manage the behavior of the Salt Master.
- # Values that are commented out but have an empty line after the comment are
- # defaults that do not need to be set in the config. If there is no blank line
- # after the comment then the value is presented as an example and is not the
- # default.
-
- # The id to be passed in the publish job to minions.
- # This is used for MultiSyndics to return the job to the requesting master.
- # This must be the same string as the syndic is configured with.
- # master_id: None
- {{ get_config('master_id', 'None') }}
-
- # Per default, the master will automatically include all config files
- # from master.d/*.conf (master.d is a directory in the same directory
- # as the main master config file).
- {{ get_config('default_include', 'master.d/*.conf') }}
-
- # The address of the interface to bind to:
- {{ get_config('interface', '0.0.0.0') }}
-
- # Whether the master should listen for IPv6 connections. If this is set to True,
- # the interface option must be adjusted, too. (For example: "interface: '::'")
- {{ get_config('ipv6', 'False') }}
-
- # The tcp port used by the publisher:
- {{ get_config('publish_port', '4505') }}
-
- # The user under which the salt master will run. Salt will update all
- # permissions to allow the specified user to run the master. The exception is
- # the job cache, which must be deleted if this user is changed. If the
- # modified files cause conflicts, set verify_env to False.
- {{ get_config('user', 'root') }}
-
- # The port used by the communication interface. The ret (return) port is the
- # interface used for the file server, authentication, job returns, etc.
- {{ get_config('ret_port', '4506') }}
-
- # Specify the location of the daemon process ID file:
- {{ get_config('pidfile', '/var/run/salt-master.pid') }}
-
- # The root directory prepended to these options: pki_dir, cachedir,
- # sock_dir, log_file, autosign_file, autoreject_file, extension_modules,
- # key_logfile, pidfile:
- {{ get_config('root_dir', '/') }}
-
- # The path to the master's configuration file.
- {{ get_config('conf_file', '/etc/salt/master') }}
-
- # Directory used to store public key data:
- {{ get_config('pki_dir', '/etc/salt/pki/master') }}
-
- # Key cache. Increases master speed for large numbers of accepted
- # keys. Available options: 'sched'. (Updates on a fixed schedule.)
- # Note that enabling this feature means that minions will not be
- # available to target for up to the length of the maintanence loop
- # which by default is 60s.
- {{ get_config('key_cache', '') }}
-
- # Directory to store job and cache data:
- # This directory may contain sensitive data and should be protected accordingly.
- #
- {{ get_config('cachedir', '/var/cache/salt/master') }}
-
- # Directory for custom modules. This directory can contain subdirectories for
- # each of Salt's module types such as "runners", "output", "wheel", "modules",
- # "states", "returners", etc.
- {{ get_config('extension_modules', '<no default>') }}
-
- # Directory for custom modules. This directory can contain subdirectories for
- # each of Salt's module types such as "runners", "output", "wheel", "modules",
- # "states", "returners", "engines", etc.
- # Like 'extension_modules' but can take an array of paths
- {% if 'module_dirs' in cfg_master -%}
- {%- do default_keys.append('module_dirs') %}
- module_dirs:
- {%- for dir in cfg_master['module_dirs'] %}
- - {{ dir}}
- {%- endfor -%}
- {% elif 'module_dirs' in cfg_salt -%}
- module_dirs:
- {%- for dir in cfg_salt['module_dirs'] %}
- - {{ dir}}
- {%- endfor -%}
- {% else -%}
- #module_dirs: <no default>
- # - /var/cache/salt/minion/extmods
- {% endif %}
-
- # Verify and set permissions on configuration directories at startup:
- {{ get_config('verify_env', 'True') }}
-
- # Set the number of hours to keep old job information in the job cache:
- {{ get_config('keep_jobs', '24') }}
-
- # The number of seconds to wait when the client is requesting information
- # about running jobs.
- {{ get_config('gather_job_timeout', '10') }}
-
- # Set the default timeout for the salt command and api. The default is 5
- # seconds.
- {{ get_config('timeout', '5') }}
-
- # The loop_interval option controls the seconds for the master's maintenance
- # process check cycle. This process updates file server backends, cleans the
- # job cache and executes the scheduler.
- {{ get_config('loop_interval', '60') }}
-
- # Set the default outputter used by the salt command. The default is "nested".
- {{ get_config('output', 'nested') }}
-
- # Set the default output file used by the salt command. Default is to output
- # to the CLI and not to a file. Functions the same way as the "--out-file"
- # CLI option, only sets this to a single file for all salt commands.
- {{ get_config('output_file', 'None') }}
-
- # Return minions that timeout when running commands like test.ping
- {{ get_config('show_timeout', 'True') }}
-
- # By default, output is colored. To disable colored output, set the color value
- # to False.
- {{ get_config('color', 'True') }}
-
- # Do not strip off the colored output from nested results and state outputs
- # (true by default).
- {{ get_config('strip_colors', 'False') }}
-
- # To display a summary of the number of minions targeted, the number of
- # minions returned, and the number of minions that did not return, set the
- # cli_summary value to True. (False by default.)
- #
- {{ get_config('cli_summary', 'False') }}
-
- # Set the directory used to hold unix sockets:
- {{ get_config('sock_dir', '/var/run/salt/master') }}
-
- # The master can take a while to start up when lspci and/or dmidecode is used
- # to populate the grains for the master. Enable if you want to see GPU hardware
- # data for your master.
- {{ get_config('enable_gpu_grains', 'False') }}
-
- # The master maintains a job cache. While this is a great addition, it can be
- # a burden on the master for larger deployments (over 5000 minions).
- # Disabling the job cache will make previously executed jobs unavailable to
- # the jobs system and is not generally recommended.
- {{ get_config('job_cache', 'True') }}
-
- # Cache minion grains, pillar and mine data via the cache subsystem in the
- # cachedir or a database.
- {{ get_config('minion_data_cache', 'True') }}
-
- # Cache subsystem module to use for minion data cache.
- {{ get_config('cache', 'localfs') }}
- # Enables a fast in-memory cache booster and sets the expiration time.
- {{ get_config('memcache_expire_seconds', '0') }}
- # Set a memcache limit in items (bank + key) per cache storage (driver + driver_opts).
- {{ get_config('memcache_max_items', '1024') }}
- # Each time a cache storage got full cleanup all the expired items not just the oldest one.
- {{ get_config('memcache_full_cleanup', 'False') }}
- # Enable collecting the memcache stats and log it on `debug` log level.
- {{ get_config('memcache_debug', 'False') }}
-
- # Store all returns in the given returner.
- # Setting this option requires that any returner-specific configuration also
- # be set. See various returners in salt/returners for details on required
- # configuration values. (See also, event_return_queue below.)
- {{ get_config('event_return', 'mysql') }}
-
- # On busy systems, enabling event_returns can cause a considerable load on
- # the storage system for returners. Events can be queued on the master and
- # stored in a batched fashion using a single transaction for multiple events.
- # By default, events are not queued.
- {{ get_config('event_return_queue', '0') }}
-
- # Only return events matching tags in a whitelist, supports glob matches.
- {% if 'event_return_whitelist' in cfg_master -%}
- {%- do default_keys.append('event_return_whitelist') %}
- event_return_whitelist:
- {%- for event_return in cfg_master['event_return_whitelist'] %}
- - {{ event_return }}
- {%- endfor -%}
- {% elif 'event_return_whitelist' in cfg_salt -%}
- event_return_whitelist:
- {%- for event_return in cfg_salt['event_return_whitelist'] %}
- - {{ event_return }}
- {%- endfor -%}
- {% else -%}
- #event_return_whitelist:
- # - salt/master/a_tag
- # - salt/run/*/ret
- {% endif %}
-
- # Store all event returns **except** the tags in a blacklist supports globs.
- {% if 'event_return_blacklist' in cfg_master -%}
- {%- do default_keys.append('event_return_blacklist') %}
- event_return_blacklist:
- {%- for event_return in cfg_master['event_return_blacklist'] %}
- - {{ event_return }}
- {%- endfor -%}
- {% elif 'event_return_blacklist' in cfg_salt -%}
- event_return_blacklist:
- {%- for event_return in cfg_salt['event_return_blacklist'] %}
- - {{ event_return }}
- {%- endfor -%}
- {% else -%}
- #event_return_blacklist:
- # - salt/master/not_this_tag
- # - salt/wheel/*/ret
- {% endif %}
-
- # 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
- # master event bus. The value is expressed in bytes.
- {{ get_config('max_event_size', '1048576') }}
-
- # By default, the master AES key rotates every 24 hours. The next command
- # following a key rotation will trigger a key refresh from the minion which may
- # result in minions which do not respond to the first command after a key refresh.
- #
- # To tell the master to ping all minions immediately after an AES key refresh, set
- # ping_on_rotate to True. This should mitigate the issue where a minion does not
- # appear to initially respond after a key is rotated.
- #
- # Note that ping_on_rotate may cause high load on the master immediately after
- # the key rotation event as minions reconnect. Consider this carefully if this
- # salt master is managing a large number of minions.
- #
- # If disabled, it is recommended to handle this event by listening for the
- # 'aes_key_rotate' event with the 'key' tag and acting appropriately.
- {{ get_config('ping_on_rotate', 'False') }}
-
- # By default, the master deletes its cache of minion data when the key for that
- # minion is removed. To preserve the cache after key deletion, set
- # 'preserve_minion_cache' to True.
- #
- # WARNING: This may have security implications if compromised minions auth with
- # a previous deleted minion ID.
- {{ get_config('preserve_minion_cache', 'False') }}
-
- # If max_minions is used in large installations, the master might experience
- # high-load situations because of having to check the number of connected
- # minions for every authentication. This cache provides the minion-ids of
- # all connected minions to all MWorker-processes and greatly improves the
- # performance of max_minions.
- {{ get_config('con_cache', 'False') }}
-
- # The master 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 master configuration file lives in (this file). Paths can make use
- # of shell-style globbing. If no files are matched by a path passed to this
- # option, then the master will log a warning message.
- #
- # Include a config file from some other path:
- # include: /etc/salt/extra_config
- #
- # Include config from several files and directories:
- # include:
- # - /etc/salt/extra_config
- {{ get_config('include', '[]') }}
-
- ##### Large-scale tuning settings #####
- ##########################################
- # Max open files
- #
- # Each minion connecting to the master uses AT LEAST one file descriptor, the
- # master subscription connection. If enough minions connect you might start
- # seeing on the console (and then salt-master crashes):
- # Too many open files (tcp_listener.cpp:335)
- # Aborted (core dumped)
- #
- # By default this value will be the one of `ulimit -Hn`, ie, the hard limit for
- # max open files.
- #
- # If you wish to set a different value than the default one, uncomment and
- # configure this setting. Remember that this value CANNOT be higher than the
- # hard limit. Raising the hard limit depends on your OS and/or distribution,
- # a good way to find the limit is to search the internet. For example:
- # raise max open files hard limit debian
- #
- {{ get_config('max_open_files', '100000') }}
-
- # The number of worker threads to start. These threads are used to manage
- # return calls made from minions to the master. If the master seems to be
- # running slowly, increase the number of threads. This setting can not be
- # set lower than 3.
- {{ get_config('worker_threads', '5') }}
-
- # Set the ZeroMQ high water marks
- # http://api.zeromq.org/3-2:zmq-setsockopt
-
- # The listen queue size / backlog
- {{ get_config('zmq_backlog', '1000') }}
-
- # The publisher interface ZeroMQPubServerChannel
- {{ get_config('pub_hwm', '1000') }}
-
- # These two ZMQ HWM settings, salt_event_pub_hwm and event_publisher_pub_hwm
- # are significant for masters with thousands of minions. When these are
- # insufficiently high it will manifest in random responses missing in the CLI
- # and even missing from the job cache. Masters that have fast CPUs and many
- # cores with appropriate worker_threads will not need these set as high.
-
- # On deployment with 8,000 minions, 2.4GHz CPUs, 24 cores, 32GiB memory has
- # these settings:
- #
- # salt_event_pub_hwm: 128000
- # event_publisher_pub_hwm: 64000
-
- # ZMQ high-water-mark for SaltEvent pub socket
- {{ get_config('salt_event_pub_hwm', '20000') }}
-
- # ZMQ high-water-mark for EventPublisher pub socket
- {{ get_config('event_publisher_pub_hwm', '10000') }}
-
- # The master may allocate memory per-event and not
- # reclaim it.
- # To set a high-water mark for memory allocation, use
- # ipc_write_buffer to set a high-water mark for message
- # buffering.
- # Value: In bytes. Set to 'dynamic' to have Salt select
- # a value for you. Default is disabled.
- {%- if 'ipc_write_buffer' in cfg_master %}
- {{ get_config('ipc_write_buffer', 'dynamic') }}
- {%- else %}
- # ipc_write_buffer: 'dynamic'
- {%- endif %}
-
-
- ##### Security settings #####
- ##########################################
- # Enable "open mode", this mode still maintains encryption, but turns off
- # authentication, this is only intended for highly secure environments or for
- # the situation where your keys end up in a bad state. If you run in open mode
- # you do so at your own risk!
- {{ get_config('open_mode', 'False') }}
-
- # Enable auto_accept, this setting will automatically accept all incoming
- # public keys from the minions. Note that this is insecure.
- {{ get_config('auto_accept', 'False') }}
-
- # Time in minutes that an incoming public key with a matching name found in
- # pki_dir/minion_autosign/keyid is automatically accepted. Expired autosign keys
- # are removed when the master checks the minion_autosign directory.
- # 0 equals no timeout
- {{ get_config('autosign_timeout', '120') }}
-
- # If the autosign_file is specified, incoming keys specified in the
- # autosign_file will be automatically accepted. This is insecure. Regular
- # expressions as well as globing lines are supported.
- {{ get_config('autosign_file', '/etc/salt/autosign.conf') }}
-
- # Works like autosign_file, but instead allows you to specify minion IDs for
- # which keys will automatically be rejected. Will override both membership in
- # the autosign_file and the auto_accept setting.
- {{ get_config('autoreject_file', '/etc/salt/autoreject.conf') }}
-
- # Enable permissive access to the salt keys. This allows you to run the
- # master or minion as root, but have a non-root group be given access to
- # your pki_dir. To make the access explicit, root must belong to the group
- # you've given access to. This is potentially quite insecure. If an autosign_file
- # is specified, enabling permissive_pki_access will allow group access to that
- # specific file.
- {{ get_config('permissive_pki_access', 'False') }}
-
- # Allow users on the master access to execute specific commands on minions.
- # This setting should be treated with care since it opens up execution
- # capabilities to non root users. By default this capability is completely
- # disabled.
- #publisher_acl:
- # larry:
- # - test.ping
- # - network.*
- # - '*':
- # - pkg.*
- #
- {% if 'publisher_acl' in cfg_master -%}
- {%- do default_keys.append('publisher_acl') %}
- publisher_acl:
- {%- for user, commands in cfg_master['publisher_acl']|dictsort %}
- {{ user }}:
- {%- for command in commands %}
- {%- if command is mapping %}
- {%- for target, targetcommands in command.items() %}
- - {% raw %}'{% endraw %}{{ target }}{% raw %}'{% endraw %}:
- {%- for targetcommand in targetcommands %}
- - {% raw %}'{% endraw %}{{ targetcommand }}{% raw %}'{% endraw %}
- {%- endfor -%}
- {%- endfor -%}
- {%- else %}
- - {% raw %}'{% endraw %}{{ command }}{% raw %}'{% endraw %}
- {%- endif %}
- {%- endfor -%}
- {%- endfor -%}
- {% elif 'publisher_acl' in cfg_salt -%}
- publisher_acl:
- {%- for user, commands in cfg_salt['publisher_acl']|dictsort %}
- {{ user }}:
- {%- for command in commands %}
- {%- if command is mapping %}
- {%- for target, targetcommands in command.items() %}
- - {% raw %}'{% endraw %}{{ target }}{% raw %}'{% endraw %}:
- {%- for targetcommand in targetcommands %}
- - {% raw %}'{% endraw %}{{ targetcommand }}{% raw %}'{% endraw %}
- {%- endfor -%}
- {%- endfor -%}
- {%- else %}
- - {% raw %}'{% endraw %}{{ command }}{% raw %}'{% endraw %}
- {%- endif %}
- {%- endfor -%}
- {%- endfor -%}
- {% elif 'client_acl' in cfg_master -%}
- {%- do default_keys.append('client_acl') %}
- publisher_acl:
- {%- for name, user in cfg_master['client_acl']|dictsort %}
- {{ name}}:
- {%- for command in user %}
- - {% raw %}'{% endraw %}{{ command }}{% raw %}'{% endraw %}
- {%- endfor -%}
- {%- endfor -%}
- {% elif 'client_acl' in cfg_salt -%}
- publisher_acl:
- {%- for name, user in cfg_salt['client_acl']|dictsort %}
- {{ name }}:
- {%- for command in user %}
- - {% raw %}'{% endraw %}{{ command }}{% raw %}'{% endraw %}
- {%- endfor -%}
- {%- endfor -%}
- {% else -%}
- {%- endif %}
-
- # Blacklist any of the following users or modules
- #
- # This example would blacklist all non sudo users, including root from
- # running any commands. It would also blacklist any use of the "cmd"
- # module. This is completely disabled by default.
- #
- #
- # Check the list of configured users in client ACL against users on the
- # system and throw errors if they do not exist.
- {{ get_config('client_acl_verify', 'True') }}
- #
- {% if 'publisher_acl_blacklist' in cfg_master %}
- {%- do default_keys.append('publisher_acl_blacklist') %}
- publisher_acl_blacklist:
- users:
- {% for user in cfg_master['publisher_acl_blacklist'].get('users', []) %}
- - {{ user }}
- {% endfor %}
- modules:
- {% for mod in cfg_master['publisher_acl_blacklist'].get('modules', []) %}
- - {{ mod }}
- {% endfor %}
- {% elif 'publisher_acl_blacklist' in cfg_salt %}
- publisher_acl_blacklist:
- users:
- {% for user in cfg_salt['publisher_acl_blacklist'].get('users', []) %}
- - {{ user }}
- {% endfor %}
- modules:
- {% for mod in cfg_salt['publisher_acl_blacklist'].get('modules', []) %}
- - {{ mod }}
- {% endfor %}
- {% elif 'client_acl_blacklist' in cfg_master %}
- {%- do default_keys.append('client_acl_blacklist') %}
- publisher_acl_blacklist:
- users:
- {% for user in cfg_master['client_acl_blacklist'].get('users', []) %}
- - {{ user }}
- {% endfor %}
- modules:
- {% for mod in cfg_master['client_acl_blacklist'].get('modules', []) %}
- - {{ mod }}
- {% endfor %}
- {% elif 'client_acl_blacklist' in cfg_salt %}
- publisher_acl_blacklist:
- users:
- {% for user in cfg_salt['client_acl_blacklist'].get('users', []) %}
- - {{ user }}
- {% endfor %}
- modules:
- {% for mod in cfg_salt['client_acl_blacklist'].get('modules', []) %}
- - {{ mod }}
- {% endfor %}
- {% else %}
- #publisher_acl_blacklist:
- # users:
- # - root
- # - '^(?!sudo_).*$' # all non sudo users
- # modules:
- # - cmd
- {% endif %}
- #
- # WARNING: client_acl and client_acl_blacklist options are deprecated and will
- # be removed in the future releases. Use publisher_acl and
- # publisher_acl_blacklist instead.
-
- # Enforce publisher_acl & publisher_acl_blacklist when users have sudo
- # access to the salt command.
- {{ get_config('sudo_acl', 'False') }}
-
- # The external auth system uses the Salt auth modules to authenticate and
- # validate users to access areas of the Salt system.
- #external_auth:
- # pam:
- # fred:
- # - test.*
- {%- if 'external_auth' in cfg_master %}
- {%- do default_keys.append('external_auth') %}
- external_auth:
- {%- for auth, users in cfg_master['external_auth']|dictsort %}
- {{ auth }}:
- {%- for user, commands in users.items() %}
- {%- if user.startswith('^') %}
- {{ user }}: {% raw %}'{% endraw %}{{ commands }}{% raw %}'{% endraw %}
- {%- else %}
- {{ user }}:
- {%- for command in commands %}
- {%- if command is mapping %}
- {%- for target, targetcommands in command.items() %}
- - {% raw %}'{% endraw %}{{ target }}{% raw %}'{% endraw %}:
- {%- for targetcommand in targetcommands %}
- {%- if targetcommand is mapping %}
- {%- for module, options in targetcommand.items() %}
- - {% raw %}'{% endraw %}{{ module }}{% raw %}'{% endraw %}:
- {%- for category, arguments in options.items() %}
- {% raw %}'{% endraw %}{{ category }}{% raw %}'{% endraw %}:
- {%- if arguments is mapping %}
- {%- for key, argument in arguments.items() %}
- {% raw %}'{% endraw %}{{ key }}{% raw %}'{% endraw %}: {% raw %}'{% endraw %}{{ argument }}{% raw %}'{% endraw %}
- {%- endfor %}
- {%- else %}
- {%- for argument in arguments %}
- - {% raw %}'{% endraw %}{{ argument }}{% raw %}'{% endraw %}
- {%- endfor %}
- {%- endif %}
- {%- endfor %}
- {%- endfor %}
- {%- else %}
- - {% raw %}'{% endraw %}{{ targetcommand }}{% raw %}'{% endraw %}
- {%- endif %}
- {%- endfor %}
- {%- endfor %}
- {%- else %}
- - {% raw %}'{% endraw %}{{ command }}{% raw %}'{% endraw %}
- {%- endif %}
- {%- endfor -%}
- {%- endif %}
- {%- endfor -%}
- {%- endfor -%}
- {%- endif %}
-
- # Time (in seconds) for a newly generated token to live. Default: 12 hours
- {{ get_config('token_expire', '43200') }}
- #
- # Allow eauth users to specify the expiry time of the tokens they generate.
- # A boolean applies to all users or a dictionary of whitelisted eauth backends
- # and usernames may be given.
- # token_expire_user_override:
- # pam:
- # - fred
- # - tom
- # ldap:
- # - gary
- #
- #token_expire_user_override: False
-
- # Allow minions to push files to the master. This is disabled by default, for
- # security purposes.
- {{ get_config('file_recv', 'False') }}
-
- # Set a hard-limit on the size of the files that can be pushed to the master.
- # It will be interpreted as megabytes. Default: 100
- {{ get_config('file_recv_max_size', '100') }}
-
- # Signature verification on messages published from the master.
- # This causes the master to cryptographically sign all messages published to its event
- # bus, and minions then verify that signature before acting on the message.
- #
- # This is False by default.
- #
- # Note that to facilitate interoperability with masters and minions that are different
- # versions, if sign_pub_messages is True but a message is received by a minion with
- # no signature, it will still be accepted, and a warning message will be logged.
- # Conversely, if sign_pub_messages is False, but a minion receives a signed
- # message it will be accepted, the signature will not be checked, and a warning message
- # will be logged. This behavior went away in Salt 2014.1.0 and these two situations
- # will cause minion to throw an exception and drop the message.
- {{ get_config('sign_pub_message', 'False') }}
-
- # Use TLS/SSL encrypted connection between master and minion.
- # Can be set to a dictionary containing keyword arguments corresponding to Python's
- # 'ssl.wrap_socket' method.
- # Default is None.
- #ssl:
- # keyfile: <path_to_keyfile>
- # certfile: <path_to_certfile>
- # ssl_version: PROTOCOL_TLSv1_2
-
- # Sign the master auth-replies with a cryptographic signature of the masters public key.
- # Please see the tutorial how to use these settings in the Multimaster-PKI with Failover Tutorial
- {{ get_config('master_sign_pubkey', 'False') }}
-
- # The customizable name of the signing-key-pair without suffix.
- # master_sign_key_name: <filename_without_suffix>
- {{ get_config('master_sign', '{}') }}
-
- # The name of the file in the masters pki-directory that holds the pre-calculated
- # signature of the masters public-key.
- # master_pubkey_signature: <filename>
- {{ get_config('master_pubkey_signature', '{}') }}
-
- # Instead of computing the signature for each auth-reply, use a pre-calculated signature.
- # The master_pubkey_signature must also be set for this.
- {{ get_config('master_use_pubkey_signature', 'False') }}
-
- # Rotate the salt-masters AES-key when a minion-public is deleted with salt-key.
- # This is a very important security-setting. Disabling it will enable deleted minions to still
- # listen in on the messages published by the salt-master.
- # Do not disable this unless it is absolutely clear what this does.
- {{ get_config('rotate_aes_key', 'True') }}
-
- # Unique ID attribute name for the user. For Active Directory should be set
- # to 'sAMAccountName'. Default value is 'memberUid'.
- {{ get_config('auth.ldap.accountattributename', 'memberUid') }}
-
- # Set this to True if LDAP is Active Directory. Default is False
- {{ get_config('auth.ldap.activedirectory', False) }}
-
- # Bind to LDAP anonymously to determine group membership
- # Active Directory does not allow anonymous binds without special configuration
- {{ get_config('auth.ldap.anonymous', False) }}
-
- # The base DN under which users can be found in LDAP
- {{ get_config('auth.ldap.basedn', '') }}
-
- # The user Salt authenticates to search for a users' Distinguished Name and
- # group membership.
- {{ get_config('auth.ldap.binddn', '') }}
-
- # The bind password to go along with the bind dn (binddn).
- {{ get_config('auth.ldap.bindpw', '') }}
-
- # The filter used to find the DN associated with a user. For most LDAPs use
- # the value {% raw %}'uid={{ username }}'{% endraw %}. For Active Directory use the value
- # {% raw %}'sAMAccountName={{username}}'{% endraw %}.
- {{ get_config('auth.ldap.filter', '') }}
-
- # The attribute used for user group membership. Defaults to 'memberOf'
- {{ get_config('auth.ldap.groupattribute', 'memberOf') }}
-
- # LDAP group class. Use 'group' for Active Directory. Defaults to 'posixGroup'
- {{ get_config('auth.ldap.groupclass', 'posixGroup') }}
-
- # To specify an OU that contains group data. Not used for Active Directory
- # Default value: 'Groups'
- {{ get_config('auth.ldap.groupou', 'Groups') }}
-
- # Allows the administrator to strip off a certain set of domain names
- # so the hostnames looked up in the directory service can match the minion IDs.
- {{ get_config('auth.ldap.minion_stripdomains', []) }}
-
- # Verify server's TLS certificate. Default value: False
- {{ get_config('auth.ldap.no_verify', False) }}
-
- # Only for Active Directory. Default value: 'person'
- {{ get_config('auth.ldap.persontype', 'person') }}
-
- # Port to connect via. Default value: '389'
- {{ get_config('auth.ldap.port', '389') }}
-
- # LDAP scope level, almost always 2. Default value: 2
- {{ get_config('auth.ldap.scope', 2) }}
-
- # Server to auth against. Default value: 'localhost'
- {{ get_config('auth.ldap.server', 'localhost') }}
-
- # Use TLS when connecting. Default value: False
- {{ get_config('auth.ldap.tls', False) }}
-
- # Server specified in URI format. Overrides .ldap.server, .ldap.port,
- # .ldap.tls. Default value: ''
- {{ get_config('auth.ldap.uri', '') }}
-
- ##### Salt-SSH Configuration #####
- ##########################################
-
- # Pass in an alternative location for the salt-ssh roster file
- {{ get_config('roster_file', '/etc/salt/roster') }}
-
- # Define locations for roster files so they can be chosen when using Salt API.
- # An administrator can place roster files into these locations. Then when
- # calling Salt API, parameter 'roster_file' should contain a relative path to
- # these locations. That is, "roster_file=/foo/roster" will be resolved as
- # "/etc/salt/roster.d/foo/roster" etc. This feature prevents passing insecure
- # custom rosters through the Salt API.
- #
- {%- if 'rosters' in cfg_master %}
- rosters:
- {% for name in cfg_master['rosters'] -%}
- - {{ name }}
- {% endfor -%}
- {%- else %}
- #rosters:
- # - /etc/salt/roster.d
- # - /opt/salt/some/more/rosters
- {%- endif %}
-
- # The log file of the salt-ssh command:
- {{ get_config('ssh_log_file', '/var/log/salt/ssh') }}
-
- # Pass in minion option overrides that will be inserted into the SHIM for
- # salt-ssh calls. The local minion config is not used for salt-ssh. Can be
- # overridden on a per-minion basis in the roster (`minion_opts`)
- #ssh_minion_opts:
- # gpg_keydir: /root/gpg
- {{ get_config('ssh_minion_opts', '{}') }}
-
- # Set this to True to default to using ~/.ssh/id_rsa for salt-ssh
- # authentication with minions
- {{ get_config('ssh_use_home_key', 'False') }}
-
- ##### Master Module Management #####
- ##########################################
- # Manage how master side modules are loaded.
-
- # Add any additional locations to look for master runners:
- {{ get_config('runner_dirs', '[]') }}
-
- # Enable Cython for master side modules:
- {{ get_config('cython_enable', 'False') }}
-
-
- ##### State System settings #####
- ##########################################
- # The state system uses a "top" file to tell the minions what environment to
- # use and what modules to use. The state_top file is defined relative to the
- # root of the base environment as defined in "File Server settings" below.
- {{ get_config('state_top', 'top.sls') }}
-
- # The master_tops option replaces the external_nodes option by creating
- # a plugable system for the generation of external top data. The external_nodes
- # option is deprecated by the master_tops option.
- #
- # To gain the capabilities of the classic external_nodes system, use the
- # following configuration:
- # master_tops:
- # ext_nodes: <Shell command which returns yaml>
- #
- #master_tops: {}
- {% if 'master_tops' in cfg_master %}
- {%- do default_keys.append('master_tops') %}
- master_tops:
- {%- for master in cfg_master['master_tops'] -%}
- {%- if cfg_master['master_tops'][master] is mapping %}
- {{ master }}:
- {%- for parameter in cfg_master['master_tops'][master] %}
- {{ parameter }}: {{ cfg_master['master_tops'][master][parameter] }}
- {%- endfor -%}
- {%- elif cfg_master['master_tops'][master] is string %}
- {{ master }}: {{ cfg_master['master_tops'][master] }}
- {%- elif cfg_master['master_tops'][master] is iterable %}
- {{ master }}:
- {%- for item in cfg_master['master_tops'][master] %}
- - {{ item }}
- {%- endfor -%}
- {%- else %}
- {{ master }}: {{ cfg_master['master_tops'][master] }}
- {% endif %}
- {%- endfor %}
- {% endif %}
-
- # The external_nodes option allows Salt to gather data that would normally be
- # placed in a top file. The external_nodes option is the executable that will
- # return the ENC data. Remember that Salt will look for external nodes AND top
- # files and combine the results if both are enabled!
- {{ get_config('external_nodes', 'None') }}
-
- # The renderer to use on the minions to render the state data
- {{ get_config('renderer', 'yaml_jinja') }}
-
- # The Jinja renderer can strip extra carriage returns and whitespace
- # See http://jinja.pocoo.org/docs/api/#high-level-api
- #
- # If this is set to True the first newline after a Jinja block is removed
- # (block, not variable tag!). Defaults to False, corresponds to the Jinja
- # environment init variable "trim_blocks".
- {{ get_config('jinja_trim_blocks', 'False') }}
- #
- # If this is set to True leading spaces and tabs are stripped from the start
- # of a line to a block. Defaults to False, corresponds to the Jinja
- # environment init variable "lstrip_blocks".
- {{ get_config('jinja_lstrip_blocks', 'False') }}
-
- # The failhard option tells the minions to stop immediately after the first
- # failure detected in the state execution, defaults to False
- {{ get_config('failhard', 'False') }}
-
- # The state_verbose and state_output settings can be used to change the way
- # state system data is printed to the display. By default all data is printed.
- # The state_verbose setting can be set to True or False, when set to False
- # all data that has a result of True and no changes will be suppressed.
- {{ get_config('state_verbose', 'True') }}
-
- # 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. If set to 'mixed', the output
- # will be terse unless a state failed, in which case that output will be full.
- # If set to 'changes', the output will be full unless the state didn't change.
- {{ get_config('state_output', 'full') }}
-
- # Automatically aggregate all states that have support for mod_aggregate by
- # setting to 'True'. Or pass a list of state module names to automatically
- # aggregate just those types.
- #
- # state_aggregate:
- # - pkg
- #
- #state_aggregate: False
- {{ get_config('state_aggregate', '{}') }}
-
- # Send progress events as each function in a state run completes execution
- # by setting to 'True'. Progress events are in the format
- # 'salt/job/<JID>/prog/<MID>/<RUN NUM>'.
- {{ get_config('state_events', 'False') }}
-
- # Enable extra routines for YAML renderer used states containing UTF characters.
- {{ get_config('yaml_utf8', 'False') }}
-
- ##### File Server settings #####
- ##########################################
- # Salt runs a lightweight file server written in zeromq to deliver files to
- # minions. This file server is built into the master daemon and does not
- # require a dedicated port.
-
- # The file server works on environments passed to the master, each environment
- # can have multiple root directories, the subdirectories in the multiple file
- # roots cannot match, otherwise the downloaded files will not be able to be
- # reliably ensured. A base environment is required to house the top file.
- # Example:
- # file_roots:
- # base:
- # - /srv/salt/
- # dev:
- # - /srv/salt/dev/services
- # - /srv/salt/dev/states
- # prod:
- # - /srv/salt/prod/services
- # - /srv/salt/prod/states
- #
- {% if 'file_roots' in cfg_master -%}
- {%- do default_keys.append('file_roots') %}
- {{ file_roots(cfg_master['file_roots']) }}
- {%- elif 'file_roots' in cfg_salt -%}
- {{ file_roots(cfg_salt['file_roots']) }}
- {%- elif formulas|length -%}
- {{ file_roots({'base': ['/srv/salt']}) }}
- {%- else -%}
- #file_roots:
- # base:
- # - /srv/salt
- #
- {%- endif %}
-
- # When using multiple environments, each with their own top file, the
- # default behaviour is an unordered merge. To prevent top files from
- # being merged together and instead to only use the top file from the
- # requested environment, set this value to 'same'.
- {{ get_config('top_file_merging_strategy', 'merge') }}
-
- # To specify the order in which environments are merged, set the ordering
- # in the env_order option. Given a conflict, the last matching value will
- # win.
- {{ get_config('env_order', '["base", "dev", "prod"]') }}
-
- # If top_file_merging_strategy is set to 'same' and an environment does not
- # contain a top file, the top file in the environment specified by default_top
- # will be used instead.
- {{ get_config('default_top', 'base') }}
-
- # The hash_type is the hash to use when discovering the hash of a file on
- # the master server. The default is md5 but sha1, sha224, sha256, sha384
- # and sha512 are also supported.
- #
- # WARNING: While md5 and sha1 are also supported, do not use it due to the high chance
- # of possible collisions and thus security breach.
- #
- # Prior to changing this value, the master should be stopped and all Salt
- # caches should be cleared.
- {{ get_config('hash_type', 'md5') }}
-
- # The buffer size in the file server can be adjusted here:
- {{ get_config('file_buffer_size', '1048576') }}
-
- # A regular expression (or a list of expressions) that will be matched
- # against the file path before syncing the modules and states to the minions.
- # This includes files affected by the file.recurse state.
- # For example, if you manage your custom modules and states in subversion
- # and don't want all the '.svn' folders and content synced to your minions,
- # you could set this to '/\.svn($|/)'. By default nothing is ignored.
- {%- if 'file_ignore_regex' in cfg_master %}
- {%- do default_keys.append('file_ignore_regex') %}
- file_ignore_regex:
- {%- for regex in cfg_master['file_ignore_regex'] %}
- - {{ regex }}
- {%- endfor %}
- {%- elif 'file_ignore_regex' in cfg_salt %}
- file_ignore_regex:
- {%- for regex in cfg_salt['file_ignore_regex'] %}
- - {{ regex }}
- {%- endfor %}
- {%- else %}
- #file_ignore_regex:
- # - '/\.svn($|/)'
- # - '/\.git($|/)'
- {%- endif %}
-
- # A file glob (or list of file globs) that will be matched against the file
- # path before syncing the modules and states to the minions. This is similar
- # to file_ignore_regex above, but works on globs instead of regex. By default
- # nothing is ignored.
- {%- if 'file_ignore_glob' in cfg_master %}
- {%- do default_keys.append('file_ignore_glob') %}
- file_ignore_glob:
- {%- for glob in cfg_master['file_ignore_glob'] %}
- - '{{ glob }}'
- {%- endfor %}
- {%- elif 'file_ignore_glob' in cfg_salt %}
- file_ignore_glob:
- {%- for glob in cfg_salt['file_ignore_glob'] %}
- - '{{ glob }}'
- {%- endfor %}
- {%- else %}
- # file_ignore_glob:
- # - '*.pyc'
- # - '*/somefolder/*.bak'
- # - '*.swp'
- {%- endif %}
-
- # File Server Backend
- #
- # Salt supports a modular fileserver backend system, this system allows
- # the salt master to link directly to third party systems to gather and
- # manage the files available to minions. Multiple backends can be
- # configured and will be searched for the requested file in the order in which
- # they are defined here. The default setting only enables the standard backend
- # "roots" which uses the "file_roots" option.
- #fileserver_backend:
- # - roots
- #
- # To use multiple backends list them in the order they are searched:
- #fileserver_backend:
- # - git
- # - roots
- {% if 'fileserver_backend' in cfg_master -%}
- {%- do default_keys.append('fileserver_backend') %}
- fileserver_backend:
- {%- for backend in cfg_master['fileserver_backend'] %}
- - {{ backend }}
- {%- endfor -%}
- {%- endif %}
-
- # Uncomment the line below if you do not want the file_server to follow
- # symlinks when walking the filesystem tree. This is set to True
- # by default. Currently this only applies to the default roots
- # fileserver_backend.
- {{ get_config('fileserver_followsymlinks', 'False') }}
-
- # Uncomment the line below if you do not want symlinks to be
- # treated as the files they are pointing to. By default this is set to
- # False. By uncommenting the line below, any detected symlink while listing
- # files on the Master will not be returned to the Minion.
- {{ get_config('fileserver_ignoresymlinks', 'True') }}
-
- # 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,
- # enable the option below. This might be useful for installations where a file root
- # has a very large number of files and performance is impacted. Default is False.
- {{ get_config('fileserver_limit_traversal', 'False') }}
-
- # Salt caches the list of files/symlinks/directories for each fileserver backend
- # and environment as they are requested, to guard against a performance bottleneck
- # at scale when many minions all ask the fileserver which files are available
- # simultaneously. This configuration parameter allows for the max age of that
- # cache to be altered.
- #
- # Set this value to 0 to disable use of this cache altogether, but keep in mind
- # that this may increase the CPU load on the master when running a highstate on
- # a large number of minions.
- #
- # Rather than altering this configuration parameter, it may be advisable to use
- # the fileserver.clear_list_cache runner to clear these caches.
- {{ get_config('fileserver_list_cache_time', '20') }}
-
- # The fileserver can fire events off every time the fileserver is updated,
- # these are disabled by default, but can be easily turned on by setting this
- # flag to True
- {{ get_config('fileserver_events', 'False') }}
-
- # Git File Server Backend Configuration
- #
- # Optional parameter used to specify the provider to be used for gitfs. Must
- # be one of the following: pygit2, gitpython, or dulwich. If unset, then each
- # will be tried in that same order, and the first one with a compatible
- # version installed will be the provider that is used.
- {{ get_config('gitfs_provider', 'pygit2') }}
-
- # Along with gitfs_password, is used to authenticate to HTTPS remotes.
- {{ get_config('gitfs_user', 'git') }}
-
- # Along with gitfs_user, is used to authenticate to HTTPS remotes.
- # This parameter is not required if the repository does not use authentication.
- {{ get_config('gitfs_password', '') }}
-
- # By default, Salt will not authenticate to an HTTP (non-HTTPS) remote.
- # This parameter enables authentication over HTTP. Enable this at your own risk.
- {{ get_config('gitfs_insecure_auth', 'False') }}
-
- # Along with gitfs_privkey (and optionally gitfs_passphrase), is used to
- # authenticate to SSH remotes. This parameter (or its per-remote counterpart)
- # is required for SSH remotes.
- {{ get_config('gitfs_pubkey', '') }}
-
- # Along with gitfs_pubkey (and optionally gitfs_passphrase), is used to
- # authenticate to SSH remotes. This parameter (or its per-remote counterpart)
- # is required for SSH remotes.
- {{ get_config('gitfs_privkey', '') }}
-
- # This parameter is optional, required only when the SSH key being used to
- # authenticate is protected by a passphrase.
- {{ get_config('gitfs_passphrase', '') }}
-
- # When using the git fileserver backend at least one git remote needs to be
- # defined. The user running the salt master will need read access to the repo.
- #
- # The repos will be searched in order to find the file requested by a client
- # and the first repo to have the file will return it.
- # When using the git backend branches and tags are translated into salt
- # environments.
- # Note: file:// repos will be treated as a remote, so refs you want used must
- # exist in that repo as *local* refs.
- {% if 'gitfs_remotes' in cfg_master -%}
- {%- do default_keys.append('gitfs_remotes') %}
- gitfs_remotes:
- {%- for remote in cfg_master['gitfs_remotes'] %}
- {%- if remote is iterable and remote is not string %}
- {%- for repo, children in remote.items() %}
- - {{ repo }}:
- {%- for child in children %}
- {%- for key, value in child.items() %}
- - {{ key }}: {{ value }}
- {%- endfor -%}
- {%- endfor -%}
- {%- endfor -%}
- {%- else %}
- - {{ remote }}
- {%- endif -%}
- {%- endfor -%}
- {%- endif %}
-
- #gitfs_remotes:
- # - git://github.com/saltstack/salt-states.git
- # - file:///var/git/saltmaster
- #
- # The gitfs_ssl_verify option specifies whether to ignore ssl certificate
- # errors when contacting the gitfs backend. You might want to set this to
- # false if you're using a git backend that uses a self-signed certificate but
- # keep in mind that setting this flag to anything other than the default of True
- # is a security concern, you may want to try using the ssh transport.
- {{ get_config('gitfs_ssl_verify', 'True') }}
-
- # The gitfs_root option gives the ability to serve files from a subdirectory
- # within the repository. The path is defined relative to the root of the
- # repository and defaults to the repository root.
- {{ get_config('gitfs_root', 'somefolder/otherfolder') }}
-
- # The gitfs_env_whitelist and gitfs_env_blacklist parameters allow for greater
- # control over which branches/tags are exposed as fileserver environments.
- {% if 'gitfs_env_whitelist' in cfg_master -%}
- {%- do default_keys.append('gitfs_env_whitelist') %}
- gitfs_env_whitelist:
- {%- for git_env in cfg_master['gitfs_env_whitelist'] %}
- - {{ git_env }}
- {%- endfor -%}
- {% else -%}
- # gitfs_env_whitelist:
- # - base
- # - v1.*
- {% endif %}
-
- {% if 'gitfs_env_blacklist' in cfg_master -%}
- {%- do default_keys.append('gitfs_env_blacklist') %}
- gitfs_env_blacklist:
- {%- for git_env in cfg_master['gitfs_env_blacklist'] %}
- - {{ git_env }}
- {%- endfor -%}
- {% else -%}
- # gitfs_env_blacklist:
- # - bug/*
- # - feature/*
- {% endif %}
-
- # S3 File Server Backend Configuration
- #
- # S3 credentials must be set in the master config file.
- # Alternatively, if on EC2 these credentials can be automatically
- # loaded from instance metadata.
- {% if 's3.keyid' in cfg_master -%}
- {{ get_config('s3.keyid', '<no default>') }}
- {{ get_config('s3.key', '<no default>') }}
- {% else -%}
- # s3.keyid: GKTADJGHEIQSXMKKRBJ08H
- # s3.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
- {% endif %}
- # This fileserver supports two modes of operation for the buckets:
- # - A single bucket per environment
- # - Multiple environments per bucket
- #
- # Note that bucket names must be all lowercase both in the AWS console
- # and in Salt, otherwise you may encounter SignatureDoesNotMatch
- # errors.
- #
- # A multiple-environment bucket must adhere to the following root
- # directory structure:
- #
- # s3://<bucket name>/<environment>/<files>
- #
- # This fileserver back-end requires the use of the MD5 hashing
- # algorithm. MD5 may not be compliant with all security policies.
- {% if 's3.buckets' in cfg_master -%}
- {{ get_config('s3.buckets', '<no default>') }}
- {% else -%}
- # s3.buckets: #single bucket per environment
- # production:
- # - bucket1
- # - bucket2
- # staging:
- # - bucket3
- # - bucket4
- #
- # s3.buckets: #multiple environments per bucket
- # - bucket1
- # - bucket2
- # - bucket3
- # - bucket4
- {% endif %}
-
- ##### Pillar settings #####
- ##########################################
- # Salt Pillars allow for the building of global data that can be made selectively
- # available to different minions based on minion grain filtering. The Salt
- # Pillar is laid out in the same fashion as the file server, with environments,
- # a top file and sls files. However, pillar data does not need to be in the
- # highstate format, and is generally just key/value pairs.
- {% if 'pillar_roots' in cfg_master -%}
- {%- do default_keys.append('pillar_roots') %}
- pillar_roots:
- {%- for name, roots in cfg_master['pillar_roots']|dictsort %}
- {{ name }}:
- {%- for dir in roots %}
- - {{ dir }}
- {%- endfor -%}
- {%- endfor -%}
- {% elif 'pillar_roots' in cfg_salt -%}
- pillar_roots:
- {%- for name, roots in cfg_salt['pillar_roots']|dictsort %}
- {{ name }}:
- {%- for dir in roots %}
- - {{ dir }}
- {%- endfor -%}
- {%- endfor -%}
- {%- else -%}
- #pillar_roots:
- # base:
- # - /srv/pillar
- #
- {%- endif %}
-
- {% if 'ext_pillar' in cfg_master %}
- {%- do default_keys.append('ext_pillar') %}
- ext_pillar:
- {%- for pillar in cfg_master['ext_pillar'] -%}
- {%- for key in pillar -%}
- {%- if pillar[key] is string %}
- - {{ key }}: {{ pillar[key] }}
- {%- elif pillar[key] is iterable and pillar[key] is not mapping %}
- - {{ key }}:
- {%- for parameter in pillar[key] %}
- {%- if parameter is iterable and parameter is not string %}
- {%- for param, children in parameter.items() %}
- {%- if children is string %}
- - {{ param }}: {{ children }}
- {%- else %}
- - {{ param }}:
- {%- for child in children %}
- {%- for key, value in child.items() %}
- - {{ key }}: {{ value }}
- {%- endfor -%}
- {%- endfor -%}
- {%- endif -%}
- {%- endfor -%}
- {%- else %}
- - {{ parameter }}
- {%- endif %}
- {%- endfor -%}
- {%- elif pillar[key] is mapping and pillar[key] is not string %}
- - {{ key }}:
- {%- for parameter in pillar[key] %}
- {{ parameter }}: {{pillar[key][parameter]}}
- {%- endfor %}
- {%- else %}
- # Error in rendering {{ key }}, please read https://docs.saltstack.com/en/latest/topics/development/external_pillars.html#configuration
- {% endif %}
- {%- endfor -%}
- {%- endfor %}
- {% elif 'ext_pillar' in cfg_salt %}
- ext_pillar:
- {% for pillar in cfg_salt['ext_pillar'] %}
- - {{ pillar.items()[0][0] }}: {{ pillar.items()[0][1] }}
- {% endfor %}
- {% else %}
- #ext_pillar:
- # - hiera: /etc/hiera.yaml
- # - cmd_yaml: cat /etc/salt/yaml
- {% endif %}
-
- # The ext_pillar_first option allows for external pillar sources to populate
- # before file system pillar. This allows for targeting file system pillar from
- # ext_pillar.
- {{ get_config('ext_pillar_first', 'False') }}
-
- # The external pillars permitted to be used on-demand using pillar.ext
- {%- if 'on_demand_ext_pillar' in cfg_master %}
- on_demand_ext_pillar:
- {% for name in cfg_master['on_demand_ext_pillar'] -%}
- - {{ name }}
- {% endfor -%}
- {%- else %}
- #on_demand_ext_pillar:
- # - libvirt
- # - virtkey
- {%- endif %}
-
- # The pillar_gitfs_ssl_verify option specifies whether to ignore ssl certificate
- # errors when contacting the pillar gitfs backend. You might want to set this to
- # false if you're using a git backend that uses a self-signed certificate but
- # keep in mind that setting this flag to anything other than the default of True
- # is a security concern, you may want to try using the ssh transport.
- {{ get_config('pillar_gitfs_ssl_verify', 'True') }}
-
- # The pillar_opts option adds the master configuration file data to a dict in
- # the pillar called "master". This is used to set simple configurations in the
- # master config file that can then be used on minions.
- {{ get_config('pillar_opts', 'False') }}
-
- # The pillar_safe_render_error option prevents the master from passing pillar
- # render errors to the minion. This is set on by default because the error could
- # contain templating data which would give that minion information it shouldn't
- # have, like a password! When set true the error message will only show:
- # Rendering SLS 'my.sls' failed. Please see master log for details.
- {{ get_config('pillar_safe_render_error', 'True') }}
-
- # The pillar_source_merging_strategy option allows you to configure merging strategy
- # between different sources. It accepts five values: none, recurse, aggregate, overwrite,
- # or smart. None will not do any merging at all. Recurse will merge recursively mapping of data.
- # Aggregate instructs aggregation of elements between sources that use the #!yamlex renderer. Overwrite
- # will overwrite elements according the order in which they are processed. This is
- # behavior of the 2014.1 branch and earlier. Smart guesses the best strategy based
- # on the "renderer" setting and is the default value.
- {{ get_config('pillar_source_merging_strategy', 'smart') }}
-
- # Recursively merge lists by aggregating them instead of replacing them.
- {{ get_config('pillar_merge_lists', 'False') }}
-
- # Set this option to 'True' to force a 'KeyError' to be raised whenever an
- # attempt to retrieve a named value from pillar fails. When this option is set
- # to 'False', the failed attempt returns an empty string. Default is 'False'.
- {{ get_config('pillar_raise_on_missing', 'False') }}
-
- # Git External Pillar (git_pillar) Configuration Options
- #
- # Specify the provider to be used for git_pillar. Must be either pygit2 or
- # gitpython. If unset, then both will be tried in that same order, and the
- # first one with a compatible version installed will be the provider that
- # is used.
- {{ get_config('git_pillar_provider', 'pygit2') }}
-
- # If the desired branch matches this value, and the environment is omitted
- # from the git_pillar configuration, then the environment for that git_pillar
- # remote will be base.
- {{ get_config('git_pillar_base', 'master') }}
-
- # If the branch is omitted from a git_pillar remote, then this branch will
- # be used instead.
- {{ get_config('git_pillar_branch', 'master') }}
-
- # Environment to use for git_pillar remotes. This is normally derived from
- # the branch/tag (or from a per-remote env parameter), but if set this will
- # override the process of deriving the env from the branch/tag name.
- {{ get_config('git_pillar_env', '') }}
-
- # Path relative to the root of the repository where the git_pillar top file
- # and SLS files are located.
- {{ get_config('git_pillar_root', 'pillar') }}
-
- # Specifies whether or not to ignore SSL certificate errors when contacting
- # the remote repository.
- {{ get_config('git_pillar_ssl_verify', True) }}
-
- # When set to False, if there is an update/checkout lock for a git_pillar
- # remote and the pid written to it is not running on the master, the lock
- # file will be automatically cleared and a new lock will be obtained.
- {{ get_config('git_pillar_global_lock', False) }}
-
- # Git External Pillar Authentication Options
- #
- # Along with git_pillar_password, is used to authenticate to HTTPS remotes.
- {{ get_config('git_pillar_user', '') }}
-
- # Along with git_pillar_user, is used to authenticate to HTTPS remotes.
- # This parameter is not required if the repository does not use authentication.
- {{ get_config('git_pillar_password', '') }}
-
- # By default, Salt will not authenticate to an HTTP (non-HTTPS) remote.
- # This parameter enables authentication over HTTP.
- {{ get_config('git_pillar_insecure_auth', False) }}
-
- # Along with git_pillar_privkey (and optionally git_pillar_passphrase),
- # is used to authenticate to SSH remotes.
- {{ get_config('git_pillar_pubkey', '') }}
-
- # Along with git_pillar_pubkey (and optionally git_pillar_passphrase),
- # is used to authenticate to SSH remotes.
- {{ get_config('git_pillar_privkey', '') }}
-
- # This parameter is optional, required only when the SSH key being used
- # to authenticate is protected by a passphrase.
- {{ get_config('git_pillar_passphrase', '') }}
-
- # A master can cache pillars locally to bypass the expense of having to render them
- # for each minion on every request. This feature should only be enabled in cases
- # where pillar rendering time is known to be unsatisfactory and any attendant security
- # concerns about storing pillars in a master cache have been addressed.
- #
- # When enabling this feature, be certain to read through the additional ``pillar_cache_*``
- # configuration options to fully understand the tunable parameters and their implications.
- #
- # Note: setting ``pillar_cache: True`` has no effect on targeting Minions with Pillars.
- # See https://docs.saltstack.com/en/latest/topics/targeting/pillar.html
- {{ get_config('pillar_cache', 'False') }}
-
- # If and only if a master has set ``pillar_cache: True``, the cache TTL controls the amount
- # of time, in seconds, before the cache is considered invalid by a master and a fresh
- # pillar is recompiled and stored.
- {{ get_config('pillar_cache_ttl', '3600') }}
-
- # If and only if a master has set `pillar_cache: True`, one of several storage providers
- # can be utililzed.
- #
- # `disk`: The default storage backend. This caches rendered pillars to the master cache.
- # Rendered pillars are serialized and deserialized as msgpack structures for speed.
- # Note that pillars are stored UNENCRYPTED. Ensure that the master cache
- # has permissions set appropriately. (Same defaults are provided.)
- #
- # memory: [EXPERIMENTAL] An optional backend for pillar caches which uses a pure-Python
- # in-memory data structure for maximal performance. There are several caveats,
- # however. First, because each master worker contains its own in-memory cache,
- # there is no guarantee of cache consistency between minion requests. This
- # works best in situations where the pillar rarely if ever changes. Secondly,
- # and perhaps more importantly, this means that unencrypted pillars will
- # be accessible to any process which can examine the memory of the ``salt-master``!
- # This may represent a substantial security risk.
- #
- {{ get_config('pillar_cache_backend', 'disk') }}
-
-
- ##### Syndic settings #####
- ##########################################
- # The Salt syndic is used to pass commands through a master from a higher
- # master. Using the syndic is simple. If this is a master that will have
- # syndic servers(s) below it, then set the "order_masters" setting to True.
- #
- # If this is a master that will be running a syndic daemon for passthrough, then
- # the "syndic_master" setting needs to be set to the location of the master server
- # to receive commands from.
-
- # Set the order_masters setting to True if this master will command lower
- # masters' syndic interfaces.
- {{ get_config('order_masters', 'False') }}
-
- # If this master will be running a salt syndic daemon, syndic_master tells
- # this master where to receive commands from.
- {{ get_config('syndic_master', 'masterofmasters') }}
-
- # This is the 'ret_port' of the MasterOfMaster:
- {{ get_config('syndic_master_port', '4506') }}
-
- # PID file of the syndic daemon:
- {{ get_config('syndic_pidfile', '/var/run/salt-syndic.pid') }}
-
- # LOG file of the syndic daemon:
- {{ get_config('syndic_log_file', '/var/log/salt/syndic') }}
-
- # The user under which the salt syndic will run.
- {{ get_config('syndic_user', 'root') }}
-
- # The behaviour of the multi-syndic when connection to a master of masters failed.
- # Can specify ``random`` (default) or ``ordered``. If set to ``random``, masters
- # will be iterated in random order. If ``ordered`` is specified, the configured
- # order will be used.
- {{ get_config('syndic_failover', 'random') }}
-
- # The number of seconds for the salt client to wait for additional syndics to
- # check in with their lists of expected minions before giving up.
- {{ get_config('syndic_wait', '5') }}
-
-
- ##### Peer Publish settings #####
- ##########################################
- # Salt minions can send commands to other minions, but only if the minion is
- # allowed to. By default "Peer Publication" is disabled, and when enabled it
- # is enabled for specific minions and specific commands. This allows secure
- # compartmentalization of commands based on individual minions.
-
- # The configuration uses regular expressions to match minions and then a list
- # of regular expressions to match functions. The following will allow the
- # minion authenticated as foo.example.com to execute functions from the test
- # and pkg modules.
- #peer:
- # foo.example.com:
- # - test.*
- # - pkg.*
- #
- # This will allow all minions to execute all commands:
- #peer:
- # .*:
- # - .*
- #
- # This is not recommended, since it would allow anyone who gets root on any
- # single minion to instantly have root on all of the minions!
- {% if 'peer' in cfg_master %}
- {%- do default_keys.append('peer') %}
- peer:
- {% for name, roots in cfg_master['peer'].items() %}
- {{ name }}:
- {% for mod in roots %}
- - {{ mod }}
- {% endfor %}
- {% endfor %}
- {% elif 'peer' in cfg_salt %}
- peer:
- {% for name, roots in cfg_salt['peer'].items() %}
- {{ name }}:
- {% for mod in roots %}
- - {{ mod }}
- {% endfor %}
- {% endfor %}
- {% endif %}
-
- # Minions can also be allowed to execute runners from the salt master.
- # Since executing a runner from the minion could be considered a security risk,
- # it needs to be enabled. This setting functions just like the peer setting
- # except that it opens up runners instead of module functions.
- #
- # All peer runner support is turned off by default and must be enabled before
- # using. This will enable all peer runners for all minions:
- #peer_run:
- # .*:
- # - .*
- #
- # To enable just the manage.up runner for the minion foo.example.com:
- #peer_run:
- # foo.example.com:
- # - manage.up
- {% if 'peer_run' in cfg_master %}
- {%- do default_keys.append('peer_run') %}
- peer_run:
- {%- for name, roots in cfg_master['peer_run'].items() %}
- {{ name }}:
- {%- for mod in roots %}
- - {{ mod }}
- {%- endfor %}
- {%- endfor %}
- {%- elif 'peer_run' in cfg_salt %}
- peer_run:
- {%- for name, roots in cfg_salt['peer_run'].items() %}
- {{ name }}:
- {%- for mod in roots %}
- - {{ mod }}
- {%- endfor %}
- {%- endfor %}
- {%- endif %}
-
- ##### Mine settings #####
- #####################################
- # Restrict mine.get access from minions. By default any minion has a full access
- # to get all mine data from master cache. In acl definion below, only pcre matches
- # are allowed.
- # mine_get:
- # .*:
- # - .*
- #
- # The example below enables minion foo.example.com to get 'network.interfaces' mine
- # data only, minions web* to get all network.* and disk.* mine data and all other
- # minions won't get any mine data.
- {% if 'mine_get' in cfg_master -%}
- {%- do default_keys.append('mine_get') %}
- mine_get:
- {%- for minion, data in cfg_master['mine_get']|dictsort %}
- {{ minion }}:
- {%- for command in data %}
- - {% raw %}'{% endraw %}{{ command }}{% raw %}'{% endraw %}
- {%- endfor -%}
- {%- endfor -%}
- {% elif 'mine_get' in cfg_salt -%}
- mine_get:
- {%- for minion, data in cfg_salt['mine_get']|dictsort %}
- {{ minion }}:
- {%- for command in data %}
- - {% raw %}'{% endraw %}{{ command }}{% raw %}'{% endraw %}
- {%- endfor -%}
- {%- endfor -%}
- {% else -%}
- # mine_get:
- # foo.example.com:
- # - network.interfaces
- # web.*:
- # - network.*
- # - disk.*
- {%- endif %}
-
- ##### Logging settings #####
- ##########################################
- # The location of the master log file
- # The master log can be sent to a regular file, local path name, or network
- # location. Remote logging works best when configured to use rsyslogd(8) (e.g.:
- # ``file:///dev/log``), with rsyslogd(8) configured for network logging. The URI
- # format is: <file|udp|tcp>://<host|socketpath>:<port-if-required>/<log-facility>
- #log_file: /var/log/salt/master
- #log_file: file:///dev/log
- #log_file: udp://loghost:10514
-
- {{ get_config('log_file', '/var/log/salt/master') }}
- {{ get_config('key_logfile', '/var/log/salt/key') }}
-
- # The level of messages to send to the console.
- # One of 'garbage', 'trace', 'debug', info', 'warning', 'error', 'critical'.
- #
- # The following log levels are considered INSECURE and may log sensitive data:
- # ['garbage', 'trace', 'debug']
- #
- {{ get_config('log_level', 'warning') }}
-
- # The level of messages to send to the log file.
- # One of 'garbage', 'trace', 'debug', info', 'warning', 'error', 'critical'.
- # If using 'log_granular_levels' this must be set to the highest desired level.
- {{ get_config('log_level_logfile', 'warning') }}
-
- # The date and time format used in log messages. Allowed date/time formating
- # can be seen here: http://docs.python.org/library/time.html#time.strftime
- {{ get_config('log_datefmt', "'%H:%M:%S'") }}
- {{ get_config('log_datefmt_logfile', "'%Y-%m-%d %H:%M:%S'") }}
-
- # The format of the console logging messages. Allowed formatting options can
- # be seen here: http://docs.python.org/library/logging.html#logrecord-attributes
- #
- # 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.
- #
- {{ get_config('log_fmt_console', "'%(colorlevel)s %(colormsg)s'") }}
- {{ get_config('log_fmt_console', "'[%(levelname)-8s] %(message)s'") }}
-
- {{ get_config('log_fmt_logfile', "'%(asctime)s,%(msecs)03.0f [%(name)-17s][%(levelname)-8s] %(message)s'") }}
-
- # This can be used to control logging levels more specificically. This
- # example sets the main salt library at the 'warning' level, but sets
- # 'salt.modules' to log at the 'debug' level:
- # log_granular_levels:
- # 'salt': 'warning'
- # 'salt.modules': 'debug'
- #
- {% if 'log_granular_levels' in cfg_master %}
- {%- do default_keys.append('log_granular_levels') %}
- log_granular_levels:
- {% for name, lvl in cfg_master['log_granular_levels'].items() %}
- {{ name }}: {{ lvl }}
- {% endfor %}
- {% elif 'log_granular_levels' in cfg_salt %}
- log_granular_levels:
- {% for name, lvl in cfg_salt['log_granular_levels'].items() %}
- {{ name }}: {{ lvl }}
- {% endfor %}
- {% else %}
- #log_granular_levels: {}
- {% endif %}
-
- ##### Node Groups ######
- ##########################################
- # Node groups allow for logical groupings of minion nodes. A group consists of
- # a group name and a compound target. Nodgroups can reference other nodegroups
- # with 'N@' classifier. Ensure that you do not have circular references.
- #
- #nodegroups:
- # group1: 'L@foo.domain.com,bar.domain.com,baz.domain.com or bl*.domain.com'
- # group2: 'G@os:Debian and foo.domain.com'
- # group3: 'G@os:Debian and N@group1'
- # group4:
- # - 'G@foo:bar'
- # - 'or'
- # - 'G@foo:baz'
- {%- if 'nodegroups' in cfg_master %}
- {%- do default_keys.append('nodegroups') %}
- nodegroups:
- {%- for name, lvl in cfg_master['nodegroups'].items() %}
- {{ name }}: {{ lvl }}
- {%- endfor %}
- {%- elif 'nodegroups' in cfg_salt %}
- nodegroups:
- {%- for name, lvl in cfg_salt['nodegroups'].items() %}
- {{ name }}: {{ lvl }}
- {%- endfor %}
- {%- endif %}
-
- ##### Range Cluster settings #####
- ##########################################
- # The range server (and optional port) that serves your cluster information
- # https://github.com/ytoolshed/range/wiki/%22yamlfile%22-module-file-spec
- #
- {{ get_config('range_server', 'range:80') }}
-
-
- ##### Windows Software Repo settings #####
- ###########################################
- # Specify the provider to be used for git_pillar. Must be either pygit2 or
- # gitpython. If unset, then both will be tried in that same order, and the
- # first one with a compatible version installed will be the provider that
- # is used.
- {{ get_config('winrepo_provider', 'pygit2') }}
-
- # Repo settings for 2015.8+ master used with 2015.8+ Windows minions
- #
- # Location of the repo on the master:
- {{ get_config('winrepo_dir_ng', '/srv/salt/win/repo-ng') }}
-
- # List of git repositories to include with the local repo:
- {% if 'winrepo_remotes_ng' in cfg_master %}
- {%- do default_keys.append('winrepo_remotes_ng') %}
- winrepo_remotes_ng:
- {% for repo in cfg_master['winrepo_remotes_ng'] %}
- - {{ repo }}
- {% endfor %}
- {% elif 'winrepo_remotes_ng' in cfg_salt %}
- winrepo_remotes_ng:
- {% for repo in cfg_salt['winrepo_remotes_ng'] %}
- - {{ repo }}
- {% endfor %}
- {% else %}
- #winrepo_remotes_ng:
- # - 'https://github.com/saltstack/salt-winrepo-ng.git'
- {% endif %}
-
- # Repo settings for 2015.8+ master used with pre-2015.8 Windows minions
- #
- # Location of the repo on the master:
- {{ get_config('winrepo_dir', '/srv/salt/win/repo') }}
-
- # Location of the master's repo cache file:
- {{ get_config('winrepo_cachefile', 'winrepo.p') }}
-
- # List of git repositories to include with the local repo:
- {% if 'winrepo_remotes' in cfg_master %}
- {%- do default_keys.append('winrepo_remotes') %}
- winrepo_remotes:
- {% for repo in cfg_master['winrepo_remotes'] %}
- - {{ repo }}
- {% endfor %}
- {% elif 'winrepo_remotes' in cfg_salt %}
- winrepo_remotes:
- {% for repo in cfg_salt['winrepo_remotes'] %}
- - {{ repo }}
- {% endfor %}
- {% else %}
- #winrepo_remotes:
- # - 'https://github.com/saltstack/salt-winrepo.git'
- {% endif %}
-
- ##### Windows Software Repo settings - Pre 2015.8 #####
- ########################################################
- # Legacy repo settings for pre-2015.8 Windows minions.
- #
- # Location of the repo on the master:
- {{ get_config('win_repo', '/srv/salt/win/repo') }}
-
- # Location of the master's repo cache file:
- {{ get_config('win_repo_mastercachefile', '/srv/salt/win/repo/winrepo.p') }}
-
- # List of git repositories to include with the local repo:
- {% if 'win_gitrepos' in cfg_master %}
- {%- do default_keys.append('win_gitrepos') %}
- win_gitrepos:
- {% for repo in cfg_master['win_gitrepos'] %}
- - {{ repo }}
- {% endfor %}
- {% elif 'win_gitrepos' in cfg_salt %}
- win_gitrepos:
- {% for repo in cfg_salt['win_gitrepos'] %}
- - {{ repo }}
- {% endfor %}
- {% else %}
- #winrepo_remotes:
- # - 'https://github.com/saltstack/salt-winrepo.git'
- {% endif %}
-
- ##### Returner settings ######
- ############################################
- # Which returner(s) will be used for minion's result:
- #return: mysql
- {{ get_config('return', '')}}
-
-
- ###### Miscellaneous settings ######
- ############################################
- # Default match type for filtering events tags: startswith, endswith, find, regex, fnmatch
- {{ get_config('event_match_type', 'startswith') }}
-
- # Save runner returns to the job cache
- {{ get_config('runner_returns', 'True') }}
-
- # Permanently include any available Python 3rd party modules into Salt Thin
- # when they are generated for Salt-SSH or other purposes.
- # The modules should be named by the names they are actually imported inside the Python.
- # The value of the parameters can be either one module or a comma separated list of them.
- {%- if 'thin_extra_mods' in cfg_master %}
- {{ get_config('thin_extra_mods', '') }}
- {%- else %}
- #thin_extra_mods: foo,bar
- {%- endif %}
-
- {%- if 'halite' in cfg_master %}
- {%- do default_keys.append('halite') %}
- ##### Halite #####
- ##########################################
- halite:
- {%- for name, value in cfg_master['halite'].items() %}
- {{ name }}: {{ value }}
- {%- endfor %}
- {%- endif %}
-
- {%- if 'rest_cherrypy' in cfg_master %}
- {%- do default_keys.append('rest_cherrypy') %}
- ##### rest_cherrypy #####
- ##########################################
- rest_cherrypy:
- {%- for name, value in cfg_master['rest_cherrypy'].items() %}
- {{ name }}: {{ value }}
- {%- endfor %}
- {%- endif %}
-
- {%- if 'rest_tornado' in cfg_master %}
- {%- do default_keys.append('rest_tornado') %}
- ##### rest_tornado #####
- ###########################################
- rest_tornado:
- {%- for name, value in cfg_master['rest_tornado'].items() %}
- {{ name }}: {{ value }}
- {%- endfor %}
- {%- endif %}
-
- {%- if 'presence_events' in cfg_master %}
- ##### presence events #####
- ##########################################
- {{ get_config('presence_events', 'False') }}
- {%- endif %}
-
- {%- if 'consul_config' in cfg_master %}
- {%- do default_keys.append('consul_config') %}
- ##### consul_config #####
- ##########################################
- consul_config:
- {%- for name, value in cfg_master['consul_config'].items() %}
- {{ name }}: {{ value }}
- {%- endfor %}
- {%- endif %}
-
- {% if 'mongo' in cfg_master -%}
- {%- do default_keys.append('mongo') %}
- ##### mongodb connection settings #####
- ##########################################
- {%- for name, value in cfg_master['mongo'].items() %}
- mongo.{{ name }}: {{ value }}
- {%- endfor %}
-
- {% if 'alternative.mongo' in cfg_master -%}
- {%- do default_keys.append('alternative.mongo') %}
- {%- for name, value in cfg_master['alternative.mongo'].items() %}
- alternative.mongo.{{ name }}: {{ value }}
- {%- endfor %}
- {% endif %}
- {%- endif %}
-
- {%- for configname in cfg_master %}
- {%- if configname not in reserved_keys and configname not in default_keys %}
- {{ configname }}:
- {{ cfg_master[configname]| yaml(False) | indent(2) }}
- {%- endif %}
- {%- endfor %}
|