saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Clean up Sphinx build errors in develop branch

Browse source
This commit is contained in:
Erik Johnson 2018-06-06 20:19:44 -05:00
parent 713ae1dca7
commit 04a80673a2
No known key found for this signature in database
GPG key ID: 5E5583C437808F3F
36 changed files with 415 additions and 408 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/conf.py
View file

@ -6,6 +6,7 @@ Sphinx documentation for Salt
import functools
import sys
import os
import re
import types
import time
@ -151,6 +152,7 @@ MOCK_MODULES = [
'ntsecuritycon',
'napalm',
'dson',
'hjson',
'jnpr',
'json',
'lxml',
@ -316,6 +318,9 @@ modindex_common_prefix = ['salt.']
autosummary_generate = True
# strip git rev as there won't necessarily be a release based on it
stripped_release = re.sub(r'-\d+-g[0-9a-f]+$', '', release)
# Define a substitution for linking to the latest release tarball
rst_prolog = """\
.. |current_release_doc| replace:: :doc:`/topics/releases/{release}`
@ -352,7 +357,7 @@ rst_prolog = """\
<p>x86_64: <a href="https://repo.saltstack.com/osx/salt-{release}-py3-x86_64.pkg"><strong>salt-{release}-py3-x86_64.pkg</strong></a>
| <a href="https://repo.saltstack.com/osx/salt-{release}-py3-x86_64.pkg.md5"><strong>md5</strong></a></p>
""".format(release=release)
""".format(release=stripped_release)
# A shortcut for linking to tickets on the GitHub issue tracker
extlinks = {

2
doc/ref/configuration/master.rst
View file

@ -1140,7 +1140,7 @@ The ssh password to log in with.
.. conf_master:: ssh_priv_passwd
``ssh_priv_passwd``
--------------
-------------------
Default: ``''``

1
doc/ref/modules/all/index.rst
View file

@ -486,7 +486,6 @@ execution modules
win_system
win_task
win_timezone
win_update
win_useradd
win_wua
x509

6
doc/ref/modules/all/salt.modules.panos.rst
View file

@ -1,6 +1,6 @@
===================
==================
salt.modules.panos
===================
==================
.. automodule:: salt.modules.panos
:members:
:members:

6
doc/ref/modules/all/salt.modules.win_update.rst
View file

@ -1,6 +0,0 @@
=======================
salt.modules.win_update
=======================
.. automodule:: salt.modules.win_update
:members:

3
doc/ref/states/all/index.rst
View file

@ -75,7 +75,6 @@ state modules
debconfmod
dellchassis
disk
docker
docker_container
docker_image
docker_network
@ -136,7 +135,6 @@ state modules
jboss7
jenkins
junos
k8s
kapacitor
kernelpkg
keyboard
@ -308,7 +306,6 @@ state modules
win_smtp_server
win_snmp
win_system
win_update
win_wua
winrepo
x509

6
doc/ref/states/all/salt.states.docker.rst
View file

@ -1,6 +0,0 @@
==================
salt.states.docker
==================
.. automodule:: salt.states.docker
:members:

6
doc/ref/states/all/salt.states.k8s.rst
View file

@ -1,6 +0,0 @@
===============
salt.states.k8s
===============
.. automodule:: salt.states.k8s
:members:

6
doc/ref/states/all/salt.states.panos.rst
View file

@ -1,6 +1,6 @@
================
=================
salt.states.panos
================
=================
.. automodule:: salt.states.panos
:members:
:members:

6
doc/ref/states/all/salt.states.win_update.rst
View file

@ -1,6 +0,0 @@
======================
salt.states.win_update
======================
.. automodule:: salt.states.win_update
:members:

8
doc/ref/states/failhard.rst
View file

@ -10,6 +10,8 @@ But the situation may exist, where you would want all state execution to stop
if a single state execution fails. The capability to do this is called
``failing hard``.
.. _state-level-failhard:
State Level Failhard
====================
@ -36,6 +38,8 @@ executed.
It is possible to override a Global Failhard (see below) by explicitly setting
it to ``False`` in the state.
.. _global-failhard:
Global Failhard
===============
@ -52,5 +56,5 @@ in states not being executed or even checked. It can also be confusing to
see states failhard if an admin is not actively aware that the failhard has
been set.
To use the global failhard set failhard: True in the master configuration
file.
To use the global failhard set :conf_master:`failhard` to ``True`` in the
master configuration file.

2
doc/ref/states/requisites.rst
View file

@ -869,7 +869,7 @@ See :ref:`Reloading Modules <reloading-modules>`.
- reload_grains: true
grains_read:
module.run:
module.run:
- name: grains.items
.. _unless-requisite:

18
doc/topics/cloud/azurearm.rst
View file

@ -289,11 +289,13 @@ Optional. If set, the VM will be added to the specified availability set.
volumes
-------
Optional. A list of dictionaries describing data disks to attach to the instance can
be specified using this setting. The data disk dictionaries are passed entirely to the
`Azure DataDisk object
<https://docs.microsoft.com/en-us/python/api/azure.mgmt.compute.v2017_12_01.models.datadisk?view=azure-python>`_
, so ad-hoc options can be handled as long as they are valid properties of the object.
Optional. A list of dictionaries describing data disks to attach to the
instance can be specified using this setting. The data disk dictionaries are
passed entirely to the `Azure DataDisk object
<https://docs.microsoft.com/en-us/python/api/azure.mgmt.compute.v2017_12_01.models.datadisk?view=azure-python>`_,
so ad-hoc options can be handled as long as they are valid properties of the
object.
.. code-block:: yaml
@ -328,7 +330,7 @@ Optional. Default is ``False``. Normally when a VM is deleted, its associated
interfaces and IPs are retained. This is useful if you expect the deleted VM
to be recreated with the same name and network settings. If you would like
interfaces and IPs to be deleted when their associated VM is deleted, set this
to ``True``.
to ``True``.
userdata
--------
@ -347,14 +349,14 @@ How this is used depends on the operating system that is being deployed. If
used, any ``userdata`` setting will be ignored.
userdata_sendkeys
-------------
-----------------
Optional. Set to ``True`` in order to generate salt minion keys and provide
them as variables to the userdata script when running it through the template
renderer. The keys can be referenced as ``{{opts['priv_key']}}`` and
``{{opts['pub_key']}}``.
userdata_template
-------------
-----------------
Optional. Enter the renderer, such as ``jinja``, to be used for the userdata
script template.

181
doc/topics/cloud/profitbricks.rst
View file

@ -156,136 +156,127 @@ command:
# salt-cloud --list-sizes my-profitbricks-config
.. versionadded:: Fluorine
One or more public IP address can be reserved with the following command:
.. versionchanged:: Fluorine
.. code-block:: bash
One or more public IP address can be reserved with the following command:
# salt-cloud -f reserve_ipblock my-profitbricks-config location='us/ewr' size=1
.. code-block:: bash
# salt-cloud -f reserve_ipblock my-profitbricks-config location='us/ewr' size=1
Profile Specifics:
------------------
The following list explains some of the important properties.
size
Can be one of the options listed in the output of the following command:
- ``size`` - Can be one of the options listed in the output of the following
command:
.. code-block:: bash
.. code-block:: bash
salt-cloud --list-sizes my-profitbricks-config
salt-cloud --list-sizes my-profitbricks-config
image
Can be one of the options listed in the output of the following command:
- ``image`` - Can be one of the options listed in the output of the following
command:
.. code-block:: bash
.. code-block:: bash
salt-cloud --list-images my-profitbricks-config
salt-cloud --list-images my-profitbricks-config
image_alias
Can be one of the options listed in the output of the following command:
- ``image_alias`` - Can be one of the options listed in the output of the
following command:
.. code-block:: bash
.. code-block:: bash
salt-cloud -f list_images my-profitbricks-config
salt-cloud -f list_images my-profitbricks-config
disk_size
This option allows you to override the size of the disk as defined by the
size. The disk size is set in gigabytes (GB).
- ``disk_size`` - This option allows you to override the size of the disk as
defined by the size. The disk size is set in gigabytes (GB).
disk_type
This option allow the disk type to be set to HDD or SSD. The default is
HDD.
- ``disk_type`` - This option allow the disk type to be set to HDD or SSD. The
default is HDD.
.. versionadded:: Fluorine
image_password
A password is set on the image for the "root" or "Administrator" account.
This field may only be set during volume creation. Only valid with
ProfitBricks supplied HDD (not ISO) images. The password must contain at
least 8 and no more than 50 characters. Only these characters are
allowed: [a-z][A-Z][0-9]
.. versionadded:: Fluorine
cores
This option allows you to override the number of CPU cores as defined by
the size.
- ``image_password`` - A password is set on the image for the "root" or
"Administrator" account. This field may only be set during volume creation.
Only valid with ProfitBricks supplied HDD (not ISO) images. The password must
contain at least 8 and no more than 50 characters. Only these characters are
allowed: [a-z][A-Z][0-9]
ram
This option allows you to override the amount of RAM defined by the size.
The value must be a multiple of 256, e.g. 256, 512, 768, 1024, and so
forth.
- ``cores`` - This option allows you to override the number of CPU cores as
defined by the size.
public_lan
This option will connect the server to the specified public LAN. If no
LAN exists, then a new public LAN will be created. The value accepts a LAN
ID (integer).
- ``ram`` - This option allows you to override the amount of RAM defined by the
size. The value must be a multiple of 256, e.g. 256, 512, 768, 1024, and so
forth.
.. versionadded:: Fluorine
public_ips
Public IPs assigned to the NIC in the public LAN.
- ``public_lan`` - This option will connect the server to the specified public
LAN. If no LAN exists, then a new public LAN will be created. The value
accepts a LAN ID (integer).
public_firewall_rules
This option allows for a list of firewall rules assigned to the public
network interface.
.. versionadded:: Fluorine
Firewall Rule Name:
protocol: <protocol> (TCP, UDP, ICMP)
source_mac: <source-mac>
source_ip: <source-ip>
target_ip: <target-ip>
port_range_start: <port-range-start>
port_range_end: <port-range-end>
icmp_type: <icmp-type>
icmp_code: <icmp-code>
- ``public_ips`` - Public IPs assigned to the NIC in the public LAN.
private_lan
This option will connect the server to the specified private LAN. If no
LAN exists, then a new private LAN will be created. The value accepts a LAN
ID (integer).
- ``public_firewall_rules`` - This option allows for a list of firewall rules
assigned to the public network interface.
.. versionadded:: Fluorine
private_ips
Private IPs assigned in the private LAN. NAT setting is ignored when this setting is active.
.. code-block:: yaml
private_firewall_rules
This option allows for a list of firewall rules assigned to the private
network interface.
Firewall Rule Name:
protocol: <protocol> (TCP, UDP, ICMP)
source_mac: <source-mac>
source_ip: <source-ip>
target_ip: <target-ip>
port_range_start: <port-range-start>
port_range_end: <port-range-end>
icmp_type: <icmp-type>
icmp_code: <icmp-code>
Firewall Rule Name:
protocol: <protocol> (TCP, UDP, ICMP)
source_mac: <source-mac>
source_ip: <source-ip>
target_ip: <target-ip>
port_range_start: <port-range-start>
port_range_end: <port-range-end>
icmp_type: <icmp-type>
icmp_code: <icmp-code>
- ``private_lan`` - This option will connect the server to the specified
private LAN. If no LAN exists, then a new private LAN will be created. The
value accepts a LAN ID (integer).
ssh_private_key
Full path to the SSH private key file.
.. versionadded:: Fluorine
ssh_public_key
Full path to the SSH public key file.
- ``private_ips`` - Private IPs assigned in the private LAN. NAT setting is
ignored when this setting is active.
ssh_interface
This option will use the private LAN IP for node connections (such as
as bootstrapping the node) instead of the public LAN IP. The value accepts
'private_lan'.
- ``private_firewall_rules`` - This option allows for a list of firewall rules
assigned to the private network interface.
cpu_family
This option allow the CPU family to be set to AMD_OPTERON or INTEL_XEON.
The default is AMD_OPTERON.
.. code-block:: yaml
volumes:
This option allows a list of additional volumes by name that will be
created and attached to the server. Each volume requires 'disk_size'
and, optionally, 'disk_type'. The default is HDD.
Firewall Rule Name:
protocol: <protocol> (TCP, UDP, ICMP)
source_mac: <source-mac>
source_ip: <source-ip>
target_ip: <target-ip>
port_range_start: <port-range-start>
port_range_end: <port-range-end>
icmp_type: <icmp-type>
icmp_code: <icmp-code>
deploy
Set to False if Salt should not be installed on the node.
- ``ssh_private_key`` - Full path to the SSH private key file
wait_for_timeout
The timeout to wait in seconds for provisioning resources such as servers.
The default wait_for_timeout is 15 minutes.
- ``ssh_public_key`` - Full path to the SSH public key file
- ``ssh_interface`` - This option will use the private LAN IP for node
connections (such as as bootstrapping the node) instead of the public LAN IP.
The value accepts 'private_lan'.
- ``cpu_family`` - This option allow the CPU family to be set to AMD_OPTERON or
INTEL_XEON. The default is AMD_OPTERON.
- ``volumes`` - This option allows a list of additional volumes by name that
will be created and attached to the server. Each volume requires 'disk_size'
and, optionally, 'disk_type'. The default is HDD.
- ``deploy`` - Set to ``False`` if Salt should not be installed on the node.
- ``wait_for_timeout`` - The timeout to wait in seconds for provisioning
resources such as servers. The default wait_for_timeout is 15 minutes.
For more information concerning cloud profiles, see :ref:`here
</topics/cloud/profiles>`.
<salt-cloud-profiles>`.

3
doc/topics/installation/freebsd.rst
View file

@ -5,7 +5,8 @@ FreeBSD
Installation
============
Salt is available in the FreeBSD ports at `sysutils/py-salt. <https://www.freshports.org/sysutils/py-salt/>`__
Salt is available in the FreeBSD ports tree at `sysutils/py-salt
<https://www.freshports.org/sysutils/py-salt/>`_.
FreeBSD binary repo

1
doc/topics/releases/2015.8.0.rst
View file

@ -21,7 +21,6 @@ See the following links for instructions:
- :ref:`Red Hat / CentOS 5, 6, 7 <installation-rhel-repo>`
- :ref:`Debian 8 <installation-debian-repo>`
- :ref:`Windows <windows-installer>`
- :ref:`FreeBSD <freebsd-upstream>`
Send Event on State Completion
==============================

307
doc/topics/releases/fluorine.rst
View file

@ -5,7 +5,7 @@ Salt Release Notes - Codename Fluorine
======================================
New Docker Proxy Minion
-----------------------
=======================
Docker containers can now be treated as actual minions without installing salt
in the container, using the new :py:mod:`docker proxy minion <salt.proxy.docker>`.
@ -24,7 +24,7 @@ module.
Grains Dictionary Passed into Custom Grains
-------------------------------------------
===========================================
Starting in this release, if a custom grains function accepts a variable named
``grains``, the Grains dictionary of the already compiled grains will be passed
@ -34,7 +34,7 @@ since those are compiled first.
"Virtual Package" Support Dropped for APT
-----------------------------------------
=========================================
In APT, some packages have an associated list of packages which they provide.
This allows one to do things like run ``apt-get install foo`` when the real
@ -260,7 +260,7 @@ help determine what package name is correct:
Minion Startup Events
---------------------
=====================
When a minion starts up it sends a notification on the event bus with a tag
that looks like this: ``salt/minion/<minion_id>/start``. For historical reasons
@ -279,7 +279,7 @@ syndic respects :conf_minion:`enable_legacy_startup_events` as well.
Failhard changes
----------------
================
It is now possible to override a global failhard setting with a state-level
failhard setting. This is most useful in case where global failhard is set to
@ -294,7 +294,7 @@ any ``onfail*``-requisites were used).
Pass Through Options to :py:func:`file.serialize <salt.states.file.serialize>` State
------------------------------------------------------------------------------------
====================================================================================
This allows for more granular control over the way in which the dataset is
serialized. See the documentation for the new ``serializer_opts`` option in the
@ -303,7 +303,7 @@ information.
:py:func:`file.patch <salt.sates.file.patch>` State Rewritten
-------------------------------------------------------------
=============================================================
The :py:func:`file.patch <salt.sates.file.patch>` state has been rewritten with
several new features:
@ -317,10 +317,10 @@ file should be.
Deprecations
------------
============
API Deprecations
================
----------------
Support for :ref:`LocalClient <local-client>`'s ``expr_form`` argument has
been removed. Please use ``tgt_type`` instead. This change was made due to
@ -340,121 +340,160 @@ their code to use ``tgt_type``.
{'jerry': 'root'}
Module Deprecations
===================
-------------------
The ``napalm_network`` module had the following changes:
- The :py:mod:`napalm_network <salt.modules.napalm_network>` module has been
changed as follows:
- Support for the ``template_path`` has been removed in the ``load_template``
function. This is because support for NAPALM native templates has been
dropped.
- Support for the ``template_path`` has been removed from
:py:func:`net.load_template <salt.modules.napalm_network.load_template>`
function. This is because support for NAPALM native templates has been
dropped.
The ``trafficserver`` module had the following changes:
- The :py:mod:`trafficserver <salt.modules.trafficserver>` module has been
changed as follows:
- Support for the ``match_var`` function was removed. Please use the
``match_metric`` function instead.
- Support for the ``read_var`` function was removed. Please use the
``read_config`` function instead.
- Support for the ``set_var`` function was removed. Please use the
``set_config`` function instead.
- The ``trafficserver.match_var`` function was removed. Please use
:py:func:`trafficserver.match_metric
<salt.modules.trafficserver.match_metric>` instead.
The ``win_update`` module has been removed. It has been replaced by ``win_wua``
module.
- The ``trafficserver.read_var`` function was removed. Please use
:py:func:`trafficserver.read_config
<salt.modules.trafficserver.read_config>` instead.
The ``win_wua`` module had the following changes:
- The ``trafficserver.set_var`` function was removed. Please use
:py:func:`trafficserver.set_config
<salt.modules.trafficserver.set_config>` instead.
- Support for the ``download_update`` function has been removed. Please use the
``download`` function instead.
- Support for the ``download_updates`` function has been removed. Please use the
``download`` function instead.
- Support for the ``install_update`` function has been removed. Please use the
``install`` function instead.
- Support for the ``install_updates`` function has been removed. Please use the
``install`` function instead.
- Support for the ``list_update`` function has been removed. Please use the
``get`` function instead.
- Support for the ``list_updates`` function has been removed. Please use the
``list`` function instead.
- The ``win_update`` module has been removed. It has been replaced by
:py:mod:`win_wua <salt.modules.win_wua>`.
- The :py:mod:`win_wua <salt.modules.win_wua>` module has been changed as
follows:
- The ``win_wua.download_update`` and ``win_wua.download_updates``
functions have been removed. Please use :py:func:`win_wua.download
<salt.modules.win_wua.download>` instead.
- The ``win_wua.install_update`` and ``win_wua.install_updates``
functions have been removed. Please use :py:func:`win_wua.install
<salt.modules.win_wua.install>` instead.
- The ``win_wua.list_update`` function has been removed. Please use
functions have been removed. Please use :py:func:`win_wua.get
<salt.modules.win_wua.get>` instead.
- The ``win_wua.list_updates`` function has been removed. Please use
functions have been removed. Please use :py:func:`win_wua.list
<salt.modules.win_wua.list_>` instead.
Pillar Deprecations
===================
-------------------
The ``vault`` pillar had the following changes:
- The :py:mod:`vault <salt.pillar.vault>` external pillar has been changed as
follows:
- Support for the ``profile`` argument was removed. Any options passed up until
and following the first ``path=`` are discarded.
- Support for the ``profile`` argument was removed. Any options passed up
until and following the first ``path=`` are discarded.
Roster Deprecations
===================
-------------------
The ``cache`` roster had the following changes:
- The :py:mod:`cache <salt.roster.cache>` roster has been changed as follows:
- Support for ``roster_order`` as a list or tuple has been removed. As of the
``Fluorine`` release, ``roster_order`` must be a dictionary.
- The ``roster_order`` option now includes IPv6 in addition to IPv4 for the
``private``, ``public``, ``global`` or ``local`` settings. The syntax for these
settings has changed to ``ipv4-*`` or ``ipv6-*``, respectively.
- Support for ``roster_order`` as a list or tuple has been removed. As of
the ``Fluorine`` release, ``roster_order`` must be a dictionary.
- The ``roster_order`` option now includes IPv6 in addition to IPv4 for the
``private``, ``public``, ``global`` or ``local`` settings. The syntax for
these settings has changed to ``ipv4-*`` or ``ipv6-*``, respectively.
State Deprecations
==================
------------------
The ``docker`` state has been removed. The following functions should be used
instead.
- The ``docker`` state module has been removed
- The ``docker.running`` function was removed. Please update applicable SLS files
to use the ``docker_container.running`` function instead.
- The ``docker.stopped`` function was removed. Please update applicable SLS files
to use the ``docker_container.stopped`` function instead.
- The ``docker.absent`` function was removed. Please update applicable SLS files
to use the ``docker_container.absent`` function instead.
- The ``docker.absent`` function was removed. Please update applicable SLS files
to use the ``docker_container.absent`` function instead.
- The ``docker.network_present`` function was removed. Please update applicable
SLS files to use the ``docker_network.present`` function instead.
- The ``docker.network_absent`` function was removed. Please update applicable
SLS files to use the ``docker_network.absent`` function instead.
- The ``docker.image_present`` function was removed. Please update applicable SLS
files to use the ``docker_image.present`` function instead.
- The ``docker.image_absent`` function was removed. Please update applicable SLS
files to use the ``docker_image.absent`` function instead.
- The ``docker.volume_present`` function was removed. Please update applicable SLS
files to use the ``docker_volume.present`` function instead.
- The ``docker.volume_absent`` function was removed. Please update applicable SLS
files to use the ``docker_volume.absent`` function instead.
- In :ref:`2017.7.0 <release-2017-7-0>`, the states from this module were
split into four separate state modules:
The ``docker_network`` state had the following changes:
- :py:mod:`docker_container <salt.states.docker_container>`
- Support for the ``driver`` option has been removed from the ``absent`` function.
This option had no functionality in ``docker_network.absent``.
- :py:mod:`docker_image <salt.states.docker_image>`
The ``git`` state had the following changes:
- :py:mod:`docker_volume <salt.states.docker_volume>`
- Support for the ``ref`` option in the ``detached`` state has been removed.
Please use the ``rev`` option instead.
- :py:mod:`docker_network <salt.states.docker_network>`
The ``k8s`` state has been removed. The following functions should be used
instead:
- The ``docker`` module remained, for backward-compatibility, but it has now
been removed. Please update SLS files to use the new state names:
- The ``k8s.label_absent`` function was removed. Please update applicable SLS
files to use the ``kubernetes.node_label_absent`` function instead.
- The ``k8s.label_present`` function was removed. Please updated applicable SLS
files to use the ``kubernetes.node_label_present`` function instead.
- The ``k8s.label_folder_absent`` function was removed. Please update applicable
SLS files to use the ``kubernetes.node_label_folder_absent`` function instead.
- ``docker.running`` => :py:func:`docker_container.running
<salt.states.docker_container.running>`
The ``netconfig`` state had the following changes:
- ``docker.stopped`` => :py:func:`docker_container.stopped
<salt.states.docker_container.stopped>`
- Support for the ``template_path`` option in the ``managed`` state has been
removed. This is because support for NAPALM native templates has been dropped.
- ``docker.absent`` => :py:func:`docker_container.absent
<salt.states.docker_container.absent>`
The ``trafficserver`` state had the following changes:
- ``docker.network_present`` => :py:func:`docker_network.present
<salt.states.docker_network.present>`
- Support for the ``set_var`` function was removed. Please use the ``config``
function instead.
- ``docker.network_absent`` => :py:func:`docker_network.absent
<salt.states.docker_network.absent>`
The ``win_update`` state has been removed. Please use the ``win_wua`` state instead.
- ``docker.image_present`` => :py:func:`docker_image.present
<salt.states.docker_image.present>`
- ``docker.image_absent`` => :py:func:`docker_image.absent
<salt.states.docker_image.absent>`
- ``docker.volume_present`` => :py:func:`docker_volume.present
<salt.states.docker_volume.present>`
- ``docker.volume_absent`` => :py:func:`docker_volume.absent
<salt.states.docker_volume.absent>`
- The :py:mod:`docker_network <salt.states.docker_network>` state module has
been changed as follows:
- The ``driver`` option has been removed from
:py:func:`docker_network.absent <salt.states.docker_network.absent>`. It
had no functionality, as the state simply deletes the specified network
name if it exists.
- The deprecated ``ref`` option has been removed from the
:py:func:`git.detached <salt.states.git.detached>` state. Please use ``rev``
instead.
- The ``k8s`` state module has been removed in favor of the :py:mod:`kubernetes
<salt.states.kubernetes>` state mdoule. Please update SLS files as follows:
- In place of ``k8s.label_present``, use
:py:func:`kubernetes.node_label_present
<salt.states.kubernetes.node_label_present>`
- In place of ``k8s.label_absent``, use
:py:func:`kubernetes.node_label_absent
<salt.states.kubernetes.node_label_absent>`
- In place of ``k8s.label_folder_absent``, use
:py:func:`kubernetes.node_label_folder_absent
<salt.states.kubernetes.node_label_folder_absent>`
- Support for the ``template_path`` option in the :py:func:`netconfig.managed
<salt.states.netconfig.managed` state has been removed. This is because
support for NAPALM native templates has been dropped.
- The :py:func:`trafficserver.set_var <salt.states.trafficserver.set_var>`
state has been removed. Please use :py:func:`trafficserver.config
<salt.states.trafficserver.config>` instead.
- The ``win_update`` state module has been removed. It has been replaced by
:py:mod:`win_wua <salt.states.win_wua>`.
Utils Deprecations
==================
------------------
The ``vault`` utils module had the following changes:
@ -462,7 +501,17 @@ The ``vault`` utils module had the following changes:
Please see the :mod:`vault execution module <salt.modules.vault>` documentation for
details on the new configuration schema.
=====================
Dependency Deprecations
-----------------------
Salt-Cloud has been updated to use the ``pypsexec`` Python library instead of the
``winexe`` executable. Both ``winexe`` and ``pypsexec`` run remote commands
against Windows OSes. Since ``winexe`` is not packaged for every system, it has
been deprecated in favor of ``pypsexec``.
Salt-Cloud has deprecated the use ``impacket`` in favor of ``smbprotocol``.
This changes was made because ``impacket`` is not compatible with Python 3.
SaltSSH major updates
=====================
@ -494,10 +543,11 @@ configuration in /etc/salt/master as follows:
markupsafe: /opt/markupsafe
backports_abc: /opt/backports_abc.py
It is also possible to use several alternative versions of Salt. You can for instance generate
a minimal tarball using runners and include that. But this is only possible, when such specific
Salt version is also available on the Master machine, although does not need to be directly
installed together with the older Python interpreter.
It is also possible to use several alternative versions of Salt. You can for
instance generate a minimal tarball using runners and include that. But this is
only possible, when such specific Salt version is also available on the Master
machine, although does not need to be directly installed together with the
older Python interpreter.
SaltSSH now support private key's passphrase. You can configure it by:
@ -506,56 +556,41 @@ SaltSSH now support private key's passphrase. You can configure it by:
* `priv_passwd` for salt roster file
========================
Salt-Cloud major updates
========================
Dependency Deprecations
=======================
Salt-Cloud has been updated to use the ``pypsexec`` Python library instead of the
``winexe`` executable. Both ``winexe`` and ``pypsexec`` run remote commands
against Windows OSes. Since ``winexe`` is not packaged for every system, it has
been deprecated in favor of ``pypsexec``.
Salt-Cloud has deprecated the use ``impacket`` in favor of ``smbprotocol``.
This changes was made because ``impacket`` is not compatible with Python 3.
====================
State Module Changes
====================
states.saltmod
--------------
The 'test' option now defaults to None. A value of True or False set here is
passed to the state being run and can be used to override a ``test:True`` option
set in the minion's config file. In previous releases the minion's config option
would take precedence and it would be impossible to run an orchestration on a
minion with test mode set to True in the config file.
:py:mod:`salt <salt.states.saltmod>` State Module (used in orchestration)
-------------------------------------------------------------------------
The ``test`` option now defaults to None. A value of ``True`` or ``False`` set
here is passed to the state being run and can be used to override a ``test:
True`` option set in the minion's config file. In previous releases the
minion's config option would take precedence and it would be impossible to run
an orchestration on a minion with test mode set to True in the config file.
If a minion is not in permanent test mode due to the config file and the 'test'
argument here is left as None then a value of ``test=True`` on the command-line is
passed correctly to the minion to run an orchestration in test mode. At present
it is not possible to pass ``test=False`` on the command-line to override a
minion in permanent test mode and so the ``test:False`` option must still be set
minion in permanent test mode and so the ``test: False`` option must still be set
in the orchestration file.
states.event
--------------
The :ref:`event.send <salt.states.event.send>` state does not know the results of
the sent event, so returns changed every state run. It can now be set to
return changed or unchanged.
:py:func:`event.send <salt.states.event.send>` State
----------------------------------------------------
The :py:func:`event.send <salt.states.event.send>` state does not know the
results of the sent event, so returns changed every state run. It can now be
set to return changed or unchanged.
============================
LDAP External Authentication
============================
freeipa 'groupattribute' support
--------------------------------
Previously, if Salt was using external authentication against a freeipa LDAP system
it could only search for users via the 'accountattributename' field. This release
add an additional search using the 'groupattribute' field as well. The original
'accountattributename' search is done first then the 'groupattribute' allowing for
backward compatibility with previous Salt releases.
freeipa ``groupattribute`` support
----------------------------------
Previously, if Salt was using external authentication against a freeipa LDAP
system it could only search for users via the ``accountattributename`` field.
This release add an additional search using the ``groupattribute`` field as
well. The original ``accountattributename`` search is done first then the
``groupattribute`` allowing for backward compatibility with previous Salt
releases.

2
salt/fileserver/s3fs.py
View file

@ -69,7 +69,7 @@ structure::
If you deal with objects greater than 8MB, then you should use the
following AWS CLI config to avoid mutipart upload:
.. code-block::
.. code-block:: text
s3 =
multipart_threshold = 1024MB

11
salt/modules/cimc.py
View file

@ -1,8 +1,8 @@
# -*- coding: utf-8 -*-
'''
Module to provide Cisco UCS compatibility to Salt.
Module to provide Cisco UCS compatibility to Salt
:codeauthor: :email:`Spencer Ervin <spencer_ervin@hotmail.com>`
:codeauthor: ``Spencer Ervin <spencer_ervin@hotmail.com>``
:maturity: new
:depends: none
:platform: unix
@ -15,12 +15,13 @@ parameters, or as configuration settings in pillar as a Salt proxy.
Options passed into opts will be ignored if options are passed into pillar.
.. seealso::
:prox:`Cisco UCS Proxy Module <salt.proxy.cimc>`
:py:mod:`Cisco UCS Proxy Module <salt.proxy.cimc>`
About
=====
This execution module was designed to handle connections to a Cisco UCS server. This module adds support to send
connections directly to the device through the rest API.
This execution module was designed to handle connections to a Cisco UCS server.
This module adds support to send connections directly to the device through the
rest API.
'''

11
salt/modules/cloud.py
View file

@ -205,11 +205,14 @@ def map_run(path=None, **kwargs):
Execute a salt cloud map file
Cloud Map data can be retrieved from several sources:
- a local file (provide the path to the file to the 'path' argument)
- a JSON-formatted map directly (provide the appropriately formatted to using the 'map_data' argument)
- the Salt Pillar (provide the map name of under 'pillar:cloud:maps' to the 'map_pillar' argument)
Note: Only one of these sources can be read at a time. The options are listed in their order of precedence.
- a local file (provide the path to the file to the 'path' argument)
- a JSON-formatted map directly (provide the appropriately formatted to using the 'map_data' argument)
- the Salt Pillar (provide the map name of under 'pillar:cloud:maps' to the 'map_pillar' argument)
.. note::
Only one of these sources can be read at a time. The options are listed
in their order of precedence.
CLI Examples:

91
salt/modules/cmdmod.py
View file

@ -1087,11 +1087,9 @@ def run(cmd,
.. versionadded:: Fluorine
:param bool stdin_raw_newlines : False
Normally, newlines present in ``stdin`` as ``\\n`` will be 'unescaped',
i.e. replaced with a ``\n``. Set this parameter to ``True`` to leave
the newlines as-is. This should be used when you are supplying data
using ``stdin`` that should not be modified.
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\\n``
present in the ``stdin`` value to newlines.
.. versionadded:: Fluorine
@ -1329,11 +1327,9 @@ def shell(cmd,
.. versionadded:: Fluorine
:param bool stdin_raw_newlines : False
Normally, newlines present in ``stdin`` as ``\\n`` will be 'unescaped',
i.e. replaced with a ``\n``. Set this parameter to ``True`` to leave
the newlines as-is. This should be used when you are supplying data
using ``stdin`` that should not be modified.
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\\n``
present in the ``stdin`` value to newlines.
.. versionadded:: Fluorine
@ -1544,11 +1540,9 @@ def run_stdout(cmd,
.. versionadded:: Fluorine
:param bool stdin_raw_newlines : False
Normally, newlines present in ``stdin`` as ``\\n`` will be 'unescaped',
i.e. replaced with a ``\n``. Set this parameter to ``True`` to leave
the newlines as-is. This should be used when you are supplying data
using ``stdin`` that should not be modified.
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\\n``
present in the ``stdin`` value to newlines.
.. versionadded:: Fluorine
@ -1742,11 +1736,9 @@ def run_stderr(cmd,
.. versionadded:: Fluorine
:param bool stdin_raw_newlines : False
Normally, newlines present in ``stdin`` as ``\\n`` will be 'unescaped',
i.e. replaced with a ``\n``. Set this parameter to ``True`` to leave
the newlines as-is. This should be used when you are supplying data
using ``stdin`` that should not be modified.
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\\n``
present in the ``stdin`` value to newlines.
.. versionadded:: Fluorine
@ -1964,11 +1956,9 @@ def run_all(cmd,
.. versionadded:: Fluorine
:param bool stdin_raw_newlines : False
Normally, newlines present in ``stdin`` as ``\\n`` will be 'unescaped',
i.e. replaced with a ``\n``. Set this parameter to ``True`` to leave
the newlines as-is. This should be used when you are supplying data
using ``stdin`` that should not be modified.
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\\n``
present in the ``stdin`` value to newlines.
.. versionadded:: Fluorine
@ -2153,11 +2143,9 @@ def retcode(cmd,
.. versionadded:: Fluorine
:param bool stdin_raw_newlines : False
Normally, newlines present in ``stdin`` as ``\\n`` will be 'unescaped',
i.e. replaced with a ``\n``. Set this parameter to ``True`` to leave
the newlines as-is. This should be used when you are supplying data
using ``stdin`` that should not be modified.
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\\n``
present in the ``stdin`` value to newlines.
.. versionadded:: Fluorine
@ -2401,11 +2389,9 @@ def script(source,
.. versionadded:: Fluorine
:param bool stdin_raw_newlines : False
Normally, newlines present in ``stdin`` as ``\\n`` will be 'unescaped',
i.e. replaced with a ``\n``. Set this parameter to ``True`` to leave
the newlines as-is. This should be used when you are supplying data
using ``stdin`` that should not be modified.
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\\n``
present in the ``stdin`` value to newlines.
.. versionadded:: Fluorine
@ -2647,11 +2633,9 @@ def script_retcode(source,
.. versionadded:: Fluorine
:param bool stdin_raw_newlines : False
Normally, newlines present in ``stdin`` as ``\\n`` will be 'unescaped',
i.e. replaced with a ``\n``. Set this parameter to ``True`` to leave
the newlines as-is. This should be used when you are supplying data
using ``stdin`` that should not be modified.
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\\n``
present in the ``stdin`` value to newlines.
.. versionadded:: Fluorine
@ -2970,7 +2954,8 @@ def run_chroot(root,
the return code will be overridden with zero.
.. versionadded:: Fluorine
CLI Example:
CLI Example:
.. code-block:: bash
@ -3453,11 +3438,9 @@ def powershell(cmd,
.. versionadded:: Fluorine
:param bool stdin_raw_newlines : False
Normally, newlines present in ``stdin`` as ``\\n`` will be 'unescaped',
i.e. replaced with a ``\n``. Set this parameter to ``True`` to leave
the newlines as-is. This should be used when you are supplying data
using ``stdin`` that should not be modified.
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\\n``
present in the ``stdin`` value to newlines.
.. versionadded:: Fluorine
@ -3757,11 +3740,9 @@ def powershell_all(cmd,
.. versionadded:: Fluorine
:param bool stdin_raw_newlines : False
Normally, newlines present in ``stdin`` as ``\\n`` will be 'unescaped',
i.e. replaced with a ``\n``. Set this parameter to ``True`` to leave
the newlines as-is. This should be used when you are supplying data
using ``stdin`` that should not be modified.
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\\n``
present in the ``stdin`` value to newlines.
.. versionadded:: Fluorine
@ -4016,11 +3997,9 @@ def run_bg(cmd,
.. versionadded:: Fluorine
:param bool stdin_raw_newlines : False
Normally, newlines present in ``stdin`` as ``\\n`` will be 'unescaped',
i.e. replaced with a ``\n``. Set this parameter to ``True`` to leave
the newlines as-is. This should be used when you are supplying data
using ``stdin`` that should not be modified.
:param bool stdin_raw_newlines: False
If ``True``, Salt will not automatically convert the characters ``\\n``
present in the ``stdin`` value to newlines.
.. versionadded:: Fluorine

48
salt/modules/defaults.py
View file

@ -156,34 +156,38 @@ def update(dest, defaults, merge_lists=True, in_place=True):
and defaults.deepcopy to avoid redundant in jinja.
Example:
.. code-block:: yaml
group01:
defaults:
enabled: True
extra:
- test
- stage
nodes:
host01:
index: foo
upstream: bar
host02:
index: foo2
upstream: bar2
group01:
defaults:
enabled: True
extra:
- test
- stage
nodes:
host01:
index: foo
upstream: bar
host02:
index: foo2
upstream: bar2
.. code-block::
{% do salt['defaults.update'](group01.nodes, group01.defaults) %}
.. code-block:: jinja
{% do salt['defaults.update'](group01.nodes, group01.defaults) %}
Each node will look like the following:
.. code-block:: yaml
host01:
enabled: True
index: foo
upstream: bar
extra:
- test
- stage
host01:
enabled: True
index: foo
upstream: bar
extra:
- test
- stage
merge_lists : True
If True, it will also merge lists instead of replace their items.

6
salt/modules/glusterfs.py
View file

@ -709,9 +709,12 @@ def get_op_version(name):
.. versionadded:: Fluorine
Returns the glusterfs volume op-version
name
Name of the glusterfs volume
CLI Example:
.. code-block:: bash
salt '*' glusterfs.get_op_version <volume>
@ -778,9 +781,12 @@ def set_op_version(version):
.. versionadded:: Fluorine
Set the glusterfs volume op-version
version
Version to set the glusterfs volume op-version
CLI Example:
.. code-block:: bash
salt '*' glusterfs.set_op_version <volume>

9
salt/modules/mac_service.py
View file

@ -1,11 +1,13 @@
# -*- coding: utf-8 -*-
'''
The service module for macOS
.. versionadded:: 2016.3.0
This module has support for services in the following locations.
.. code-block:: bash
/System/Library/LaunchDaemons/
/System/Library/LaunchAgents/
/Library/LaunchDaemons/
@ -15,10 +17,9 @@ This module has support for services in the following locations.
/Users/foo/Library/LaunchAgents/
.. note::
As of version "Fluorine", if a service is located in a ``LaunchAgent`` path
and a ``runas`` user is NOT specified the current console user will be used
to properly interact with the service.
As of the Fluorine release, if a service is located in a ``LaunchAgent``
path and a ``runas`` user is NOT specified, the current console user will
be used to properly interact with the service.
'''
from __future__ import absolute_import, unicode_literals, print_function

6
salt/modules/panos.py
View file

@ -1,8 +1,8 @@
# -*- coding: utf-8 -*-
'''
Module to provide Palo Alto compatibility to Salt.
Module to provide Palo Alto compatibility to Salt
:codeauthor: :email:`Spencer Ervin <spencer_ervin@hotmail.com>`
:codeauthor: ``Spencer Ervin <spencer_ervin@hotmail.com>``
:maturity: new
:depends: none
:platform: unix
@ -17,7 +17,7 @@ parameters, or as configuration settings in pillar as a Salt proxy.
Options passed into opts will be ignored if options are passed into pillar.
.. seealso::
:prox:`Palo Alto Proxy Module <salt.proxy.panos>`
:py:mod:`Palo Alto Proxy Module <salt.proxy.panos>`
About
=====

8
salt/modules/pkgng.py
View file

@ -1885,7 +1885,7 @@ def hold(name=None, pkgs=None, **kwargs): # pylint: disable=W0613
.. note::
This function is provided primarily for compatibilty with some
parts of :py:module:`states.pkg <salt.states.pkg>`.
parts of :py:mod:`states.pkg <salt.states.pkg>`.
Consider using Consider using :py:func:`pkg.lock <salt.modules.pkgng.lock>` instead. instead.
name
@ -1949,9 +1949,9 @@ def unhold(name=None, pkgs=None, **kwargs): # pylint: disable=W0613
Remove version locks
.. note::
This function is provided primarily for compatibilty with some
parts of :py:module:`states.pkg <salt.states.pkg>`.
Consider using :py:func:`pkg.unlock <salt.modules.pkgng.unlock>` instead.
This function is provided primarily for compatibilty with some parts of
:py:mod:`states.pkg <salt.states.pkg>`. Consider using
:py:func:`pkg.unlock <salt.modules.pkgng.unlock>` instead.
name
The name of the package to be unheld

5
salt/modules/purefb.py
View file

@ -297,8 +297,9 @@ def fs_create(name, size=None, proto='NFS', nfs_rules='*(rw,no_root_squash)', sn
snapshot: boolean
(Optional) Are snapshots enabled on the filesystem. Default is False
nfs_rules : string
(Optional) export rules for NFS. If not specified default is *(rw,no_root_squash)
Refer to Pure Storage documentation for formatting rules.
(Optional) export rules for NFS. If not specified default is
``*(rw,no_root_squash)``. Refer to Pure Storage documentation for
formatting rules.
size : string
if specified capacity of filesystem. If not specified default to 32G.
Refer to Pure Storage documentation for formatting rules.

6
salt/modules/vmctl.py
View file

@ -4,7 +4,7 @@ Manage vms running on the OpenBSD VMM hypervisor using vmctl(8).
.. versionadded:: Fluorine
:codeauthor: :email:`Jasper Lievisse Adriaanse <jasper@openbsd.org>`
:codeauthor: ``Jasper Lievisse Adriaanse <jasper@openbsd.org>``
.. note::
@ -285,8 +285,8 @@ def start(name=None, id=None, bootpath=None, disk=None, disks=None, local_iface=
def status(name=None, id=None):
'''
List VMs running on the host, or only the VM specified by ``id''.
When both a name and id are provided, the id is ignored.
List VMs running on the host, or only the VM specified by ``id``. When
both a name and id are provided, the id is ignored.
name:
Name of the defined VM.

17
salt/modules/win_task.py
View file

@ -1752,14 +1752,15 @@ def add_trigger(name=None,
- 3 days (default)
:param str delay: The time the trigger waits after its activation to start the task.
Valid values are:
- 15 seconds
- 30 seconds
- 1 minute
- 30 minutes
- 1 hour
- 8 hours
- 1 day
Valid values are:
- 15 seconds
- 30 seconds
- 1 minute
- 30 minutes
- 1 hour
- 8 hours
- 1 day
**kwargs**

4
salt/modules/zabbix.py
View file

@ -333,8 +333,8 @@ def compare_params(defined, existing, return_old_value=False):
:param defined: Zabbix object definition taken from sls file.
:param existing: Existing Zabbix object taken from result of an API call.
:param return_old_value: Default False. If True, returns dict("old"=old_val, "new"=new_val) for rollback purpose.
:return: Params that are different from existing object. Result extended by object ID can be passed directly to
Zabbix API update method.
:return: Params that are different from existing object. Result extended by
object ID can be passed directly to Zabbix API update method.
'''
# Comparison of data types
if not isinstance(defined, type(existing)):

6
salt/renderers/hjson.py
View file

@ -1,8 +1,10 @@
# -*- coding: utf-8 -*-
'''
Hjson_ renderer for Salt
hjson renderer for Salt
.. _Hjson: http://laktak.github.io/hjson/
See the hjson_ documentation for more information
.. _hjson: http://laktak.github.io/hjson/
'''
from __future__ import absolute_import, print_function, unicode_literals

6
salt/returners/pgjsonb.py
View file

@ -64,11 +64,11 @@ Should you wish the returner data to be cleaned out every so often, set
Setting it to ``0`` or leaving it unset will cause the data to stay in the tables.
Should you wish to archive jobs in a different table for later processing,
set ``archive_jobs`` to True. Salt will create 3 archive tables
set ``archive_jobs`` to True. Salt will create 3 archive tables;
- ``jids_archive``
- ``salt_returns_archive`
- ``salt_events_archive`
- ``salt_returns_archive``
- ``salt_events_archive``
and move the contents of ``jids``, ``salt_returns``, and ``salt_events`` that are
more than ``keep_jobs`` hours old to these tables.

4
salt/states/cimc.py
View file

@ -2,7 +2,7 @@
'''
A state module to manage Cisco UCS chassis devices.
:codeauthor: :email:`Spencer Ervin <spencer_ervin@hotmail.com>`
:codeauthor: ``Spencer Ervin <spencer_ervin@hotmail.com>``
:maturity: new
:depends: none
:platform: unix
@ -14,7 +14,7 @@ This state module was designed to handle connections to a Cisco Unified Computin
relies on the CIMC proxy module to interface with the device.
.. seealso::
:prox:`CIMC Proxy Module <salt.proxy.cimc>`
:py:mod:`CIMC Proxy Module <salt.proxy.cimc>`
'''

4
salt/states/event.py
View file

@ -27,8 +27,8 @@ def send(name,
<salt.modules.event.send>` execution module of the same name,
with the additional argument:
:param show_changed: state will show as changed with the data
argument as the change value. If false, shows as unchanged.
:param show_changed: If ``True``, state will show as changed with the data
argument as the change value. If ``False``, shows as unchanged.
Example:

6
salt/states/panos.py
View file

@ -2,7 +2,7 @@
'''
A state module to manage Palo Alto network devices.
:codeauthor: :email:`Spencer Ervin <spencer_ervin@hotmail.com>`
:codeauthor: ``Spencer Ervin <spencer_ervin@hotmail.com>``
:maturity: new
:depends: none
:platform: unix
@ -64,7 +64,7 @@ The proxy['panos.is_required_version'] method will check if a panos device is cu
greater than the passed version. For example, proxy['panos.is_required_version']('7.0.0') would match both 7.1.0 and
8.0.0.
.. code-block:: yaml
.. code-block:: jinja
{% if proxy['panos.is_required_version']('8.0.0') %}
panos/deviceconfig/system/motd-and-banner:
@ -79,7 +79,7 @@ greater than the passed version. For example, proxy['panos.is_required_version']
{% endif %}
.. seealso::
:prox:`Palo Alto Proxy Module <salt.proxy.panos>`
:py:mod:`Palo Alto Proxy Module <salt.proxy.panos>`
'''

4
salt/states/zabbix_template.py
View file

@ -380,8 +380,8 @@ def present(name, params, static_host_list=True, **kwargs):
:param name: Zabbix Template name
:param params: Additional parameters according to Zabbix API documentation
:param static_host_list: If hosts assigned to the template are controlled only by this state or can be also
assigned externally
:param static_host_list: If hosts assigned to the template are controlled
only by this state or can be also assigned externally
:param _connection_user: Optional - zabbix user (can also be set in opts or pillar, see module's docstring)
:param _connection_password: Optional - zabbix password (can also be set in opts or pillar, see module's docstring)
:param _connection_url: Optional - url of zabbix frontend (can also be set in opts, pillar, see module's docstring)