valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-06 16:45:27 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update Lithium docstrings in 2015.2 branch

Browse Source
This commit is contained in:
Erik Johnson 2015-05-06 09:27:40 -05:00 committed by Colton Myers
parent 8510a4c30e
commit 0504e7a184
87 changed files with 367 additions and 367 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/man/salt-api.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-API" "1" "April 21, 2015" "2015.2.0rc2-143-g32ef5ca" "Salt"
.TH "SALT-API" "1" "April 21, 2015" "2015.5.0rc2-143-g32ef5ca" "Salt"
.SH NAME
salt-api \- salt-api Command
.

2
doc/man/salt-cloud.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-CLOUD" "1" "April 21, 2015" "2015.2.0rc2-143-g32ef5ca" "Salt"
.TH "SALT-CLOUD" "1" "April 21, 2015" "2015.5.0rc2-143-g32ef5ca" "Salt"
.SH NAME
salt-cloud \- Salt Cloud Command
.

2
doc/man/salt-cp.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-CP" "1" "March 09, 2015" "2015.2.0rc1-133-g24fa806" "Salt"
.TH "SALT-CP" "1" "March 09, 2015" "2015.5.0rc1-133-g24fa806" "Salt"
.SH NAME
salt-cp \- salt-cp Documentation
.

2
doc/man/salt-key.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-KEY" "1" "March 09, 2015" "2015.2.0rc1-133-g24fa806" "Salt"
.TH "SALT-KEY" "1" "March 09, 2015" "2015.5.0rc1-133-g24fa806" "Salt"
.SH NAME
salt-key \- salt-key Documentation
.

2
doc/man/salt-master.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-MASTER" "1" "March 09, 2015" "2015.2.0rc1-133-g24fa806" "Salt"
.TH "SALT-MASTER" "1" "March 09, 2015" "2015.5.0rc1-133-g24fa806" "Salt"
.SH NAME
salt-master \- salt-master Documentation
.

2
doc/man/salt-minion.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-MINION" "1" "March 09, 2015" "2015.2.0rc1-133-g24fa806" "Salt"
.TH "SALT-MINION" "1" "March 09, 2015" "2015.5.0rc1-133-g24fa806" "Salt"
.SH NAME
salt-minion \- salt-minion Documentation
.

2
doc/man/salt-run.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-RUN" "1" "March 09, 2015" "2015.2.0rc1-133-g24fa806" "Salt"
.TH "SALT-RUN" "1" "March 09, 2015" "2015.5.0rc1-133-g24fa806" "Salt"
.SH NAME
salt-run \- salt-run Documentation
.

2
doc/man/salt-ssh.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-SSH" "1" "March 09, 2015" "2015.2.0rc1-133-g24fa806" "Salt"
.TH "SALT-SSH" "1" "March 09, 2015" "2015.5.0rc1-133-g24fa806" "Salt"
.SH NAME
salt-ssh \- salt-ssh Documentation
.

2
doc/man/salt-syndic.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-SYNDIC" "1" "March 09, 2015" "2015.2.0rc1-133-g24fa806" "Salt"
.TH "SALT-SYNDIC" "1" "March 09, 2015" "2015.5.0rc1-133-g24fa806" "Salt"
.SH NAME
salt-syndic \- salt-syndic Documentation
.

2
doc/man/salt-unity.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-UNITY" "1" "March 09, 2015" "2015.2.0rc1-133-g24fa806" "Salt"
.TH "SALT-UNITY" "1" "March 09, 2015" "2015.5.0rc1-133-g24fa806" "Salt"
.SH NAME
salt-unity \- salt-unity Command
.

2
doc/man/salt.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT" "1" "March 09, 2015" "2015.2.0rc1-133-g24fa806" "Salt"
.TH "SALT" "1" "March 09, 2015" "2015.5.0rc1-133-g24fa806" "Salt"
.SH NAME
salt \- salt
.

336
doc/man/salt.7
View File

File diff suppressed because it is too large Load Diff

4
doc/ref/configuration/master.rst
View File

@ -379,7 +379,7 @@ local job cache on the master.
``event_return``
-----------------
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Default: ``''``
@ -1855,7 +1855,7 @@ There are additional details at :ref:`salt-pillars`
``ext_pillar_first``
--------------------
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
The ext_pillar_first option allows for external pillar sources to populate
before file system pillar. This allows for targeting file system pillar from

2
doc/topics/cloud/misc.rst
View File

@ -291,7 +291,7 @@ only the EC2 driver supports this functionality.
SSH Agent
=========
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
If the ssh key is not stored on the server salt-cloud is being run on, set
ssh_agent, and salt-cloud will use the forwarded ssh-agent to authenticate.

2
doc/topics/mine/index.rst
View File

@ -65,7 +65,7 @@ be adjusted for the minion via the `mine_interval` option:
Mine in Salt-SSH
================
As of the 2015.2.0 release of salt, salt-ssh supports ``mine.get``.
As of the 2015.5.0 release of salt, salt-ssh supports ``mine.get``.
Because the minions cannot provide their own ``mine_functions`` configuration,
we retrieve the args for specified mine functions in one of three places,

2
doc/topics/releases/2014.7.0.rst
View File

@ -46,7 +46,7 @@ paradigm. This allows for many new capabilities to be added to Salt in the
upcoming releases.
Please keep in mind that this is a beta release of RAET and we hope for bugs to
be worked out, performance to be better realized and more in the 2015.2.0
be worked out, performance to be better realized and more in the 2015.5.0
release.
Simply stated, users running Salt with RAET should expect some hiccups as we

2
doc/topics/transports/raet/index.rst
View File

@ -66,7 +66,7 @@ Limitations
===========
The 2014.7 release of RAET is not complete! The Syndic and Multi Master have
not been completed yet and these are slated for completion in the 2015.2.0
not been completed yet and these are slated for completion in the 2015.5.0
release.
Also, Salt-Raet allows for more control over the client but these hooks have

22
doc/topics/tutorials/lxc.rst
View File

@ -12,7 +12,7 @@ LXC Management with Salt
.. warning::
Some features are only currently available in the ``develop`` branch, and
are new in the upcoming 2015.2.0 release. These new features will be
are new in the upcoming 2015.5.0 release. These new features will be
clearly labeled.
@ -110,19 +110,19 @@ another whole profile that differs in just one value.
.. note::
In the 2014.7.x release cycle and earlier, container profiles are defined
under ``lxc.profile``. This parameter will still work in version 2015.2.0,
under ``lxc.profile``. This parameter will still work in version 2015.5.0,
but is deprecated and will be removed in a future release. Please note
however that the profile merging feature described above will only work
with profiles defined under ``lxc.container_profile``, and only in versions
2015.2.0 and later.
2015.5.0 and later.
Additionally, in version 2015.2.0 container profiles have been expanded to
Additionally, in version 2015.5.0 container profiles have been expanded to
support passing template-specific CLI options to :mod:`lxc.create
<salt.modules.lxc.create>`. Below is a table describing the parameters which
can be configured in container profiles:
================== ================== ====================
Parameter 2015.2.0 and Newer 2014.7.x and Earlier
Parameter 2015.5.0 and Newer 2014.7.x and Earlier
================== ================== ====================
*template*:sup:`1` Yes Yes
*options*:sup:`1` Yes No
@ -193,11 +193,11 @@ profile, while those minions without the above Pillar data would use the
.. note::
In the 2014.7.x release cycle and earlier, network profiles are defined
under ``lxc.nic``. This parameter will still work in version 2015.2.0, but
under ``lxc.nic``. This parameter will still work in version 2015.5.0, but
is deprecated and will be removed in a future release. Please note however
that the profile merging feature described above will only work with
profiles defined under ``lxc.network_profile``, and only in versions
2015.2.0 and later.
2015.5.0 and later.
The following are parameters which can be configured in network profiles. These
will directly correspond to a parameter in an LXC configuration file (see ``man
@ -263,7 +263,7 @@ container, with three values:
3. **arch** - CPU architecture (i.e. ``amd64`` or ``i386``)
The :mod:`lxc.images <salt.modules.lxc.images>` function (new in version
2015.2.0) can be used to list the available images. Alternatively, the releases
2015.5.0) can be used to list the available images. Alternatively, the releases
can be viewed on http://images.linuxcontainers.org/images/. The images are
organized in such a way that the **dist**, **release**, and **arch** can be
determined using the following URL format:
@ -407,11 +407,11 @@ Running Commands Within a Container
For containers which are not running their own Minion, commands can be run
within the container in a manner similar to using (:mod:`cmd.run
<salt.modules.cmdmod.run`). The means of doing this have been changed
significantly in version 2015.2.0 (though the deprecated behavior will still be
significantly in version 2015.5.0 (though the deprecated behavior will still be
supported for a few releases). Both the old and new usage are documented
below.
2015.2.0 and Newer
2015.5.0 and Newer
------------------
New functions have been added to mimic the behavior of the functions in the
@ -467,7 +467,7 @@ To run a command and return all information:
Container Management Using States
=================================
Several states are being renamed or otherwise modified in version 2015.2.0. The
Several states are being renamed or otherwise modified in version 2015.5.0. The
information in this tutorial refers to the new states. For
2014.7.x and earlier, please refer to the :mod:`documentation for the LXC
states <salt.states.lxc>`.

2
salt/auth/yubico.py
View File

@ -3,7 +3,7 @@
'''
Provide authentication using YubiKey.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
:depends: yubico-client Python module

2
salt/beacons/diskusage.py
View File

@ -2,7 +2,7 @@
'''
Beacon to monitor disk usage.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
'''
# Import Python libs

2
salt/beacons/network_info.py
View File

@ -2,7 +2,7 @@
'''
Beacon to monitor statistics from ethernet adapters
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
'''
# Import Python libs

2
salt/client/ssh/wrapper/mine.py
View File

@ -3,7 +3,7 @@
'''
Wrapper function for mine operations for salt-ssh
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
'''
# Import python libs

2
salt/client/ssh/wrapper/publish.py
View File

@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Salt-ssh wrapper functions for the publish module.

2
salt/client/ssh/wrapper/state.py
View File

@ -515,7 +515,7 @@ def show_top():
def single(fun, name, test=None, **kwargs):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Execute a single state function with the named kwargs, returns False if
insufficient data is sent to the command

6
salt/modules/aptpkg.py
View File

@ -446,12 +446,12 @@ def install(name=None,
install_recommends
Whether to install the packages marked as recommended. Default is True.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
only_upgrade
Only upgrade the packages, if they are already installed. Default is False.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Returns a dict containing the new package names and versions::
@ -598,7 +598,7 @@ def _uninstall(action='remove', name=None, pkgs=None, **kwargs):
def autoremove(list_only=False):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Remove packages not required by another package using ``apt-get
autoremove``.

12
salt/modules/archive.py
View File

@ -168,7 +168,7 @@ def gunzip(gzipfile, template=None, runas=None):
@salt.utils.decorators.which('zip')
def cmd_zip(zip_file, sources, template=None, cwd=None, runas=None):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
In versions 2014.7.x and earlier, this function was known as
``archive.zip``.
@ -210,7 +210,7 @@ def cmd_zip(zip_file, sources, template=None, cwd=None, runas=None):
Create the zip file as the specified user. Defaults to the user under
which the minion is running.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:
@ -236,7 +236,7 @@ def zip_(zip_file, sources, template=None, cwd=None, runas=None):
'''
Uses the ``zipfile`` Python module to create zip files
.. versionchanged:: 2015.2.0
.. versionchanged:: 2015.5.0
This function was rewritten to use Python's native zip file support.
The old functionality has been preserved in the new function
:mod:`archive.cmd_zip <salt.modules.archive.cmd_zip>`. For versions
@ -373,7 +373,7 @@ def zip_(zip_file, sources, template=None, cwd=None, runas=None):
def cmd_unzip(zip_file, dest, excludes=None,
template=None, options=None, runas=None):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
In versions 2014.7.x and earlier, this function was known as
``archive.unzip``.
@ -407,7 +407,7 @@ def cmd_unzip(zip_file, dest, excludes=None,
Unpack the zip file as the specified user. Defaults to the user under
which the minion is running.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
options : None
Additional command-line options to pass to the ``unzip`` binary.
@ -450,7 +450,7 @@ def unzip(zip_file, dest, excludes=None, template=None, runas=None):
'''
Uses the ``zipfile`` Python module to unpack zip files
.. versionchanged:: 2015.2.0
.. versionchanged:: 2015.5.0
This function was rewritten to use Python's native zip file support.
The old functionality has been preserved in the new function
:mod:`archive.cmd_unzip <salt.modules.archive.cmd_unzip>`. For versions

2
salt/modules/cassandra_cql.py
View File

@ -2,7 +2,7 @@
'''
Cassandra Database Module
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
:depends: DataStax Python Driver for Apache Cassandra
https://github.com/datastax/python-driver

4
salt/modules/cmdmod.py
View File

@ -705,7 +705,7 @@ def shell(cmd,
'''
Execute the passed command and return the output as a string.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
************************************************************
WARNING: This passes the cmd argument directly to the shell
@ -1573,7 +1573,7 @@ def shells():
'''
Lists the valid shells on this system via the /etc/shells file
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example::

6
salt/modules/config.py
View File

@ -233,7 +233,7 @@ def get(key, default='', delimiter=':', merge=None):
The ``:`` (colon) is used to represent a nested dictionary level.
.. versionchanged:: 2015.2.0
.. versionchanged:: 2015.5.0
The ``delimiter`` argument was added, to allow delimiters other than
``:`` to be used.
@ -245,13 +245,13 @@ def get(key, default='', delimiter=':', merge=None):
- Master config file
delimiter
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Override the delimiter used to separate nested levels of a data
structure.
merge
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
If passed, this parameter will change the behavior of the function so
that, instead of traversing each data store above in order and

2
salt/modules/cpan.py
View File

@ -2,7 +2,7 @@
'''
Manage Perl modules using CPAN
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
'''
from __future__ import absolute_import

2
salt/modules/dockerio.py
View File

@ -1849,7 +1849,7 @@ def load(imagepath):
def save(image, filename):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Save the specified image to filename from docker
e.g. `docker save image > filename`

2
salt/modules/gpg.py
View File

@ -3,7 +3,7 @@
Manage a GPG keychains, add keys, create keys, retrieve keys
from keyservers. Sign, encrypt and sign & encrypt text and files.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. note::

2
salt/modules/grains.py
View File

@ -415,7 +415,7 @@ def filter_by(lookup_dict, grain='os_family', merge=None, default='default', bas
each case to be collected in the base and overridden by the grain
selection dictionary and the merge dictionary. Default is unset.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:

4
salt/modules/hg.py
View File

@ -172,7 +172,7 @@ def pull(cwd, opts=None, user=None, identity=None, repository=None):
identity : None
Private SSH key on the minion server for authentication (ssh://)
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:
@ -242,7 +242,7 @@ def clone(cwd, repository, opts=None, user=None, identity=None):
identity : None
Private SSH key on the minion server for authentication (ssh://)
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:

2
salt/modules/hipchat.py
View File

@ -2,7 +2,7 @@
'''
Module for sending messages to hipchat.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
:configuration: This module can be used by either passing an api key and version
directly or by specifying both in a configuration profile in the salt

62
salt/modules/lxc.py
View File

@ -347,7 +347,7 @@ def cloud_init_interface(name, vm_=None, **kwargs):
def get_container_profile(name=None, **kwargs):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Gather a pre-configured set of container configuration parameters. If no
arguments are passed, an empty profile is returned.
@ -428,7 +428,7 @@ def get_container_profile(name=None, **kwargs):
def get_network_profile(name=None):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Gather a pre-configured set of network configuration parameters. If no
arguments are passed, the following default profile is returned:
@ -958,7 +958,7 @@ def init(name,
memory
cgroups memory limit, in MB
.. versionchanged:: 2015.2.0
.. versionchanged:: 2015.5.0
If no value is passed, no limit is set. In earlier Salt versions,
not passing this value causes a 1024MB memory limit to be set, and
it was necessary to pass ``memory=0`` to set no limit.
@ -974,10 +974,10 @@ def init(name,
network_profile
Network profile to use for the container
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
nic
.. deprecated:: 2015.2.0
.. deprecated:: 2015.5.0
Use ``network_profile`` instead
nic_opts
@ -1002,7 +1002,7 @@ def init(name,
Set to ``True`` to denote a password hash instead of a plaintext
password
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
profile
A LXC profile (defined in config or pillar).
@ -1038,7 +1038,7 @@ def init(name,
Attempt to request key approval from the master. Default: ``True``
clone
.. deprecated:: 2015.2.0
.. deprecated:: 2015.5.0
Use ``clone_from`` instead
clone_from
@ -1049,7 +1049,7 @@ def init(name,
Delay in seconds between end of container creation and bootstrapping.
Useful when waiting for container to obtain a DHCP lease.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
bootstrap_url
See lxc.bootstrap
@ -1442,7 +1442,7 @@ def cloud_init(name, vm_=None, **kwargs):
def images(dist=None):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
List the available images for LXC's ``download`` template.
@ -1493,7 +1493,7 @@ def images(dist=None):
def templates():
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
List the available LXC template scripts installed on the minion
@ -1536,7 +1536,7 @@ def create(name,
network_profile
Network profile to use for container
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
**Container Creation Arguments**
@ -1816,7 +1816,7 @@ def ls_(active=None, cache=True):
active
If ``True``, return only active (i.e. running) containers
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:
@ -1856,7 +1856,7 @@ def list_(extra=False, limit=None):
Return output matching a specific state (**frozen**, **running**, or
**stopped**).
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Examples:
@ -1984,7 +1984,7 @@ def _ensure_running(name, no_start=False):
def restart(name, force=False):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Restart the named container. If the container was not running, the
container will merely be started.
@ -2018,7 +2018,7 @@ def start(name, **kwargs):
Start the named container
restart : False
.. deprecated:: 2015.2.0
.. deprecated:: 2015.5.0
Use :mod:`lxc.restart <salt.modules.lxc.restart>`
Restart the container if it is already running
@ -2053,7 +2053,7 @@ def stop(name, kill=False):
Older LXC versions will stop containers like this irrespective of this
argument.
.. versionchanged:: 2015.2.0
.. versionchanged:: 2015.5.0
Default value changed to ``False``
CLI Example:
@ -2085,7 +2085,7 @@ def freeze(name, **kwargs):
If ``True`` and the container is stopped, the container will be started
before attempting to freeze.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:
@ -2140,7 +2140,7 @@ def destroy(name, stop=False):
If ``True``, the container will be destroyed even if it is
running/frozen.
.. versionchanged:: 2015.2.0
.. versionchanged:: 2015.5.0
Default value changed to ``False``. This more closely matches the
behavior of ``lxc-destroy(1)``, and also makes it less likely that
an accidental command will destroy a running container that was
@ -2393,7 +2393,7 @@ def info(name):
def set_password(name, users, password, encrypted=True):
'''
.. versionchanged:: 2015.2.0
.. versionchanged:: 2015.5.0
Function renamed from ``set_pass`` to ``set_password``. Additionally,
this function now supports (and defaults to using) a password hash
instead of a plaintext password.
@ -2411,7 +2411,7 @@ def set_password(name, users, password, encrypted=True):
If true, ``password`` must be a password hash. Set to ``False`` to set
a plaintext password (not recommended).
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:
@ -2549,7 +2549,7 @@ def update_lxc_conf(name, lxc_conf, lxc_conf_unset):
def set_dns(name, dnsservers=None, searchdomains=None):
'''
.. versionchanged:: 2015.2.0
.. versionchanged:: 2015.5.0
The ``dnsservers`` and ``searchdomains`` parameters can now be passed
as a comma-separated list.
@ -2686,7 +2686,7 @@ def bootstrap(name,
Delay in seconds between end of container creation and bootstrapping.
Useful when waiting for container to obtain a DHCP lease.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
bootstrap_url
url, content or filepath to the salt bootstrap script
@ -2929,7 +2929,7 @@ def run_cmd(name,
ignore_retcode=False,
keep_env='http_proxy,https_proxy,no_proxy'):
'''
.. deprecated:: 2015.2.0
.. deprecated:: 2015.5.0
Use :mod:`lxc.run <salt.modules.lxc.run>` instead
'''
salt.utils.warn_until(
@ -2970,7 +2970,7 @@ def run(name,
ignore_retcode=False,
keep_env='http_proxy,https_proxy,no_proxy'):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Run :mod:`cmd.run <salt.modules.cmdmod.run>` within a container
@ -3045,7 +3045,7 @@ def run_stdout(name,
ignore_retcode=False,
keep_env='http_proxy,https_proxy,no_proxy'):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Run :mod:`cmd.run_stdout <salt.modules.cmdmod.run_stdout>` within a container
@ -3120,7 +3120,7 @@ def run_stderr(name,
ignore_retcode=False,
keep_env='http_proxy,https_proxy,no_proxy'):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Run :mod:`cmd.run_stderr <salt.modules.cmdmod.run_stderr>` within a container
@ -3193,7 +3193,7 @@ def retcode(name,
ignore_retcode=False,
keep_env='http_proxy,https_proxy,no_proxy'):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Run :mod:`cmd.retcode <salt.modules.cmdmod.retcode>` within a container
@ -3268,7 +3268,7 @@ def run_all(name,
ignore_retcode=False,
keep_env='http_proxy,https_proxy,no_proxy'):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Run :mod:`cmd.run_all <salt.modules.cmdmod.run_all>` within a container
@ -3355,7 +3355,7 @@ def cp(name, source, dest, makedirs=False):
dest
Destination on the container. Must be an absolute path.
.. versionchanged:: 2015.2.0
.. versionchanged:: 2015.5.0
If the destination is a directory, the file will be copied into
that directory.
@ -3364,7 +3364,7 @@ def cp(name, source, dest, makedirs=False):
Create the parent directory on the container if it does not already
exist.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:
@ -3663,7 +3663,7 @@ def edit_conf(conf_file, out_format='simple', read_only=False, lxc_config=None,
def apply_network_profile(name, network_profile, nic_opts=None):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Apply a network profile to a container

2
salt/modules/mount.py
View File

@ -756,7 +756,7 @@ def umount(name, device=None, user=None):
salt '*' mount.umount /mnt/foo
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
salt '*' mount.umount /mnt/foo /dev/xvdc1
'''

2
salt/modules/network.py
View File

@ -76,7 +76,7 @@ def ping(host, timeout=False, return_boolean=False):
salt '*' network.ping archlinux.org
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Return a True or False instead of ping output.

6
salt/modules/pillar.py
View File

@ -92,7 +92,7 @@ def items(*args, **kwargs):
will also override any variables of the same name in pillar or
ext_pillar.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:
@ -129,7 +129,7 @@ def item(*args, **kwargs):
will also override any variables of the same name in pillar or
ext_pillar.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Examples:
@ -186,7 +186,7 @@ def ext(external, pillar=None):
will also override any variables of the same name in pillar or
ext_pillar.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash

4
salt/modules/pip.py
View File

@ -973,7 +973,7 @@ def upgrade_available(pkg,
user=None,
cwd=None):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Check whether or not an upgrade is available for a given package
@ -991,7 +991,7 @@ def upgrade(bin_env=None,
cwd=None,
use_vt=False):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Upgrades outdated pip packages

2
salt/modules/random_org.py
View File

@ -2,7 +2,7 @@
'''
Module for retrieving random information from Random.org
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
:configuration: This module can be used by either passing an api key and version
directly or by specifying both in a configuration profile in the salt

2
salt/modules/rpm.py
View File

@ -135,7 +135,7 @@ def modified(*packages, **flags):
List the modified files that belong to a package. Not specifying any packages
will return a list of _all_ modified files on the system's RPM database.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI examples:

2
salt/modules/slack_notify.py
View File

@ -2,7 +2,7 @@
'''
Module for sending messages to Slack
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
:configuration: This module can be used by either passing an api key and version
directly or by specifying both in a configuration profile in the salt

10
salt/modules/state.py
View File

@ -271,7 +271,7 @@ def template_str(tem, queue=False, **kwargs):
def apply_(mods=None,
**kwargs):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Apply states! This function will call highstate or state.sls based on the
arguments passed in, state.apply is intended to be the main gateway for
@ -293,7 +293,7 @@ def apply_(mods=None,
def request(mods=None,
**kwargs):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Request that the local admin execute a state run via
`salt-call state.run_request`
@ -334,7 +334,7 @@ def request(mods=None,
def check_request(name=None):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Return the state request information, if any
@ -357,7 +357,7 @@ def check_request(name=None):
def clear_request(name=None):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Clear out the state execution request without executing it
@ -398,7 +398,7 @@ def clear_request(name=None):
def run_request(name='default', **kwargs):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Execute the pending state request

36
salt/modules/sysmod.py
View File

@ -51,7 +51,7 @@ def doc(*args):
Modules can be specified as globs.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash
@ -108,7 +108,7 @@ def state_doc(*args):
State names can be specified as globs.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash
@ -178,7 +178,7 @@ def runner_doc(*args):
Runner names can be specified as globs.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash
@ -236,7 +236,7 @@ def returner_doc(*args):
Returner names can be specified as globs.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash
@ -283,7 +283,7 @@ def renderer_doc(*args):
Multiple renderers can be specified.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:
@ -332,7 +332,7 @@ def list_functions(*args, **kwargs):
Function names can be specified as globs.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash
@ -370,7 +370,7 @@ def list_modules(*args):
'''
List the modules loaded on the minion
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:
@ -433,7 +433,7 @@ def argspec(module=''):
Module names can be specified as globs.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash
@ -448,7 +448,7 @@ def state_argspec(module=''):
Return the argument specification of functions in Salt state
modules.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:
@ -474,7 +474,7 @@ def returner_argspec(module=''):
Return the argument specification of functions in Salt returner
modules.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:
@ -500,7 +500,7 @@ def runner_argspec(module=''):
Return the argument specification of functions in Salt runner
modules.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:
@ -537,7 +537,7 @@ def list_state_functions(*args, **kwargs):
State function names can be specified as globs.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash
@ -587,7 +587,7 @@ def list_state_modules(*args):
State module names can be specified as globs.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash
@ -629,7 +629,7 @@ def list_runners(*args):
Runner names can be specified as globs.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash
@ -672,7 +672,7 @@ def list_runner_functions(*args, **kwargs):
Runner function names can be specified as globs.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash
@ -721,7 +721,7 @@ def list_returners(*args):
Returner names can be specified as globs.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash
@ -765,7 +765,7 @@ def list_returner_functions(*args, **kwargs):
Returner names can be specified as globs.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash
@ -805,7 +805,7 @@ def list_renderers(*args):
'''
List the renderers loaded on the minion
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:

2
salt/modules/system_profiler.py
View File

@ -5,7 +5,7 @@ System Profiler Module
Interface with Mac OSX's command-line System Profiler utility to get
information about package receipts and installed applications.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
'''

6
salt/modules/win_firewall.py
View File

@ -67,7 +67,7 @@ def enable(profile='allprofiles'):
'''
Enable firewall profile :param profile: (default: allprofiles)
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:
@ -82,7 +82,7 @@ def enable(profile='allprofiles'):
def get_rule(name="all"):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Get firewall rule(s) info
@ -104,7 +104,7 @@ def get_rule(name="all"):
def add_rule(name, localport, protocol="tcp", action="allow", dir="in"):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Add a new firewall rule

2
salt/modules/win_status.py
View File

@ -104,7 +104,7 @@ def _get_process_owner(process):
def master(master=None, connected=True):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Fire an event if the minion gets disconnected from its master. This
function is meant to be run via a scheduled job from the minion. If

4
salt/modules/yumpkg.py
View File

@ -2013,7 +2013,7 @@ def modified(*packages, **flags):
List the modified files that belong to a package. Not specifying any packages
will return a list of _all_ modified files on the system's RPM database.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Filtering by flags (True or False):
@ -2060,7 +2060,7 @@ def modified(*packages, **flags):
@decorators.which('yumdownloader')
def download(*packages):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Download packages to the local disk. Requires ``yumdownloader`` from
``yum-utils`` package.

10
salt/modules/zfs.py
View File

@ -158,7 +158,7 @@ def _build_zfs_cmd_list():
def exists(name):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Check if a ZFS filesystem or volume or snapshot exists.
@ -178,7 +178,7 @@ def exists(name):
def create(name, **kwargs):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Create a ZFS File System.
@ -236,7 +236,7 @@ def create(name, **kwargs):
def destroy(name, **kwargs):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Destroy a ZFS File System.
@ -269,7 +269,7 @@ def destroy(name, **kwargs):
def rename(name, new_name):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Rename or Relocate a ZFS File System.
@ -294,7 +294,7 @@ def rename(name, new_name):
def list_(name='', **kwargs):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Return a list of all datasets or a specified dataset on the system and the
values of their used, available, referenced, and mountpoint properties.

12
salt/modules/zpool.py
View File

@ -84,7 +84,7 @@ def iostat(name=''):
def list_():
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Return a list of all pools in the system with health status and space usage
@ -190,7 +190,7 @@ def scrub(pool_name=None):
def create(pool_name, *vdevs, **kwargs):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Create a simple zpool, a mirrored zpool, a zpool having nested VDEVs, a hybrid zpool with cache, spare and log drives or a zpool with RAIDZ-1, RAIDZ-2 or RAIDZ-3
@ -409,7 +409,7 @@ def create_file_vdev(size, *vdevs):
def export(*pools, **kwargs):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Export storage pools
@ -452,7 +452,7 @@ def export(*pools, **kwargs):
def import_(pool_name='', new_name='', **kwargs):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Import storage pools or list pools available for import
@ -504,7 +504,7 @@ def import_(pool_name='', new_name='', **kwargs):
def online(pool_name, *vdevs, **kwargs):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Ensure that the specified devices are online
@ -557,7 +557,7 @@ def online(pool_name, *vdevs, **kwargs):
def offline(pool_name, *vdevs, **kwargs):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Ensure that the specified devices are offline

2
salt/modules/zypper.py
View File

@ -945,7 +945,7 @@ def modified(*packages, **flags):
List the modified files that belong to a package. Not specifying any packages
will return a list of _all_ modified files on the system's RPM database.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Filtering by flags (True or False):

2
salt/output/newline_values_only.py
View File

@ -3,7 +3,7 @@
Display values only, separated by newlines
==========================================
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
This outputter is designed for Salt CLI return data. It will do the following
to the return dict:

2
salt/pillar/git_pillar.py
View File

@ -18,7 +18,7 @@ to look for Pillar files (such as ``top.sls``).
.. versionchanged:: 2014.7.0
The optional ``root`` parameter will be added.
.. versionchanged:: 2015.2.0
.. versionchanged:: 2015.5.0
The special branch name '__env__' will be replace by the
environment ({{env}})

2
salt/returners/carbon_return.py
View File

@ -53,7 +53,7 @@ To use the carbon returner, append '--return carbon' to the salt command.
To use the alternative configuration, append '--return_config alternative' to the salt command.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash

2
salt/returners/cassandra_cql_return.py
View File

@ -2,7 +2,7 @@
'''
Return data to a cassandra server
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
:maintainer: Corin Kochenower<ckochenower@saltstack.com>
:maturity: new as of 2015.2

2
salt/returners/couchdb_return.py
View File

@ -25,7 +25,7 @@ To use the couchdb returner, append ``--return couchdb`` to the salt command. Ex
To use the alternative configuration, append ``--return_config alternative`` to the salt command.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash

4
salt/returners/hipchat_return.py
View File

@ -2,7 +2,7 @@
'''
Return salt data via hipchat.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
The following fields can be set in the minion conf file::
@ -60,7 +60,7 @@ To use the HipChat returner, append '--return hipchat' to the salt command.
To use the alternative configuration, append '--return_config alternative' to the salt command.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash

2
salt/returners/memcache_return.py
View File

@ -30,7 +30,7 @@ To use the memcache returner, append '--return memcache' to the salt command.
To use the alternative configuration, append '--return_config alternative' to the salt command.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash

2
salt/returners/mongo_future_return.py
View File

@ -46,7 +46,7 @@ To use the mongo returner, append '--return mongo' to the salt command.
To use the alternative configuration, append '--return_config alternative' to the salt command.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash

2
salt/returners/mongo_return.py
View File

@ -37,7 +37,7 @@ To use the mongo returner, append '--return mongo' to the salt command.
To use the alternative configuration, append '--return_config alternative' to the salt command.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash

2
salt/returners/mysql.py
View File

@ -108,7 +108,7 @@ To use the mysql returner, append '--return mysql' to the salt command.
To use the alternative configuration, append '--return_config alternative' to the salt command.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash

2
salt/returners/odbc.py
View File

@ -108,7 +108,7 @@ correctly. Replace with equivalent SQL for other ODBC-compliant servers
To use the alternative configuration, append '--return_config alternative' to the salt command.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash

2
salt/returners/postgres.py
View File

@ -80,7 +80,7 @@ To use the postgres returner, append '--return postgres' to the salt command.
To use the alternative configuration, append '--return_config alternative' to the salt command.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash

2
salt/returners/redis_return.py
View File

@ -30,7 +30,7 @@ To use the redis returner, append '--return redis' to the salt command.
To use the alternative configuration, append '--return_config alternative' to the salt command.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash

2
salt/returners/slack_returner.py
View File

@ -2,7 +2,7 @@
'''
Return salt data via slack
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
The following fields can be set in the minion conf file::

2
salt/returners/sms_return.py
View File

@ -3,7 +3,7 @@
'''
Return data by SMS.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
:maintainer: Damian Myerscough
:maturity: new

2
salt/returners/smtp_return.py
View File

@ -59,7 +59,7 @@ To use the SMTP returner, append '--return smtp' to the salt command.
To use the alternative configuration, append '--return_config alternative' to the salt command.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash

2
salt/returners/sqlite3_return.py
View File

@ -65,7 +65,7 @@ To use the sqlite returner, append '--return sqlite3' to the salt command.
To use the alternative configuration, append '--return_config alternative' to the salt command.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash

2
salt/returners/xmpp_return.py
View File

@ -50,7 +50,7 @@ To use the XMPP returner, append '--return xmpp' to the salt command.
To use the alternative configuration, append '--return_config alternative' to the salt command.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: bash

2
salt/roster/cloud.py
View File

@ -3,7 +3,7 @@
Use the cloud cache on the master to derive IPv4 addresses based on minion ID.
This roster requires that the minion in question was created using at least the
2015.2.0 version of Salt Cloud. Starting with the 2015.2.0 release, Salt Cloud
2015.5.0 version of Salt Cloud. Starting with the 2015.5.0 release, Salt Cloud
maintains an index of minions that it creates and deletes. This index tracks the
provider and profile configuration used to provision the minion, including
authentication information. So long as this configuration remains current, it can

2
salt/runners/jobs.py
View File

@ -100,7 +100,7 @@ def lookup_jid(jid,
display_progress
Displays progress events when set to `True`. Default: `False`.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:

6
salt/runners/lxc.py
View File

@ -152,7 +152,7 @@ def init(names, host=None, saltcloud_mode=False, quiet=False, **kwargs):
memory
cgroups memory limit, in MB
.. versionchanged:: 2015.2.0
.. versionchanged:: 2015.5.0
If no value is passed, no limit is set. In earlier Salt versions,
not passing this value causes a 1024MB memory limit to be set, and
it was necessary to pass ``memory=0`` to set no limit.
@ -169,10 +169,10 @@ def init(names, host=None, saltcloud_mode=False, quiet=False, **kwargs):
network_profile
Network profile to use for the container
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
nic
.. deprecated:: 2015.2.0
.. deprecated:: 2015.5.0
Use ``network_profile`` instead
nic_opts

4
salt/runners/state.py
View File

@ -125,7 +125,7 @@ def orchestrate_single(fun, name, test=None, queue=False, pillar=None, **kwargs)
'''
Execute a single state orchestration routine
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:
@ -155,7 +155,7 @@ def orchestrate_high(data, test=None, queue=False, pillar=None, **kwargs):
'''
Execute a single state orchestration routine
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
CLI Example:

2
salt/sdb/etcd_db.py
View File

@ -7,7 +7,7 @@ etcd Database Module
:depends: python-etcd
:platform: all
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
This module allows access to the etcd database using an ``sdb://`` URI. This
package is located at ``https://pypi.python.org/pypi/python-etcd``.

12
salt/states/file.py
View File

@ -1610,7 +1610,7 @@ def directory(name,
- mode
- ignore_dirs
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
dir_mode / mode
The permissions mode to set any directories created. Not supported on
@ -3496,35 +3496,35 @@ def copy(
If the target subdirectories don't exist create them
preserve
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Set ``preserve: True`` to preserve user/group ownership and mode
after copying. Default is ``False``. If ``preseve`` is set to ``True``,
then user/group/mode attributes will be ignored.
user
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
The user to own the copied file, this defaults to the user salt is
running as on the minion. If ``preserve`` is set to ``True``, then
this will be ignored
group
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
The group to own the copied file, this defaults to the group salt is
running as on the minion. If ``preserve`` is set to ``True`` or on
Windows this will be ignored
mode
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
The permissions to set on the copied file, aka 644, '0775', '4664'.
If ``preserve`` is set to ``True``, then this will be ignored.
Not supported on Windows
subdir
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
If the name is a directory then place the file inside the named
directory

2
salt/states/hg.py
View File

@ -70,7 +70,7 @@ def latest(name,
identity
Private SSH key on the minion server for authentication (ssh://)
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
force
Force hg to clone into pre-existing directories (deletes contents)

2
salt/states/hipchat.py
View File

@ -5,7 +5,7 @@ Send a message to Hipchat
This state is useful for sending messages to Hipchat during state runs.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: yaml

24
salt/states/lxc.py
View File

@ -28,7 +28,7 @@ def present(name,
vgname=None,
lvname=None):
'''
.. versionchanged:: 2015.2.0
.. versionchanged:: 2015.5.0
The :mod:`lxc.created <salt.states.lxc.created>` state has been renamed
to ``lxc.present``, and the :mod:`lxc.cloned <salt.states.lxc.cloned>`
state has been merged into this state.
@ -44,7 +44,7 @@ def present(name,
* If ``None``, do nothing with regards to the running state of the
container
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
clone_from
Create named container as a clone of the specified container
@ -76,7 +76,7 @@ def present(name,
<salt.modules.lxc.images>` function.
options
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Template-specific options to pass to the lxc-create command. These
correspond to the long options (ones beginning with two dashes) that
@ -329,7 +329,7 @@ def absent(name):
# Container state (running/frozen/stopped)
def running(name, restart=False):
'''
.. versionchanged:: 2015.2.0
.. versionchanged:: 2015.5.0
The :mod:`lxc.started <salt.states.lxc.started>` state has been renamed
to ``lxc.running``
@ -423,7 +423,7 @@ def running(name, restart=False):
def frozen(name, start=True):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Ensure that a container is frozen
@ -522,7 +522,7 @@ def stopped(name, kill=False):
Older LXC versions will stop containers like this irrespective of this
argument.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: yaml
@ -577,7 +577,7 @@ def stopped(name, kill=False):
# Deprecated states
def created(name, **kwargs):
'''
.. deprecated:: 2015.2.0
.. deprecated:: 2015.5.0
Use :mod:`lxc.present <salt.states.lxc.present>`
'''
salt.utils.warn_until(
@ -590,7 +590,7 @@ def created(name, **kwargs):
def started(name, restart=False):
'''
.. deprecated:: 2015.2.0
.. deprecated:: 2015.5.0
Use :mod:`lxc.running <salt.states.lxc.running>`
'''
salt.utils.warn_until(
@ -608,7 +608,7 @@ def cloned(name,
vgname=None,
profile=None):
'''
.. deprecated:: 2015.2.0
.. deprecated:: 2015.5.0
Use :mod:`lxc.present <salt.states.lxc.present>`
'''
salt.utils.warn_until(
@ -627,7 +627,7 @@ def cloned(name,
def set_pass(name, **kwargs): # pylint: disable=W0613
'''
.. deprecated:: 2015.2.0
.. deprecated:: 2015.5.0
This state function has been disabled, as it did not conform to design
guidelines. Specifically, due to the fact that :mod:`lxc.set_password
@ -659,7 +659,7 @@ def edited_conf(name, lxc_conf=None, lxc_conf_unset=None):
This state is unsuitable for setting parameters that appear more than
once in an LXC config file, or parameters which must appear in a
certain order (such as when configuring more than one network
interface). It is slated to be replaced, and as of version 2015.2.0 it
interface). It is slated to be replaced, and as of version 2015.5.0 it
is deprecated.
Edit LXC configuration options
@ -679,7 +679,7 @@ def edited_conf(name, lxc_conf=None, lxc_conf_unset=None):
'This state is unsuitable for setting parameters that appear more '
'than once in an LXC config file, or parameters which must appear in '
'a certain order (such as when configuring more than one network '
'interface). It is slated to be replaced, and as of version 2015.2.0 '
'interface). It is slated to be replaced, and as of version 2015.5.0 '
'it is deprecated.'
)
if __opts__['test']:

2
salt/states/mount.py
View File

@ -520,7 +520,7 @@ def unmounted(name,
name
The path to the location where the device is to be unmounted from
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
device
The device to be unmounted.

2
salt/states/network.py
View File

@ -170,7 +170,7 @@ all interfaces are ignored unless specified.
.. note::
Apply changes to hostname immediately.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. note::

2
salt/states/pip_state.py
View File

@ -801,7 +801,7 @@ def uptodate(name,
cwd=None,
use_vt=False):
'''
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Verify that the system is completely up to date.

8
salt/states/pkg.py
View File

@ -774,7 +774,7 @@ def installed(
Whether to install the packages marked as recommended. Default is True.
Currently only works with APT based systems.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: yaml
@ -786,7 +786,7 @@ def installed(
Only upgrade the packages, if they are already installed. Default is False.
Currently only works with APT based systems.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: yaml
@ -1187,7 +1187,7 @@ def latest(
Whether to install the packages marked as recommended. Default is True.
Currently only works with APT based systems.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: yaml
@ -1199,7 +1199,7 @@ def latest(
Only upgrade the packages, if they are already installed. Default is False.
Currently only works with APT based systems.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: yaml

2
salt/states/pyrax_queues.py
View File

@ -3,7 +3,7 @@
Manage Rackspace Queues
=======================
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
Create and destroy Rackspace queues. Be aware that this interacts with
Rackspace's services, and so may incur charges.

2
salt/states/slack.py
View File

@ -5,7 +5,7 @@ Send a message to Slack
This state is useful for sending messages to Slack during state runs.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: yaml

2
salt/utils/aws.py
View File

@ -2,7 +2,7 @@
'''
Connection library for AWS
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
This is a base library used by a number of AWS services.

6
salt/utils/schedule.py
View File

@ -145,7 +145,7 @@ the scheduled job when the minion starts up. Sometimes this is not the desired
situation. Using the 'run_on_start' parameter set to False will cause the
scheduler to skip this first run and wait until the next scheduled run.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
.. code-block:: yaml
@ -195,7 +195,7 @@ master. Because of this information for these jobs will not be listed in the
``return_job`` parameter will return the data back to the Salt master, making
the job available in this list.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
schedule:
job1:
@ -209,7 +209,7 @@ but can be used to search for specific jobs later if combined with the
return_job parameter. The metadata parameter must be specified as a
dictionary, othewise it will be ignored.
.. versionadded:: 2015.2.0
.. versionadded:: 2015.5.0
schedule:
job1: