mirror of
https://github.com/saltstack/salt.git
synced 2025-04-17 10:10:20 +00:00
Merge branch '2018.3' into replace-github-dead-link
This commit is contained in:
Gareth J. Greenaway
GitHub
commit
08728cf660
2996 changed files with 262198 additions and 80311 deletions
|
|
@ -1,5 +1,13 @@
|
|||
languages:
|
||||
Ruby: false
|
||||
JavaScript: false
|
||||
Python: true
|
||||
PHP: false
|
||||
Ruby: false
|
||||
JavaScript: false
|
||||
Python: true
|
||||
PHP: false
|
||||
|
||||
engines:
|
||||
radon:
|
||||
enabled: true
|
||||
exclude_paths:
|
||||
- "templates/"
|
||||
config:
|
||||
threshold: "D"
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ codecov:
|
|||
- drone.saltstack.com
|
||||
- jenkinsci.saltstack.com
|
||||
|
||||
branch: 2017.7
|
||||
branch: 2018.3
|
||||
|
||||
notify:
|
||||
require_ci_to_pass: no
|
||||
|
|
|
|||
33
.github/stale.yml
vendored
Normal file
33
.github/stale.yml
vendored
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
# Probot Stale configuration file
|
||||
|
||||
# Number of days of inactivity before an issue becomes stale
|
||||
# 860 is approximately 2 years and 4 months
|
||||
daysUntilStale: 860
|
||||
|
||||
# Number of days of inactivity before a stale issue is closed
|
||||
daysUntilClose: 7
|
||||
|
||||
# Issues with these labels will never be considered stale
|
||||
#exemptLabels:
|
||||
# - pinned
|
||||
# - security
|
||||
|
||||
# Label to use when marking an issue as stale
|
||||
staleLabel: stale
|
||||
|
||||
# Comment to post when marking an issue as stale. Set to `false` to disable
|
||||
markComment: |
|
||||
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
|
||||
|
||||
If this issue is closed prematurely, please leave a comment and we will gladly reopen the issue.
|
||||
|
||||
# Comment to post when removing the stale label. Set to `false` to disable
|
||||
unmarkComment: |
|
||||
Thank you for updating this issue. It is no longer marked as stale.
|
||||
|
||||
# Comment to post when closing a stale issue. Set to `false` to disable
|
||||
closeComment: false
|
||||
|
||||
# Limit to only `issues` or `pulls`
|
||||
only: issues
|
||||
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -90,6 +90,7 @@ tests/integration/cloud/providers/logs
|
|||
|
||||
# Private keys from the integration tests
|
||||
tests/integration/cloud/providers/pki/minions
|
||||
/helpers/
|
||||
|
||||
# Ignore tox virtualenvs
|
||||
/.tox/
|
||||
|
|
|
|||
14
.kitchen.yml
14
.kitchen.yml
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
<% vagrant = system('gem list -i kitchen-vagrant 2>/dev/null >/dev/null') %>
|
||||
<% version = '2017.7.8' %>
|
||||
<% version = '2018.3.3' %>
|
||||
<% platformsfile = ENV['SALT_KITCHEN_PLATFORMS'] || '.kitchen/platforms.yml' %>
|
||||
<% driverfile = ENV['SALT_KITCHEN_DRIVER'] || '.kitchen/driver.yml' %>
|
||||
<% verifierfile = ENV['SALT_KITCHEN_VERIFIER'] || '.kitchen/verifier.yml' %>
|
||||
|
|
@ -39,7 +39,7 @@ provisioner:
|
|||
max_retries: 2
|
||||
remote_states:
|
||||
name: git://github.com/saltstack/salt-jenkins.git
|
||||
branch: 2017.7
|
||||
branch: 2018.3
|
||||
repo: git
|
||||
testingdir: /testing
|
||||
salt_copy_filter:
|
||||
|
|
@ -54,7 +54,7 @@ provisioner:
|
|||
base:
|
||||
"os:Windows":
|
||||
- match: grain
|
||||
- prep_windows
|
||||
- windows
|
||||
"*":
|
||||
- <%= ENV['KITCHEN_STATE'] || 'git.salt' %>
|
||||
pillars:
|
||||
|
|
@ -165,11 +165,16 @@ platforms:
|
|||
box: mwrock/Windows2016
|
||||
name: vagrant
|
||||
gui: true
|
||||
customize:
|
||||
cpus: 4
|
||||
memory: 8192
|
||||
transport:
|
||||
name: winrm
|
||||
username: Administrator
|
||||
username: Vagrant
|
||||
password: vagrant
|
||||
provisioner:
|
||||
salt_bootstrap_url: https://raw.githubusercontent.com/saltstack/salt-bootstrap/develop/bootstrap-salt.ps1
|
||||
salt_bootstrap_options: -version <%= version %>
|
||||
init_environment: |
|
||||
Clear-Host
|
||||
$AddedLocation ="c:\salt;c:\salt\bin\Scripts"
|
||||
|
|
@ -218,6 +223,7 @@ verifier:
|
|||
sudo: true
|
||||
run_destructive: true
|
||||
transport: zeromq
|
||||
enable_filenames: true
|
||||
types:
|
||||
- ssh
|
||||
xml: /tmp/xml-unittests-output/
|
||||
|
|
|
|||
13
CONTRIBUTING.rst
Normal file
13
CONTRIBUTING.rst
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
Developing Salt
|
||||
===============
|
||||
|
||||
The Salt development team is welcoming, positive, and dedicated to
|
||||
helping people get new code and fixes into SaltStack projects. Log into
|
||||
GitHub and get started with one of the largest developer communities in
|
||||
the world. The following links should get you started:
|
||||
|
||||
`<https://github.com/saltstack>`_
|
||||
|
||||
`<https://docs.saltstack.com/en/latest/topics/development/index.html>`_
|
||||
|
||||
`<https://docs.saltstack.com/en/develop/topics/development/pull_requests.html>`_
|
||||
5
Gemfile
5
Gemfile
|
|
@ -3,7 +3,7 @@
|
|||
source 'https://rubygems.org'
|
||||
|
||||
gem 'test-kitchen', '~>1.23.3'
|
||||
gem 'kitchen-salt', '~>0.4.1'
|
||||
gem 'kitchen-salt', :git => 'https://github.com/s0undt3ch/kitchen-salt.git', :branch => 'features/nox'
|
||||
gem 'kitchen-sync'
|
||||
gem 'git'
|
||||
|
||||
|
|
@ -13,7 +13,8 @@ end
|
|||
|
||||
group :windows do
|
||||
gem 'winrm', '~>2.0'
|
||||
gem 'winrm-fs', '~>1.3.1'
|
||||
# gem 'winrm-fs', '~>1.3.1'
|
||||
gem 'winrm-fs', :git => 'https://github.com/s0undt3ch/winrm-fs.git', :branch => 'hotfix/saltstack-ci'
|
||||
end
|
||||
|
||||
group :ec2 do
|
||||
|
|
|
|||
2
LICENSE
2
LICENSE
|
|
@ -1,6 +1,6 @@
|
|||
Salt - Remote execution system
|
||||
|
||||
Copyright 2014-2016 SaltStack Team
|
||||
Copyright 2014-2019 SaltStack Team
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
|
|
|
|||
5
NOTICE
Normal file
5
NOTICE
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
Apache SaltStack
|
||||
Copyright 2014-2019 The Apache Software Foundation
|
||||
|
||||
This product includes software developed at
|
||||
The Apache Software Foundation (http://www.apache.org/).
|
||||
56
README.rst
56
README.rst
|
|
@ -2,7 +2,7 @@
|
|||
What is SaltStack?
|
||||
==================
|
||||
|
||||
SaltStack makes software for complex systems management at scale.
|
||||
SaltStack makes software for complex systems management at scale.
|
||||
SaltStack is the company that created and maintains the Salt Open
|
||||
project and develops and sells SaltStack Enterprise software, services
|
||||
and support. Easy enough to get running in minutes, scalable enough to
|
||||
|
|
@ -34,43 +34,16 @@ documentation.
|
|||
|
||||
`<https://docs.saltstack.com/en/latest/>`_
|
||||
|
||||
Get SaltStack Support and Help
|
||||
==============================
|
||||
|
||||
**IRC Chat** - Join the vibrant, helpful and positive SaltStack chat room in
|
||||
Freenode at #salt. There is no need to introduce yourself, or ask permission to
|
||||
join in, just help and be helped! Make sure to wait for an answer, sometimes it
|
||||
may take a few moments for someone to reply.
|
||||
|
||||
`<http://webchat.freenode.net/?channels=salt&uio=Mj10cnVlJjk9dHJ1ZSYxMD10cnVl83>`_
|
||||
|
||||
**Mailing List** - The SaltStack community users mailing list is hosted by
|
||||
Google groups. Anyone can post to ask questions about SaltStack products and
|
||||
anyone can help answer. Join the conversation!
|
||||
|
||||
`<https://groups.google.com/forum/#!forum/salt-users>`_
|
||||
|
||||
You may subscribe to the list without a Google account by emailing
|
||||
salt-users+subscribe@googlegroups.com and you may post to the list by emailing
|
||||
salt-users@googlegroups.com
|
||||
|
||||
**Reporting Issues** - To report an issue with Salt, please follow the
|
||||
guidelines for filing bug reports:
|
||||
`<https://docs.saltstack.com/en/develop/topics/development/reporting_bugs.html>`_
|
||||
|
||||
**SaltStack Support** - If you need dedicated, prioritized support, please
|
||||
consider a SaltStack Support package that fits your needs:
|
||||
`<http://www.saltstack.com/support>`_
|
||||
|
||||
Engage SaltStack
|
||||
================
|
||||
|
||||
`SaltConf`_, **User Groups and Meetups** - SaltStack has a vibrant and `global
|
||||
community`_ of customers, users, developers and enthusiasts. Connect with other
|
||||
Salted folks in your area of the world, or join `SaltConf18`_, the SaltStack
|
||||
annual user conference, September 10-14 in Salt Lake City. Please let us know if
|
||||
you would like to start a user group or if we should add your existing
|
||||
SaltStack user group to this list by emailing: info@saltstack.com
|
||||
Salted folks in your area of the world, or join `SaltConf`_, the SaltStack
|
||||
annual user conference held in Salt Lake City. Please visit the `SaltConf`_ site
|
||||
for details of our next conference. Also, please let us know if you would like
|
||||
to start a user group or if we should add your existing SaltStack user group to
|
||||
this list by emailing: info@saltstack.com
|
||||
|
||||
**SaltStack Training** - Get access to proprietary `SaltStack education
|
||||
offerings`_ through instructor-led training offered on-site, virtually or at
|
||||
|
|
@ -89,23 +62,8 @@ services`_ offerings.
|
|||
* LinkedIn Group - `<https://www.linkedin.com/groups/4877160>`_
|
||||
* Google+ - `<https://plus.google.com/b/112856352920437801867/+SaltStackInc/posts>`_
|
||||
|
||||
.. _SaltConf: http://www.youtube.com/user/saltstack
|
||||
.. _global community: http://www.meetup.com/pro/saltstack/
|
||||
.. _SaltConf18: http://saltconf.com/
|
||||
.. _SaltConf: http://saltconf.com/
|
||||
.. _SaltStack education offerings: http://saltstack.com/training/
|
||||
.. _SaltStack Certified Engineer (SSCE): http://saltstack.com/certification/
|
||||
.. _SaltStack professional services: http://saltstack.com/services/
|
||||
|
||||
Developing Salt
|
||||
===============
|
||||
|
||||
The Salt development team is welcoming, positive, and dedicated to
|
||||
helping people get new code and fixes into SaltStack projects. Log into
|
||||
GitHub and get started with one of the largest developer communities in
|
||||
the world. The following links should get you started:
|
||||
|
||||
`<https://github.com/saltstack>`_
|
||||
|
||||
`<https://docs.saltstack.com/en/latest/topics/development/index.html>`_
|
||||
|
||||
`<https://docs.saltstack.com/en/develop/topics/development/pull_requests.html>`_
|
||||
|
|
|
|||
33
SUPPORT.rst
Normal file
33
SUPPORT.rst
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
Get SaltStack Support and Help
|
||||
==============================
|
||||
|
||||
**IRC Chat** - Join the vibrant, helpful and positive SaltStack chat room in
|
||||
Freenode at #salt. There is no need to introduce yourself, or ask permission to
|
||||
join in, just help and be helped! Make sure to wait for an answer, sometimes it
|
||||
may take a few moments for someone to reply.
|
||||
|
||||
`<http://webchat.freenode.net/?channels=salt&uio=Mj10cnVlJjk9dHJ1ZSYxMD10cnVl83>`_
|
||||
|
||||
**SaltStack Slack** - Alongside IRC is our SaltStack Community Slack for the
|
||||
SaltStack Working groups. Use the following link to request an invitation.
|
||||
|
||||
`<https://saltstackcommunity.herokuapp.com/>`_
|
||||
|
||||
**Mailing List** - The SaltStack community users mailing list is hosted by
|
||||
Google groups. Anyone can post to ask questions about SaltStack products and
|
||||
anyone can help answer. Join the conversation!
|
||||
|
||||
`<https://groups.google.com/forum/#!forum/salt-users>`_
|
||||
|
||||
You may subscribe to the list without a Google account by emailing
|
||||
salt-users+subscribe@googlegroups.com and you may post to the list by emailing
|
||||
salt-users@googlegroups.com
|
||||
|
||||
**Reporting Issues** - To report an issue with Salt, please follow the
|
||||
guidelines for filing bug reports:
|
||||
`<https://docs.saltstack.com/en/develop/topics/development/reporting_bugs.html>`_
|
||||
|
||||
**SaltStack Support** - If you need dedicated, prioritized support, please
|
||||
consider a SaltStack Support package that fits your needs:
|
||||
`<http://www.saltstack.com/support>`_
|
||||
|
||||
11
conf/cloud
11
conf/cloud
|
|
@ -97,3 +97,14 @@
|
|||
#
|
||||
#delete_sshkeys: False
|
||||
|
||||
# Whether or not to include grains information in the /etc/salt/minion file
|
||||
# which is generated when the minion is provisioned. For example...
|
||||
# grains:
|
||||
# salt-cloud:
|
||||
# driver: ec2
|
||||
# provider: my_ec2:ec2
|
||||
# profile: micro_ec2
|
||||
#
|
||||
# Default: 'True'
|
||||
#
|
||||
#enable_cloud_grains: 'True'
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
# directory is identical.
|
||||
|
||||
#my-digitalocean-config:
|
||||
# driver: digital_ocean
|
||||
# driver: digitalocean
|
||||
# client_key: wFGEwgregeqw3435gDger
|
||||
# api_key: GDE43t43REGTrkilg43934t34qT43t4dgegerGEgg
|
||||
# location: New York 1
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
#my-digitalocean-config:
|
||||
# driver: digital_ocean
|
||||
# driver: digitalocean
|
||||
# client_key: wFGEwgregeqw3435gDger
|
||||
# api_key: GDE43t43REGTrkilg43934t34qT43t4dgegerGEgg
|
||||
# location: New York 1
|
||||
|
|
|
|||
|
|
@ -1,10 +0,0 @@
|
|||
#my-openstack-hp-config:
|
||||
# driver: openstack
|
||||
# identity_url: 'https://region-a.geo-1.identity.hpcloudsvc.com:35357/v2.0/'
|
||||
# compute_name: Compute
|
||||
# compute_region: 'az-1.region-a.geo-1'
|
||||
# tenant: myuser-tenant1
|
||||
# user: myuser
|
||||
# ssh_key_name: mykey
|
||||
# ssh_key_file: '/etc/salt/hpcloud/mykey.pem'
|
||||
# password: mypass
|
||||
|
|
@ -3,3 +3,4 @@
|
|||
# user: fred
|
||||
# password: saltybacon
|
||||
# private_key: /root/joyent.pem
|
||||
# keyname: saltstack
|
||||
|
|
|
|||
|
|
@ -1,10 +0,0 @@
|
|||
#my-openstack-rackspace-config:
|
||||
# driver: openstack
|
||||
# identity_url: 'https://identity.api.rackspacecloud.com/v2.0/tokens'
|
||||
# compute_name: cloudServersOpenStack
|
||||
# protocol: ipv4
|
||||
# compute_region: DFW
|
||||
# protocol: ipv4
|
||||
# user: myuser
|
||||
# tenant: 5555555
|
||||
# apikey: 901d3f579h23c8v73q9
|
||||
108
conf/master
108
conf/master
|
|
@ -36,7 +36,7 @@
|
|||
|
||||
# The root directory prepended to these options: pki_dir, cachedir,
|
||||
# sock_dir, log_file, autosign_file, autoreject_file, extension_modules,
|
||||
# key_logfile, pidfile:
|
||||
# key_logfile, pidfile, autosign_grains_dir:
|
||||
#root_dir: /
|
||||
|
||||
# The path to the master's configuration file.
|
||||
|
|
@ -270,9 +270,39 @@
|
|||
# a value for you. Default is disabled.
|
||||
# ipc_write_buffer: 'dynamic'
|
||||
|
||||
# These two batch settings, batch_safe_limit and batch_safe_size, are used to
|
||||
# automatically switch to a batch mode execution. If a command would have been
|
||||
# sent to more than <batch_safe_limit> minions, then run the command in
|
||||
# batches of <batch_safe_size>. If no batch_safe_size is specified, a default
|
||||
# of 8 will be used. If no batch_safe_limit is specified, then no automatic
|
||||
# batching will occur.
|
||||
#batch_safe_limit: 100
|
||||
#batch_safe_size: 8
|
||||
|
||||
# Master stats enables stats events to be fired from the master at close
|
||||
# to the defined interval
|
||||
#master_stats: False
|
||||
#master_stats_event_iter: 60
|
||||
|
||||
|
||||
##### Security settings #####
|
||||
##########################################
|
||||
# Enable passphrase protection of Master private key. Although a string value
|
||||
# is acceptable; passwords should be stored in an external vaulting mechanism
|
||||
# and retrieved via sdb. See https://docs.saltstack.com/en/latest/topics/sdb/.
|
||||
# Passphrase protection is off by default but an example of an sdb profile and
|
||||
# query is as follows.
|
||||
# masterkeyring:
|
||||
# driver: keyring
|
||||
# service: system
|
||||
#
|
||||
# key_pass: sdb://masterkeyring/key_pass
|
||||
|
||||
# Enable passphrase protection of the Master signing_key. This only applies if
|
||||
# master_sign_pubkey is set to True. This is disabled by default.
|
||||
# master_sign_pubkey: True
|
||||
# signing_key_pass: sdb://masterkeyring/signing_pass
|
||||
|
||||
# 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
|
||||
|
|
@ -294,7 +324,8 @@
|
|||
|
||||
# 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.
|
||||
# expressions as well as globing lines are supported. The file must be readonly
|
||||
# except for the owner. Use permissive_pki_access to allow the group write access.
|
||||
#autosign_file: /etc/salt/autosign.conf
|
||||
|
||||
# Works like autosign_file, but instead allows you to specify minion IDs for
|
||||
|
|
@ -302,6 +333,11 @@
|
|||
# the autosign_file and the auto_accept setting.
|
||||
#autoreject_file: /etc/salt/autoreject.conf
|
||||
|
||||
# If the autosign_grains_dir is specified, incoming keys from minons with grain
|
||||
# values matching those defined in files in this directory will be accepted
|
||||
# automatically. This is insecure. Minions need to be configured to send the grains.
|
||||
#autosign_grains_dir: /etc/salt/autosign_grains
|
||||
|
||||
# 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
|
||||
|
|
@ -421,11 +457,13 @@
|
|||
|
||||
##### Salt-SSH Configuration #####
|
||||
##########################################
|
||||
# Define the default salt-ssh roster module to use
|
||||
#roster: flat
|
||||
|
||||
# Pass in an alternative location for the salt-ssh roster file
|
||||
# Pass in an alternative location for the salt-ssh `flat` roster file
|
||||
#roster_file: /etc/salt/roster
|
||||
|
||||
# Define locations for roster files so they can be chosen when using Salt API.
|
||||
# Define locations for `flat` 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
|
||||
|
|
@ -482,6 +520,10 @@
|
|||
# targeted with the normal -N argument to salt-ssh.
|
||||
#ssh_list_nodegroups: {}
|
||||
|
||||
# salt-ssh has the ability to update the flat roster file if a minion is not
|
||||
# found in the roster. Set this to True to enable it.
|
||||
#ssh_update_roster: False
|
||||
|
||||
##### Master Module Management #####
|
||||
##########################################
|
||||
# Manage how master side modules are loaded.
|
||||
|
|
@ -489,6 +531,9 @@
|
|||
# Add any additional locations to look for master runners:
|
||||
#runner_dirs: []
|
||||
|
||||
# Add any additional locations to look for master utils:
|
||||
#utils_dirs: []
|
||||
|
||||
# Enable Cython for master side modules:
|
||||
#cython_enable: False
|
||||
|
||||
|
|
@ -514,18 +559,35 @@
|
|||
# The renderer to use on the minions to render the state data
|
||||
#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".
|
||||
#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".
|
||||
#jinja_lstrip_blocks: False
|
||||
# Default Jinja environment options for all templates except sls templates
|
||||
#jinja_env:
|
||||
# block_start_string: '{%'
|
||||
# block_end_string: '%}'
|
||||
# variable_start_string: '{{'
|
||||
# variable_end_string: '}}'
|
||||
# comment_start_string: '{#'
|
||||
# comment_end_string: '#}'
|
||||
# line_statement_prefix:
|
||||
# line_comment_prefix:
|
||||
# trim_blocks: False
|
||||
# lstrip_blocks: False
|
||||
# newline_sequence: '\n'
|
||||
# keep_trailing_newline: False
|
||||
|
||||
# Jinja environment options for sls templates
|
||||
#jinja_sls_env:
|
||||
# block_start_string: '{%'
|
||||
# block_end_string: '%}'
|
||||
# variable_start_string: '{{'
|
||||
# variable_end_string: '}}'
|
||||
# comment_start_string: '{#'
|
||||
# comment_end_string: '#}'
|
||||
# line_statement_prefix:
|
||||
# line_comment_prefix:
|
||||
# trim_blocks: False
|
||||
# lstrip_blocks: False
|
||||
# newline_sequence: '\n'
|
||||
# keep_trailing_newline: False
|
||||
|
||||
# The failhard option tells the minions to stop immediately after the first
|
||||
# failure detected in the state execution, defaults to False
|
||||
|
|
@ -537,11 +599,12 @@
|
|||
# all data that has a result of True and no changes will be suppressed.
|
||||
#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.
|
||||
# The state_output setting controls which results will be output full multi line
|
||||
# full, terse - each state will be full/terse
|
||||
# mixed - only states with errors will be full
|
||||
# changes - states with changes and errors will be full
|
||||
# full_id, mixed_id, changes_id and terse_id are also allowed;
|
||||
# when set, the state ID will be used as name in the output
|
||||
#state_output: full
|
||||
|
||||
# The state_output_diff setting changes whether or not the output from
|
||||
|
|
@ -918,7 +981,7 @@
|
|||
#pillar_cache_ttl: 3600
|
||||
|
||||
# If and only if a master has set `pillar_cache: True`, one of several storage providers
|
||||
# can be utililzed.
|
||||
# can be utilized.
|
||||
#
|
||||
# `disk`: The default storage backend. This caches rendered pillars to the master cache.
|
||||
# Rendered pillars are serialized and deserialized as msgpack structures for speed.
|
||||
|
|
@ -1219,4 +1282,3 @@
|
|||
# use OS defaults, typically 75 seconds on Linux, see
|
||||
# /proc/sys/net/ipv4/tcp_keepalive_intvl.
|
||||
#tcp_keepalive_intvl: -1
|
||||
|
||||
|
|
|
|||
26
conf/minion
26
conf/minion
|
|
@ -66,6 +66,11 @@
|
|||
# Set to zero if the minion should shutdown and not retry.
|
||||
# retry_dns: 30
|
||||
|
||||
# Set the number of times to attempt to resolve
|
||||
# the master hostname if name resolution fails. Defaults to None,
|
||||
# which will attempt the resolution indefinitely.
|
||||
# retry_dns_count: 3
|
||||
|
||||
# Set the port used by the master reply and authentication server.
|
||||
#master_port: 4506
|
||||
|
||||
|
|
@ -640,9 +645,12 @@
|
|||
# all data that has a result of True and no changes will be suppressed.
|
||||
#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.
|
||||
# The state_output setting controls which results will be output full multi line
|
||||
# full, terse - each state will be full/terse
|
||||
# mixed - only states with errors will be full
|
||||
# changes - states with changes and errors will be full
|
||||
# full_id, mixed_id, changes_id and terse_id are also allowed;
|
||||
# when set, the state ID will be used as name in the output
|
||||
#state_output: full
|
||||
|
||||
# The state_output_diff setting changes whether or not the output from
|
||||
|
|
@ -668,6 +676,12 @@
|
|||
# certfile: <path_to_certfile>
|
||||
# ssl_version: PROTOCOL_TLSv1_2
|
||||
|
||||
# Grains to be sent to the master on authentication to check if the minion's key
|
||||
# will be accepted automatically. Needs to be configured on the master.
|
||||
#autosign_grains:
|
||||
# - uuid
|
||||
# - server_id
|
||||
|
||||
|
||||
###### Reactor Settings #####
|
||||
###########################################
|
||||
|
|
@ -694,6 +708,12 @@
|
|||
# for a full explanation.
|
||||
#multiprocessing: True
|
||||
|
||||
# Limit the maximum amount of processes or threads created by salt-minion.
|
||||
# This is useful to avoid resource exhaustion in case the minion receives more
|
||||
# publications than it is able to handle, as it limits the number of spawned
|
||||
# processes or threads. -1 is the default and disables the limit.
|
||||
#process_count_max: -1
|
||||
|
||||
|
||||
##### Logging settings #####
|
||||
##########################################
|
||||
|
|
|
|||
|
|
@ -498,9 +498,12 @@
|
|||
# all data that has a result of True and no changes will be suppressed.
|
||||
#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.
|
||||
# The state_output setting controls which results will be output full multi line
|
||||
# full, terse - each state will be full/terse
|
||||
# mixed - only states with errors will be full
|
||||
# changes - states with changes and errors will be full
|
||||
# full_id, mixed_id, changes_id and terse_id are also allowed;
|
||||
# when set, the state ID will be used as name in the output
|
||||
#state_output: full
|
||||
|
||||
# The state_output_diff setting changes whether or not the output from
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ syndic_user: salt
|
|||
|
||||
# The root directory prepended to these options: pki_dir, cachedir,
|
||||
# sock_dir, log_file, autosign_file, autoreject_file, extension_modules,
|
||||
# key_logfile, pidfile:
|
||||
# key_logfile, pidfile, autosign_grains_dir:
|
||||
#root_dir: /
|
||||
|
||||
# The path to the master's configuration file.
|
||||
|
|
@ -293,7 +293,8 @@ syndic_user: salt
|
|||
|
||||
# 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.
|
||||
# expressions as well as globing lines are supported. The file must be readonly
|
||||
# except for the owner. Use permissive_pki_access to allow the group write access.
|
||||
#autosign_file: /etc/salt/autosign.conf
|
||||
|
||||
# Works like autosign_file, but instead allows you to specify minion IDs for
|
||||
|
|
@ -301,6 +302,11 @@ syndic_user: salt
|
|||
# the autosign_file and the auto_accept setting.
|
||||
#autoreject_file: /etc/salt/autoreject.conf
|
||||
|
||||
# If the autosign_grains_dir is specified, incoming keys from minons with grain
|
||||
# values matching those defined in files in this directory will be accepted
|
||||
# automatically. This is insecure. Minions need to be configured to send the grains.
|
||||
#autosign_grains_dir: /etc/salt/autosign_grains
|
||||
|
||||
# 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
|
||||
|
|
@ -420,11 +426,13 @@ syndic_user: salt
|
|||
|
||||
##### Salt-SSH Configuration #####
|
||||
##########################################
|
||||
# Define the default salt-ssh roster module to use
|
||||
#roster: flat
|
||||
|
||||
# Pass in an alternative location for the salt-ssh roster file
|
||||
# Pass in an alternative location for the salt-ssh `flat` roster file
|
||||
#roster_file: /etc/salt/roster
|
||||
|
||||
# Define locations for roster files so they can be chosen when using Salt API.
|
||||
# Define locations for `flat` 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
|
||||
|
|
@ -513,18 +521,35 @@ syndic_user: salt
|
|||
# The renderer to use on the minions to render the state data
|
||||
#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".
|
||||
#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".
|
||||
#jinja_lstrip_blocks: False
|
||||
# Default Jinja environment options for all templates except sls templates
|
||||
#jinja_env:
|
||||
# block_start_string: '{%'
|
||||
# block_end_string: '%}'
|
||||
# variable_start_string: '{{'
|
||||
# variable_end_string: '}}'
|
||||
# comment_start_string: '{#'
|
||||
# comment_end_string: '#}'
|
||||
# line_statement_prefix:
|
||||
# line_comment_prefix:
|
||||
# trim_blocks: False
|
||||
# lstrip_blocks: False
|
||||
# newline_sequence: '\n'
|
||||
# keep_trailing_newline: False
|
||||
|
||||
# Jinja environment options for sls templates
|
||||
#jinja_sls_env:
|
||||
# block_start_string: '{%'
|
||||
# block_end_string: '%}'
|
||||
# variable_start_string: '{{'
|
||||
# variable_end_string: '}}'
|
||||
# comment_start_string: '{#'
|
||||
# comment_end_string: '#}'
|
||||
# line_statement_prefix:
|
||||
# line_comment_prefix:
|
||||
# trim_blocks: False
|
||||
# lstrip_blocks: False
|
||||
# newline_sequence: '\n'
|
||||
# keep_trailing_newline: False
|
||||
|
||||
# The failhard option tells the minions to stop immediately after the first
|
||||
# failure detected in the state execution, defaults to False
|
||||
|
|
@ -536,11 +561,12 @@ syndic_user: salt
|
|||
# all data that has a result of True and no changes will be suppressed.
|
||||
#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.
|
||||
# The state_output setting controls which results will be output full multi line
|
||||
# full, terse - each state will be full/terse
|
||||
# mixed - only states with errors will be full
|
||||
# changes - states with changes and errors will be full
|
||||
# full_id, mixed_id, changes_id and terse_id are also allowed;
|
||||
# when set, the state ID will be used as name in the output
|
||||
#state_output: full
|
||||
|
||||
# The state_output_diff setting changes whether or not the output from
|
||||
|
|
@ -1203,4 +1229,3 @@ syndic_user: salt
|
|||
# use OS defaults, typically 75 seconds on Linux, see
|
||||
# /proc/sys/net/ipv4/tcp_keepalive_intvl.
|
||||
#tcp_keepalive_intvl: -1
|
||||
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ clean:
|
|||
|
||||
# User-friendly check for sphinx-build
|
||||
check_sphinx-build:
|
||||
@which $(SPHINXBUILD) >/dev/null 2>&1 || (echo "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)" >&2; false)
|
||||
@which $(SPHINXBUILD) >/dev/null 2>&1 || (echo "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://www.sphinx-doc.org/en/master/)" >&2; false)
|
||||
|
||||
html: check_sphinx-build translations
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
|
|
|
|||
BIN
doc/_static/napalm_logo.png
vendored
Normal file
BIN
doc/_static/napalm_logo.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 37 KiB |
BIN
doc/_static/proxy_minions.png
vendored
BIN
doc/_static/proxy_minions.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 113 KiB After Width: | Height: | Size: 101 KiB |
13
doc/_themes/saltstack2/layout.html
vendored
13
doc/_themes/saltstack2/layout.html
vendored
|
|
@ -71,6 +71,14 @@
|
|||
{%- endmacro %}
|
||||
<html>
|
||||
<head>
|
||||
<!-- Google Tag Manager -->
|
||||
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
|
||||
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
|
||||
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
|
||||
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
|
||||
})(window,document,'script','dataLayer','GTM-MCK7VL3');</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
|
||||
<meta charset="{{ encoding }}">
|
||||
{{ metatags }}
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
|
|
@ -120,6 +128,11 @@
|
|||
</head>
|
||||
|
||||
<body class="index">
|
||||
<!-- Google Tag Manager (noscript) -->
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MCK7VL3"
|
||||
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
<!-- End Google Tag Manager (noscript) -->
|
||||
|
||||
<!--[if lt IE 8]>
|
||||
<p>You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser.</a></p>
|
||||
<![endif]-->
|
||||
|
|
|
|||
159
doc/conf.py
159
doc/conf.py
|
|
@ -3,7 +3,6 @@
|
|||
'''
|
||||
Sphinx documentation for Salt
|
||||
'''
|
||||
import functools
|
||||
import sys
|
||||
import os
|
||||
import types
|
||||
|
|
@ -12,7 +11,6 @@ import time
|
|||
from sphinx.directives import TocTree
|
||||
|
||||
|
||||
# pylint: disable=R0903
|
||||
class Mock(object):
|
||||
'''
|
||||
Mock out specified imports.
|
||||
|
|
@ -24,7 +22,7 @@ class Mock(object):
|
|||
|
||||
http://read-the-docs.readthedocs.org/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules
|
||||
'''
|
||||
def __init__(self, mapping=None, *args, **kwargs):
|
||||
def __init__(self, mapping=None, *args, **kwargs): # pylint: disable=unused-argument
|
||||
"""
|
||||
Mapping allows autodoc to bypass the Mock object, but actually assign
|
||||
a specific value, expected by a specific attribute returned.
|
||||
|
|
@ -40,14 +38,12 @@ class Mock(object):
|
|||
return Mock(mapping=self.__mapping)
|
||||
|
||||
def __getattr__(self, name):
|
||||
#__mapping = {'total': 0}
|
||||
data = None
|
||||
if name in self.__mapping:
|
||||
data = self.__mapping.get(name)
|
||||
elif name in ('__file__', '__path__'):
|
||||
data = '/dev/null'
|
||||
elif name == '__qualname__':
|
||||
raise AttributeError("'Mock' object has no attribute '__qualname__'")
|
||||
elif name in ('__mro_entries__', '__qualname__'):
|
||||
raise AttributeError("'Mock' object has no attribute '%s'" % (name))
|
||||
else:
|
||||
data = Mock(mapping=self.__mapping)
|
||||
return data
|
||||
|
|
@ -55,10 +51,30 @@ class Mock(object):
|
|||
def __iter__(self):
|
||||
return self
|
||||
|
||||
def next(self):
|
||||
@staticmethod
|
||||
def __next__():
|
||||
raise StopIteration
|
||||
|
||||
# pylint: enable=R0903
|
||||
# For Python 2
|
||||
next = __next__
|
||||
|
||||
|
||||
def mock_decorator_with_params(*oargs, **okwargs): # pylint: disable=unused-argument
|
||||
'''
|
||||
Optionally mock a decorator that takes parameters
|
||||
|
||||
E.g.:
|
||||
|
||||
@blah(stuff=True)
|
||||
def things():
|
||||
pass
|
||||
'''
|
||||
def inner(fn, *iargs, **ikwargs): # pylint: disable=unused-argument
|
||||
if hasattr(fn, '__call__'):
|
||||
return fn
|
||||
return Mock()
|
||||
return inner
|
||||
|
||||
|
||||
MOCK_MODULES = [
|
||||
# Python stdlib
|
||||
|
|
@ -153,7 +169,6 @@ MOCK_MODULES = [
|
|||
'napalm',
|
||||
'dson',
|
||||
'jnpr',
|
||||
'json',
|
||||
'lxml',
|
||||
'lxml.etree',
|
||||
'jnpr.junos',
|
||||
|
|
@ -178,40 +193,24 @@ MOCK_MODULES = [
|
|||
'msgpack',
|
||||
]
|
||||
|
||||
MOCK_MODULES_MAPPING = {
|
||||
'cherrypy': {'config': mock_decorator_with_params},
|
||||
'ntsecuritycon': {
|
||||
'STANDARD_RIGHTS_REQUIRED': 0,
|
||||
'SYNCHRONIZE': 0,
|
||||
},
|
||||
'psutil': {'total': 0}, # Otherwise it will crash Sphinx
|
||||
}
|
||||
|
||||
for mod_name in MOCK_MODULES:
|
||||
if mod_name == 'psutil':
|
||||
mock = Mock(mapping={'total': 0}) # Otherwise it will crash Sphinx
|
||||
else:
|
||||
mock = Mock()
|
||||
sys.modules[mod_name] = mock
|
||||
|
||||
def mock_decorator_with_params(*oargs, **okwargs):
|
||||
'''
|
||||
Optionally mock a decorator that takes parameters
|
||||
|
||||
E.g.:
|
||||
|
||||
@blah(stuff=True)
|
||||
def things():
|
||||
pass
|
||||
'''
|
||||
def inner(fn, *iargs, **ikwargs):
|
||||
if hasattr(fn, '__call__'):
|
||||
return fn
|
||||
else:
|
||||
return Mock()
|
||||
return inner
|
||||
sys.modules[mod_name] = Mock(mapping=MOCK_MODULES_MAPPING.get(mod_name))
|
||||
|
||||
# Define a fake version attribute for the following libs.
|
||||
sys.modules['libcloud'].__version__ = '0.0.0'
|
||||
sys.modules['msgpack'].version = (1, 0, 0)
|
||||
sys.modules['psutil'].version_info = (3, 0, 0)
|
||||
sys.modules['pymongo'].version = '0.0.0'
|
||||
sys.modules['ntsecuritycon'].STANDARD_RIGHTS_REQUIRED = 0
|
||||
sys.modules['ntsecuritycon'].SYNCHRONIZE = 0
|
||||
|
||||
# Define a fake version attribute for the following libs.
|
||||
sys.modules['cherrypy'].config = mock_decorator_with_params
|
||||
sys.modules['tornado'].version_info = (0, 0, 0)
|
||||
|
||||
|
||||
# -- Add paths to PYTHONPATH ---------------------------------------------------
|
||||
|
|
@ -223,12 +222,12 @@ except NameError:
|
|||
docs_basepath = os.path.abspath(os.path.dirname('.'))
|
||||
|
||||
addtl_paths = (
|
||||
os.pardir, # salt itself (for autodoc)
|
||||
'_ext', # custom Sphinx extensions
|
||||
os.pardir, # salt itself (for autodoc)
|
||||
'_ext', # custom Sphinx extensions
|
||||
)
|
||||
|
||||
for path in addtl_paths:
|
||||
sys.path.insert(0, os.path.abspath(os.path.join(docs_basepath, path)))
|
||||
for addtl_path in addtl_paths:
|
||||
sys.path.insert(0, os.path.abspath(os.path.join(docs_basepath, addtl_path)))
|
||||
|
||||
|
||||
# We're now able to import salt
|
||||
|
|
@ -251,9 +250,9 @@ on_saltstack = 'SALT_ON_SALTSTACK' in os.environ
|
|||
project = 'Salt'
|
||||
|
||||
version = salt.version.__version__
|
||||
latest_release = '2018.3.3' # latest release
|
||||
previous_release = '2017.7.8' # latest release from previous branch
|
||||
previous_release_dir = '2017.7' # path on web server for previous branch
|
||||
latest_release = '2019.2.0' # latest release
|
||||
previous_release = '2018.3.4' # latest release from previous branch
|
||||
previous_release_dir = '2018.3' # path on web server for previous branch
|
||||
next_release = '' # next release
|
||||
next_release_dir = '' # path on web server for next release branch
|
||||
|
||||
|
|
@ -265,7 +264,7 @@ if on_saltstack:
|
|||
|
||||
# < --- START do not merge these settings to other branches START ---> #
|
||||
build_type = 'previous' # latest, previous, develop, next
|
||||
release = previous_release # version, latest_release, previous_release
|
||||
release = previous_release # version, latest_release, previous_release
|
||||
# < --- END do not merge these settings to other branches END ---> #
|
||||
|
||||
# Set google custom search engine
|
||||
|
|
@ -307,7 +306,7 @@ extensions = [
|
|||
]
|
||||
|
||||
try:
|
||||
import sphinxcontrib.spelling
|
||||
import sphinxcontrib.spelling # false positive, pylint: disable=unused-import
|
||||
except ImportError:
|
||||
pass
|
||||
else:
|
||||
|
|
@ -371,7 +370,8 @@ gettext_compact = False
|
|||
|
||||
|
||||
### HTML options
|
||||
html_theme = os.environ.get('HTML_THEME', 'saltstack2') # set 'HTML_THEME=saltstack' to use previous theme
|
||||
# set 'HTML_THEME=saltstack' to use previous theme
|
||||
html_theme = os.environ.get('HTML_THEME', 'saltstack2')
|
||||
html_theme_path = ['_themes']
|
||||
html_title = u''
|
||||
html_short_title = 'Salt'
|
||||
|
|
@ -439,7 +439,7 @@ html_show_copyright = True
|
|||
### Latex options
|
||||
|
||||
latex_documents = [
|
||||
('contents', 'Salt.tex', 'Salt Documentation', 'SaltStack, Inc.', 'manual'),
|
||||
('contents', 'Salt.tex', 'Salt Documentation', 'SaltStack, Inc.', 'manual'),
|
||||
]
|
||||
|
||||
latex_logo = '_static/salt-logo.png'
|
||||
|
|
@ -447,7 +447,7 @@ latex_logo = '_static/salt-logo.png'
|
|||
latex_elements = {
|
||||
'inputenc': '', # use XeTeX instead of the inputenc LaTeX package.
|
||||
'utf8extra': '',
|
||||
'preamble': '''
|
||||
'preamble': r'''
|
||||
\usepackage{fontspec}
|
||||
\setsansfont{Linux Biolinum O}
|
||||
\setromanfont{Linux Libertine O}
|
||||
|
|
@ -459,35 +459,36 @@ latex_elements = {
|
|||
|
||||
|
||||
### Linkcheck options
|
||||
linkcheck_ignore = [r'http://127.0.0.1',
|
||||
r'http://salt:\d+',
|
||||
r'http://local:\d+',
|
||||
r'https://console.aws.amazon.com',
|
||||
r'http://192.168.33.10',
|
||||
r'http://domain:\d+',
|
||||
r'http://123.456.789.012:\d+',
|
||||
r'http://localhost',
|
||||
r'https://groups.google.com/forum/#!forum/salt-users',
|
||||
r'http://logstash.net/docs/latest/inputs/udp',
|
||||
r'http://logstash.net/docs/latest/inputs/zeromq',
|
||||
r'http://www.youtube.com/saltstack',
|
||||
r'https://raven.readthedocs.io',
|
||||
r'https://getsentry.com',
|
||||
r'https://salt-cloud.readthedocs.io',
|
||||
r'https://salt.readthedocs.io',
|
||||
r'http://www.pip-installer.org/',
|
||||
r'http://www.windowsazure.com/',
|
||||
r'https://github.com/watching',
|
||||
r'dash-feed://',
|
||||
r'https://github.com/saltstack/salt/',
|
||||
r'http://bootstrap.saltstack.org',
|
||||
r'https://bootstrap.saltstack.com',
|
||||
r'https://raw.githubusercontent.com/saltstack/salt-bootstrap/stable/bootstrap-salt.sh',
|
||||
r'media.readthedocs.org/dash/salt/latest/salt.xml',
|
||||
r'https://portal.aws.amazon.com/gp/aws/securityCredentials',
|
||||
r'https://help.github.com/articles/fork-a-repo',
|
||||
r'dash-feed://https%3A//media.readthedocs.org/dash/salt/latest/salt.xml'
|
||||
]
|
||||
linkcheck_ignore = [
|
||||
r'http://127.0.0.1',
|
||||
r'http://salt:\d+',
|
||||
r'http://local:\d+',
|
||||
r'https://console.aws.amazon.com',
|
||||
r'http://192.168.33.10',
|
||||
r'http://domain:\d+',
|
||||
r'http://123.456.789.012:\d+',
|
||||
r'http://localhost',
|
||||
r'https://groups.google.com/forum/#!forum/salt-users',
|
||||
r'http://logstash.net/docs/latest/inputs/udp',
|
||||
r'http://logstash.net/docs/latest/inputs/zeromq',
|
||||
r'http://www.youtube.com/saltstack',
|
||||
r'https://raven.readthedocs.io',
|
||||
r'https://getsentry.com',
|
||||
r'https://salt-cloud.readthedocs.io',
|
||||
r'https://salt.readthedocs.io',
|
||||
r'http://www.pip-installer.org/',
|
||||
r'http://www.windowsazure.com/',
|
||||
r'https://github.com/watching',
|
||||
r'dash-feed://',
|
||||
r'https://github.com/saltstack/salt/',
|
||||
r'http://bootstrap.saltstack.org',
|
||||
r'https://bootstrap.saltstack.com',
|
||||
r'https://raw.githubusercontent.com/saltstack/salt-bootstrap/stable/bootstrap-salt.sh',
|
||||
r'media.readthedocs.org/dash/salt/latest/salt.xml',
|
||||
r'https://portal.aws.amazon.com/gp/aws/securityCredentials',
|
||||
r'https://help.github.com/articles/fork-a-repo',
|
||||
r'dash-feed://https%3A//media.readthedocs.org/dash/salt/latest/salt.xml',
|
||||
]
|
||||
|
||||
linkcheck_anchors = False
|
||||
|
||||
|
|
@ -526,10 +527,12 @@ epub_copyright = copyright
|
|||
epub_scheme = 'URL'
|
||||
epub_identifier = 'http://saltstack.com/'
|
||||
|
||||
epub_tocdup = False
|
||||
#epub_tocdepth = 3
|
||||
|
||||
|
||||
def skip_mod_init_member(app, what, name, obj, skip, options):
|
||||
# pylint: disable=too-many-arguments,unused-argument
|
||||
if name.startswith('_'):
|
||||
return True
|
||||
if isinstance(obj, types.FunctionType) and obj.__name__ == 'mod_init':
|
||||
|
|
|
|||
|
|
@ -21,6 +21,7 @@ Salt Table of Contents
|
|||
topics/thorium/index
|
||||
topics/cloud/index
|
||||
topics/proxyminion/index
|
||||
topics/network_automation/index
|
||||
topics/virt/index
|
||||
ref/cli/index
|
||||
ref/pillar/index
|
||||
|
|
@ -29,6 +30,7 @@ Salt Table of Contents
|
|||
topics/api
|
||||
topics/topology/index
|
||||
topics/cache/index
|
||||
topics/slots/index
|
||||
topics/windows/index
|
||||
topics/development/index
|
||||
topics/releases/index
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SALT-API" "1" "August 06, 2018" "2017.7.8" "Salt"
|
||||
.TH "SALT-API" "1" "Sep 21, 2018" "2018.3.4" "Salt"
|
||||
.SH NAME
|
||||
salt-api \- salt-api Command
|
||||
.
|
||||
|
|
@ -103,9 +103,9 @@ Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
|
|||
.UNINDENT
|
||||
.SH SEE ALSO
|
||||
.sp
|
||||
\fIsalt\-api(7)\fP
|
||||
\fIsalt(7)\fP
|
||||
\fIsalt\-master(1)\fP
|
||||
\fBsalt\-api(7)\fP
|
||||
\fBsalt(7)\fP
|
||||
\fBsalt\-master(1)\fP
|
||||
.SH AUTHOR
|
||||
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
|
||||
.\" Generated by docutils manpage writer.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SALT-CALL" "1" "August 06, 2018" "2017.7.8" "Salt"
|
||||
.TH "SALT-CALL" "1" "Sep 21, 2018" "2018.3.4" "Salt"
|
||||
.SH NAME
|
||||
salt-call \- salt-call Documentation
|
||||
.
|
||||
|
|
@ -265,9 +265,9 @@ output. Set to True or False. Default: none.
|
|||
.UNINDENT
|
||||
.SH SEE ALSO
|
||||
.sp
|
||||
\fIsalt(1)\fP
|
||||
\fIsalt\-master(1)\fP
|
||||
\fIsalt\-minion(1)\fP
|
||||
\fBsalt(1)\fP
|
||||
\fBsalt\-master(1)\fP
|
||||
\fBsalt\-minion(1)\fP
|
||||
.SH AUTHOR
|
||||
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
|
||||
.\" Generated by docutils manpage writer.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SALT-CLOUD" "1" "August 06, 2018" "2017.7.8" "Salt"
|
||||
.TH "SALT-CLOUD" "1" "Sep 21, 2018" "2018.3.4" "Salt"
|
||||
.SH NAME
|
||||
salt-cloud \- Salt Cloud Command
|
||||
.
|
||||
|
|
@ -197,7 +197,7 @@ New in version 2014.7.0.
|
|||
|
||||
.sp
|
||||
Display a list of configured profiles. Pass in a cloud provider to view
|
||||
the provider\(aqs associated profiles, such as \fBdigital_ocean\fP, or pass in
|
||||
the provider\(aqs associated profiles, such as \fBdigitalocean\fP, or pass in
|
||||
\fBall\fP to list all the configured profiles.
|
||||
.UNINDENT
|
||||
.SS Cloud Providers Listings
|
||||
|
|
@ -387,10 +387,10 @@ salt\-cloud \-m /path/to/cloud.map \-Q
|
|||
.UNINDENT
|
||||
.SH SEE ALSO
|
||||
.sp
|
||||
\fIsalt\-cloud(7)\fP
|
||||
\fIsalt(7)\fP
|
||||
\fIsalt\-master(1)\fP
|
||||
\fIsalt\-minion(1)\fP
|
||||
\fBsalt\-cloud(7)\fP
|
||||
\fBsalt(7)\fP
|
||||
\fBsalt\-master(1)\fP
|
||||
\fBsalt\-minion(1)\fP
|
||||
.SH AUTHOR
|
||||
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
|
||||
.\" Generated by docutils manpage writer.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SALT-CP" "1" "August 06, 2018" "2017.7.8" "Salt"
|
||||
.TH "SALT-CP" "1" "Sep 21, 2018" "2018.3.4" "Salt"
|
||||
.SH NAME
|
||||
salt-cp \- salt-cp Documentation
|
||||
.
|
||||
|
|
@ -201,9 +201,9 @@ New in version 2016.3.7,2016.11.6,2017.7.0.
|
|||
.UNINDENT
|
||||
.SH SEE ALSO
|
||||
.sp
|
||||
\fIsalt(1)\fP
|
||||
\fIsalt\-master(1)\fP
|
||||
\fIsalt\-minion(1)\fP
|
||||
\fBsalt(1)\fP
|
||||
\fBsalt\-master(1)\fP
|
||||
\fBsalt\-minion(1)\fP
|
||||
.SH AUTHOR
|
||||
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
|
||||
.\" Generated by docutils manpage writer.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SALT-KEY" "1" "August 06, 2018" "2017.7.8" "Salt"
|
||||
.TH "SALT-KEY" "1" "Sep 21, 2018" "2018.3.4" "Salt"
|
||||
.SH NAME
|
||||
salt-key \- salt-key Documentation
|
||||
.
|
||||
|
|
@ -340,9 +340,9 @@ Auto\-create a signing key\-pair if it does not yet exist
|
|||
.UNINDENT
|
||||
.SH SEE ALSO
|
||||
.sp
|
||||
\fIsalt(7)\fP
|
||||
\fIsalt\-master(1)\fP
|
||||
\fIsalt\-minion(1)\fP
|
||||
\fBsalt(7)\fP
|
||||
\fBsalt\-master(1)\fP
|
||||
\fBsalt\-minion(1)\fP
|
||||
.SH AUTHOR
|
||||
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
|
||||
.\" Generated by docutils manpage writer.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SALT-MASTER" "1" "August 06, 2018" "2017.7.8" "Salt"
|
||||
.TH "SALT-MASTER" "1" "Sep 21, 2018" "2018.3.4" "Salt"
|
||||
.SH NAME
|
||||
salt-master \- salt-master Documentation
|
||||
.
|
||||
|
|
@ -108,9 +108,9 @@ Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
|
|||
.UNINDENT
|
||||
.SH SEE ALSO
|
||||
.sp
|
||||
\fIsalt(1)\fP
|
||||
\fIsalt(7)\fP
|
||||
\fIsalt\-minion(1)\fP
|
||||
\fBsalt(1)\fP
|
||||
\fBsalt(7)\fP
|
||||
\fBsalt\-minion(1)\fP
|
||||
.SH AUTHOR
|
||||
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
|
||||
.\" Generated by docutils manpage writer.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SALT-MINION" "1" "August 06, 2018" "2017.7.8" "Salt"
|
||||
.TH "SALT-MINION" "1" "Sep 21, 2018" "2018.3.4" "Salt"
|
||||
.SH NAME
|
||||
salt-minion \- salt-minion Documentation
|
||||
.
|
||||
|
|
@ -109,9 +109,9 @@ Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
|
|||
.UNINDENT
|
||||
.SH SEE ALSO
|
||||
.sp
|
||||
\fIsalt(1)\fP
|
||||
\fIsalt(7)\fP
|
||||
\fIsalt\-master(1)\fP
|
||||
\fBsalt(1)\fP
|
||||
\fBsalt(7)\fP
|
||||
\fBsalt\-master(1)\fP
|
||||
.SH AUTHOR
|
||||
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
|
||||
.\" Generated by docutils manpage writer.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SALT-PROXY" "1" "August 06, 2018" "2017.7.8" "Salt"
|
||||
.TH "SALT-PROXY" "1" "Sep 21, 2018" "2018.3.4" "Salt"
|
||||
.SH NAME
|
||||
salt-proxy \- salt-proxy Documentation
|
||||
.
|
||||
|
|
@ -116,10 +116,10 @@ Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
|
|||
.UNINDENT
|
||||
.SH SEE ALSO
|
||||
.sp
|
||||
\fIsalt(1)\fP
|
||||
\fIsalt(7)\fP
|
||||
\fIsalt\-master(1)\fP
|
||||
\fIsalt\-minion(1)\fP
|
||||
\fBsalt(1)\fP
|
||||
\fBsalt(7)\fP
|
||||
\fBsalt\-master(1)\fP
|
||||
\fBsalt\-minion(1)\fP
|
||||
.SH AUTHOR
|
||||
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
|
||||
.\" Generated by docutils manpage writer.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SALT-RUN" "1" "August 06, 2018" "2017.7.8" "Salt"
|
||||
.TH "SALT-RUN" "1" "Sep 21, 2018" "2018.3.4" "Salt"
|
||||
.SH NAME
|
||||
salt-run \- salt-run Documentation
|
||||
.
|
||||
|
|
@ -114,9 +114,9 @@ Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
|
|||
.UNINDENT
|
||||
.SH SEE ALSO
|
||||
.sp
|
||||
\fIsalt(1)\fP
|
||||
\fIsalt\-master(1)\fP
|
||||
\fIsalt\-minion(1)\fP
|
||||
\fBsalt(1)\fP
|
||||
\fBsalt\-master(1)\fP
|
||||
\fBsalt\-minion(1)\fP
|
||||
.SH AUTHOR
|
||||
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
|
||||
.\" Generated by docutils manpage writer.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SALT-SSH" "1" "August 06, 2018" "2017.7.8" "Salt"
|
||||
.TH "SALT-SSH" "1" "Sep 21, 2018" "2018.3.4" "Salt"
|
||||
.SH NAME
|
||||
salt-ssh \- salt-ssh Documentation
|
||||
.
|
||||
|
|
@ -348,9 +348,9 @@ output. Set to True or False. Default: none.
|
|||
.UNINDENT
|
||||
.SH SEE ALSO
|
||||
.sp
|
||||
\fIsalt(7)\fP
|
||||
\fIsalt\-master(1)\fP
|
||||
\fIsalt\-minion(1)\fP
|
||||
\fBsalt(7)\fP
|
||||
\fBsalt\-master(1)\fP
|
||||
\fBsalt\-minion(1)\fP
|
||||
.SH AUTHOR
|
||||
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
|
||||
.\" Generated by docutils manpage writer.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SALT-SYNDIC" "1" "August 06, 2018" "2017.7.8" "Salt"
|
||||
.TH "SALT-SYNDIC" "1" "Sep 21, 2018" "2018.3.4" "Salt"
|
||||
.SH NAME
|
||||
salt-syndic \- salt-syndic Documentation
|
||||
.
|
||||
|
|
@ -110,9 +110,9 @@ Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
|
|||
.UNINDENT
|
||||
.SH SEE ALSO
|
||||
.sp
|
||||
\fIsalt(1)\fP
|
||||
\fIsalt\-master(1)\fP
|
||||
\fIsalt\-minion(1)\fP
|
||||
\fBsalt(1)\fP
|
||||
\fBsalt\-master(1)\fP
|
||||
\fBsalt\-minion(1)\fP
|
||||
.SH AUTHOR
|
||||
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
|
||||
.\" Generated by docutils manpage writer.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SALT-UNITY" "1" "August 06, 2018" "2017.7.8" "Salt"
|
||||
.TH "SALT-UNITY" "1" "Sep 21, 2018" "2018.3.4" "Salt"
|
||||
.SH NAME
|
||||
salt-unity \- salt-unity Command
|
||||
.
|
||||
|
|
@ -50,17 +50,17 @@ invokes that script.
|
|||
.SH OPTIONS
|
||||
.SH SEE ALSO
|
||||
.sp
|
||||
\fIsalt\-api(1)\fP
|
||||
\fIsalt\-call(1)\fP
|
||||
\fIsalt\-cloud(1)\fP
|
||||
\fIsalt\-cp(1)\fP
|
||||
\fIsalt\-key(1)\fP
|
||||
\fIsalt\-main(1)\fP
|
||||
\fIsalt\-master(1)\fP
|
||||
\fIsalt\-minion(1)\fP
|
||||
\fIsalt\-run(1)\fP
|
||||
\fIsalt\-ssh(1)\fP
|
||||
\fIsalt\-syndic(1)\fP
|
||||
\fBsalt\-api(1)\fP
|
||||
\fBsalt\-call(1)\fP
|
||||
\fBsalt\-cloud(1)\fP
|
||||
\fBsalt\-cp(1)\fP
|
||||
\fBsalt\-key(1)\fP
|
||||
\fBsalt\-main(1)\fP
|
||||
\fBsalt\-master(1)\fP
|
||||
\fBsalt\-minion(1)\fP
|
||||
\fBsalt\-run(1)\fP
|
||||
\fBsalt\-ssh(1)\fP
|
||||
\fBsalt\-syndic(1)\fP
|
||||
.SH AUTHOR
|
||||
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
|
||||
.\" Generated by docutils manpage writer.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SALT" "1" "August 06, 2018" "2017.7.8" "Salt"
|
||||
.TH "SALT" "1" "Sep 21, 2018" "2018.3.4" "Salt"
|
||||
.SH NAME
|
||||
salt \- salt
|
||||
.
|
||||
|
|
@ -125,7 +125,7 @@ minions to execute on.
|
|||
.B \-a EAUTH, \-\-auth=EAUTH
|
||||
Pass in an external authentication medium to validate against. The
|
||||
credentials will be prompted for. The options are \fIauto\fP,
|
||||
\fIkeystone\fP, \fIldap\fP, \fIpam\fP, and \fIstormpath\fP\&. Can be used with the \-T
|
||||
\fIkeystone\fP, \fIldap\fP, and \fIpam\fP\&. Can be used with the \-T
|
||||
option.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
|
|
@ -334,9 +334,9 @@ output. Set to True or False. Default: none.
|
|||
.UNINDENT
|
||||
.SH SEE ALSO
|
||||
.sp
|
||||
\fIsalt(7)\fP
|
||||
\fIsalt\-master(1)\fP
|
||||
\fIsalt\-minion(1)\fP
|
||||
\fBsalt(7)\fP
|
||||
\fBsalt\-master(1)\fP
|
||||
\fBsalt\-minion(1)\fP
|
||||
.SH AUTHOR
|
||||
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
|
||||
.\" Generated by docutils manpage writer.
|
||||
|
|
|
|||
61407
doc/man/salt.7
61407
doc/man/salt.7
File diff suppressed because it is too large
Load diff
|
|
@ -1,6 +1,6 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SPM" "1" "August 06, 2018" "2017.7.8" "Salt"
|
||||
.TH "SPM" "1" "Sep 21, 2018" "2018.3.4" "Salt"
|
||||
.SH NAME
|
||||
spm \- Salt Package Manager Command
|
||||
.
|
||||
|
|
@ -132,9 +132,9 @@ in that directory which describes them.
|
|||
.UNINDENT
|
||||
.SH SEE ALSO
|
||||
.sp
|
||||
\fIsalt(1)\fP
|
||||
\fIsalt\-master(1)\fP
|
||||
\fIsalt\-minion(1)\fP
|
||||
\fBsalt(1)\fP
|
||||
\fBsalt\-master(1)\fP
|
||||
\fBsalt\-minion(1)\fP
|
||||
.SH AUTHOR
|
||||
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
|
||||
.\" Generated by docutils manpage writer.
|
||||
|
|
|
|||
|
|
@ -12,6 +12,7 @@ auth modules
|
|||
|
||||
auto
|
||||
django
|
||||
file
|
||||
keystone
|
||||
ldap
|
||||
mysql
|
||||
|
|
@ -19,5 +20,4 @@ auth modules
|
|||
pki
|
||||
rest
|
||||
sharedsecret
|
||||
stormpath
|
||||
yubico
|
||||
|
|
|
|||
6
doc/ref/auth/all/salt.auth.file.rst
Normal file
6
doc/ref/auth/all/salt.auth.file.rst
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
==============
|
||||
salt.auth.file
|
||||
==============
|
||||
|
||||
.. automodule:: salt.auth.file
|
||||
:members:
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
===================
|
||||
salt.auth.stormpath
|
||||
===================
|
||||
|
||||
.. automodule:: salt.auth.stormpath
|
||||
:members:
|
||||
|
|
@ -22,6 +22,7 @@ beacon modules
|
|||
load
|
||||
log
|
||||
memusage
|
||||
napalm_beacon
|
||||
network_info
|
||||
network_settings
|
||||
pkg
|
||||
|
|
|
|||
6
doc/ref/beacons/all/salt.beacons.napalm_beacon.rst
Normal file
6
doc/ref/beacons/all/salt.beacons.napalm_beacon.rst
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
==========================
|
||||
salt.beacons.napalm_beacon
|
||||
==========================
|
||||
|
||||
.. automodule:: salt.beacons.napalm_beacon
|
||||
:members:
|
||||
6
doc/ref/cache/all/index.rst
vendored
6
doc/ref/cache/all/index.rst
vendored
|
|
@ -1,7 +1,7 @@
|
|||
.. _all-salt.cache:
|
||||
|
||||
=============
|
||||
cache modules
|
||||
Cache Modules
|
||||
=============
|
||||
|
||||
.. currentmodule:: salt.cache
|
||||
|
|
@ -10,6 +10,8 @@ cache modules
|
|||
:toctree:
|
||||
:template: autosummary.rst.tmpl
|
||||
|
||||
localfs
|
||||
consul
|
||||
etcd_cache
|
||||
localfs
|
||||
mysql_cache
|
||||
redis_cache
|
||||
|
|
|
|||
4
doc/ref/cache/all/salt.cache.consul.rst
vendored
4
doc/ref/cache/all/salt.cache.consul.rst
vendored
|
|
@ -1,5 +1,5 @@
|
|||
salt.cache.consul module
|
||||
========================
|
||||
salt.cache.consul
|
||||
=================
|
||||
|
||||
.. automodule:: salt.cache.consul
|
||||
:members:
|
||||
|
|
|
|||
5
doc/ref/cache/all/salt.cache.etcd_cache.rst
vendored
Normal file
5
doc/ref/cache/all/salt.cache.etcd_cache.rst
vendored
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
salt.cache.etcd_cache
|
||||
=====================
|
||||
|
||||
.. automodule:: salt.cache.etcd_cache
|
||||
:members:
|
||||
4
doc/ref/cache/all/salt.cache.localfs.rst
vendored
4
doc/ref/cache/all/salt.cache.localfs.rst
vendored
|
|
@ -1,5 +1,5 @@
|
|||
salt.cache.localfs module
|
||||
=========================
|
||||
salt.cache.localfs
|
||||
==================
|
||||
|
||||
.. automodule:: salt.cache.localfs
|
||||
:members:
|
||||
|
|
|
|||
5
doc/ref/cache/all/salt.cache.mysql_cache.rst
vendored
Normal file
5
doc/ref/cache/all/salt.cache.mysql_cache.rst
vendored
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
salt.cache.mysql_cache
|
||||
======================
|
||||
|
||||
.. automodule:: salt.cache.mysql_cache
|
||||
:members:
|
||||
4
doc/ref/cache/all/salt.cache.redis_cache.rst
vendored
4
doc/ref/cache/all/salt.cache.redis_cache.rst
vendored
|
|
@ -1,5 +1,5 @@
|
|||
salt.cache.redis_cache module
|
||||
=============================
|
||||
salt.cache.redis_cache
|
||||
======================
|
||||
|
||||
.. automodule:: salt.cache.redis_cache
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -6,12 +6,9 @@ Output Options
|
|||
Pass in an alternative outputter to display the return of data. This
|
||||
outputter can be any of the available outputters:
|
||||
|
||||
``grains``, ``highstate``, ``json``, ``key``, ``overstatestage``, ``pprint``, ``raw``, ``txt``, ``yaml``
|
||||
|
||||
Some outputters are formatted only for data returned from specific
|
||||
functions; for instance, the ``grains`` outputter will not work for non-grains
|
||||
data.
|
||||
``highstate``, ``json``, ``key``, ``overstatestage``, ``pprint``, ``raw``, ``txt``, ``yaml``, and :ref:`many others <all-salt.output>`.
|
||||
|
||||
Some outputters are formatted only for data returned from specific functions.
|
||||
If an outputter is used that does not support the data passed into it, then
|
||||
Salt will fall back on the ``pprint`` outputter and display the return data
|
||||
using the Python ``pprint`` standard library module.
|
||||
|
|
|
|||
|
|
@ -136,7 +136,7 @@ Query Options
|
|||
.. versionadded:: 2014.7.0
|
||||
|
||||
Display a list of configured profiles. Pass in a cloud provider to view
|
||||
the provider's associated profiles, such as ``digital_ocean``, or pass in
|
||||
the provider's associated profiles, such as ``digitalocean``, or pass in
|
||||
``all`` to list all the configured profiles.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -73,7 +73,7 @@ Options
|
|||
|
||||
Pass in an external authentication medium to validate against. The
|
||||
credentials will be prompted for. The options are `auto`,
|
||||
`keystone`, `ldap`, `pam`, and `stormpath`. Can be used with the -T
|
||||
`keystone`, `ldap`, and `pam`. Can be used with the -T
|
||||
option.
|
||||
|
||||
.. option:: -T, --make-token
|
||||
|
|
|
|||
|
|
@ -92,13 +92,13 @@ RunnerClient
|
|||
------------
|
||||
|
||||
.. autoclass:: salt.runner.RunnerClient
|
||||
:members: cmd, async, cmd_sync, cmd_async
|
||||
:members: cmd, asynchronous, cmd_sync, cmd_async
|
||||
|
||||
WheelClient
|
||||
-----------
|
||||
|
||||
.. autoclass:: salt.wheel.WheelClient
|
||||
:members: cmd, async, cmd_sync, cmd_async
|
||||
:members: cmd, asynchronous, cmd_sync, cmd_async
|
||||
|
||||
CloudClient
|
||||
-----------
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ cloud modules
|
|||
aliyun
|
||||
azurearm
|
||||
cloudstack
|
||||
digital_ocean
|
||||
digitalocean
|
||||
dimensiondata
|
||||
ec2
|
||||
gce
|
||||
|
|
@ -23,6 +23,7 @@ cloud modules
|
|||
lxc
|
||||
msazure
|
||||
nova
|
||||
oneandone
|
||||
opennebula
|
||||
openstack
|
||||
parallels
|
||||
|
|
@ -34,6 +35,8 @@ cloud modules
|
|||
scaleway
|
||||
softlayer
|
||||
softlayer_hw
|
||||
vagrant
|
||||
virtualbox
|
||||
vmware
|
||||
vultrpy
|
||||
xen
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
===============================
|
||||
========================
|
||||
salt.cloud.clouds.aliyun
|
||||
===============================
|
||||
========================
|
||||
|
||||
.. automodule:: salt.cloud.clouds.aliyun
|
||||
:members:
|
||||
:members:
|
||||
|
|
|
|||
|
|
@ -1,6 +0,0 @@
|
|||
===============================
|
||||
salt.cloud.clouds.digital_ocean
|
||||
===============================
|
||||
|
||||
.. automodule:: salt.cloud.clouds.digital_ocean
|
||||
:members:
|
||||
6
doc/ref/clouds/all/salt.cloud.clouds.digitalocean.rst
Normal file
6
doc/ref/clouds/all/salt.cloud.clouds.digitalocean.rst
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
==============================
|
||||
salt.cloud.clouds.digitalocean
|
||||
==============================
|
||||
|
||||
.. automodule:: salt.cloud.clouds.digitalocean
|
||||
:members:
|
||||
6
doc/ref/clouds/all/salt.cloud.clouds.oneandone.rst
Normal file
6
doc/ref/clouds/all/salt.cloud.clouds.oneandone.rst
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
===========================
|
||||
salt.cloud.clouds.oneandone
|
||||
===========================
|
||||
|
||||
.. automodule:: salt.cloud.clouds.oneandone
|
||||
:members:
|
||||
|
|
@ -3,4 +3,4 @@ salt.cloud.clouds.openstack
|
|||
===========================
|
||||
|
||||
.. automodule:: salt.cloud.clouds.openstack
|
||||
:members:
|
||||
:members:
|
||||
|
|
|
|||
6
doc/ref/clouds/all/salt.cloud.clouds.vagrant.rst
Normal file
6
doc/ref/clouds/all/salt.cloud.clouds.vagrant.rst
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
=========================
|
||||
salt.cloud.clouds.vagrant
|
||||
=========================
|
||||
|
||||
.. automodule:: salt.cloud.clouds.vagrant
|
||||
:members:
|
||||
|
|
@ -1,5 +1,6 @@
|
|||
salt.cloud.clouds.vultrpy module
|
||||
================================
|
||||
=========================
|
||||
salt.cloud.clouds.vultrpy
|
||||
=========================
|
||||
|
||||
.. automodule:: salt.cloud.clouds.vultrpy
|
||||
:members:
|
||||
|
|
|
|||
6
doc/ref/clouds/all/salt.cloud.clouds.xen.rst
Normal file
6
doc/ref/clouds/all/salt.cloud.clouds.xen.rst
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
=====================
|
||||
salt.cloud.clouds.xen
|
||||
=====================
|
||||
|
||||
.. automodule:: salt.cloud.clouds.xen
|
||||
:members:
|
||||
|
|
@ -96,6 +96,23 @@ The user to run the Salt processes
|
|||
|
||||
.. conf_master:: ret_port
|
||||
|
||||
``enable_ssh_minions``
|
||||
----------------------
|
||||
|
||||
|
||||
Default: ``False``
|
||||
|
||||
Tell the master to also use salt-ssh when running commands against minions.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
enable_ssh_minions: True
|
||||
|
||||
.. note::
|
||||
|
||||
Cross-minion communication is still not possible. The Salt mine and
|
||||
publish.publish do not work between minion types.
|
||||
|
||||
``ret_port``
|
||||
------------
|
||||
|
||||
|
|
@ -140,7 +157,8 @@ an alternative root.
|
|||
This directory is prepended to the following options:
|
||||
:conf_master:`pki_dir`, :conf_master:`cachedir`, :conf_master:`sock_dir`,
|
||||
:conf_master:`log_file`, :conf_master:`autosign_file`,
|
||||
:conf_master:`autoreject_file`, :conf_master:`pidfile`.
|
||||
:conf_master:`autoreject_file`, :conf_master:`pidfile`,
|
||||
:conf_master:`autosign_grains_dir`.
|
||||
|
||||
.. conf_master:: conf_file
|
||||
|
||||
|
|
@ -234,6 +252,7 @@ Valid options:
|
|||
- clouds
|
||||
- tops
|
||||
- roster
|
||||
- tokens
|
||||
|
||||
.. conf_master:: module_dirs
|
||||
|
||||
|
|
@ -406,6 +425,19 @@ to False.
|
|||
|
||||
color: False
|
||||
|
||||
.. conf_master:: color_theme
|
||||
|
||||
``color_theme``
|
||||
---------------
|
||||
|
||||
Default: ``""``
|
||||
|
||||
Specifies a path to the color theme to use for colored command line output.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
color_theme: /etc/salt/color_theme
|
||||
|
||||
.. conf_master:: cli_summary
|
||||
|
||||
``cli_summary``
|
||||
|
|
@ -803,6 +835,8 @@ that connect to a master via localhost.
|
|||
``ping_on_rotate``
|
||||
------------------
|
||||
|
||||
.. versionadded:: 2014.7.0
|
||||
|
||||
Default: ``False``
|
||||
|
||||
By default, the master AES key rotates every 24 hours. The next command
|
||||
|
|
@ -813,9 +847,9 @@ 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.
|
||||
Note that enabling this 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.
|
||||
|
|
@ -861,6 +895,29 @@ following example shows how to start a TCP transport alongside a ZMQ transport.
|
|||
ret_port: 4606
|
||||
zeromq: []
|
||||
|
||||
.. conf_master:: master_stats
|
||||
|
||||
``master_stats``
|
||||
----------------
|
||||
|
||||
Default: False
|
||||
|
||||
Turning on the master stats enables runtime throughput and statistics events
|
||||
to be fired from the master event bus. These events will report on what
|
||||
functions have been run on the master and how long these runs have, on
|
||||
average, taken over a given period of time.
|
||||
|
||||
.. conf_master:: master_stats_event_iter
|
||||
|
||||
``master_stats_event_iter``
|
||||
---------------------------
|
||||
|
||||
Default: 60
|
||||
|
||||
The time in seconds to fire master_stats events. This will only fire in
|
||||
conjunction with receiving a request to the master, idle masters will not
|
||||
fire these events.
|
||||
|
||||
.. conf_master:: sock_pool_size
|
||||
|
||||
``sock_pool_size``
|
||||
|
|
@ -988,6 +1045,19 @@ cache events are fired when a minion requests a minion data cache refresh.
|
|||
Salt-SSH Configuration
|
||||
======================
|
||||
|
||||
.. conf_master:: roster
|
||||
|
||||
``roster``
|
||||
---------------
|
||||
|
||||
Default: ``flat``
|
||||
|
||||
Define the default salt-ssh roster module to use
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
roster: cache
|
||||
|
||||
.. conf_master:: roster_defaults
|
||||
|
||||
``roster_defaults``
|
||||
|
|
@ -1012,12 +1082,34 @@ Default settings which will be inherited by all rosters.
|
|||
|
||||
Default: ``/etc/salt/roster``
|
||||
|
||||
Pass in an alternative location for the salt-ssh roster file.
|
||||
Pass in an alternative location for the salt-ssh :py:mod:`flat
|
||||
<salt.roster.flat>` roster file.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
roster_file: /root/roster
|
||||
|
||||
.. conf_master:: rosters
|
||||
|
||||
``rosters``
|
||||
-----------
|
||||
|
||||
Default: ``None``
|
||||
|
||||
Define locations for :py:mod:`flat <salt.roster.flat>` 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, the :conf_master:`roster_file`
|
||||
parameter 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.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
rosters:
|
||||
- /etc/salt/roster.d
|
||||
- /opt/salt/some/more/rosters
|
||||
|
||||
.. conf_master:: ssh_passwd
|
||||
|
||||
``ssh_passwd``
|
||||
|
|
@ -1288,6 +1380,12 @@ comparison, then by globbing, then by full-string regex matching.
|
|||
This should still be considered a less than secure option, due to the fact
|
||||
that trust is based on just the requesting minion id.
|
||||
|
||||
.. versionchanged:: 2018.3.0
|
||||
For security reasons the file must be readonly except for it's owner.
|
||||
If :conf_master:`permissive_pki_access` is ``True`` the owning group can also
|
||||
have write access, but if Salt is running as ``root`` it must be a member of that group.
|
||||
A less strict requirement also existed in previous version.
|
||||
|
||||
.. conf_master:: autoreject_file
|
||||
|
||||
``autoreject_file``
|
||||
|
|
@ -1302,6 +1400,32 @@ minion IDs for which keys will automatically be rejected. Will override both
|
|||
membership in the :conf_master:`autosign_file` and the
|
||||
:conf_master:`auto_accept` setting.
|
||||
|
||||
.. conf_master:: autosign_grains_dir
|
||||
|
||||
``autosign_grains_dir``
|
||||
-----------------------
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
Default: ``not defined``
|
||||
|
||||
If the ``autosign_grains_dir`` is specified, incoming keys from minions with
|
||||
grain values that match those defined in files in the autosign_grains_dir
|
||||
will be accepted automatically. Grain values that should be accepted automatically
|
||||
can be defined by creating a file named like the corresponding grain in the
|
||||
autosign_grains_dir and writing the values into that file, one value per line.
|
||||
Lines starting with a ``#`` will be ignored.
|
||||
Minion must be configured to send the corresponding grains on authentication.
|
||||
This should still be considered a less than secure option, due to the fact
|
||||
that trust is based on just the requesting minion.
|
||||
|
||||
Please see the :ref:`Autoaccept Minions from Grains <tutorial-autoaccept-grains>`
|
||||
documentation for more information.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
autosign_grains_dir: /etc/salt/autosign_grains
|
||||
|
||||
.. conf_master:: permissive_pki_access
|
||||
|
||||
``permissive_pki_access``
|
||||
|
|
@ -1758,6 +1882,22 @@ Set additional directories to search for runner modules.
|
|||
runner_dirs:
|
||||
- /var/lib/salt/runners
|
||||
|
||||
.. conf_master:: utils_dirs
|
||||
|
||||
``utils_dirs``
|
||||
---------------
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
Default: ``[]``
|
||||
|
||||
Set additional directories to search for util modules.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
utils_dirs:
|
||||
- /var/lib/salt/utils
|
||||
|
||||
.. conf_master:: cython_enable
|
||||
|
||||
``cython_enable``
|
||||
|
|
@ -1787,7 +1927,8 @@ Default: ``top.sls``
|
|||
|
||||
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.
|
||||
root of the base environment. The value of "state_top" is also used for the
|
||||
pillar top file
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
|
@ -1934,11 +2075,121 @@ the cloud profile or master config file, no templating will be performed.
|
|||
|
||||
userdata_template: jinja
|
||||
|
||||
.. conf_master:: jinja_env
|
||||
|
||||
``jinja_env``
|
||||
-------------
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
Default: ``{}``
|
||||
|
||||
jinja_env overrides the default Jinja environment options for
|
||||
**all templates except sls templates**.
|
||||
To set the options for sls templates use :conf_master:`jinja_sls_env`.
|
||||
|
||||
.. note::
|
||||
|
||||
The `Jinja2 Environment documentation <http://jinja.pocoo.org/docs/api/#jinja2.Environment>`_ is the official source for the default values.
|
||||
Not all the options listed in the jinja documentation can be overridden using :conf_master:`jinja_env` or :conf_master:`jinja_sls_env`.
|
||||
|
||||
The default options are:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
jinja_env:
|
||||
block_start_string: '{%'
|
||||
block_end_string: '%}'
|
||||
variable_start_string: '{{'
|
||||
variable_end_string: '}}'
|
||||
comment_start_string: '{#'
|
||||
comment_end_string: '#}'
|
||||
line_statement_prefix:
|
||||
line_comment_prefix:
|
||||
trim_blocks: False
|
||||
lstrip_blocks: False
|
||||
newline_sequence: '\n'
|
||||
keep_trailing_newline: False
|
||||
|
||||
.. conf_master:: jinja_sls_env
|
||||
|
||||
``jinja_sls_env``
|
||||
-----------------
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
Default: ``{}``
|
||||
|
||||
jinja_sls_env sets the Jinja environment options for **sls templates**.
|
||||
The defaults and accepted options are exactly the same as they are
|
||||
for :conf_master:`jinja_env`.
|
||||
|
||||
The default options are:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
jinja_sls_env:
|
||||
block_start_string: '{%'
|
||||
block_end_string: '%}'
|
||||
variable_start_string: '{{'
|
||||
variable_end_string: '}}'
|
||||
comment_start_string: '{#'
|
||||
comment_end_string: '#}'
|
||||
line_statement_prefix:
|
||||
line_comment_prefix:
|
||||
trim_blocks: False
|
||||
lstrip_blocks: False
|
||||
newline_sequence: '\n'
|
||||
keep_trailing_newline: False
|
||||
|
||||
Example using line statements and line comments to increase ease of use:
|
||||
|
||||
If your configuration options are
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
jinja_sls_env:
|
||||
line_statement_prefix: '%'
|
||||
line_comment_prefix: '##'
|
||||
|
||||
With these options jinja will interpret anything after a ``%`` at the start of a line (ignoreing whitespace)
|
||||
as a jinja statement and will interpret anything after a ``##`` as a comment.
|
||||
|
||||
This allows the following more convenient syntax to be used:
|
||||
|
||||
.. code-block:: jinja
|
||||
|
||||
## (this comment will not stay once rendered)
|
||||
# (this comment remains in the rendered template)
|
||||
## ensure all the formula services are running
|
||||
% for service in formula_services:
|
||||
enable_service_{{ service }}:
|
||||
service.running:
|
||||
name: {{ service }}
|
||||
% endfor
|
||||
|
||||
The following less convenient but equivalent syntax would have to
|
||||
be used if you had not set the line_statement and line_comment options:
|
||||
|
||||
.. code-block:: jinja
|
||||
|
||||
{# (this comment will not stay once rendered) #}
|
||||
# (this comment remains in the rendered template)
|
||||
{# ensure all the formula services are running #}
|
||||
{% for service in formula_services %}
|
||||
enable_service_{{ service }}:
|
||||
service.running:
|
||||
name: {{ service }}
|
||||
{% endfor %}
|
||||
|
||||
.. conf_master:: jinja_trim_blocks
|
||||
|
||||
``jinja_trim_blocks``
|
||||
---------------------
|
||||
|
||||
.. deprecated:: 2018.3.0
|
||||
Replaced by :conf_master:`jinja_env` and :conf_master:`jinja_sls_env`
|
||||
|
||||
.. versionadded:: 2014.1.0
|
||||
|
||||
Default: ``False``
|
||||
|
|
@ -1956,6 +2207,9 @@ to the Jinja environment init variable ``trim_blocks``.
|
|||
``jinja_lstrip_blocks``
|
||||
-----------------------
|
||||
|
||||
.. deprecated:: 2018.3.0
|
||||
Replaced by :conf_master:`jinja_env` and :conf_master:`jinja_sls_env`
|
||||
|
||||
.. versionadded:: 2014.1.0
|
||||
|
||||
Default: ``False``
|
||||
|
|
@ -2004,11 +2258,14 @@ output for states that failed or states that have changes.
|
|||
|
||||
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. 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.
|
||||
The state_output setting controls which results will be output full multi line:
|
||||
|
||||
* ``full``, ``terse`` - each state will be full/terse
|
||||
* ``mixed`` - only states with errors will be full
|
||||
* ``changes`` - states with changes and errors will be full
|
||||
|
||||
``full_id``, ``mixed_id``, ``changes_id`` and ``terse_id`` are also allowed;
|
||||
when set, the state ID will be used as name in the output.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
|
@ -2115,7 +2372,7 @@ Example:
|
|||
|
||||
fileserver_backend:
|
||||
- roots
|
||||
- git
|
||||
- gitfs
|
||||
|
||||
.. note::
|
||||
For masterless Salt, this parameter must be specified in the minion config
|
||||
|
|
@ -2161,6 +2418,12 @@ Master will not be returned to the Minion.
|
|||
------------------------------
|
||||
|
||||
.. versionadded:: 2014.1.0
|
||||
.. deprecated:: 2018.3.4
|
||||
This option is now ignored. Firstly, it only traversed
|
||||
:conf_master:`file_roots`, which means it did not work for the other
|
||||
fileserver backends. Secondly, since this option was added we have added
|
||||
caching to the code that traverses the file_roots (and gitfs, etc.), which
|
||||
greatly reduces the amount of traversal that is done.
|
||||
|
||||
Default: ``False``
|
||||
|
||||
|
|
@ -2298,6 +2561,19 @@ nothing is ignored.
|
|||
fileserver, it is good practice to include ``'\*.swp'`` in the
|
||||
:conf_master:`file_ignore_glob`.
|
||||
|
||||
.. conf_master:: master_roots
|
||||
|
||||
``master_roots``
|
||||
----------------
|
||||
|
||||
Default: ``/srv/salt-master``
|
||||
|
||||
A master-only copy of the :conf_master:`file_roots` dictionary, used by the
|
||||
state compiler.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
master_roots: /srv/salt-master
|
||||
|
||||
roots: Master's Local File Server
|
||||
---------------------------------
|
||||
|
|
@ -2323,6 +2599,8 @@ 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.
|
||||
|
||||
As of 2018.3.5 and 2019.2.1, it is possible to have `__env__` as a catch-all environment.
|
||||
|
||||
Example:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
|
@ -2336,26 +2614,35 @@ Example:
|
|||
prod:
|
||||
- /srv/salt/prod/services
|
||||
- /srv/salt/prod/states
|
||||
__env__:
|
||||
- /srv/salt/default
|
||||
|
||||
.. note::
|
||||
For masterless Salt, this parameter must be specified in the minion config
|
||||
file.
|
||||
|
||||
.. conf_master:: master_roots
|
||||
.. conf_master:: roots_update_interval
|
||||
|
||||
``master_roots``
|
||||
----------------
|
||||
``roots_update_interval``
|
||||
*************************
|
||||
|
||||
Default: ``/srv/salt-master``
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
A master-only copy of the file_roots dictionary, used by the state compiler.
|
||||
Default: ``60``
|
||||
|
||||
This option defines the update interval (in seconds) for
|
||||
:conf_master:`file_roots`.
|
||||
|
||||
.. note::
|
||||
Since ``file_roots`` consists of files local to the minion, the update
|
||||
process for this fileserver backend just reaps the cache for this backend.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
master_roots: /srv/salt-master
|
||||
roots_update_interval: 120
|
||||
|
||||
git: Git Remote File Server Backend
|
||||
-----------------------------------
|
||||
gitfs: Git Remote File Server Backend
|
||||
-------------------------------------
|
||||
|
||||
.. conf_master:: gitfs_remotes
|
||||
|
||||
|
|
@ -2521,12 +2808,68 @@ gitfs remotes.
|
|||
- dev:
|
||||
- ref: develop
|
||||
|
||||
.. conf_master:: gitfs_env_whitelist
|
||||
.. conf_master:: gitfs_disable_saltenv_mapping
|
||||
|
||||
``gitfs_env_whitelist``
|
||||
***********************
|
||||
``gitfs_disable_saltenv_mapping``
|
||||
*********************************
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
Default: ``False``
|
||||
|
||||
When set to ``True``, all saltenv mapping logic is disregarded (aside from
|
||||
which branch/tag is mapped to the ``base`` saltenv). To use any other
|
||||
environments, they must then be defined using :ref:`per-saltenv configuration
|
||||
parameters <gitfs-per-saltenv-config>`.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
gitfs_disable_saltenv_mapping: True
|
||||
|
||||
.. note::
|
||||
This is is a global configuration option, see :ref:`here
|
||||
<gitfs-per-remote-config>` for examples of configuring it for individual
|
||||
repositories.
|
||||
|
||||
.. conf_master:: gitfs_ref_types
|
||||
|
||||
``gitfs_ref_types``
|
||||
*******************
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
Default: ``['branch', 'tag', 'sha']``
|
||||
|
||||
This option defines what types of refs are mapped to fileserver environments
|
||||
(i.e. saltenvs). It also sets the order of preference when there are
|
||||
ambiguously-named refs (i.e. when a branch and tag both have the same name).
|
||||
The below example disables mapping of both tags and SHAs, so that only branches
|
||||
are mapped as saltenvs:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
gitfs_ref_types:
|
||||
- branch
|
||||
|
||||
.. note::
|
||||
This is is a global configuration option, see :ref:`here
|
||||
<gitfs-per-remote-config>` for examples of configuring it for individual
|
||||
repositories.
|
||||
|
||||
.. note::
|
||||
``sha`` is special in that it will not show up when listing saltenvs (e.g.
|
||||
with the :py:func:`fileserver.envs <salt.runners.fileserver.envs>` runner),
|
||||
but works within states and with :py:func:`cp.cache_file
|
||||
<salt.modules.cp.cache_file>` to retrieve a file from a specific git SHA.
|
||||
|
||||
.. conf_master:: gitfs_saltenv_whitelist
|
||||
|
||||
``gitfs_saltenv_whitelist``
|
||||
***************************
|
||||
|
||||
.. versionadded:: 2014.7.0
|
||||
.. versionchanged:: 2018.3.0
|
||||
Renamed from ``gitfs_env_whitelist`` to ``gitfs_saltenv_whitelist``
|
||||
|
||||
Default: ``[]``
|
||||
|
||||
|
|
@ -2537,17 +2880,19 @@ information can be found in the :ref:`GitFS Walkthrough
|
|||
|
||||
.. code-block:: yaml
|
||||
|
||||
gitfs_env_whitelist:
|
||||
gitfs_saltenv_whitelist:
|
||||
- base
|
||||
- v1.*
|
||||
- 'mybranch\d+'
|
||||
|
||||
.. conf_master:: gitfs_env_blacklist
|
||||
.. conf_master:: gitfs_saltenv_blacklist
|
||||
|
||||
``gitfs_env_blacklist``
|
||||
***********************
|
||||
``gitfs_saltenv_blacklist``
|
||||
***************************
|
||||
|
||||
.. versionadded:: 2014.7.0
|
||||
.. versionchanged:: 2018.3.0
|
||||
Renamed from ``gitfs_env_blacklist`` to ``gitfs_saltenv_blacklist``
|
||||
|
||||
Default: ``[]``
|
||||
|
||||
|
|
@ -2558,7 +2903,7 @@ information can be found in the :ref:`GitFS Walkthrough
|
|||
|
||||
.. code-block:: yaml
|
||||
|
||||
gitfs_env_blacklist:
|
||||
gitfs_saltenv_blacklist:
|
||||
- base
|
||||
- v1.*
|
||||
- 'mybranch\d+'
|
||||
|
|
@ -2593,6 +2938,22 @@ they were created by a different master.
|
|||
|
||||
.. __: http://www.gluster.org/
|
||||
|
||||
.. conf_master:: gitfs_update_interval
|
||||
|
||||
``gitfs_update_interval``
|
||||
*************************
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
Default: ``60``
|
||||
|
||||
This option defines the default update interval (in seconds) for gitfs remotes.
|
||||
The update interval can also be set for a single repository via a
|
||||
:ref:`per-remote config option <gitfs-per-remote-config>`
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
gitfs_update_interval: 120
|
||||
|
||||
GitFS Authentication Options
|
||||
****************************
|
||||
|
|
@ -2751,8 +3112,8 @@ can be found in the :ref:`GitFS Walkthrough <gitfs-custom-refspecs>`.
|
|||
- '+refs/pull/*/head:refs/remotes/origin/pr/*'
|
||||
- '+refs/pull/*/merge:refs/remotes/origin/merge/*'
|
||||
|
||||
hg: Mercurial Remote File Server Backend
|
||||
----------------------------------------
|
||||
hgfs: Mercurial Remote File Server Backend
|
||||
------------------------------------------
|
||||
|
||||
.. conf_master:: hgfs_remotes
|
||||
|
||||
|
|
@ -2891,12 +3252,14 @@ bookmark should be used as the ``base`` environment.
|
|||
|
||||
hgfs_base: salt
|
||||
|
||||
.. conf_master:: hgfs_env_whitelist
|
||||
.. conf_master:: hgfs_saltenv_whitelist
|
||||
|
||||
``hgfs_env_whitelist``
|
||||
**********************
|
||||
``hgfs_saltenv_whitelist``
|
||||
**************************
|
||||
|
||||
.. versionadded:: 2014.7.0
|
||||
.. versionchanged:: 2018.3.0
|
||||
Renamed from ``hgfs_env_whitelist`` to ``hgfs_saltenv_whitelist``
|
||||
|
||||
Default: ``[]``
|
||||
|
||||
|
|
@ -2908,23 +3271,25 @@ expression must match the entire minion ID.
|
|||
If used, only branches/bookmarks/tags which match one of the specified
|
||||
expressions will be exposed as fileserver environments.
|
||||
|
||||
If used in conjunction with :conf_master:`hgfs_env_blacklist`, then the subset
|
||||
If used in conjunction with :conf_master:`hgfs_saltenv_blacklist`, then the subset
|
||||
of branches/bookmarks/tags which match the whitelist but do *not* match the
|
||||
blacklist will be exposed as fileserver environments.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
hgfs_env_whitelist:
|
||||
hgfs_saltenv_whitelist:
|
||||
- base
|
||||
- v1.*
|
||||
- 'mybranch\d+'
|
||||
|
||||
.. conf_master:: hgfs_env_blacklist
|
||||
.. conf_master:: hgfs_saltenv_blacklist
|
||||
|
||||
``hgfs_env_blacklist``
|
||||
**********************
|
||||
``hgfs_saltenv_blacklist``
|
||||
**************************
|
||||
|
||||
.. versionadded:: 2014.7.0
|
||||
.. versionchanged:: 2018.3.0
|
||||
Renamed from ``hgfs_env_blacklist`` to ``hgfs_saltenv_blacklist``
|
||||
|
||||
Default: ``[]``
|
||||
|
||||
|
|
@ -2936,19 +3301,35 @@ expression must match the entire minion ID.
|
|||
If used, branches/bookmarks/tags which match one of the specified expressions
|
||||
will *not* be exposed as fileserver environments.
|
||||
|
||||
If used in conjunction with :conf_master:`hgfs_env_whitelist`, then the subset
|
||||
If used in conjunction with :conf_master:`hgfs_saltenv_whitelist`, then the subset
|
||||
of branches/bookmarks/tags which match the whitelist but do *not* match the
|
||||
blacklist will be exposed as fileserver environments.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
hgfs_env_blacklist:
|
||||
hgfs_saltenv_blacklist:
|
||||
- base
|
||||
- v1.*
|
||||
- 'mybranch\d+'
|
||||
|
||||
svn: Subversion Remote File Server Backend
|
||||
------------------------------------------
|
||||
.. conf_master:: hgfs_update_interval
|
||||
|
||||
``hgfs_update_interval``
|
||||
************************
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
Default: ``60``
|
||||
|
||||
This option defines the update interval (in seconds) for
|
||||
:conf_master:`hgfs_remotes`.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
hgfs_update_interval: 120
|
||||
|
||||
svnfs: Subversion Remote File Server Backend
|
||||
--------------------------------------------
|
||||
|
||||
.. conf_master:: svnfs_remotes
|
||||
|
||||
|
|
@ -3098,12 +3479,14 @@ also be configured on a per-remote basis, see :conf_master:`here
|
|||
|
||||
svnfs_tags: tags
|
||||
|
||||
.. conf_master:: svnfs_env_whitelist
|
||||
.. conf_master:: svnfs_saltenv_whitelist
|
||||
|
||||
``svnfs_env_whitelist``
|
||||
***********************
|
||||
``svnfs_saltenv_whitelist``
|
||||
***************************
|
||||
|
||||
.. versionadded:: 2014.7.0
|
||||
.. versionchanged:: 2018.3.0
|
||||
Renamed from ``svnfs_env_whitelist`` to ``svnfs_saltenv_whitelist``
|
||||
|
||||
Default: ``[]``
|
||||
|
||||
|
|
@ -3115,23 +3498,25 @@ must match the entire minion ID.
|
|||
If used, only branches/tags which match one of the specified expressions will
|
||||
be exposed as fileserver environments.
|
||||
|
||||
If used in conjunction with :conf_master:`svnfs_env_blacklist`, then the subset
|
||||
If used in conjunction with :conf_master:`svnfs_saltenv_blacklist`, then the subset
|
||||
of branches/tags which match the whitelist but do *not* match the blacklist
|
||||
will be exposed as fileserver environments.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
svnfs_env_whitelist:
|
||||
svnfs_saltenv_whitelist:
|
||||
- base
|
||||
- v1.*
|
||||
- 'mybranch\d+'
|
||||
|
||||
.. conf_master:: svnfs_env_blacklist
|
||||
.. conf_master:: svnfs_saltenv_blacklist
|
||||
|
||||
``svnfs_env_blacklist``
|
||||
***********************
|
||||
``svnfs_saltenv_blacklist``
|
||||
***************************
|
||||
|
||||
.. versionadded:: 2014.7.0
|
||||
.. versionchanged:: 2018.3.0
|
||||
Renamed from ``svnfs_env_blacklist`` to ``svnfs_saltenv_blacklist``
|
||||
|
||||
Default: ``[]``
|
||||
|
||||
|
|
@ -3143,19 +3528,35 @@ expression must match the entire minion ID.
|
|||
If used, branches/tags which match one of the specified expressions will *not*
|
||||
be exposed as fileserver environments.
|
||||
|
||||
If used in conjunction with :conf_master:`svnfs_env_whitelist`, then the subset
|
||||
If used in conjunction with :conf_master:`svnfs_saltenv_whitelist`, then the subset
|
||||
of branches/tags which match the whitelist but do *not* match the blacklist
|
||||
will be exposed as fileserver environments.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
svnfs_env_blacklist:
|
||||
svnfs_saltenv_blacklist:
|
||||
- base
|
||||
- v1.*
|
||||
- 'mybranch\d+'
|
||||
|
||||
minion: MinionFS Remote File Server Backend
|
||||
-------------------------------------------
|
||||
.. conf_master:: svnfs_update_interval
|
||||
|
||||
``svnfs_update_interval``
|
||||
*************************
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
Default: ``60``
|
||||
|
||||
This option defines the update interval (in seconds) for
|
||||
:conf_master:`svnfs_remotes`.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
svnfs_update_interval: 120
|
||||
|
||||
minionfs: MinionFS Remote File Server Backend
|
||||
---------------------------------------------
|
||||
|
||||
.. conf_master:: minionfs_env
|
||||
|
||||
|
|
@ -3244,6 +3645,72 @@ exposed.
|
|||
- dev*
|
||||
- 'mail\d+.mydomain.tld'
|
||||
|
||||
.. conf_master:: minionfs_update_interval
|
||||
|
||||
``minionfs_update_interval``
|
||||
****************************
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
Default: ``60``
|
||||
|
||||
This option defines the update interval (in seconds) for :ref:`MinionFS
|
||||
<tutorial-minionfs>`.
|
||||
|
||||
.. note::
|
||||
Since :ref:`MinionFS <tutorial-minionfs>` consists of files local to the
|
||||
master, the update process for this fileserver backend just reaps the cache
|
||||
for this backend.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
minionfs_update_interval: 120
|
||||
|
||||
azurefs: Azure File Server Backend
|
||||
----------------------------------
|
||||
|
||||
.. versionadded:: 2015.8.0
|
||||
|
||||
See the :mod:`azurefs documentation <salt.fileserver.azurefs>` for usage
|
||||
examples.
|
||||
|
||||
.. conf_master:: azurefs_update_interval
|
||||
|
||||
``azurefs_update_interval``
|
||||
***************************
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
Default: ``60``
|
||||
|
||||
This option defines the update interval (in seconds) for azurefs.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
azurefs_update_interval: 120
|
||||
|
||||
s3fs: S3 File Server Backend
|
||||
----------------------------
|
||||
|
||||
.. versionadded:: 0.16.0
|
||||
|
||||
See the :mod:`s3fs documentation <salt.fileserver.s3fs>` for usage examples.
|
||||
|
||||
.. conf_master:: s3fs_update_interval
|
||||
|
||||
``s3fs_update_interval``
|
||||
************************
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
Default: ``60``
|
||||
|
||||
This option defines the update interval (in seconds) for s3fs.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
s3fs_update_interval: 120
|
||||
|
||||
|
||||
.. _pillar-configuration-master:
|
||||
|
||||
|
|
@ -3714,7 +4181,7 @@ they were created by a different master.
|
|||
Default: ``True``
|
||||
|
||||
Normally, when processing :ref:`git_pillar remotes
|
||||
<git-pillar-2015-8-0-and-later>`, if more than one repo under the same ``git``
|
||||
<git-pillar-configuration>`, if more than one repo under the same ``git``
|
||||
section in the ``ext_pillar`` configuration refers to the same pillar
|
||||
environment, then each repo in a given environment will have access to the
|
||||
other repos' files to be referenced in their top files. However, it may be
|
||||
|
|
@ -4637,6 +5104,21 @@ https://github.com/ytoolshed/range/wiki/%22yamlfile%22-module-file-spec
|
|||
Include Configuration
|
||||
=====================
|
||||
|
||||
Configuration can be loaded from multiple files. The order in which this is
|
||||
done is:
|
||||
|
||||
1. The master config file itself
|
||||
|
||||
2. The files matching the glob in :conf_master:`default_include`
|
||||
|
||||
3. The files matching the glob in :conf_master:`include` (if defined)
|
||||
|
||||
Each successive step overrides any values defined in the previous steps.
|
||||
Therefore, any config options defined in one of the
|
||||
:conf_master:`default_include` files would override the same value in the
|
||||
master config file, and any options defined in :conf_master:`include` would
|
||||
override both.
|
||||
|
||||
.. conf_master:: default_include
|
||||
|
||||
``default_include``
|
||||
|
|
|
|||
|
|
@ -133,6 +133,24 @@ name) is set in the :conf_minion:`master` configuration setting.
|
|||
|
||||
master_uri_format: ip_only
|
||||
|
||||
.. conf_minion:: master_tops_first
|
||||
|
||||
``master_tops_first``
|
||||
---------------------
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
Default: ``False``
|
||||
|
||||
SLS targets defined using the :ref:`Master Tops <master-tops-system>` system
|
||||
are normally executed *after* any matches defined in the :ref:`Top File
|
||||
<states-top>`. Set this option to ``True`` to have the minion execute the
|
||||
:ref:`Master Tops <master-tops-system>` states first.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
master_tops_first: True
|
||||
|
||||
.. conf_minion:: master_type
|
||||
|
||||
``master_type``
|
||||
|
|
@ -289,6 +307,23 @@ Set to zero if the minion should shutdown and not retry.
|
|||
|
||||
retry_dns: 30
|
||||
|
||||
.. conf_minion:: retry_dns_count
|
||||
|
||||
``retry_dns_count``
|
||||
-------------------
|
||||
|
||||
.. versionadded:: 2018.3.4
|
||||
|
||||
Default: ``None``
|
||||
|
||||
Set the number of attempts to perform when resolving
|
||||
the master hostname if name resolution fails.
|
||||
By default the minion will retry indefinitely.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
retry_dns_count: 3
|
||||
|
||||
.. conf_minion:: master_port
|
||||
|
||||
``master_port``
|
||||
|
|
@ -317,6 +352,117 @@ option on the Salt master.
|
|||
|
||||
publish_port: 4505
|
||||
|
||||
.. conf_minion:: source_interface_name
|
||||
|
||||
``source_interface_name``
|
||||
-------------------------
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
The name of the interface to use when establishing the connection to the Master.
|
||||
|
||||
.. note::
|
||||
|
||||
If multiple IP addresses are configured on the named interface,
|
||||
the first one will be selected. In that case, for a better selection,
|
||||
consider using the :conf_minion:`source_address` option.
|
||||
|
||||
.. note::
|
||||
|
||||
To use an IPv6 address from the named interface, make sure the option
|
||||
:conf_minion:`ipv6` is enabled, i.e., ``ipv6: true``.
|
||||
|
||||
.. note::
|
||||
|
||||
If the interface is down, it will avoid using it, and the Minion
|
||||
will bind to ``0.0.0.0`` (all interfaces).
|
||||
|
||||
.. warning::
|
||||
|
||||
This option requires modern version of the underlying libraries used by
|
||||
the selected transport:
|
||||
|
||||
- ``zeromq`` requires ``pyzmq`` >= 16.0.1 and ``libzmq`` >= 4.1.6
|
||||
- ``tcp`` requires ``tornado`` >= 4.5
|
||||
|
||||
Configuration example:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
source_interface_name: bond0.1234
|
||||
|
||||
.. conf_minion:: source_address
|
||||
|
||||
``source_address``
|
||||
------------------
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
The source IP address or the domain name to be used when connecting the Minion
|
||||
to the Master.
|
||||
See :conf_minion:`ipv6` for IPv6 connections to the Master.
|
||||
|
||||
.. warning::
|
||||
|
||||
This option requires modern version of the underlying libraries used by
|
||||
the selected transport:
|
||||
|
||||
- ``zeromq`` requires ``pyzmq`` >= 16.0.1 and ``libzmq`` >= 4.1.6
|
||||
- ``tcp`` requires ``tornado`` >= 4.5
|
||||
|
||||
Configuration example:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
source_address: if-bond0-1234.sjc.us-west.internal
|
||||
|
||||
.. conf_minion:: source_ret_port
|
||||
|
||||
``source_ret_port``
|
||||
-------------------
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
The source port to be used when connecting the Minion to the Master ret server.
|
||||
|
||||
.. warning::
|
||||
|
||||
This option requires modern version of the underlying libraries used by
|
||||
the selected transport:
|
||||
|
||||
- ``zeromq`` requires ``pyzmq`` >= 16.0.1 and ``libzmq`` >= 4.1.6
|
||||
- ``tcp`` requires ``tornado`` >= 4.5
|
||||
|
||||
Configuration example:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
source_ret_port: 49017
|
||||
|
||||
.. conf_minion:: source_publish_port
|
||||
|
||||
``source_publish_port``
|
||||
-----------------------
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
The source port to be used when connecting the Minion to the Master publish
|
||||
server.
|
||||
|
||||
.. warning::
|
||||
|
||||
This option requires modern version of the underlying libraries used by
|
||||
the selected transport:
|
||||
|
||||
- ``zeromq`` requires ``pyzmq`` >= 16.0.1 and ``libzmq`` >= 4.1.6
|
||||
- ``tcp`` requires ``tornado`` >= 4.5
|
||||
|
||||
Configuration example:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
source_publish_port: 49018
|
||||
|
||||
.. conf_minion:: user
|
||||
|
||||
``user``
|
||||
|
|
@ -462,6 +608,20 @@ FQDN (for instance, Solaris).
|
|||
|
||||
append_domain: foo.org
|
||||
|
||||
.. conf_minion:: minion_id_lowercase
|
||||
|
||||
``minion_id_lowercase``
|
||||
-----------------------
|
||||
|
||||
Default: ``False``
|
||||
|
||||
Convert minion id to lowercase when it is being generated. Helpful when some hosts
|
||||
get the minion id in uppercase. Cached ids will remain the same and not converted.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
minion_id_lowercase: True
|
||||
|
||||
.. conf_minion:: cachedir
|
||||
|
||||
``cachedir``
|
||||
|
|
@ -477,6 +637,19 @@ This directory may contain sensitive data and should be protected accordingly.
|
|||
|
||||
cachedir: /var/cache/salt/minion
|
||||
|
||||
.. conf_master:: color_theme
|
||||
|
||||
``color_theme``
|
||||
---------------
|
||||
|
||||
Default: ``""``
|
||||
|
||||
Specifies a path to the color theme to use for colored command line output.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
color_theme: /etc/salt/color_theme
|
||||
|
||||
.. conf_minion:: append_minionid_config_dirs
|
||||
|
||||
``append_minionid_config_dirs``
|
||||
|
|
@ -630,6 +803,52 @@ A value of 10 minutes is a reasonable default.
|
|||
|
||||
grains_refresh_every: 0
|
||||
|
||||
.. conf_minion:: metadata_server_grains
|
||||
|
||||
``metadata_server_grains``
|
||||
--------------------------
|
||||
|
||||
.. versionadded:: 2017.7.0
|
||||
|
||||
Default: ``False``
|
||||
|
||||
Set this option to enable gathering of cloud metadata from
|
||||
``http://169.254.169.254/latest`` for use in grains (see :py:mod:`here
|
||||
<salt.grains.metadata>` for more information).
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
metadata_server_grains: True
|
||||
|
||||
.. conf_minion:: fibre_channel_grains
|
||||
|
||||
``fibre_channel_grains``
|
||||
------------------------
|
||||
|
||||
Default: ``False``
|
||||
|
||||
The ``fibre_channel_grains`` setting will enable the ``fc_wwn`` grain for
|
||||
Fibre Channel WWN's on the minion. Since this grain is expensive, it is
|
||||
disabled by default.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
fibre_channel_grains: True
|
||||
|
||||
.. conf_minion:: iscsi_grains
|
||||
|
||||
``iscsi_grains``
|
||||
------------------------
|
||||
|
||||
Default: ``False``
|
||||
|
||||
The ``iscsi_grains`` setting will enable the ``iscsi_iqn`` grain on the
|
||||
minion. Since this grain is expensive, it is disabled by default.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
iscsi_grains: True
|
||||
|
||||
.. conf_minion:: mine_enabled
|
||||
|
||||
``mine_enabled``
|
||||
|
|
@ -1211,6 +1430,40 @@ option to ``False`` to keep Salt from updating the mine with this information.
|
|||
|
||||
docker.update_mine: False
|
||||
|
||||
.. conf_minion:: docker.compare_container_networks
|
||||
|
||||
``docker.compare_container_networks``
|
||||
-------------------------------------
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
Default: ``{'static': ['Aliases', 'Links', 'IPAMConfig'], 'automatic': ['IPAddress', 'Gateway', 'GlobalIPv6Address', 'IPv6Gateway']}``
|
||||
|
||||
Specifies which keys are examined by
|
||||
:py:func:`docker.compare_container_networks
|
||||
<salt.modules.dockermod.compare_container_networks>`.
|
||||
|
||||
.. note::
|
||||
This should not need to be modified unless new features added to Docker
|
||||
result in new keys added to the network configuration which must be
|
||||
compared to determine if two containers have different network configs.
|
||||
This config option exists solely as a way to allow users to continue using
|
||||
Salt to manage their containers after an API change, without waiting for a
|
||||
new Salt release to catch up to the changes in the Docker API.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
docker.compare_container_networks:
|
||||
static:
|
||||
- Aliases
|
||||
- Links
|
||||
- IPAMConfig
|
||||
automatic:
|
||||
- IPAddress
|
||||
- Gateway
|
||||
- GlobalIPv6Address
|
||||
- IPv6Gateway
|
||||
|
||||
.. conf_minion:: optimization_order
|
||||
|
||||
``optimization_order``
|
||||
|
|
@ -1231,19 +1484,20 @@ the priority of optimization level(s) Salt's module loader should prefer.
|
|||
- 0
|
||||
- 1
|
||||
|
||||
Minion Module Management
|
||||
========================
|
||||
Minion Execution Module Management
|
||||
==================================
|
||||
|
||||
.. conf_minion:: disable_modules
|
||||
|
||||
``disable_modules``
|
||||
-------------------
|
||||
|
||||
Default: ``[]`` (all modules are enabled by default)
|
||||
Default: ``[]`` (all execution 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.
|
||||
be able to execute a certain module.
|
||||
|
||||
However, 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 lower the minion's memory footprint.
|
||||
|
|
@ -1282,7 +1536,8 @@ Default: ``[]`` (Module whitelisting is disabled. Adding anything to the config
|
|||
will cause only the listed modules to be enabled. Modules not in the list will
|
||||
not be loaded.)
|
||||
|
||||
This option is the reverse of disable_modules.
|
||||
This option is the reverse of disable_modules. If enabled, only execution modules in this
|
||||
list will be loaded and executed on the minion.
|
||||
|
||||
Note that this is a very large hammer and it can be quite difficult to keep the minion working
|
||||
the way you think it should since Salt uses many modules internally itself. At a bare minimum
|
||||
|
|
@ -1714,15 +1969,19 @@ output for states that failed or states that have changes.
|
|||
|
||||
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.
|
||||
The state_output setting controls which results will be output full multi line:
|
||||
|
||||
* ``full``, ``terse`` - each state will be full/terse
|
||||
* ``mixed`` - only states with errors will be full
|
||||
* ``changes`` - states with changes and errors will be full
|
||||
|
||||
``full_id``, ``mixed_id``, ``changes_id`` and ``terse_id`` are also allowed;
|
||||
when set, the state ID will be used as name in the output.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
state_output: full
|
||||
|
||||
|
||||
.. conf_minion:: state_output_diff
|
||||
|
||||
``state_output_diff``
|
||||
|
|
@ -1771,9 +2030,15 @@ enabled and can be disabled by changing this value to ``False``.
|
|||
If ``extmod_whitelist`` is specified, modules which are not whitelisted will also be cleaned here.
|
||||
|
||||
.. conf_minion:: environment
|
||||
.. conf_minion:: saltenv
|
||||
|
||||
``environment``
|
||||
---------------
|
||||
``saltenv``
|
||||
-----------
|
||||
|
||||
.. versionchanged:: 2018.3.0
|
||||
Renamed from ``environment`` to ``saltenv``. If ``environment`` is used,
|
||||
``saltenv`` will take its value. If both are used, ``environment`` will be
|
||||
ignored and ``saltenv`` will be used.
|
||||
|
||||
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
|
||||
|
|
@ -1782,7 +2047,25 @@ environments is to isolate via the top file.
|
|||
|
||||
.. code-block:: yaml
|
||||
|
||||
environment: dev
|
||||
saltenv: dev
|
||||
|
||||
.. conf_minion:: lock_saltenv
|
||||
|
||||
``lock_saltenv``
|
||||
----------------
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
Default: ``False``
|
||||
|
||||
For purposes of running states, this option prevents using the ``saltenv``
|
||||
argument to manually set the environment. This is useful to keep a minion which
|
||||
has the :conf_minion:`saltenv` option set to ``dev`` from running states from
|
||||
an environment other than ``dev``.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
lock_saltenv: True
|
||||
|
||||
.. conf_minion:: snapper_states
|
||||
|
||||
|
|
@ -2163,6 +2446,41 @@ It will be interpreted as megabytes.
|
|||
|
||||
file_recv_max_size: 100
|
||||
|
||||
.. conf_minion:: pass_to_ext_pillars
|
||||
|
||||
``pass_to_ext_pillars``
|
||||
-----------------------
|
||||
|
||||
Specify a list of configuration keys whose values are to be passed to
|
||||
external pillar functions.
|
||||
|
||||
Suboptions can be specified using the ':' notation (i.e. ``option:suboption``)
|
||||
|
||||
The values are merged and included in the ``extra_minion_data`` optional
|
||||
parameter of the external pillar function. The ``extra_minion_data`` parameter
|
||||
is passed only to the external pillar functions that have it explicitly
|
||||
specified in their definition.
|
||||
|
||||
If the config contains
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
opt1: value1
|
||||
opt2:
|
||||
subopt1: value2
|
||||
subopt2: value3
|
||||
|
||||
pass_to_ext_pillars:
|
||||
- opt1
|
||||
- opt2: subopt1
|
||||
|
||||
the ``extra_minion_data`` parameter will be
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
{'opt1': 'value1',
|
||||
'opt2': {'subopt1': 'value2'}}
|
||||
|
||||
Security Settings
|
||||
=================
|
||||
|
||||
|
|
@ -2263,6 +2581,27 @@ minion's pki directory.
|
|||
|
||||
master_sign_key_name: <filename_without_suffix>
|
||||
|
||||
.. conf_minion:: autosign_grains
|
||||
|
||||
``autosign_grains``
|
||||
-------------------
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
Default: ``not defined``
|
||||
|
||||
The grains that should be sent to the master on authentication to decide if
|
||||
the minion's key should be accepted automatically.
|
||||
|
||||
Please see the :ref:`Autoaccept Minions from Grains <tutorial-autoaccept-grains>`
|
||||
documentation for more information.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
autosign_grains:
|
||||
- uuid
|
||||
- server_id
|
||||
|
||||
.. conf_minion:: always_verify_signature
|
||||
|
||||
``always_verify_signature``
|
||||
|
|
@ -2435,6 +2774,23 @@ executed in a thread.
|
|||
|
||||
multiprocessing: True
|
||||
|
||||
.. conf_minion:: process_count_max
|
||||
|
||||
``process_count_max``
|
||||
---------------------
|
||||
|
||||
.. versionadded:: 2018.3.0
|
||||
|
||||
Default: ``-1``
|
||||
|
||||
Limit the maximum amount of processes or threads created by ``salt-minion``.
|
||||
This is useful to avoid resource exhaustion in case the minion receives more
|
||||
publications than it is able to handle, as it limits the number of spawned
|
||||
processes or threads. ``-1`` is the default and disables the limit.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
process_count_max: -1
|
||||
|
||||
.. _minion-logging-settings:
|
||||
|
||||
|
|
@ -2641,7 +2997,22 @@ at the moment a single state fails
|
|||
Include Configuration
|
||||
=====================
|
||||
|
||||
.. conf_minion:: include
|
||||
Configuration can be loaded from multiple files. The order in which this is
|
||||
done is:
|
||||
|
||||
1. The minion config file itself
|
||||
|
||||
2. The files matching the glob in :conf_minion:`default_include`
|
||||
|
||||
3. The files matching the glob in :conf_minion:`include` (if defined)
|
||||
|
||||
Each successive step overrides any values defined in the previous steps.
|
||||
Therefore, any config options defined in one of the
|
||||
:conf_minion:`default_include` files would override the same value in the
|
||||
minion config file, and any options defined in :conf_minion:`include` would
|
||||
override both.
|
||||
|
||||
.. conf_minion:: default_include
|
||||
|
||||
``default_include``
|
||||
-------------------
|
||||
|
|
@ -2659,6 +3030,7 @@ file.
|
|||
files are prefixed with an underscore. A common example of this is the
|
||||
``_schedule.conf`` file.
|
||||
|
||||
.. conf_minion:: include
|
||||
|
||||
``include``
|
||||
-----------
|
||||
|
|
@ -2965,3 +3337,31 @@ URL of the repository:
|
|||
Replace ``<commit_id>`` 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.
|
||||
|
||||
``ssh_merge_pillar``
|
||||
--------------------
|
||||
|
||||
.. versionadded:: 2018.3.2
|
||||
|
||||
Default: ``True``
|
||||
|
||||
Merges the compiled pillar data with the pillar data already available globally.
|
||||
This is useful when using ``salt-ssh`` or ``salt-call --local`` and overriding the pillar
|
||||
data in a state file:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
apply_showpillar:
|
||||
module.run:
|
||||
- name: state.apply
|
||||
- mods:
|
||||
- showpillar
|
||||
- kwargs:
|
||||
pillar:
|
||||
test: "foo bar"
|
||||
|
||||
If set to ``True`` the ``showpillar`` state will have access to the
|
||||
global pillar data.
|
||||
|
||||
If set to ``False`` only the overriding pillar data will be available
|
||||
to the ``showpillar`` state.
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ engine modules
|
|||
ircbot
|
||||
junos_syslog
|
||||
logentries
|
||||
logstash
|
||||
logstash_engine
|
||||
napalm_syslog
|
||||
reactor
|
||||
redis_sentinel
|
||||
|
|
|
|||
|
|
@ -1,6 +0,0 @@
|
|||
=====================
|
||||
salt.engines.logstash
|
||||
=====================
|
||||
|
||||
.. automodule:: salt.engines.logstash
|
||||
:members:
|
||||
6
doc/ref/engines/all/salt.engines.logstash_engine.rst
Normal file
6
doc/ref/engines/all/salt.engines.logstash_engine.rst
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
============================
|
||||
salt.engines.logstash_engine
|
||||
============================
|
||||
|
||||
.. automodule:: salt.engines.logstash_engine
|
||||
:members:
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
.. _all-salt_executors:
|
||||
.. _all-salt.executors:
|
||||
|
||||
=================
|
||||
executors modules
|
||||
|
|
|
|||
85
doc/ref/executors/index.rst
Normal file
85
doc/ref/executors/index.rst
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
.. _executors:
|
||||
|
||||
=========
|
||||
Executors
|
||||
=========
|
||||
|
||||
Executors are used by minion to execute module functions. Executors can be used
|
||||
to modify the functions behavior, do any pre-execution steps or execute in a
|
||||
specific way like sudo executor.
|
||||
|
||||
Executors could be passed as a list and they will be used one-by-one in the
|
||||
order. If an executor returns ``None`` the next one will be called. If an
|
||||
executor returns non-``None`` the execution sequence is terminated and the
|
||||
returned value is used as a result. It's a way executor could control modules
|
||||
execution working as a filter. Note that executor could actually not execute
|
||||
the function but just do something else and return ``None`` like ``splay``
|
||||
executor does. In this case some other executor have to be used as a final
|
||||
executor that will actually execute the function. See examples below.
|
||||
|
||||
Executors list could be passed by minion config file in the following way:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
module_executors:
|
||||
- splay
|
||||
- direct_call
|
||||
splaytime: 30
|
||||
|
||||
The same could be done by command line:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
salt -t 40 --module-executors='[splay, direct_call]' --executor-opts='{splaytime: 30}' '*' test.ping
|
||||
|
||||
And the same command called via netapi will look like this:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
curl -sSk https://localhost:8000 \
|
||||
-H 'Accept: application/x-yaml' \
|
||||
-H 'X-Auth-Token: 697adbdc8fe971d09ae4c2a3add7248859c87079' \
|
||||
-H 'Content-type: application/json' \
|
||||
-d '[{
|
||||
"client": "local",
|
||||
"tgt": "*",
|
||||
"fun": "test.ping",
|
||||
"module_executors": ["splay", "direct_call"],
|
||||
"executor_opts": {"splaytime": 10}
|
||||
}]'
|
||||
|
||||
.. seealso:: :ref:`The full list of executors <all-salt.executors>`
|
||||
|
||||
Writing Salt Executors
|
||||
----------------------
|
||||
|
||||
A Salt executor is written in a similar manner to a Salt execution module.
|
||||
Executor is a python module placed into the ``executors`` folder and containing
|
||||
the ``execute`` function with the following signature:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
def execute(opts, data, func, args, kwargs)
|
||||
|
||||
Where the args are:
|
||||
|
||||
``opts``:
|
||||
Dictionary containing the minion configuration options
|
||||
``data``:
|
||||
Dictionary containing the load data including ``executor_opts`` passed via
|
||||
cmdline/API.
|
||||
``func``, ``args``, ``kwargs``:
|
||||
Execution module function to be executed and it's arguments. For instance the
|
||||
simplest ``direct_call`` executor just runs it as ``func(*args, **kwargs)``.
|
||||
``Returns``:
|
||||
``None`` if the execution sequence must be continued with the next executor.
|
||||
Error string or execution result if the job is done and execution must be
|
||||
stopped.
|
||||
|
||||
Specific options could be passed to the executor via minion config or via
|
||||
``executor_opts`` argument. For instance to access ``splaytime`` option set by
|
||||
minion config executor should access ``opts.get('splaytime')``. To access the
|
||||
option set by commandline or API ``data.get('executor_opts',
|
||||
{}).get('splaytime')`` should be used. So if an option is safe and must be
|
||||
accessible by user executor should check it in both places, but if an option is
|
||||
unsafe it should be read from the only config ignoring the passed request data.
|
||||
|
|
@ -9,6 +9,7 @@ execution modules
|
|||
.. toctree::
|
||||
|
||||
salt.modules.group
|
||||
salt.modules.kernelpkg
|
||||
salt.modules.pkg
|
||||
salt.modules.service
|
||||
salt.modules.shadow
|
||||
|
|
@ -24,10 +25,11 @@ execution modules
|
|||
aix_group
|
||||
aliases
|
||||
alternatives
|
||||
ansiblegate
|
||||
apache
|
||||
apcups
|
||||
apf
|
||||
apk
|
||||
apkpkg
|
||||
aptpkg
|
||||
archive
|
||||
artifactory
|
||||
|
|
@ -39,13 +41,13 @@ execution modules
|
|||
bcache
|
||||
beacons
|
||||
bigip
|
||||
blockdev
|
||||
bluez
|
||||
bluez_bluetooth
|
||||
boto3_elasticache
|
||||
boto3_route53
|
||||
boto_apigateway
|
||||
boto_asg
|
||||
boto_cfn
|
||||
boto_cloudfront
|
||||
boto_cloudtrail
|
||||
boto_cloudwatch
|
||||
boto_cloudwatch_event
|
||||
|
|
@ -98,10 +100,11 @@ execution modules
|
|||
cyg
|
||||
daemontools
|
||||
data
|
||||
datadog_api
|
||||
ddns
|
||||
deb_apache
|
||||
deb_postgres
|
||||
debbuild
|
||||
debuild_pkgbuild
|
||||
debconfmod
|
||||
debian_ip
|
||||
debian_service
|
||||
|
|
@ -114,13 +117,13 @@ execution modules
|
|||
dnsutil
|
||||
dockercompose
|
||||
dockermod
|
||||
dpkg
|
||||
dpkg_lowpkg
|
||||
drac
|
||||
dracr
|
||||
drbd
|
||||
dummyproxy_package
|
||||
dummyproxy_pkg
|
||||
dummyproxy_service
|
||||
ebuild
|
||||
ebuildpkg
|
||||
eix
|
||||
elasticsearch
|
||||
environ
|
||||
|
|
@ -146,6 +149,7 @@ execution modules
|
|||
git
|
||||
github
|
||||
glance
|
||||
glanceng
|
||||
glusterfs
|
||||
gnomedesktop
|
||||
gpg
|
||||
|
|
@ -161,14 +165,13 @@ execution modules
|
|||
hg
|
||||
hipchat
|
||||
hosts
|
||||
htpasswd
|
||||
http
|
||||
ifttt
|
||||
ilo
|
||||
icinga2
|
||||
incron
|
||||
influx
|
||||
influx08
|
||||
influxdbmod
|
||||
influxdb08mod
|
||||
infoblox
|
||||
ini_manage
|
||||
inspectlib
|
||||
|
|
@ -192,16 +195,22 @@ execution modules
|
|||
k8s
|
||||
kapacitor
|
||||
kerberos
|
||||
kernelpkg_linux_apt
|
||||
kernelpkg_linux_yum
|
||||
key
|
||||
keyboard
|
||||
keystone
|
||||
keystoneng
|
||||
kmod
|
||||
kubernetes
|
||||
launchctl
|
||||
kubernetesmod
|
||||
launchctl_service
|
||||
layman
|
||||
ldap3
|
||||
ldapmod
|
||||
libcloud_compute
|
||||
libcloud_dns
|
||||
libcloud_loadbalancer
|
||||
libcloud_storage
|
||||
linux_acl
|
||||
linux_ip
|
||||
linux_lvm
|
||||
|
|
@ -214,14 +223,14 @@ execution modules
|
|||
lvs
|
||||
lxc
|
||||
mac_assistive
|
||||
mac_brew
|
||||
mac_defaults
|
||||
mac_brew_pkg
|
||||
macdefaults
|
||||
mac_desktop
|
||||
mac_group
|
||||
mac_keychain
|
||||
mac_package
|
||||
macpackage
|
||||
mac_pkgutil
|
||||
mac_ports
|
||||
mac_portspkg
|
||||
mac_power
|
||||
mac_service
|
||||
mac_shadow
|
||||
|
|
@ -232,10 +241,11 @@ execution modules
|
|||
mac_user
|
||||
mac_xattr
|
||||
makeconf
|
||||
mandrill
|
||||
marathon
|
||||
match
|
||||
mattermost
|
||||
mdadm
|
||||
mdadm_raid
|
||||
mdata
|
||||
memcached
|
||||
mine
|
||||
|
|
@ -253,13 +263,13 @@ execution modules
|
|||
nacl
|
||||
nagios
|
||||
nagios_rpc
|
||||
namecheap_dns
|
||||
namecheap_domains_dns
|
||||
namecheap_domains
|
||||
namecheap_ns
|
||||
namecheap_domains_ns
|
||||
namecheap_ssl
|
||||
namecheap_users
|
||||
napalm
|
||||
napalm_acl
|
||||
napalm_netacl
|
||||
napalm_bgp
|
||||
napalm_network
|
||||
napalm_ntp
|
||||
|
|
@ -269,11 +279,13 @@ execution modules
|
|||
napalm_users
|
||||
napalm_yang_mod
|
||||
netaddress
|
||||
netbox
|
||||
netbsd_sysctl
|
||||
netbsdservice
|
||||
netscaler
|
||||
network
|
||||
neutron
|
||||
neutronng
|
||||
nfs3
|
||||
nftables
|
||||
nginx
|
||||
|
|
@ -286,21 +298,23 @@ execution modules
|
|||
omapi
|
||||
openbsd_sysctl
|
||||
openbsdpkg
|
||||
openbsdrcctl
|
||||
openbsdrcctl_service
|
||||
openbsdservice
|
||||
openscap
|
||||
openstack_config
|
||||
openstack_mng
|
||||
openvswitch
|
||||
opkg
|
||||
opsgenie
|
||||
oracle
|
||||
osquery
|
||||
pacman
|
||||
out
|
||||
pacmanpkg
|
||||
pagerduty
|
||||
pagerduty_util
|
||||
pam
|
||||
parallels
|
||||
parted
|
||||
parted_partition
|
||||
pcs
|
||||
pdbedit
|
||||
pecl
|
||||
|
|
@ -320,6 +334,7 @@ execution modules
|
|||
ps
|
||||
publish
|
||||
puppet
|
||||
purefa
|
||||
pushbullet
|
||||
pushover_notify
|
||||
pw_group
|
||||
|
|
@ -337,7 +352,7 @@ execution modules
|
|||
rdp
|
||||
redismod
|
||||
reg
|
||||
rest_package
|
||||
rest_pkg
|
||||
rest_sample_utils
|
||||
rest_service
|
||||
restartcheck
|
||||
|
|
@ -345,14 +360,15 @@ execution modules
|
|||
rh_ip
|
||||
rh_service
|
||||
riak
|
||||
rpm
|
||||
rpmbuild
|
||||
rpm_lowpkg
|
||||
rpmbuild_pkgbuild
|
||||
rsync
|
||||
runit
|
||||
rvm
|
||||
s3
|
||||
s6
|
||||
salt_proxy
|
||||
saltcheck
|
||||
saltcloudmod
|
||||
saltutil
|
||||
schedule
|
||||
|
|
@ -373,14 +389,14 @@ execution modules
|
|||
smartos_virt
|
||||
smartos_vmadm
|
||||
smbios
|
||||
smf
|
||||
smf_service
|
||||
smtp
|
||||
solaris_fmadm
|
||||
solaris_group
|
||||
solaris_shadow
|
||||
solaris_system
|
||||
solaris_user
|
||||
solarisips
|
||||
solarisipspkg
|
||||
solarispkg
|
||||
solr
|
||||
solrcloud
|
||||
|
|
@ -388,16 +404,16 @@ execution modules
|
|||
splunk_search
|
||||
sqlite3
|
||||
ssh
|
||||
ssh_package
|
||||
ssh_pkg
|
||||
ssh_service
|
||||
snapper
|
||||
state
|
||||
status
|
||||
statuspage
|
||||
stormpath
|
||||
supervisord
|
||||
suse_apache
|
||||
svn
|
||||
swarm
|
||||
swift
|
||||
sysbench
|
||||
sysfs
|
||||
|
|
@ -406,12 +422,14 @@ execution modules
|
|||
sysrc
|
||||
system
|
||||
system_profiler
|
||||
systemd
|
||||
systemd_service
|
||||
telegram
|
||||
telemetry
|
||||
temp
|
||||
test
|
||||
testinframod
|
||||
test_virtual
|
||||
textfsm_mod
|
||||
timezone
|
||||
tls
|
||||
tomcat
|
||||
|
|
@ -420,10 +438,11 @@ execution modules
|
|||
tuned
|
||||
twilio_notify
|
||||
udev
|
||||
upstart
|
||||
upstart_service
|
||||
uptime
|
||||
useradd
|
||||
uwsgi
|
||||
vagrant
|
||||
varnish
|
||||
vault
|
||||
vbox_guest
|
||||
|
|
@ -432,6 +451,7 @@ execution modules
|
|||
virt
|
||||
virtualenv_mod
|
||||
vsphere
|
||||
webutil
|
||||
win_autoruns
|
||||
win_certutil
|
||||
win_dacl
|
||||
|
|
@ -453,7 +473,7 @@ execution modules
|
|||
win_pki
|
||||
win_powercfg
|
||||
win_psget
|
||||
win_repo
|
||||
winrepo
|
||||
win_servermanager
|
||||
win_service
|
||||
win_shadow
|
||||
|
|
@ -467,7 +487,7 @@ execution modules
|
|||
win_useradd
|
||||
win_wua
|
||||
x509
|
||||
xapi
|
||||
xapi_virt
|
||||
xbpspkg
|
||||
xfs
|
||||
xmpp
|
||||
|
|
@ -480,5 +500,6 @@ execution modules
|
|||
znc
|
||||
zoneadm
|
||||
zonecfg
|
||||
zookeeper
|
||||
zpool
|
||||
zypper
|
||||
zypperpkg
|
||||
|
|
|
|||
6
doc/ref/modules/all/salt.modules.ansiblegate.rst
Normal file
6
doc/ref/modules/all/salt.modules.ansiblegate.rst
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
========================
|
||||
salt.modules.ansiblegate
|
||||
========================
|
||||
|
||||
.. automodule:: salt.modules.ansiblegate
|
||||
:members:
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
salt.modules.apk module
|
||||
=======================
|
||||
|
||||
.. automodule:: salt.modules.apk
|
||||
:members:
|
||||
:undoc-members:
|
||||
7
doc/ref/modules/all/salt.modules.apkpkg.rst
Normal file
7
doc/ref/modules/all/salt.modules.apkpkg.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
===================
|
||||
salt.modules.apkpkg
|
||||
===================
|
||||
|
||||
.. automodule:: salt.modules.apkpkg
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
=====================
|
||||
salt.modules.blockdev
|
||||
=====================
|
||||
|
||||
.. automodule:: salt.modules.blockdev
|
||||
:members:
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
==================
|
||||
salt.modules.bluez
|
||||
==================
|
||||
|
||||
.. automodule:: salt.modules.bluez
|
||||
:members:
|
||||
6
doc/ref/modules/all/salt.modules.bluez_bluetooth.rst
Normal file
6
doc/ref/modules/all/salt.modules.bluez_bluetooth.rst
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
============================
|
||||
salt.modules.bluez_bluetooth
|
||||
============================
|
||||
|
||||
.. automodule:: salt.modules.bluez_bluetooth
|
||||
:members:
|
||||
6
doc/ref/modules/all/salt.modules.boto_cloudfront.rst
Normal file
6
doc/ref/modules/all/salt.modules.boto_cloudfront.rst
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
============================
|
||||
salt.modules.boto_cloudfront
|
||||
============================
|
||||
|
||||
.. automodule:: salt.modules.boto_cloudfront
|
||||
:members:
|
||||
6
doc/ref/modules/all/salt.modules.datadog_api.rst
Normal file
6
doc/ref/modules/all/salt.modules.datadog_api.rst
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
========================
|
||||
salt.modules.datadog_api
|
||||
========================
|
||||
|
||||
.. automodule:: salt.modules.datadog_api
|
||||
:members:
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
=====================
|
||||
salt.modules.debbuild
|
||||
=====================
|
||||
|
||||
.. automodule:: salt.modules.debbuild
|
||||
:members:
|
||||
|
|
@ -1,7 +1,6 @@
|
|||
==============================
|
||||
salt.modules.napalm_acl module
|
||||
salt.modules.debuild_pkgbuild
|
||||
==============================
|
||||
|
||||
.. automodule:: salt.modules.napalm_acl
|
||||
.. automodule:: salt.modules.debuild_pkgbuild
|
||||
:members:
|
||||
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
=================
|
||||
salt.modules.dpkg
|
||||
=================
|
||||
|
||||
.. automodule:: salt.modules.dpkg
|
||||
:members:
|
||||
6
doc/ref/modules/all/salt.modules.dpkg_lowpkg.rst
Normal file
6
doc/ref/modules/all/salt.modules.dpkg_lowpkg.rst
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
========================
|
||||
salt.modules.dpkg_lowpkg
|
||||
========================
|
||||
|
||||
.. automodule:: salt.modules.dpkg_lowpkg
|
||||
:members:
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
salt.modules.dummyproxy_package module
|
||||
======================================
|
||||
|
||||
.. automodule:: salt.modules.dummyproxy_package
|
||||
:members:
|
||||
:undoc-members:
|
||||
7
doc/ref/modules/all/salt.modules.dummyproxy_pkg.rst
Normal file
7
doc/ref/modules/all/salt.modules.dummyproxy_pkg.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
==================================
|
||||
salt.modules.dummyproxy_pkg module
|
||||
==================================
|
||||
|
||||
.. automodule:: salt.modules.dummyproxy_pkg
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
===================
|
||||
salt.modules.ebuild
|
||||
===================
|
||||
|
||||
.. automodule:: salt.modules.ebuild
|
||||
:members:
|
||||
:exclude-members: available_version
|
||||
7
doc/ref/modules/all/salt.modules.ebuildpkg.rst
Normal file
7
doc/ref/modules/all/salt.modules.ebuildpkg.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
======================
|
||||
salt.modules.ebuildpkg
|
||||
======================
|
||||
|
||||
.. automodule:: salt.modules.ebuildpkg
|
||||
:members:
|
||||
:exclude-members: available_version
|
||||
6
doc/ref/modules/all/salt.modules.glanceng.rst
Normal file
6
doc/ref/modules/all/salt.modules.glanceng.rst
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
=====================
|
||||
salt.modules.glanceng
|
||||
=====================
|
||||
|
||||
.. automodule:: salt.modules.glanceng
|
||||
:members:
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
=====================
|
||||
salt.modules.htpasswd
|
||||
=====================
|
||||
|
||||
.. automodule:: salt.modules.htpasswd
|
||||
:members:
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
===================
|
||||
salt.modules.influx
|
||||
===================
|
||||
|
||||
.. automodule:: salt.modules.influx
|
||||
:members:
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
salt.modules.influx08 module
|
||||
============================
|
||||
|
||||
.. automodule:: salt.modules.influx08
|
||||
:members:
|
||||
:undoc-members:
|
||||
7
doc/ref/modules/all/salt.modules.influxdb08mod.rst
Normal file
7
doc/ref/modules/all/salt.modules.influxdb08mod.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
==========================
|
||||
salt.modules.influxdb08mod
|
||||
==========================
|
||||
|
||||
.. automodule:: salt.modules.influxdb08mod
|
||||
:members:
|
||||
:undoc-members:
|
||||
6
doc/ref/modules/all/salt.modules.influxdbmod.rst
Normal file
6
doc/ref/modules/all/salt.modules.influxdbmod.rst
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
========================
|
||||
salt.modules.influxdbmod
|
||||
========================
|
||||
|
||||
.. automodule:: salt.modules.influxdbmod
|
||||
:members:
|
||||
19
doc/ref/modules/all/salt.modules.kernelpkg.rst
Normal file
19
doc/ref/modules/all/salt.modules.kernelpkg.rst
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
.. _virtual-kernelpkg:
|
||||
|
||||
======================
|
||||
salt.modules.kernelpkg
|
||||
======================
|
||||
|
||||
.. py:module:: salt.modules.kernelpkg
|
||||
:synopsis: A virtual module for managing kernel packages
|
||||
|
||||
``kernelpkg`` is a virtual module that is fulfilled by one of the following modules:
|
||||
|
||||
============================================ ========================================
|
||||
Execution Module Used for
|
||||
============================================ ========================================
|
||||
:py:mod:`~salt.modules.kernelpkg_linux_apt` Debian/Ubuntu-based distros which use
|
||||
``apt-get`` for package management
|
||||
:py:mod:`~salt.modules.kernelpkg_linux_yum` RedHat-based distros and derivatives
|
||||
using ``yum`` or ``dnf``
|
||||
============================================ ========================================
|
||||
6
doc/ref/modules/all/salt.modules.kernelpkg_linux_apt.rst
Normal file
6
doc/ref/modules/all/salt.modules.kernelpkg_linux_apt.rst
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
================================
|
||||
salt.modules.kernelpkg_linux_apt
|
||||
================================
|
||||
|
||||
.. automodule:: salt.modules.kernelpkg_linux_apt
|
||||
:members:
|
||||
6
doc/ref/modules/all/salt.modules.kernelpkg_linux_yum.rst
Normal file
6
doc/ref/modules/all/salt.modules.kernelpkg_linux_yum.rst
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
================================
|
||||
salt.modules.kernelpkg_linux_yum
|
||||
================================
|
||||
|
||||
.. automodule:: salt.modules.kernelpkg_linux_yum
|
||||
:members:
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Reference in a new issue