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

Update refrences to Oxygen codename to 2018.3.0

Browse source
This commit is contained in:
Erik Johnson 2018-02-21 21:47:41 -06:00
parent 2934d55c0b
commit 1668a489c4
No known key found for this signature in database
GPG key ID: 5E5583C437808F3F
169 changed files with 763 additions and 706 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1364,7 +1364,7 @@ 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:: Oxygen
.. 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.
@ -1389,7 +1389,7 @@ membership in the :conf_master:`autosign_file` and the
``autosign_grains_dir``
-----------------------
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Default: ``not defined``
@ -1886,7 +1886,7 @@ Set additional directories to search for runner modules.
``utils_dirs``
---------------
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Default: ``[]``
@ -2096,7 +2096,7 @@ the cloud profile or master config file, no templating will be performed.
``jinja_env``
-------------
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Default: ``{}``
@ -2132,7 +2132,7 @@ The default options are:
``jinja_sls_env``
-----------------
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Default: ``{}``
@ -2202,7 +2202,7 @@ be used if you had not set the line_statement and line_comment options:
``jinja_trim_blocks``
---------------------
.. deprecated:: Oxygen
.. deprecated:: 2018.3.0
Replaced by :conf_master:`jinja_env` and :conf_master:`jinja_sls_env`
.. versionadded:: 2014.1.0
@ -2222,7 +2222,7 @@ to the Jinja environment init variable ``trim_blocks``.
``jinja_lstrip_blocks``
-----------------------
.. deprecated:: Oxygen
.. deprecated:: 2018.3.0
Replaced by :conf_master:`jinja_env` and :conf_master:`jinja_sls_env`
.. versionadded:: 2014.1.0
@ -2631,7 +2631,7 @@ Example:
``roots_update_interval``
*************************
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Default: ``60``
@ -2818,7 +2818,7 @@ gitfs remotes.
``gitfs_disable_saltenv_mapping``
*********************************
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Default: ``False``
@ -2841,7 +2841,7 @@ parameters <gitfs-per-saltenv-config>`.
``gitfs_ref_types``
*******************
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Default: ``['branch', 'tag', 'sha']``
@ -2873,7 +2873,7 @@ are mapped as saltenvs:
***************************
.. versionadded:: 2014.7.0
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Renamed from ``gitfs_env_whitelist`` to ``gitfs_saltenv_whitelist``
Default: ``[]``
@ -2896,7 +2896,7 @@ information can be found in the :ref:`GitFS Walkthrough
***************************
.. versionadded:: 2014.7.0
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Renamed from ``gitfs_env_blacklist`` to ``gitfs_saltenv_blacklist``
Default: ``[]``
@ -2948,7 +2948,7 @@ they were created by a different master.
``gitfs_update_interval``
*************************
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Default: ``60``
@ -3263,7 +3263,7 @@ bookmark should be used as the ``base`` environment.
**************************
.. versionadded:: 2014.7.0
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Renamed from ``hgfs_env_whitelist`` to ``hgfs_saltenv_whitelist``
Default: ``[]``
@ -3293,7 +3293,7 @@ blacklist will be exposed as fileserver environments.
**************************
.. versionadded:: 2014.7.0
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Renamed from ``hgfs_env_blacklist`` to ``hgfs_saltenv_blacklist``
Default: ``[]``
@ -3322,7 +3322,7 @@ blacklist will be exposed as fileserver environments.
``hgfs_update_interval``
************************
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Default: ``60``
@ -3490,7 +3490,7 @@ also be configured on a per-remote basis, see :conf_master:`here
***************************
.. versionadded:: 2014.7.0
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Renamed from ``svnfs_env_whitelist`` to ``svnfs_saltenv_whitelist``
Default: ``[]``
@ -3520,7 +3520,7 @@ will be exposed as fileserver environments.
***************************
.. versionadded:: 2014.7.0
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Renamed from ``svnfs_env_blacklist`` to ``svnfs_saltenv_blacklist``
Default: ``[]``
@ -3549,7 +3549,7 @@ will be exposed as fileserver environments.
``svnfs_update_interval``
*************************
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Default: ``60``
@ -3655,7 +3655,7 @@ exposed.
``minionfs_update_interval``
****************************
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Default: ``60``
@ -3684,7 +3684,7 @@ examples.
``azurefs_update_interval``
***************************
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Default: ``60``
@ -3706,7 +3706,7 @@ See the :mod:`s3fs documentation <salt.fileserver.s3fs>` for usage examples.
``s3fs_update_interval``
************************
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Default: ``60``

20
doc/ref/configuration/minion.rst
View file

@ -138,7 +138,7 @@ name) is set in the :conf_minion:`master` configuration setting.
``master_tops_first``
---------------------
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Default: ``False``
@ -340,7 +340,7 @@ option on the Salt master.
``source_interface_name``
-------------------------
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
The name of the interface to use when establishing the connection to the Master.
@ -379,7 +379,7 @@ Configuration example:
``source_address``
------------------
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
The source IP address or the domain name to be used when connecting the Minion
to the Master.
@ -404,7 +404,7 @@ Configuration example:
``source_ret_port``
-------------------
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
The source port to be used when connecting the Minion to the Master ret server.
@ -427,7 +427,7 @@ Configuration example:
``source_publish_port``
-----------------------
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
The source port to be used when connecting the Minion to the Master publish
server.
@ -1324,7 +1324,7 @@ The password used for HTTP proxy access.
``docker.compare_container_networks``
-------------------------------------
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Default: ``{'static': ['Aliases', 'Links', 'IPAMConfig'], 'automatic': ['IPAddress', 'Gateway', 'GlobalIPv6Address', 'IPv6Gateway']}``
@ -1904,7 +1904,7 @@ enabled and can be disabled by changing this value to ``False``.
``saltenv``
-----------
.. versionchanged:: Oxygen
.. 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.
@ -1923,7 +1923,7 @@ environments is to isolate via the top file.
``lock_saltenv``
----------------
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Default: ``False``
@ -2455,7 +2455,7 @@ minion's pki directory.
``autosign_grains``
-------------------
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Default: ``not defined``
@ -2648,7 +2648,7 @@ executed in a thread.
``process_count_max``
-------
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Default: ``-1``

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

@ -257,7 +257,7 @@ large groups of states easily in any requisite statement.
require_any
~~~~~~~~~~~
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
The use of ``require_any`` demands that one of the required states executes before the
dependent state. The state containing the ``require_any`` requisite is defined as the
@ -380,7 +380,7 @@ to Salt ensuring that the service is running.
watch_any
~~~~~~~~~
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
The state containing the ``watch_any`` requisite is defined as the watching
state. The states specified in the ``watch_any`` statement are defined as the watched
@ -517,7 +517,7 @@ The ``onfail`` requisite is applied in the same way as ``require`` as ``watch``:
onfail_any
~~~~~~~~~~
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
The ``onfail_any`` requisite allows for reactions to happen strictly as a response
to the failure of at least one other state. This can be used in a number of ways, such as
@ -616,7 +616,7 @@ if any of the watched states changes.
onchanges_any
~~~~~~~~~~~~~
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
The ``onchanges_any`` requisite makes a state only apply one of the required states
generates changes, and if one of the watched state's "result" is ``True``. This can be

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

@ -156,7 +156,7 @@ A State Module must return a dict containing the following keys/values:
in test mode without applying the change, ``False`` can be returned.
- **comment:** A list of strings or a single string summarizing the result.
Note that support for lists of strings is available as of Salt Oxygen.
Note that support for lists of strings is available as of Salt 2018.3.0.
Lists of strings will be joined with newlines to form the final comment;
this is useful to allow multiple comments from subparts of a state.
Prefer to keep line lengths short (use multiple lines as needed),

4
doc/topics/cloud/misc.rst
View file

@ -392,7 +392,7 @@ script, a cloud profile using ``file_map`` might look like:
Running Pre-Flight Commands
===========================
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
To execute specified preflight shell commands on a VM before the deploy script is
run, use the ``preflight_cmds`` option. These must be defined as a list in a cloud
@ -413,7 +413,7 @@ These commands will run in sequence **before** the bootstrap script is executed.
Force Minion Config
===================
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
The ``force_minion_config`` option requests the bootstrap process to overwrite
an existing minion configuration file and public/private key files.

4
doc/topics/cloud/saltify.rst
View file

@ -89,7 +89,7 @@ to it can be verified with Salt:
Destroy Options
---------------
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
For obvious reasons, the ``destroy`` action does not actually vaporize hardware.
If the salt master is connected, it can tear down parts of the client machines.
@ -113,7 +113,7 @@ and can execute the following options:
Wake On LAN
-----------
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
In addition to connecting a hardware machine to a Salt master,
you have the option of sending a wake-on-LAN

2
doc/topics/cloud/vmware.rst
View file

@ -286,7 +286,7 @@ Set up an initial profile at ``/etc/salt/cloud.profiles`` or
eagerly_scrub
Specifies whether the disk should be rewrite with zeros during thick provisioning or not.
Default is ``eagerly_scrub: False``.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
controller
Specify the SCSI controller label to which this disk should be attached.
This should be specified only when creating both the specified SCSI

2
doc/topics/development/conventions/formulas.rst
View file

@ -58,7 +58,7 @@ States. GitFS is a quick and natural way to use Formulas.
3. Restart the Salt master.
Beginning with the Oxygen release, using formulas with GitFS is now much more
Beginning with the 2018.3.0 release, using formulas with GitFS is now much more
convenient for deployments which use many different fileserver environments
(i.e. saltenvs). Using the :ref:`all_saltenvs <gitfs-global-remotes>`
parameter, files from a single git branch/tag will appear in all environments.

8
doc/topics/jinja/index.rst
View file

@ -834,7 +834,7 @@ Returns:
----------
.. versionadded:: 2017.7.0
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Renamed from ``str_to_num`` to ``to_num``.
Converts a string to its numerical value.
@ -882,7 +882,7 @@ Example:
--------------------
.. versionadded:: 2017.7.0
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Renamed from ``json_decode_list`` to ``json_encode_list``. When you encode
something you get bytes, and when you decode, you get your locale's
encoding (usually a ``unicode`` type). This filter was incorrectly-named
@ -911,7 +911,7 @@ Returns:
--------------------
.. versionadded:: 2017.7.0
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Renamed from ``json_decode_dict`` to ``json_encode_dict``. When you encode
something you get bytes, and when you decode, you get your locale's
encoding (usually a ``unicode`` type). This filter was incorrectly-named
@ -942,7 +942,7 @@ Returns:
---------------
.. versionadded:: 2017.7.0
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Renamed from ``rand_str`` to ``random_hash`` to more accurately describe
what the filter does. ``rand_str`` will be supported until the Neon
release.

2
doc/topics/master_tops/index.rst
View file

@ -89,6 +89,6 @@ bare-bones example:
.. note::
If a master_tops module returns :ref:`top file <states-top>` data for a
given minion, it will be added to the states configured in the top file. It
will *not* replace it altogether. The Oxygen release adds additional
will *not* replace it altogether. The 2018.3.0 release adds additional
functionality allowing a minion to treat master_tops as the single source
of truth, irrespective of the top file.

12
doc/topics/orchestrate/orchestrate_runner.rst
View file

@ -263,16 +263,16 @@ To execute with pillar data.
Return Codes in Runner/Wheel Jobs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
State (``salt.state``) jobs are able to report failure via the :ref:`state
return dictionary <state-return-data>`. Remote execution (``salt.function``)
jobs are able to report failure by setting a ``retcode`` key in the
``__context__`` dictionary. However, runner (``salt.runner``) and wheel
(``salt.wheel``) jobs would only report a ``False`` result when the
runner/wheel function raised an exception. As of the Oxygen release, it is now
possible to set a retcode in runner and wheel functions just as you can do in
remote execution functions. Here is some example pseudocode:
runner/wheel function raised an exception. As of the 2018.3.0 release, it is
now possible to set a retcode in runner and wheel functions just as you can do
in remote execution functions. Here is some example pseudocode:
.. code-block:: python
@ -591,11 +591,11 @@ loadable and parsable format:
}
The Oxygen release includes a couple fixes to make parsing this data easier and
The 2018.3.0 release includes a couple fixes to make parsing this data easier and
more accurate. The first is the ability to set a :ref:`return code
<orchestrate-runner-return-codes-runner-wheel>` in a custom runner or wheel
function, as noted above. The second is a change to how failures are included
in the return data. Prior to the Oxygen release, minions that failed a
in the return data. Prior to the 2018.3.0 release, minions that failed a
``salt.state`` orchestration job would show up in the ``comment`` field of the
return data, in a human-readable string that was not easily parsed. They are
now included in the ``changes`` dictionary alongside the minions that

3
doc/topics/proxyminion/index.rst
View file

@ -157,7 +157,8 @@ will need to be restarted to pick up any changes. A corresponding utility funct
In addition, a salt.utils helper function called `is_proxy()` was added to make
it easier to tell when the running minion is a proxy minion. **NOTE: This
function was renamed to salt.utils.platform.is_proxy() for the Oxygen release**
function was renamed to salt.utils.platform.is_proxy() for the 2018.3.0
release**
New in 2015.8
-------------

9
doc/topics/reactor/index.rst
View file

@ -115,11 +115,10 @@ Name Description
============================== ==================================================================================
.. note::
The ``local`` and ``caller`` reaction types will be renamed for the Oxygen
release. These reaction types were named after Salt's internal client
interfaces, and are not intuitively named. Both ``local`` and ``caller``
will continue to work in Reactor SLS files, but for the Oxygen release the
documentation will be updated to reflect the new preferred naming.
The ``local`` and ``caller`` reaction types will likely be renamed in a
future release. These reaction types were named after Salt's internal
client interfaces, and are not intuitively named. Both ``local`` and
``caller`` will continue to work in Reactor SLS files, however.
Where to Put Reactor SLS Files
==============================

10
doc/topics/releases/version_numbers.rst
View file

@ -34,7 +34,7 @@ Assigned codenames:
- Boron: ``2016.3.0``
- Carbon: ``2016.11.0``
- Nitrogen: ``2017.7.0``
- Oxygen: ``TBD``
- Oxygen: ``2018.3.0``
- Fluorine: ``TBD``
Example
@ -69,10 +69,10 @@ Example arguments for `git checkout`:
+------------+----------------------------------------------------------------------------+
| v2016.11.1 | Tag signaling the commit that the 2016.11.1 release is based on. |
+------------+----------------------------------------------------------------------------+
Further reading on `release branch and develop branch
Further reading on `release branch and develop branch
<https://docs.saltstack.com/en/latest/topics/development/contributing.html#which-salt-branch>`_.
Influence of the `git checkout` argument on `git describe`:
+------------+----------------------------+-----------------------------------------------+
@ -97,4 +97,4 @@ Some details of v2016.11.1-220-g9a1550d (from `git describe` after `git checkout
|220 | Commits on top of the most recent tag, relative to your local git fetch |
+---------------+-------------------------------------------------------------------------+
|gf2eb3dc | 'g' + git SHA ("abbreviated name") of the most recent commit |
+---------------+-------------------------------------------------------------------------+
+---------------+-------------------------------------------------------------------------+

2
doc/topics/slots/index.rst
View file

@ -4,7 +4,7 @@
Slots
=====
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
.. note:: This functionality is under development and could be changed in the
future releases

2
doc/topics/tutorials/autoaccept_grains.rst
View file

@ -4,7 +4,7 @@
Autoaccept minions from Grains
==============================
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
To automatically accept minions based on certain characteristics, e.g. the ``uuid``
you can specify certain grain values on the salt master. Minions with matching grains

14
doc/topics/tutorials/gitfs.rst
View file

@ -196,7 +196,7 @@ master:
- gitfs
.. note::
``git`` also works here. Prior to the Oxygen release, *only* ``git``
``git`` also works here. Prior to the 2018.3.0 release, *only* ``git``
would work.
2. Specify one or more ``git://``, ``https://``, ``file://``, or ``ssh://``
@ -314,9 +314,9 @@ configured gitfs remotes):
* :conf_master:`gitfs_privkey` (**pygit2 only**, new in 2014.7.0)
* :conf_master:`gitfs_passphrase` (**pygit2 only**, new in 2014.7.0)
* :conf_master:`gitfs_refspecs` (new in 2017.7.0)
* :conf_master:`gitfs_disable_saltenv_mapping` (new in Oxygen)
* :conf_master:`gitfs_ref_types` (new in Oxygen)
* :conf_master:`gitfs_update_interval` (new in Oxygen)
* :conf_master:`gitfs_disable_saltenv_mapping` (new in 2018.3.0)
* :conf_master:`gitfs_ref_types` (new in 2018.3.0)
* :conf_master:`gitfs_update_interval` (new in 2018.3.0)
.. note::
pygit2 only supports disabling SSL verification in versions 0.23.2 and
@ -370,7 +370,7 @@ tremendous amount of customization. Here's some example usage:
``name``, ``saltenv``, and ``all_saltenvs`` parameters, which are only
available to per-remote configurations.
The ``all_saltenvs`` parameter is new in the Oxygen release.
The ``all_saltenvs`` parameter is new in the 2018.3.0 release.
In the example configuration above, the following is true:
@ -526,7 +526,7 @@ would only fetch branches and tags (the default).
Global Remotes
==============
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
The ``all_saltenvs`` per-remote configuration parameter overrides the logic
Salt uses to map branches/tags to fileserver environments (i.e. saltenvs). This
@ -553,7 +553,7 @@ single branch.
Update Intervals
================
Prior to the Oxygen release, GitFS would update its fileserver backends as part
Prior to the 2018.3.0 release, GitFS would update its fileserver backends as part
of a dedicated "maintenance" process, in which various routine maintenance
tasks were performed. This tied the update interval to the
:conf_master:`loop_interval` config option, and also forced all fileservers to

2
doc/topics/tutorials/libcloud.rst
View file

@ -4,7 +4,7 @@
Using Apache Libcloud for declarative and procedural multi-cloud orchestration
==============================================================================
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
.. note::

4
doc/topics/tutorials/minionfs.rst
View file

@ -86,8 +86,8 @@ option on the master:
- minionfs
.. note::
``minion`` also works here. Prior to the Oxygen release, *only* ``minion``
would work.
``minion`` also works here. Prior to the 2018.3.0 release, *only*
``minion`` would work.
Also, as described earlier, ``file_recv: True`` is needed to enable the
master to receive files pushed from minions. As always, changes to the

2
doc/topics/utils/index.rst
View file

@ -81,7 +81,7 @@ the ``foo`` utility module with a ``__virtual__`` function.
def bar():
return 'baz'
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Instantiating objects from classes declared in util modules works with
Master side modules, such as Runners, Outputters, etc.

2
salt/auth/__init__.py
View file

@ -389,7 +389,7 @@ class LoadAuth(object):
def check_authentication(self, load, auth_type, key=None, show_username=False):
'''
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Go through various checks to see if the token/eauth/user can be authenticated.

2
salt/auth/file.py
View file

@ -2,7 +2,7 @@
'''
Provide authentication using local files
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
The `file` auth module allows simple authentication via local files. Different
filetypes are supported, including:

2
salt/beacons/aix_account.py
View file

@ -2,7 +2,7 @@
'''
Beacon to fire event when we notice a AIX user is locked due to many failed login attempts.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:depends: none
'''

2
salt/beacons/napalm_beacon.py
View file

@ -3,7 +3,7 @@
NAPALM functions
================
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Watch NAPALM functions and fire events on specific triggers.

9
salt/cloud/clouds/cloudstack.py
View file

@ -42,10 +42,11 @@ from salt.ext import six
# pylint: disable=import-error
try:
from libcloud.compute.drivers.cloudstack import CloudStackNetwork
# This work-around for Issue #32743 is no longer needed for libcloud >= 1.4.0.
# However, older versions of libcloud must still be supported with this work-around.
# This work-around can be removed when the required minimum version of libcloud is
# 2.0.0 (See PR #40837 - which is implemented in Salt Oxygen).
# This work-around for Issue #32743 is no longer needed for libcloud >=
# 1.4.0. However, older versions of libcloud must still be supported with
# this work-around. This work-around can be removed when the required
# minimum version of libcloud is 2.0.0 (See PR #40837 - which is
# implemented in Salt 2018.3.0).
if _LooseVersion(libcloud.__version__) < _LooseVersion('1.4.0'):
# See https://github.com/saltstack/salt/issues/32743
import libcloud.security

9
salt/cloud/clouds/dimensiondata.py
View file

@ -40,10 +40,11 @@ try:
from libcloud.loadbalancer.types import Provider as Provider_lb
from libcloud.loadbalancer.providers import get_driver as get_driver_lb
# This work-around for Issue #32743 is no longer needed for libcloud >= 1.4.0.
# However, older versions of libcloud must still be supported with this work-around.
# This work-around can be removed when the required minimum version of libcloud is
# 2.0.0 (See PR #40837 - which is implemented in Salt Oxygen).
# This work-around for Issue #32743 is no longer needed for libcloud >=
# 1.4.0. However, older versions of libcloud must still be supported with
# this work-around. This work-around can be removed when the required
# minimum version of libcloud is 2.0.0 (See PR #40837 - which is
# implemented in Salt 2018.3.0).
if _LooseVersion(libcloud.__version__) < _LooseVersion('1.4.0'):
# See https://github.com/saltstack/salt/issues/32743
import libcloud.security

9
salt/cloud/clouds/gce.py
View file

@ -70,10 +70,11 @@ try:
ResourceInUseError,
ResourceNotFoundError,
)
# This work-around for Issue #32743 is no longer needed for libcloud >= 1.4.0.
# However, older versions of libcloud must still be supported with this work-around.
# This work-around can be removed when the required minimum version of libcloud is
# 2.0.0 (See PR #40837 - which is implemented in Salt Oxygen).
# This work-around for Issue #32743 is no longer needed for libcloud >=
# 1.4.0. However, older versions of libcloud must still be supported with
# this work-around. This work-around can be removed when the required
# minimum version of libcloud is 2.0.0 (See PR #40837 - which is
# implemented in Salt 2018.3.0).
if _LooseVersion(libcloud.__version__) < _LooseVersion('1.4.0'):
# See https://github.com/saltstack/salt/issues/32743
import libcloud.security

4
salt/cloud/clouds/opennebula.py
View file

@ -758,7 +758,7 @@ def get_template_image(kwargs=None, call=None):
'''
Returns a template's image from the given template name.
.. versionadded:: oxygen
.. versionadded:: 2018.3.0
.. code-block:: bash
@ -921,7 +921,7 @@ def _get_device_template(disk, disk_info, template=None):
'''
Returns the template format to create a disk in open nebula
.. versionadded:: oxygen
.. versionadded:: 2018.3.0
'''
def _require_disk_opts(*args):

12
salt/cloud/clouds/saltify.py
View file

@ -9,7 +9,7 @@ The Saltify module is designed to install Salt on a remote machine, virtual or
bare metal, using SSH. This module is useful for provisioning machines which
are already installed, but not Salted.
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The wake_on_lan capability, and actions destroy, reboot, and query functions were added.
Use of this module requires some configuration in cloud profile and provider
@ -88,7 +88,7 @@ def avail_images(call=None):
returns a list of available profiles.
..versionadded:: Oxygen
..versionadded:: 2018.3.0
'''
vm_ = get_configured_provider()
@ -118,7 +118,7 @@ def list_nodes(call=None):
returns a list of dictionaries of defined standard fields.
..versionadded:: Oxygen
..versionadded:: 2018.3.0
'''
nodes = _list_nodes_full(call)
@ -164,7 +164,7 @@ def list_nodes_full(call=None):
for 'saltify' minions, returns dict of grains (enhanced).
..versionadded:: Oxygen
..versionadded:: 2018.3.0
'''
ret = _list_nodes_full(call)
@ -399,7 +399,7 @@ def _verify(vm_):
def destroy(name, call=None):
''' Destroy a node.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Disconnect a minion from the master, and remove its keys.
@ -489,7 +489,7 @@ def reboot(name, call=None):
'''
Reboot a saltify minion.
..versionadded:: Oxygen
..versionadded:: 2018.3.0
name
The name of the VM to reboot.

2
salt/cloud/clouds/vagrant.py
View file

@ -10,7 +10,7 @@ Use of this module requires some configuration in cloud profile and provider
files as described in the
:ref:`Getting Started with Vagrant <getting-started-with-vagrant>` documentation.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
'''

2
salt/engines/http_logstash.py
View file

@ -6,7 +6,7 @@ HTTP Logstash engine
An engine that reads messages from the salt event bus and pushes
them onto a logstash endpoint via HTTP requests.
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
.. note::
By default, this engine take everything from the Salt bus and exports into

6
salt/fileserver/azurefs.py
View file

@ -12,9 +12,9 @@ the Master config file.
fileserver_backend:
- azurefs
Starting in Oxygen, this fileserver requires the standalone Azure Storage SDK
for Python. Theoretically any version >= v0.20.0 should work, but it was
developed against the v0.33.0 version.
Starting in Salt 2018.3.0, this fileserver requires the standalone Azure
Storage SDK for Python. Theoretically any version >= v0.20.0 should work, but
it was developed against the v0.33.0 version.
Each storage container will be mapped to an environment. By default, containers
will be mapped to the ``base`` environment. You can override this behavior with

2
salt/fileserver/gitfs.py
View file

@ -14,7 +14,7 @@ Master config file.
- gitfs
.. note::
``git`` also works here. Prior to the Oxygen release, *only* ``git``
``git`` also works here. Prior to the 2018.3.0 release, *only* ``git``
would work.
The Git fileserver backend supports both pygit2_ and GitPython_, to provide the

2
salt/fileserver/hgfs.py
View file

@ -11,7 +11,7 @@ Master config file.
- hgfs
.. note::
``hg`` also works here. Prior to the Oxygen release, *only* ``hg`` would
``hg`` also works here. Prior to the 2018.3.0 release, *only* ``hg`` would
work.
After enabling this backend, branches, bookmarks, and tags in a remote

4
salt/fileserver/minionfs.py
View file

@ -17,8 +17,8 @@ allowed to push files to the Master), and ``minionfs`` must be added to the
- minionfs
.. note::
``minion`` also works here. Prior to the Oxygen release, *only* ``minion``
would work.
``minion`` also works here. Prior to the 2018.3.0 release, *only*
``minion`` would work.
Other minionfs settings include: :conf_master:`minionfs_whitelist`,
:conf_master:`minionfs_blacklist`, :conf_master:`minionfs_mountpoint`, and

4
salt/fileserver/svnfs.py
View file

@ -13,8 +13,8 @@ Master config file.
- svnfs
.. note::
``svn`` also works here. Prior to the Oxygen release, *only* ``svn`` would
work.
``svn`` also works here. Prior to the 2018.3.0 release, *only* ``svn``
would work.
This backend assumes a standard svn layout with directories for ``branches``,
``tags``, and ``trunk``, at the repository root.

2
salt/grains/zfs.py
View file

@ -7,7 +7,7 @@ ZFS grain provider
:depends: salt.utils, salt.module.cmdmod
:platform: illumos,freebsd,linux
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
'''
from __future__ import absolute_import, print_function, unicode_literals

2
salt/modules/aix_shadow.py
View file

@ -2,7 +2,7 @@
'''
Manage account locks on AIX systems
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:depends: none
'''

2
salt/modules/aptly.py
View file

@ -2,7 +2,7 @@
'''
Aptly Debian repository manager.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
'''
# Import python libs
from __future__ import absolute_import, print_function, unicode_literals

8
salt/modules/aptpkg.py
View file

@ -497,7 +497,7 @@ def install(name=None,
Install a specific version of the package, e.g. 1.2.3~0ubuntu0. Ignored
if "pkgs" or "sources" is passed.
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
version can now contain comparison operators (e.g. ``>1.2.3``,
``<=2.0``, etc.)
@ -518,7 +518,7 @@ def install(name=None,
ignored when comparing the currently-installed version to the desired
version.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Multiple Package Installation Options:
@ -1086,7 +1086,7 @@ def upgrade(refresh=True, dist_upgrade=False, **kwargs):
download_only
Only donwload the packages, don't unpack or install them
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
force_conf_new
Always install the new version of any configuration files.
@ -2160,7 +2160,7 @@ def mod_repo(repo, saltenv='base', **kwargs):
key_text
GPG key in string form to add to the APT GPG keyring
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
consolidate : False
If ``True``, will attempt to de-duplicate and consolidate sources

4
salt/modules/archive.py
View file

@ -157,7 +157,7 @@ def list_(name,
re-downloading the archive if the cached copy matches the specified
hash.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
.. _tarfile: https://docs.python.org/2/library/tarfile.html
.. _xz: http://tukaani.org/xz/
@ -1135,7 +1135,7 @@ def is_encrypted(name, clean=False, saltenv='base', source_hash=None):
re-downloading the archive if the cached copy matches the specified
hash.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
CLI Examples:

2
salt/modules/boto_cloudfront.py
View file

@ -2,7 +2,7 @@
'''
Connection module for Amazon CloudFront
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:depends: boto3

2
salt/modules/boto_ec2.py
View file

@ -1865,7 +1865,7 @@ def get_all_tags(filters=None, region=None, key=None, keyid=None, profile=None):
'''
Describe all tags matching the filter criteria, or all tags in the account otherwise.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
filters
(dict) - Additional constraints on which volumes to return. Note that valid filters vary

2
salt/modules/boto_route53.py
View file

@ -343,7 +343,7 @@ def create_healthcheck(ip_addr=None, fqdn=None, region=None, key=None, keyid=Non
'''
Create a Route53 healthcheck
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
ip_addr

2
salt/modules/boto_s3.py
View file

@ -2,7 +2,7 @@
'''
Connection module for Amazon S3 using boto3
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:configuration: This module accepts explicit AWS credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles or

2
salt/modules/chocolatey.py
View file

@ -432,7 +432,7 @@ def install(name,
execution_timeout (str):
Chocolatey execution timeout value you want to pass to the installation process. Default is None.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Returns:
str: The output of the ``chocolatey`` command

56
salt/modules/cmdmod.py
View file

@ -856,7 +856,7 @@ def run(cmd,
:param str prepend_path: $PATH segment to prepend (trailing ':' not
necessary) to $PATH
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param str template: If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
@ -881,7 +881,7 @@ def run(cmd,
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
@ -904,7 +904,7 @@ def run(cmd,
This is separate from ``output_loglevel``, which only handles how
Salt logs to the minion log.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param int timeout: A timeout in seconds for the executed process to return.
@ -1087,7 +1087,7 @@ def shell(cmd,
:param str prepend_path: $PATH segment to prepend (trailing ':' not necessary)
to $PATH
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param str template: If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
@ -1112,7 +1112,7 @@ def shell(cmd,
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
@ -1135,7 +1135,7 @@ def shell(cmd,
This is separate from ``output_loglevel``, which only handles how
Salt logs to the minion log.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param int timeout: A timeout in seconds for the executed process to
return.
@ -1286,7 +1286,7 @@ def run_stdout(cmd,
:param str prepend_path: $PATH segment to prepend (trailing ':' not necessary)
to $PATH
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param str template: If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
@ -1311,7 +1311,7 @@ def run_stdout(cmd,
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
@ -1334,7 +1334,7 @@ def run_stdout(cmd,
This is separate from ``output_loglevel``, which only handles how
Salt logs to the minion log.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param int timeout: A timeout in seconds for the executed process to
return.
@ -1482,7 +1482,7 @@ def run_stderr(cmd,
:param str prepend_path: $PATH segment to prepend (trailing ':' not
necessary) to $PATH
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param str template: If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
@ -1507,7 +1507,7 @@ def run_stderr(cmd,
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
@ -1530,7 +1530,7 @@ def run_stderr(cmd,
This is separate from ``output_loglevel``, which only handles how
Salt logs to the minion log.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param int timeout: A timeout in seconds for the executed process to
return.
@ -1680,7 +1680,7 @@ def run_all(cmd,
:param str prepend_path: $PATH segment to prepend (trailing ':' not
necessary) to $PATH
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param str template: If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,
@ -1705,7 +1705,7 @@ def run_all(cmd,
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
@ -1728,7 +1728,7 @@ def run_all(cmd,
This is separate from ``output_loglevel``, which only handles how
Salt logs to the minion log.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param int timeout: A timeout in seconds for the executed process to
return.
@ -1739,7 +1739,7 @@ def run_all(cmd,
:param bool encoded_cmd: Specify if the supplied command is encoded.
Only applies to shell 'powershell'.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param bool redirect_stderr: If set to ``True``, then stderr will be
redirected to stdout. This is helpful for cases where obtaining both
@ -1921,7 +1921,7 @@ def retcode(cmd,
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
@ -2152,7 +2152,7 @@ def script(source,
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
@ -2175,7 +2175,7 @@ def script(source,
This is separate from ``output_loglevel``, which only handles how
Salt logs to the minion log.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param int timeout: If the command has not terminated after timeout
seconds, send the subprocess sigterm, and if sigterm is ignored, follow
@ -2382,7 +2382,7 @@ def script_retcode(source,
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
@ -2664,7 +2664,7 @@ def run_chroot(root,
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
@ -2687,7 +2687,7 @@ def run_chroot(root,
This is separate from ``output_loglevel``, which only handles how
Salt logs to the minion log.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param int timeout:
A timeout in seconds for the executed process to return.
@ -3125,7 +3125,7 @@ def powershell(cmd,
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
@ -3148,7 +3148,7 @@ def powershell(cmd,
This is separate from ``output_loglevel``, which only handles how
Salt logs to the minion log.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param int timeout: A timeout in seconds for the executed process to return.
@ -3329,7 +3329,7 @@ def powershell_all(cmd,
salt '*' cmd.run_all '$PSVersionTable.CLRVersion' shell=powershell
salt '*' cmd.run_all 'Get-NetTCPConnection' shell=powershell
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
.. warning::
@ -3409,7 +3409,7 @@ def powershell_all(cmd,
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
@ -3615,7 +3615,7 @@ def run_bg(cmd,
the `locale` line in the output of :py:func:`test.versions_report
<salt.modules.test.versions_report>`.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param str output_loglevel: Control the loglevel at which the output from
the command is logged to the minion log.
@ -3665,7 +3665,7 @@ def run_bg(cmd,
:param str prepend_path: $PATH segment to prepend (trailing ':' not
necessary) to $PATH
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:param str template: If this setting is applied then the named templating
engine will be used to render the downloaded file. Currently jinja,

8
salt/modules/cp.py
View file

@ -240,7 +240,7 @@ def get_file(path,
gzip=None,
**kwargs):
'''
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
``dest`` can now be a directory
Used to get a single file from the salt master
@ -354,7 +354,7 @@ def get_dir(path, dest, saltenv='base', template=None, gzip=None, **kwargs):
def get_url(path, dest='', saltenv='base', makedirs=False, source_hash=None):
'''
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
``dest`` can now be a directory
Used to get a single file from a URL.
@ -391,7 +391,7 @@ def get_url(path, dest='', saltenv='base', makedirs=False, source_hash=None):
minion's file cache, this option can be passed to keep the minion from
re-downloading the file if the cached copy matches the specified hash.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
CLI Example:
@ -445,7 +445,7 @@ def cache_file(path, saltenv='base', source_hash=None):
minion's file cache, this option can be passed to keep the minion from
re-downloading the file if the cached copy matches the specified hash.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
CLI Example:

2
salt/modules/cryptdev.py
View file

@ -2,7 +2,7 @@
'''
Salt module to manage Unix cryptsetup jobs and the crypttab file
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
'''
# Import python libraries

2
salt/modules/debian_service.py
View file

@ -229,7 +229,7 @@ def status(name, sig=None):
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The service name can now be a glob (e.g. ``salt*``)
Args:

100
salt/modules/dockermod.py
View file

@ -789,7 +789,7 @@ def get_client_args(limit=None):
.. versionchanged:: 2017.7.0
Replaced the container config args with the ones from the API's
``create_container`` function.
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Added ability to limit the input to specific client functions
Many functions in Salt have been written to support the full list of
@ -884,7 +884,7 @@ def _get_create_kwargs(skip_translate=None,
def compare_containers(first, second, ignore=None):
'''
.. versionadded:: 2017.7.0
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Renamed from ``docker.compare_container`` to
``docker.compare_containers`` (old function name remains as an alias)
@ -967,7 +967,7 @@ compare_container = salt.utils.functools.alias_function(
def compare_container_networks(first, second):
'''
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Returns the differences between two containers' networks. When a network is
only present one of the two containers, that network's diff will simply be
@ -1204,7 +1204,7 @@ def compare_container_networks(first, second):
def compare_networks(first, second, ignore='Name,Id,Created,Containers'):
'''
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Compare two networks and return any differences between the two
@ -1277,7 +1277,7 @@ def compare_networks(first, second, ignore='Name,Id,Created,Containers'):
def connected(name, verbose=False):
'''
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Return a list of running containers attached to the specified network
@ -1866,7 +1866,7 @@ def list_tags():
def resolve_image_id(name):
'''
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Given an image name (or partial image ID), return the full image ID. If no
match is found among the locally-pulled images, then ``False`` will be
@ -1897,7 +1897,7 @@ def resolve_image_id(name):
def resolve_tag(name, tags=None, **kwargs):
'''
.. versionadded:: 2017.7.2
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Instead of matching against pulled tags using
:py:func:`docker.list_tags <salt.modules.dockermod.list_tags>`, this
function now simply inspects the passed image name using
@ -1920,10 +1920,10 @@ def resolve_tag(name, tags=None, **kwargs):
is found but there are no tags, then a list will still be returned, but
it will simply contain the image ID.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
tags
.. deprecated:: Oxygen
.. deprecated:: 2018.3.0
Ignored if passed, will be removed in the Neon release.
CLI Examples:
@ -1972,7 +1972,7 @@ def resolve_tag(name, tags=None, **kwargs):
def logs(name, **kwargs):
'''
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Support for all of docker-py's `logs()`_ function's arguments, with the
exception of ``stream``.
@ -2393,7 +2393,7 @@ def create(image,
start : False
If ``True``, start container after creating it
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
skip_translate
This function translates Salt CLI or SLS input into the format which
@ -2764,7 +2764,7 @@ def create(image,
- ``labels=foo,bar=baz``
- ``labels="['foo', 'bar=baz']"``
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Labels both with and without values can now be mixed. Earlier
releases only permitted one method or the other.
@ -3158,7 +3158,7 @@ def run_container(image,
networks=None,
**kwargs):
'''
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Equivalent to ``docker run`` on the Docker CLI. Runs the container, waits
for it to exit, and returns the container's logs when complete.
@ -3762,7 +3762,7 @@ def rm_(name, force=False, volumes=False, **kwargs):
Optional timeout to be passed to :py:func:`docker.stop
<salt.modules.dockermod.stop>` if stopping the container.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
volumes : False
Also remove volumes associated with container
@ -3839,7 +3839,7 @@ def build(path=None,
buildargs=None,
image=None):
'''
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
If the built image should be tagged, then the repository and tag must
now be passed separately using the ``repository`` and ``tag``
arguments, rather than together in the (now deprecated) ``image``
@ -3853,15 +3853,15 @@ def build(path=None,
repository
Optional repository name for the image being built
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
tag : latest
Tag name for the image (required if ``repository`` is passed)
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
image
.. deprecated:: Oxygen
.. deprecated:: 2018.3.0
Use both ``repository`` and ``tag`` instead
cache : True
@ -4020,7 +4020,7 @@ def commit(name,
author=None,
image=None):
'''
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The repository and tag must now be passed separately using the
``repository`` and ``tag`` arguments, rather than together in the (now
deprecated) ``image`` argument.
@ -4034,15 +4034,15 @@ def commit(name,
repository
Repository name for the image being committed
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
tag : latest
Tag name for the image
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
image
.. deprecated:: Oxygen
.. deprecated:: 2018.3.0
Use both ``repository`` and ``tag`` instead
message
@ -4168,7 +4168,7 @@ def import_(source,
api_response=False,
image=None):
'''
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The repository and tag must now be passed separately using the
``repository`` and ``tag`` arguments, rather than together in the (now
deprecated) ``image`` argument.
@ -4185,15 +4185,15 @@ def import_(source,
repository
Repository name for the image being imported
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
tag : latest
Tag name for the image
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
image
.. deprecated:: Oxygen
.. deprecated:: 2018.3.0
Use both ``repository`` and ``tag`` instead
api_response : False
@ -4276,7 +4276,7 @@ def import_(source,
def load(path, repository=None, tag=None, image=None):
'''
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
If the loaded image should be tagged, then the repository and tag must
now be passed separately using the ``repository`` and ``tag``
arguments, rather than together in the (now deprecated) ``image``
@ -4298,16 +4298,16 @@ def load(path, repository=None, tag=None, image=None):
<salt.modules.dockermod.tag_>`. If a repository name is provided, then
the ``tag`` argument is also required.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
tag
Tag name to go along with the repository name, if the loaded image is
to be tagged.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
image
.. deprecated:: Oxygen
.. deprecated:: 2018.3.0
Use both ``repository`` and ``tag`` instead
@ -4433,7 +4433,7 @@ def pull(image,
api_response=False,
client_timeout=salt.utils.docker.CLIENT_TIMEOUT):
'''
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
If no tag is specified in the ``image`` argument, all tags for the
image will be pulled. For this reason is it recommended to pass
``image`` using the ``repo:tag`` notation.
@ -4900,7 +4900,7 @@ def save(name,
def tag_(name, repository, tag='latest', force=False, image=None):
'''
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The repository and tag must now be passed separately using the
``repository`` and ``tag`` arguments, rather than together in the (now
deprecated) ``image`` argument.
@ -4914,15 +4914,15 @@ def tag_(name, repository, tag='latest', force=False, image=None):
repository
Repository name for the image to be built
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
tag : latest
Tag name for the image to be built
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
image
.. deprecated:: Oxygen
.. deprecated:: 2018.3.0
Use both ``repository`` and ``tag`` instead
force : False
@ -4964,7 +4964,7 @@ def networks(names=None, ids=None):
.. versionchanged:: 2017.7.0
The ``names`` and ``ids`` can be passed as a comma-separated list now,
as well as a Python list.
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The ``Containers`` key for each network is no longer always empty.
List existing networks
@ -5008,7 +5008,7 @@ def create_network(name,
client_timeout=salt.utils.docker.CLIENT_TIMEOUT,
**kwargs):
'''
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Support added for network configuration options other than ``driver``
and ``driver_opts``, as well as IPAM configuration.
@ -5053,7 +5053,7 @@ def create_network(name,
- docker-py `low-level API`_
- `Docker Engine API`_
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
ignore_collisions : False
Since many of docker-py's arguments differ in name from their CLI
@ -5064,7 +5064,7 @@ def create_network(name,
will be raised. Set this argument to ``True`` to suppress these errors
and keep the docker-py version of the argument.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
validate_ip_addrs : True
For parameters which accept IP addresses as input, IP address
@ -5076,7 +5076,7 @@ def create_network(name,
portion will be validated, and the subnet size will be checked to
confirm it is a valid number (1-32 for IPv4, 1-128 for IPv6).
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
.. _salt-modules-dockermod-create-network-netconf:
@ -5312,7 +5312,7 @@ def connect_container_to_network(container, net_id, **kwargs):
.. versionadded:: 2015.8.3
.. versionchanged:: 2017.7.0
Support for ``ipv4_address`` argument added
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
All arguments are now passed through to
`connect_container_to_network()`_, allowing for any new arguments added
to this function to be supported automagically.
@ -5396,7 +5396,7 @@ def disconnect_container_from_network(container, network_id):
def disconnect_all_containers_from_network(network_id):
'''
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Runs :py:func:`docker.disconnect_container_from_network
<salt.modules.dockermod.disconnect_container_from_network>` on all
@ -6582,7 +6582,7 @@ def sls(name, mods=None, **kwargs):
:conf_minion:`pillarenv` minion config option nor this CLI argument is
used, all Pillar environments will be merged together.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
pillar
Custom Pillar values, passed as a dictionary of key-value pairs
@ -6591,7 +6591,7 @@ def sls(name, mods=None, **kwargs):
Values passed this way will override Pillar values set via
``pillar_roots`` or an external Pillar source.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
CLI Example:
@ -6678,7 +6678,7 @@ def sls_build(repository,
dryrun=False,
**kwargs):
'''
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The repository and tag must now be passed separately using the
``repository`` and ``tag`` arguments, rather than together in the (now
deprecated) ``image`` argument.
@ -6692,15 +6692,15 @@ def sls_build(repository,
repository
Repository name for the image to be built
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
tag : latest
Tag name for the image to be built
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name
.. deprecated:: Oxygen
.. deprecated:: 2018.3.0
Use both ``repository`` and ``tag`` instead
base : opensuse/python
@ -6721,7 +6721,7 @@ def sls_build(repository,
:conf_minion:`pillarenv` minion config option nor this CLI argument is
used, all Pillar environments will be merged together.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
pillar
Custom Pillar values, passed as a dictionary of key-value pairs
@ -6730,7 +6730,7 @@ def sls_build(repository,
Values passed this way will override Pillar values set via
``pillar_roots`` or an external Pillar source.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
dryrun: False
when set to True the container will not be commited at the end of

22
salt/modules/file.py
View file

@ -505,7 +505,7 @@ def chgrp(path, group):
def _cmp_attrs(path, attrs):
'''
.. versionadded: Oxygen
.. versionadded:: 2018.3.0
Compare attributes of a given file to given attributes.
Returns a pair (list) where first item are attributes to
@ -534,7 +534,7 @@ def _cmp_attrs(path, attrs):
def lsattr(path):
'''
.. versionadded: Oxygen
.. versionadded:: 2018.3.0
Obtain the modifiable attributes of the given file. If path
is to a directory, an empty list is returned.
@ -565,7 +565,7 @@ def lsattr(path):
def chattr(*args, **kwargs):
'''
.. versionadded: Oxygen
.. versionadded:: 2018.3.0
Change the attributes of files
@ -3974,7 +3974,7 @@ def get_managed(
attrs
Attributes of file
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
context
Variables to add to the template context
@ -4726,7 +4726,7 @@ def check_file_meta(
attrs
Destination file attributes
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
saltenv
Salt environment used to resolve source files
@ -4832,14 +4832,14 @@ def get_diff(file1,
file1
The first file to feed into the diff utility
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Can now be either a local or remote file. In earlier releases,
thuis had to be a file local to the minion.
file2
The second file to feed into the diff utility
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Can now be either a local or remote file. In earlier releases, this
had to be a file on the salt fileserver (i.e.
``salt://somefile.txt``)
@ -4858,7 +4858,7 @@ def get_diff(file1,
except for within states, with the ``obfuscate_templates`` option set
to ``True``.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
source_hash_file1
If ``file1`` is an http(s)/ftp URL and the file exists in the minion's
@ -4866,7 +4866,7 @@ def get_diff(file1,
re-downloading the archive if the cached copy matches the specified
hash.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
source_hash_file2
If ``file2`` is an http(s)/ftp URL and the file exists in the minion's
@ -4874,7 +4874,7 @@ def get_diff(file1,
re-downloading the archive if the cached copy matches the specified
hash.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
CLI Examples:
@ -5012,7 +5012,7 @@ def manage_file(name,
attrs
attributes to be set on file: '' means remove all of them
.. versionadded: Oxygen
.. versionadded:: 2018.3.0
makedirs
make directories if they do not exist

2
salt/modules/freebsdservice.py
View file

@ -484,7 +484,7 @@ def status(name, sig=None, jail=None):
.. versionchanged:: 2016.3.4
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The service name can now be a glob (e.g. ``salt*``)
Args:

2
salt/modules/gcp_addon.py
View file

@ -6,7 +6,7 @@ and the set of routes for a particular VM is called its routing table.
For each packet leaving a virtual machine, the system searches that machine's
routing table for a single best matching route.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
This module will create a route to send traffic destined to the Internet
through your gateway instance.

2
salt/modules/gentoo_service.py
View file

@ -242,7 +242,7 @@ def status(name, sig=None):
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The service name can now be a glob (e.g. ``salt*``)
Args:

2
salt/modules/glanceng.py
View file

@ -2,7 +2,7 @@
'''
Glance module for interacting with OpenStack Glance
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:depends:shade

2
salt/modules/gpg.py
View file

@ -1051,7 +1051,7 @@ def verify(text=None,
signature
Specify the filename of a detached signature.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
CLI Example:

2
salt/modules/keystoneng.py
View file

@ -2,7 +2,7 @@
'''
Keystone module for interacting with OpenStack Keystone
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:depends:shade

2
salt/modules/launchctl.py
View file

@ -225,7 +225,7 @@ def status(name, runas=None):
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The service name can now be a glob (e.g. ``salt*``)
Args:

2
salt/modules/libcloud_compute.py
View file

@ -8,7 +8,7 @@ of supported clouds, see http://libcloud.readthedocs.io/en/latest/compute/suppor
Clouds include Amazon EC2, Azure, Google GCE, VMware, OpenStack Nova
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:configuration:
This module uses a configuration profile for one or multiple cloud providers

2
salt/modules/libcloud_loadbalancer.py
View file

@ -8,7 +8,7 @@ of supported clouds, see http://libcloud.readthedocs.io/en/latest/loadbalancer/s
Clouds include Amazon ELB, ALB, Google, Aliyun, CloudStack, Softlayer
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:configuration:
This module uses a configuration profile for one or multiple Storage providers

2
salt/modules/libcloud_storage.py
View file

@ -8,7 +8,7 @@ of supported clouds, see http://libcloud.readthedocs.io/en/latest/storage/suppor
Clouds include Amazon S3, Google Storage, Aliyun, Azure Blobs, Ceph, OpenStack swift
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:configuration:
This module uses a configuration profile for one or multiple Storage providers

4
salt/modules/logadm.py
View file

@ -183,7 +183,7 @@ def list_conf(conf_file=default_conf, log_file=None, include_unset=False):
'''
Show parsed configuration
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
conf_file : string
path to logadm.conf, defaults to /etc/logadm.conf
@ -222,7 +222,7 @@ def show_args():
'''
Show which arguments map to which flags and options.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
CLI Example:

2
salt/modules/mandrill.py
View file

@ -15,7 +15,7 @@ In the minion configuration file, the following block is required:
mandrill:
key: <API_KEY>
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
'''
# Import Python libs

6
salt/modules/mount.py
View file

@ -1303,7 +1303,7 @@ def is_mounted(name):
def read_mount_cache(name):
'''
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Provide information if the path is mounted
@ -1327,7 +1327,7 @@ def write_mount_cache(real_name,
fstype,
mount_opts):
'''
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Provide information if the path is mounted
@ -1367,7 +1367,7 @@ def write_mount_cache(real_name,
def delete_mount_cache(real_name):
'''
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Provide information if the path is mounted

28
salt/modules/napalm_network.py
View file

@ -380,7 +380,7 @@ def cli(*commands, **kwargs): # pylint: disable=unused-argument
textfsm_parse: ``False``
Try parsing the outputs using the TextFSM templates.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
.. note::
This option can be also specified in the minion configuration
@ -394,7 +394,7 @@ def cli(*commands, **kwargs): # pylint: disable=unused-argument
``salt://``, ``http://``, ``https://``, ``ftp://``,
``s3://``, ``swift://``.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
.. note::
This needs to be a directory with a flat structure, having an
@ -416,14 +416,14 @@ def cli(*commands, **kwargs): # pylint: disable=unused-argument
- ``s3://``
- ``swift://``
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
textfsm_template_dict
A dictionary with the mapping between a command
and the corresponding TextFSM path to use to extract the data.
The TextFSM paths can be specified as in ``textfsm_template``.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
.. note::
This option can be also specified in the minion configuration
@ -433,7 +433,7 @@ def cli(*commands, **kwargs): # pylint: disable=unused-argument
The name of the grain used to identify the platform name
in the TextFSM index file. Default: ``os``.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
.. note::
This option can be also specified in the minion configuration
@ -444,7 +444,7 @@ def cli(*commands, **kwargs): # pylint: disable=unused-argument
exactly as specified in the TextFSM index file.
Default: ``Platform``.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
.. note::
This is field is case sensitive, make sure
@ -458,7 +458,7 @@ def cli(*commands, **kwargs): # pylint: disable=unused-argument
index_file: ``index``
The name of the TextFSM index file, under the ``textfsm_path``. Default: ``index``.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
.. note::
This option can be also specified in the minion configuration
@ -468,26 +468,26 @@ def cli(*commands, **kwargs): # pylint: disable=unused-argument
Salt fileserver envrionment from which to retrieve the file.
Ignored if ``textfsm_path`` is not a ``salt://`` URL.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
include_empty: ``False``
Include empty files under the ``textfsm_path``.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
include_pat
Glob or regex to narrow down the files cached from the given path.
If matching with a regex, the regex must be prefixed with ``E@``,
otherwise the expression will be interpreted as a glob.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
exclude_pat
Glob or regex to exclude certain files from being cached from the given path.
If matching with a regex, the regex must be prefixed with ``E@``,
otherwise the expression will be interpreted as a glob.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
.. note::
If used with ``include_pat``, files matching this pattern will be
@ -1207,7 +1207,7 @@ def load_config(filename=None,
- ``s3://``
- ``swift://``
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
text
String containing the desired configuration.
@ -1234,7 +1234,7 @@ def load_config(filename=None,
saltenv: ``base``
Specifies the Salt environment name.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:return: a dictionary having the following keys:
@ -1422,7 +1422,7 @@ def load_template(template_name,
template_attrs: "--------------e----"
attributes of file. (see `man lsattr`)
.. versionadded:: oxygen
.. versionadded:: 2018.3.0
saltenv: base
Specifies the template environment.

2
salt/modules/netbox.py
View file

@ -20,7 +20,7 @@ private key file:
token: <NETBOX_USERNAME_API_TOKEN (OPTIONAL)>
keyfile: </PATH/TO/NETBOX/KEY (OPTIONAL)>
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
'''
from __future__ import absolute_import, print_function, unicode_literals

2
salt/modules/netbsdservice.py
View file

@ -109,7 +109,7 @@ def status(name, sig=None):
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The service name can now be a glob (e.g. ``salt*``)
Args:

2
salt/modules/neutronng.py
View file

@ -2,7 +2,7 @@
'''
Neutron module for interacting with OpenStack Neutron
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:depends:shade

2
salt/modules/nexus.py
View file

@ -2,7 +2,7 @@
'''
Module for fetching artifacts from Nexus 3.x
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
'''
# Import python libs

2
salt/modules/openbsdservice.py
View file

@ -99,7 +99,7 @@ def status(name, sig=None):
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The service name can now be a glob (e.g. ``salt*``)
Args:

2
salt/modules/opkg.py
View file

@ -149,7 +149,7 @@ def refresh_db(failhard=False, **kwargs): # pylint: disable=unused-argument
If True, raise an error with a list of the package databases that
encountered errors.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
CLI Example:

2
salt/modules/opsgenie.py
View file

@ -2,7 +2,7 @@
'''
Module for sending data to OpsGenie
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
:configuration: This module can be used in Reactor System for
posting data to OpsGenie as a remote-execution function.

2
salt/modules/out.py
View file

@ -3,7 +3,7 @@
Output Module
=============
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Execution module that processes JSON serializable data
and returns string having the format as processed by the outputters.

2
salt/modules/panos.py
View file

@ -7,7 +7,7 @@ Module to provide Palo Alto compatibility to Salt.
:depends: none
:platform: unix
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Configuration
=============

2
salt/modules/pip.py
View file

@ -1198,7 +1198,7 @@ def is_installed(pkgname=None,
salt '*' pip.is_installed salt
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
The packages wheel, setuptools, and distribute are included if the
installed pip is new enough.

4
salt/modules/pkgin.py
View file

@ -229,7 +229,7 @@ def refresh_db(force=False):
force
Pass -f so that the cache is always refreshed.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
CLI Example:
@ -312,7 +312,7 @@ def list_upgrades(refresh=True, **kwargs):
'''
List all available package upgrades.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
refresh
Whether or not to refresh the package database before installing.

48
salt/modules/purefa.py
View file

@ -47,7 +47,7 @@ Installation Prerequisites
:requires: purestorage
:platform: all
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
'''
@ -211,7 +211,7 @@ def snap_create(name, suffix=None):
Will return False is volume selected to snap does not exist.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of volume to snapshot
@ -247,7 +247,7 @@ def snap_delete(name, suffix=None, eradicate=False):
Will return False if selected snapshot does not exist.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of volume
@ -289,7 +289,7 @@ def snap_eradicate(name, suffix=None):
Will return False if snapshot is not in a deleted state.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of volume
@ -322,7 +322,7 @@ def volume_create(name, size=None):
Will return False if volume already exists.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of volume (truncated to 63 characters)
@ -360,7 +360,7 @@ def volume_delete(name, eradicate=False):
Will return False if volume doesn't exist is already in a deleted state.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of volume
@ -399,7 +399,7 @@ def volume_eradicate(name):
Will return False is volume is not in a deleted state.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of volume
@ -429,7 +429,7 @@ def volume_extend(name, size):
Will return False if new size is less than or equal to existing size.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of volume
@ -467,7 +467,7 @@ def snap_volume_create(name, target, overwrite=False):
Will return False if target volume already exists and
overwrite is not specified, or selected snapshot doesn't exist.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of volume snapshot
@ -513,7 +513,7 @@ def volume_clone(name, target, overwrite=False):
Will return False if source volume doesn't exist, or
target volume already exists and overwrite not specified.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of volume
@ -557,7 +557,7 @@ def volume_attach(name, host):
Host and volume must exist or else will return False.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of volume
@ -590,7 +590,7 @@ def volume_detach(name, host):
Will return False if either host or volume do not exist, or
if selected volume isn't already connected to the host.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of volume
@ -624,7 +624,7 @@ def host_create(name, iqn=None, wwn=None):
Fibre Channel parameters are not in a valid format.
See Pure Storage FlashArray documentation.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of host (truncated to 63 characters)
@ -675,7 +675,7 @@ def host_update(name, iqn=None, wwn=None):
by another host, or are not in a valid format.
See Pure Storage FlashArray documentation.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of host
@ -715,7 +715,7 @@ def host_delete(name):
Will return False if the host doesn't exist.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of host
@ -751,7 +751,7 @@ def hg_create(name, host=None, volume=None):
Will return False if hostgroup already exists, or if
named host or volume do not exist.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of hostgroup (truncated to 63 characters)
@ -807,7 +807,7 @@ def hg_update(name, host=None, volume=None):
Will return False is hostgroup doesn't exist, or host
or volume do not exist.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of hostgroup
@ -853,7 +853,7 @@ def hg_delete(name):
Will return False is hostgroup is already in a deleted state.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of hostgroup
@ -891,7 +891,7 @@ def hg_remove(name, volume=None, host=None):
Will return False is hostgroup does not exist, or named host or volume are
not in the hostgroup.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of hostgroup
@ -952,7 +952,7 @@ def pg_create(name, hostgroup=None, host=None, volume=None, enabled=True):
hostgroups, hosts or volumes
* Named type for protection group does not exist
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of protection group
@ -1045,7 +1045,7 @@ def pg_update(name, hostgroup=None, host=None, volume=None):
* Incorrect type selected for current protection group type
* Specified type does not exist
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of protection group
@ -1135,7 +1135,7 @@ def pg_delete(name, eradicate=False):
Will return False if protection group is already in a deleted state.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of protection group
@ -1172,7 +1172,7 @@ def pg_eradicate(name):
Will return False if protection group is not in a deleted state.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of protection group
@ -1204,7 +1204,7 @@ def pg_remove(name, hostgroup=None, host=None, volume=None):
* Protection group does not exist
* Specified type is not currently associated with the protection group
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
name : string
name of hostgroup

2
salt/modules/reg.py
View file

@ -718,7 +718,7 @@ def import_file(source, use_32bit_registry=False):
'''
Import registry settings from a Windows ``REG`` file by invoking ``REG.EXE``.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Usage:

2
salt/modules/rest_service.py
View file

@ -133,7 +133,7 @@ def status(name, sig=None):
.. versionadded:: 2015.8.0
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The service name can now be a glob (e.g. ``salt*``)
Args:

2
salt/modules/rh_service.py
View file

@ -485,7 +485,7 @@ def status(name, sig=None):
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The service name can now be a glob (e.g. ``salt*``)
Args:

4
salt/modules/saltutil.py
View file

@ -588,7 +588,7 @@ def sync_engines(saltenv=None, refresh=False, extmod_whitelist=None, extmod_blac
def sync_thorium(saltenv=None, refresh=False, extmod_whitelist=None, extmod_blacklist=None):
'''
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Sync Thorium modules from ``salt://_thorium`` to the minion
@ -1045,7 +1045,7 @@ def clear_job_cache(hours=24):
'''
Forcibly removes job cache folders and files on a minion.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
WARNING: The safest way to clear a minion cache is by first stopping
the minion and then deleting the cache files before restarting it.

6
salt/modules/schedule.py
View file

@ -968,7 +968,7 @@ def postpone_job(name,
Current time and new time should be in date string format,
default value is %Y-%m-%dT%H:%M:%S.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
CLI Example:
@ -1070,7 +1070,7 @@ def skip_job(name, current_time, **kwargs):
Time to skip should be specified as date string format,
default value is %Y-%m-%dT%H:%M:%S.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
CLI Example:
@ -1147,7 +1147,7 @@ def show_next_fire_time(name, **kwargs):
'''
Show the next fire time for scheduled job
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
CLI Example:

2
salt/modules/service.py
View file

@ -141,7 +141,7 @@ def status(name, sig=None):
If the name contains globbing, a dict mapping service name to PID or empty
string is returned.
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The service name can now be a glob (e.g. ``salt*``)
Args:

2
salt/modules/shadow.py
View file

@ -373,7 +373,7 @@ def set_expire(name, expire):
def list_users():
'''
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Return a list of all shadow users

2
salt/modules/slsutil.py
View file

@ -58,7 +58,7 @@ def renderer(path=None, string=None, default_renderer='jinja|yaml', **kwargs):
'''
Parse a string or file through Salt's renderer system
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Add support for Salt fileserver URIs.
This is an open-ended function and can be used for a variety of tasks. It

2
salt/modules/smf.py
View file

@ -232,7 +232,7 @@ def status(name, sig=None):
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The service name can now be a glob (e.g. ``salt*``)
Args:

18
salt/modules/ssh.py
View file

@ -843,11 +843,13 @@ def get_known_host(user,
port=None,
fingerprint_hash_type=None):
'''
.. deprecated:: 2018.3.0
Use :py:func:`ssh.get_known_host_entries
<salt.modules.ssh.get_known_host_entries>` instead.
Return information about known host from the configfile, if any.
If there is no such key, return None.
.. deprecated:: Oxygen
CLI Example:
.. code-block:: bash
@ -856,7 +858,7 @@ def get_known_host(user,
'''
salt.utils.versions.warn_until(
'Neon',
'\'get_known_host\' has been deprecated in favour of '
'\'get_known_host\' has been deprecated in favor of '
'\'get_known_host_entries\'. \'get_known_host\' will be '
'removed in Salt Neon.'
)
@ -871,7 +873,7 @@ def get_known_host_entries(user,
port=None,
fingerprint_hash_type=None):
'''
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Return information about known host entries from the configfile, if any.
If there are no entries for a matching hostname, return None.
@ -909,7 +911,9 @@ def recv_known_host(hostname,
'''
Retrieve information about host public key from remote server
.. deprecated:: Oxygen
.. deprecated:: 2018.3.0
Use :py:func:`ssh.recv_known_host_entries
<salt.modules.ssh.recv_known_host_entries>` instead.
hostname
The name of the remote host (e.g. "github.com")
@ -948,7 +952,7 @@ def recv_known_host(hostname,
'''
salt.utils.versions.warn_until(
'Neon',
'\'recv_known_host\' has been deprecated in favour of '
'\'recv_known_host\' has been deprecated in favor of '
'\'recv_known_host_entries\'. \'recv_known_host\' will be '
'removed in Salt Neon.'
)
@ -964,7 +968,7 @@ def recv_known_host_entries(hostname,
timeout=5,
fingerprint_hash_type=None):
'''
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Retrieve information about host public keys from remote server

2
salt/modules/ssh_service.py
View file

@ -120,7 +120,7 @@ def status(name, sig=None):
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The service name can now be a glob (e.g. ``salt*``)
Args:

2
salt/modules/state.py
View file

@ -1567,7 +1567,7 @@ def sls_id(id_, mods, test=None, queue=False, **kwargs):
``pillar_roots`` or an external Pillar source. Pillar values that
are not included in the kwarg will not be overwritten.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
CLI Example:

12
salt/modules/status.py
View file

@ -300,7 +300,7 @@ def cpustats():
.. versionchanged:: 2016.11.4
Added support for AIX
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Added support for OpenBSD
CLI Example:
@ -448,7 +448,7 @@ def meminfo():
.. versionchanged:: 2016.11.4
Added support for AIX
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Added support for OpenBSD
CLI Example:
@ -612,7 +612,7 @@ def cpuinfo():
.. versionchanged:: 2016.11.4
Added support for AIX
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Added support for NetBSD and OpenBSD
CLI Example:
@ -1081,7 +1081,7 @@ def nproc():
.. versionchanged:: 2016.11.4
Added support for AIX
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Added support for Darwin, FreeBSD and OpenBSD
CLI Example:
@ -1130,7 +1130,7 @@ def netstats():
.. versionchanged:: 2016.11.4
Added support for AIX
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Added support for OpenBSD
CLI Example:
@ -1521,7 +1521,7 @@ def version():
.. versionchanged:: 2016.11.4
Added support for AIX
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Added support for OpenBSD
CLI Example:

2
salt/modules/swarm.py
View file

@ -6,7 +6,7 @@ Docker Swarm Module using Docker's Python SDK
:codeauthor: Tyler Jones <jonestyler806@gmail.com>
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
The Docker Swarm Module is used to manage and create Docker Swarms.

2
salt/modules/systemd.py
View file

@ -1030,7 +1030,7 @@ def status(name, sig=None): # pylint: disable=unused-argument
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The service name can now be a glob (e.g. ``salt*``)
Args:

2
salt/modules/test.py
View file

@ -505,7 +505,7 @@ def rand_str(size=9999999999, hash_type=None):
def random_hash(size=9999999999, hash_type=None):
'''
.. versionadded:: 2015.5.2
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
Function has been renamed from ``test.rand_str`` to
``test.random_hash``

2
salt/modules/textfsm_mod.py
View file

@ -3,7 +3,7 @@
TextFSM
=======
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Execution module that processes plain text and extracts data
using TextFSM templates. The output is presented in JSON serializable

2
salt/modules/upstart.py
View file

@ -441,7 +441,7 @@ def status(name, sig=None):
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.. versionchanged:: Oxygen
.. versionchanged:: 2018.3.0
The service name can now be a glob (e.g. ``salt*``)
Args:

2
salt/modules/vagrant.py
View file

@ -2,7 +2,7 @@
'''
Work with virtual machines managed by Vagrant.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Mapping between a Salt node id and the Vagrant machine name
(and the path to the Vagrantfile where it is defined)

2
salt/modules/vault.py
View file

@ -40,7 +40,7 @@ Functions to interact with Hashicorp Vault.
For details please see
http://docs.python-requests.org/en/master/user/advanced/#ssl-cert-verification
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
auth
Currently only token auth is supported. The token must be able to create

8
salt/modules/win_file.py
View file

@ -1270,7 +1270,7 @@ def mkdir(path,
settings defined in this function. If ``False``, new entries will be
appended to the existing DACL. Default is ``False``.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Returns:
bool: True if successful
@ -1383,7 +1383,7 @@ def makedirs_(path,
settings defined in this function. If ``False``, new entries will be
appended to the existing DACL. Default is ``False``.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Returns:
bool: True if successful
@ -1505,7 +1505,7 @@ def makedirs_perms(path,
settings defined in this function. If ``False``, new entries will be
appended to the existing DACL. Default is ``False``.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Returns:
bool: True if successful, otherwise raises an error
@ -2028,7 +2028,7 @@ def set_perms(path,
settings defined in this function. If ``False``, new entries will be
appended to the existing DACL. Default is ``False``.
.. versionadded: Oxygen
.. versionadded:: 2018.3.0
Returns:
bool: True if successful

4
salt/modules/win_servermanager.py
View file

@ -133,7 +133,7 @@ def install(feature, recurse=False, restart=False, source=None, exclude=None):
a string of features in a comma delimited list (no spaces), or a
list of features.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Added the ability to pass a list of features to be installed.
recurse (Options[bool]):
@ -297,7 +297,7 @@ def remove(feature, remove_payload=False, restart=False):
a string of features in a comma delimited list (no spaces), or a
list of features.
.. versionadded:: Oxygen
.. versionadded:: 2018.3.0
Added the ability to pass a list of features to be removed.
remove_payload (Optional[bool]):

Some files were not shown because too many files have changed in this diff Show more