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 Nitrogen references to 2017.7.0 in doc/*

Browse source
This commit is contained in:
rallytime 2017-06-14 11:36:06 -06:00
parent 10b68e9375
commit c5b75d030a
24 changed files with 157 additions and 147 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/ref/cli/salt-cp.rst
View file

@ -33,7 +33,7 @@ specified target expression.
minions. However, this requires the file to be located within one of the
fileserver directories.
.. versionchanged:: 2016.3.7,2016.11.6,Nitrogen
.. versionchanged:: 2016.3.7,2016.11.6,2017.7.0
Compression support added, disable with ``-n``. Also, if the destination
path ends in a path separator (i.e. ``/``, or ``\`` on Windows, the
desitination will be assumed to be a directory. Finally, recursion is now
@ -60,7 +60,7 @@ Options
Disable gzip compression.
.. versionadded:: 2016.3.7,2016.11.6,Nitrogen
.. versionadded:: 2016.3.7,2016.11.6,2017.7.0
See also
========

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

@ -246,9 +246,9 @@ each of Salt's module types such as ``runners``, ``output``, ``wheel``,
extension_modules: /root/salt_extmods
``extmod_whitelist/extmod_blacklist``
--------------------
-------------------------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
By using this dictionary, the modules that are synced to the master's extmod cache using `saltutil.sync_*` can be
limited. If nothing is set to a specific type, then all modules are accepted. To block all modules of a specific type,
@ -1742,9 +1742,9 @@ on a large number of minions.
.. conf_master:: fileserver_verify_config
``fileserver_verify_config``
------------------------------
----------------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``True``
@ -2255,7 +2255,7 @@ authenticate is protected by a passphrase.
``gitfs_refspecs``
~~~~~~~~~~~~~~~~~~
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``['+refs/heads/*:refs/remotes/origin/*', '+refs/tags/*:refs/tags/*']``
@ -2801,7 +2801,7 @@ configuration is the same as :conf_master:`file_roots`:
``on_demand_ext_pillar``
------------------------
.. versionadded:: 2016.3.6,2016.11.3,Nitrogen
.. versionadded:: 2016.3.6,2016.11.3,2017.7.0
Default: ``['libvirt', 'virtkey']``
@ -2829,7 +2829,7 @@ The external pillars permitted to be used on-demand using :py:func:`pillar.ext
``decrypt_pillar``
------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``[]``
@ -2851,7 +2851,7 @@ specified by :conf_master:`decrypt_pillar_default` will be used.
``decrypt_pillar_delimiter``
----------------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``:``
@ -2870,7 +2870,7 @@ The delimiter used to distinguish nested data structures in the
``decrypt_pillar_default``
--------------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``gpg``
@ -2886,7 +2886,7 @@ pillar key in :conf_master:`decrypt_pillar`.
``decrypt_pillar_renderers``
----------------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``['gpg']``
@ -3210,7 +3210,7 @@ they were created by a different master.
``git_pillar_includes``
***********************
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``True``
@ -3341,7 +3341,7 @@ authenticate is protected by a passphrase.
``git_pillar_refspecs``
~~~~~~~~~~~~~~~~~~~~~~~
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``['+refs/heads/*:refs/remotes/origin/*', '+refs/tags/*:refs/tags/*']``
@ -3364,7 +3364,7 @@ configured both globally and for individual remotes.
``git_pillar_verify_config``
----------------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``True``
@ -3722,9 +3722,9 @@ check in with their lists of expected minions before giving up.
.. conf_master:: syndic_forward_all_events
``syndic_forward_all_events``
-------------------
-----------------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``False``
@ -4351,7 +4351,7 @@ authenticate is protected by a passphrase.
``winrepo_refspecs``
~~~~~~~~~~~~~~~~~~~~
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``['+refs/heads/*:refs/remotes/origin/*', '+refs/tags/*:refs/tags/*']``

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

@ -1262,9 +1262,9 @@ below.
service: systemd
``extmod_whitelist/extmod_blacklist``
--------------------
-------------------------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
By using this dictionary, the modules that are synced to the minion's extmod cache using `saltutil.sync_*` can be
limited. If nothing is set to a specific type, then all modules are accepted. To block all modules of a specific type,
@ -1733,7 +1733,7 @@ the pillar environments.
``on_demand_ext_pillar``
------------------------
.. versionadded:: 2016.3.6,2016.11.3,Nitrogen
.. versionadded:: 2016.3.6,2016.11.3,2017.7.0
Default: ``['libvirt', 'virtkey']``
@ -1762,7 +1762,7 @@ external pillars are permitted to be used on-demand using :py:func:`pillar.ext
``decrypt_pillar``
------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``[]``
@ -1784,7 +1784,7 @@ specified by :conf_minion:`decrypt_pillar_default` will be used.
``decrypt_pillar_delimiter``
----------------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``:``
@ -1803,7 +1803,7 @@ The delimiter used to distinguish nested data structures in the
``decrypt_pillar_default``
--------------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``gpg``
@ -1819,7 +1819,7 @@ pillar key in :conf_minion:`decrypt_pillar`.
``decrypt_pillar_renderers``
----------------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``['gpg']``
@ -1850,7 +1850,7 @@ the environment setting, but for pillar instead of states.
``pillarenv_from_saltenv``
--------------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``False``

10
doc/ref/configuration/proxy.rst
View file

@ -27,7 +27,7 @@ Proxy-specific Configuration Options
.. conf_proxy:: add_proxymodule_to_opts
``add_proxymodule_to_opts``
--------------------------
---------------------------
.. versionadded:: 2015.8.2
@ -49,7 +49,7 @@ Add the proxymodule LazyLoader object to opts.
.. versionadded:: 2016.3.0
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
Default: ``True``
@ -68,7 +68,7 @@ function in a custom way and returns the data elsewhere.
``proxy_keep_alive``
--------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``True``
@ -86,7 +86,7 @@ otherwise the connection is considered alive.
``proxy_keep_alive_interval``
-----------------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``1``
@ -104,7 +104,7 @@ The frequency of keepalive checks, in minutes. It requires the
``proxy_always_alive``
----------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Default: ``True``

2
doc/ref/peer.rst
View file

@ -126,4 +126,4 @@ To match minions using other matchers, use ``tgt_type``:
# salt-call publish.publish 'webserv* and not G@os:Ubuntu' test.ping tgt_type='compound'
.. note::
In pre-Nitrogen releases, use ``expr_form`` instead of ``tgt_type``.
In pre-2017.7.0 releases, use ``expr_form`` instead of ``tgt_type``.

22
doc/ref/states/parallel.rst
View file

@ -2,8 +2,8 @@
Running States in Parallel
==========================
Introduced in Salt version Nitrogen it is now possible to run select states
in parallel. This is accomplished very easily by adding the `parallel: True`
Introduced in Salt version ``2017.7.0`` it is now possible to run select states
in parallel. This is accomplished very easily by adding the ``parallel: True``
option to your state declaration:
.. code_block:: yaml
@ -12,7 +12,7 @@ option to your state declaration:
service.running:
- parallel: True
Now `nginx` will be started in a seperate process from the normal state run
Now ``nginx`` will be started in a seperate process from the normal state run
and will therefore not block additional states.
Parallel States and Requisites
@ -40,16 +40,16 @@ Given this example:
cmd.run:
- parallel: True
The `sleep 10` will be started first, then the state system will block on
starting nginx until the `sleep 10` completes. Once nginx has been ensured to
be running then the `sleep 5` will start.
The ``sleep 10`` will be started first, then the state system will block on
starting nginx until the ``sleep 10`` completes. Once nginx has been ensured to
be running then the ``sleep 5`` will start.
This means that the order of evaluation of Salt States and requisites are
still honored, and given that in the above case, `parallel: True` does not
still honored, and given that in the above case, ``parallel: True`` does not
actually speed things up.
To run the above state much faster make sure that the `sleep 5` is evaluated
before the `nginx` state
To run the above state much faster make sure that the ``sleep 5`` is evaluated
before the ``nginx`` state
.. code_block:: yaml
@ -67,8 +67,8 @@ before the `nginx` state
- require:
- cmd: sleep 10
Now both of the sleep calls will be started in parallel and `nginx` will still
wait for the state it requires, but while it waits the `sleep 5` state will
Now both of the sleep calls will be started in parallel and ``nginx`` will still
wait for the state it requires, but while it waits the ``sleep 5`` state will
also complete.
Things to be Careful of

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

@ -517,7 +517,7 @@ inherit inherited options.
runas
~~~~~
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
The ``runas`` global option is used to set the user which will be used to run the command in the ``cmd.run`` module.
@ -849,7 +849,7 @@ this one, include a ``mod_run_check_cmd`` in the states file for the state.
Retrying States
===============
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
The retry option in a state allows it to be executed multiple times until a desired
result is obtained or the maximum number of attempts have been made.

22
doc/topics/cloud/gce.rst
View file

@ -15,9 +15,10 @@ at https://cloud.google.com.
Dependencies
============
* LibCloud >= 1.0.0
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
* A Google Cloud Platform account with Compute Engine enabled
* A registered Service Account for authorization
@ -226,7 +227,7 @@ Use this setting to define the subnetwork an instance will be created in.
This requires that the network your instance is created under has a mode of 'custom' or 'auto'.
Additionally, the subnetwork your instance is created under is associated with the location you provide.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
tags
----
@ -526,7 +527,7 @@ not possible to add/remove existing instances to a network.
salt-cloud -f create_network gce name=mynet cidr=10.10.10.0/24
salt-cloud -f create_network gce name=mynet mode=auto description=some optional info.
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
Destroy network
---------------
@ -546,7 +547,8 @@ Specify the network name to view information about the network.
salt-cloud -f show_network gce name=mynet
Create subnetwork
--------------
-----------------
New subnetworks require a name, region, and CIDR range.
Optionally, 'description' can be provided to add an extra note to your subnetwork.
New instances can be created and added to this subnetwork by setting the subnetwork name during create. It is
@ -557,10 +559,11 @@ not possible to add/remove existing instances to a subnetwork.
salt-cloud -f create_subnetwork gce name=mynet network=mynet region=us-central1 cidr=10.0.10.0/24
salt-cloud -f create_subnetwork gce name=mynet network=mynet region=us-central1 cidr=10.10.10.0/24 description=some info about my subnet.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Destroy subnetwork
---------------
------------------
Destroy a subnetwork by specifying the name and region. If a resource is currently using
the target subnetwork an exception will be raised.
@ -568,17 +571,18 @@ the target subnetwork an exception will be raised.
salt-cloud -f delete_subnetwork gce name=mynet region=us-central1
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Show subnetwork
------------
---------------
Specify the subnetwork name to view information about the subnetwork.
.. code-block:: bash
salt-cloud -f show_subnetwork gce name=mynet
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Create address
--------------

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

@ -92,7 +92,7 @@ Any top level data element from your profile may be overridden in the map file:
- web2:
size: t2.nano
As of Salt Nitrogen, nested elements are merged, and can can be specified
As of Salt 2017.7.0, nested elements are merged, and can can be specified
individually without having to repeat the complete definition for each top
level data element. In this example a separate MAC is assigned to each VMware
instance while inheriting device parameters for for disk and network

2
doc/topics/event/master_events.rst
View file

@ -136,7 +136,7 @@ Runner Events
``state`` and ``function`` types, also includes a ``tgt_type`` value
which shows what kind of match (``glob``, ``pcre``, etc.) was used.
This value was named ``expr_form`` in the 2016.11 release cycle but has
been renamed to ``tgt_type`` in Nitrogen for consistency with other
been renamed to ``tgt_type`` in 2017.7.0 for consistency with other
events.
.. _event-master_presence:

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

@ -261,7 +261,7 @@ use ``yaml_encode`` or ``yaml_dquote``).
``to_bool``
-----------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Returns the logical value of an element.
@ -289,7 +289,7 @@ Will be rendered as:
``exactly_n_true``
------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Tests that exactly N items in an iterable are "truthy" (neither None, False, nor 0).
@ -309,9 +309,9 @@ Returns:
.. jinja_ref:: exactly_one_true
``exactly_one_true``
------------------
--------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Tests that exactly one item in an iterable is "truthy" (neither None, False, nor 0).
@ -333,7 +333,7 @@ Returns:
``quote``
---------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Wraps a text around quoutes.
@ -343,7 +343,7 @@ Wraps a text around quoutes.
``regex_search``
----------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Scan through string looking for a location where this regular expression
produces a match. Returns ``None`` in case there were no matches found
@ -364,9 +364,9 @@ Returns:
.. jinja_ref:: regex_match
``regex_match``
----------------
---------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
If zero or more characters at the beginning of string match this regular
expression, otherwise returns ``None``.
@ -389,7 +389,7 @@ Returns:
``uuid``
--------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return a UUID.
@ -411,7 +411,7 @@ Returns:
``is_list``
-----------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return if an object is list.
@ -433,7 +433,7 @@ Returns:
``is_iter``
-----------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return if an object is iterable.
@ -455,7 +455,7 @@ Returns:
``min``
-------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return the minimum value from a list.
@ -477,7 +477,7 @@ Returns:
``max``
-------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Returns the maximum value from a list.
@ -499,7 +499,7 @@ Returns:
``avg``
-------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Returns the average value of the elements of a list
@ -521,7 +521,7 @@ Returns:
``union``
---------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return the union of two lists.
@ -543,7 +543,7 @@ Returns:
``intersect``
-------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return the intersection of two lists.
@ -565,7 +565,7 @@ Returns:
``difference``
--------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return the difference of two lists.
@ -588,7 +588,7 @@ Returns:
``symmetric_difference``
------------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return the symmetric difference of two lists.
@ -610,7 +610,7 @@ Returns:
``is_sorted``
-------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return is an iterable object is already sorted.
@ -632,7 +632,7 @@ Returns:
``compare_lists``
-----------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Compare two lists and return a dictionary with the changes.
@ -654,7 +654,7 @@ Returns:
``compare_dicts``
-----------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Compare two dictionaries and return a dictionary with the changes.
@ -676,7 +676,7 @@ Returns:
``is_hex``
----------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return True if the value is hexazecimal.
@ -700,7 +700,7 @@ Returns:
``contains_whitespace``
-----------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return True if a text contains whitespaces.
@ -724,7 +724,7 @@ Returns:
``substring_in_list``
---------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return is a substring is found in a list of string values.
@ -746,7 +746,7 @@ Returns:
``check_whitelist_blacklist``
-----------------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Check a whitelist and/or blacklist to see if the value matches it.
@ -769,7 +769,7 @@ Returns:
``date_format``
---------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Converts unix timestamp into human-readable string.
@ -793,7 +793,7 @@ Returns:
``str_to_num``
--------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Converts a string to its numerical value.
@ -815,7 +815,7 @@ Returns:
``to_bytes``
------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Converts string-type object to bytes.
@ -831,7 +831,7 @@ Example:
``json_decode_list``
--------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
JSON decodes as unicode, Jinja needs bytes.
@ -853,7 +853,7 @@ Returns:
``json_decode_dict``
--------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
JSON decodes as unicode, Jinja needs bytes.
@ -875,7 +875,7 @@ Returns:
``rand_str``
------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Generate a random string and applies a hash. Default hashing: md5.
@ -900,7 +900,7 @@ Returns:
``md5``
-------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return the md5 digest of a string.
@ -922,7 +922,7 @@ Returns:
``sha256``
----------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return the sha256 digest of a string.
@ -944,7 +944,7 @@ Returns:
``sha512``
----------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return the sha512 digest of a string.
@ -966,7 +966,7 @@ Returns:
``base64_encode``
-----------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Encode a string as base64.
@ -988,7 +988,7 @@ Returns:
``base64_decode``
-----------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Decode a base64-encoded string.
@ -1008,7 +1008,7 @@ Returns:
``hmac``
--------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Verify a challenging hmac signature against a string / shared-secret. Returns
a boolean value.
@ -1031,7 +1031,7 @@ Returns:
``http_query``
--------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return the HTTP reply object from a URL.
@ -1068,7 +1068,7 @@ The following networking-related filters are supported:
``is_ip``
---------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return if a string is a valid IP Address.
@ -1101,7 +1101,7 @@ Example - test if a string is a valid loopback IP address.
``is_ipv4``
-----------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Returns if a string is a valid IPv4 address. Supports the same options
as ``is_ip``.
@ -1116,7 +1116,7 @@ as ``is_ip``.
``is_ipv6``
-----------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Returns if a string is a valid IPv6 address. Supports the same options
as ``is_ip``.
@ -1131,7 +1131,7 @@ as ``is_ip``.
``ipaddr``
----------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
From a list, returns only valid IP entries. Supports the same options
as ``is_ip``. The list can contains also IP interfaces/networks.
@ -1154,7 +1154,7 @@ Returns:
``ipv4``
--------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
From a list, returns only valid IPv4 entries. Supports the same options
as ``is_ip``. The list can contains also IP interfaces/networks.
@ -1177,7 +1177,7 @@ Returns:
``ipv6``
--------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
From a list, returns only valid IPv6 entries. Supports the same options
as ``is_ip``. The list can contains also IP interfaces/networks.
@ -1200,7 +1200,7 @@ Returns:
``network_hosts``
-----------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return the list of hosts within a networks.
@ -1222,7 +1222,7 @@ Returns:
``network_size``
----------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return the size of the network.
@ -1244,7 +1244,7 @@ Returns:
``gen_mac``
-----------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Generates a MAC address with the defined OUI prefix.
@ -1274,7 +1274,7 @@ Returns:
``mac_str_to_bytes``
--------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Converts a string representing a valid MAC address to bytes.
@ -1290,7 +1290,7 @@ Example:
``dns_check``
-------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return the ip resolved by dns, but do not exit on failure, only raise an
exception. Obeys system preference for IPv4/6 address resolution.
@ -1313,9 +1313,9 @@ File filters
.. jinja_ref:: is_text_file
``is_text_file``
---------------
----------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return if a file is text.
@ -1342,7 +1342,7 @@ Returns:
``is_binary_file``
------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return if a file is binary.
@ -1367,7 +1367,7 @@ Returns:
``is_empty_file``
-----------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return if a file is empty.
@ -1389,7 +1389,7 @@ Returns:
``file_hashsum``
----------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return the hashsum of a file.
@ -1411,7 +1411,7 @@ Returns:
``list_files``
--------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return a recursive list of files under a specific path.
@ -1437,7 +1437,7 @@ Returns:
``path_join``
-------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Joins absolute paths.
@ -1459,7 +1459,7 @@ Returns:
``which``
---------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Python clone of /usr/bin/which.
@ -1599,7 +1599,7 @@ in the current Jinja context.
Logs
----
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Yes, in Salt, one is able to debug a complex Jinja template using the logs.
For example, making the call:

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

@ -225,5 +225,5 @@ Create the Jinja template in :file:`/srv/salt/haproxy_config`:
In the above example, ``server`` will be expanded to the ``minion_id``.
.. note::
The expr_form argument will be renamed to ``tgt_type`` in the Nitrogen
The expr_form argument will be renamed to ``tgt_type`` in the 2017.7.0
release of Salt.

4
doc/topics/pillar/index.rst
View file

@ -376,7 +376,7 @@ the ``testing`` environment, without modifying the in-memory pillar data.
this case would still restrict the states' pillar data to just that of the
``testing`` pillar environment.
Starting in the Nitrogen release, it is possible to pin the pillarenv to the
Starting in the 2017.7.0 release, it is possible to pin the pillarenv to the
effective saltenv, using the :conf_minion:`pillarenv_from_saltenv` minion
config option. When this is set to ``True``, if a specific saltenv is specified
when running states, the ``pillarenv`` will be the same. This essentially makes
@ -497,7 +497,7 @@ compilation.
Encrypted Pillar SLS
--------------------
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Consider the following pillar SLS file:

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

@ -36,7 +36,7 @@ or more minions.
See :ref:`Proxyminion Beacon <proxy-minion-beacon>` to help
with easy configuration and management of ``salt-proxy`` processes.
New in Nitrogen
New in 2017.7.0
---------------
The :conf_proxy:`proxy_merge_grains_in_module` configuration variable
@ -128,7 +128,7 @@ will be executed on proxy-minion startup and its contents will be merged with
the rest of the proxy's grains. Since older proxy-minions might have used other
methods to call such a function and add its results to grains, this is config-gated
by a new proxy configuration option called ``proxy_merge_grains_in_module``. This
defaults to ``True`` in the **Nitrogen** release.
defaults to ``True`` in the **2017.7.0** release.
New in 2015.8.2
@ -377,7 +377,7 @@ the ``proxy_keep_alive_interval`` option, in minutes.
the standard install directories for grains, grains can be computed and
returned by this function. This function will be called automatically
if ``proxy_merge_grains_in_module`` is set to ``True`` in /etc/salt/proxy.
This variable defaults to ``True`` in the release code-named *Nitrogen*.
This variable defaults to ``True`` in the release code-named *2017.7.0*.
Pre 2015.8 the proxymodule also must have an ``id()`` function. 2015.8 and following don't use
this function because the proxy's id is required on the command line.
@ -621,7 +621,7 @@ the proxy and grains directories.
This function will only be called automatically if the configuration variable ``proxy_merge_grains_in_module``
is set to True in the proxy configuration file (default ``/etc/salt/proxy``). This
variable defaults to ``True`` in the release code-named *Nitrogen*.
variable defaults to ``True`` in the release code-named *2017.7.0*.
.. code: python::

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

@ -396,7 +396,7 @@ Use the ``tgt_type`` argument to specify a matcher:
.. note::
The ``tgt_type`` argument was named ``expr_form`` in releases prior to
Nitrogen (2016.11.x and earlier).
2017.7.0 (2016.11.x and earlier).
Any other parameters in the :py:meth:`LocalClient().cmd()
<salt.client.LocalClient.cmd>` method can be specified as well.

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

@ -231,7 +231,7 @@ Deprecations
- The use of ``provider`` in Salt Cloud provider files to define cloud drivers
has been deprecated in favor of using ``driver``. Both terms will work until
the Nitrogen release of Salt. Example provider file:
the 2017.7.0 release of Salt. Example provider file:
.. code-block:: yaml

2
doc/topics/releases/2016.11.0.rst
View file

@ -561,7 +561,7 @@ General Deprecations
- If ``env`` (or ``__env__``) is supplied as a keyword argument to a function
that also accepts arbitrary keyword arguments, then a new warning informs the
user that ``env`` is no longer used if it is found. This new warning will be
removed in Salt Nitrogen.
removed in Salt 2017.7.0.
.. code-block:: python

2
doc/topics/releases/2016.3.0.rst
View file

@ -274,7 +274,7 @@ Module Changes
:mod:`apache_site state module <salt.states.apache_site>`: the ``enable`` and
``disable`` functions were renamed to ``enabled`` and ``disabled``,
respectively. In :pull:`33562`, these functions were readded and properly
deprecated and will be removed in Salt Nitrogen. This fix will be available
deprecated and will be removed in Salt 2017.7.0. This fix will be available
in 2016.3.1. As a workaround, try
.. code-block:: sls

16
doc/topics/releases/nitrogen.rst → doc/topics/releases/2017.7.0.rst
View file

@ -1,8 +1,8 @@
:orphan:
.. _release-2017-7-0:
======================================
Salt Release Notes - Codename Nitrogen
======================================
===============================================
Salt 2017.7.0 Release Notes - Codename Nitrogen
===============================================
States Added for Management of systemd Unit Masking
===================================================
@ -272,7 +272,7 @@ Jinja
Filters
-------
New filters in Nitrogen:
New filters in 2017.7.0:
- :jinja_ref:`to_bool`
- :jinja_ref:`exactly_n_true`
@ -365,7 +365,7 @@ have been improved, enhanced and widenened in scope:
- Proxy keepalive: due to external factors, the connection with the remote
device can be dropped, e.g.: packet loss, idle time (no commands issued
within a couple of minutes or seconds), or simply the device decides to kill
the process. In Nitrogen we have introduced the functionality to re-establish
the process. In 2017.7.0 we have introduced the functionality to re-establish
the connection. One can disable this feature through the
:conf_proxy:`proxy_keep_alive` option and adjust the polling frequency
speciying a custom value for :conf_proxy:`proxy_keep_alive_interval`,
@ -520,7 +520,7 @@ documentation for :ref:`skip_translate
.. note::
When running the :py:func:`docker_container.running
<salt.states.docker_container.running>` state for the first time after
upgrading to Nitrogen, your container(s) may be replaced. The changes may
upgrading to 2017.7.0, your container(s) may be replaced. The changes may
show diffs for certain parameters which say that the old value was an empty
string, and the new value is ``None``. This is due to the fact that in
prior releases Salt was passing empty strings for these values when
@ -748,7 +748,7 @@ The ``htpasswd`` execution module had the following function removed:
- ``useradd_all``: Please use ``useradd`` instead.
The ``img`` execution module has been removed. All of its associated functions
were marked for removal in the Nitrogen release. The functions removed in this
were marked for removal in the 2017.7.0 release. The functions removed in this
module are mapped as follows:
- ``mount_image``/``mnt_image``: Please use ``mount.mount`` instead.

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

@ -20,6 +20,7 @@ Previous Releases
:maxdepth: 1
:glob:
2017.7.*
2016.11.*
2016.3.*
2015.8.*

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

@ -11,9 +11,11 @@ format ``YYYY.MM.R``. The year (``YYYY``) and month (``MM``) reflect when the
release was created. The bugfix release number (``R``) increments within that
feature release.
.. note:: Prior to the ``2014.1.0`` release, the typical semantic versioning was
still being used. Because of the rolling nature of the project, this did not
make sense. The ``0.17`` release was the last of that style.
.. note::
Prior to the ``2014.1.0`` release, the typical semantic versioning was
still being used. Because of the rolling nature of the project, this did not
make sense. The ``0.17`` release was the last of that style.
Code Names
----------
@ -31,8 +33,9 @@ Assigned codenames:
- Beryllium: ``2015.8.0``
- Boron: ``2016.3.0``
- Carbon: ``2016.11.0``
- Nitrogen: ``TBD``
- Nitrogen: ``2017.7.0``
- Oxygen: ``TBD``
- Fluorine: ``TBD``
Example
-------
@ -49,10 +52,12 @@ code name and the process repeats itself.
Version numbers, Git and salt --version
-------
---------------------------------------
The salt version, for programmers, is based on `git describe` and presented to end-users with `salt --version`.
Example arguments for `git checkout`
Example arguments for `git checkout`:
+------------+----------------------------------------------------------------------------+
| Argument | Comment |
+============+============================================================================+
@ -68,7 +73,8 @@ Example arguments for `git checkout`
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`
Influence of the `git checkout` argument on `git describe`:
+------------+----------------------------+-----------------------------------------------+
| Checkout | Describe | Comment |
+============+============================+===============================================+
@ -80,10 +86,9 @@ Influence of the `git checkout` argument on `git describe`
+------------+----------------------------+-----------------------------------------------+
| develop | v2016.11.1-1741-g10d5dec | Commit of most recent tag in develop |
+------------+----------------------------+-----------------------------------------------+
Some details of v2016.11.1-220-g9a1550d (from `git describe` after `git checkout 2016.11`)
Some details of v2016.11.1-220-g9a1550d (from `git describe` after `git checkout 2016.11`):
+---------------+-------------------------------------------------------------------------+
| Part | Comment |
+===============+=========================================================================+

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

@ -112,7 +112,7 @@ Calling Salt SSH
.. note:: ``salt-ssh`` on systems with Python 3.x
Salt, before the Nitrogen release, does not support Python 3.x which is the
Salt, before the 2017.7.0 release, does not support Python 3.x which is the
default on for example the popular 16.04 LTS release of Ubuntu. An easy
workaround for this scenario is to use the ``-r`` option similar to the
example above:

2
doc/topics/targeting/nodegroups.rst
View file

@ -28,7 +28,7 @@ nodegroups. Here's an example nodegroup configuration within
group2 is matching specific grains. See the :ref:`compound matchers
<targeting-compound>` documentation for more details.
As of the Nitrogen release of Salt, group names can also be prepended with
As of the 2017.7.0 release of Salt, group names can also be prepended with
a dash. This brings the usage in line with many other areas of Salt. For
example:

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

@ -329,7 +329,7 @@ configured gitfs remotes):
* :conf_master:`gitfs_pubkey` (**pygit2 only**, new in 2014.7.0)
* :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 Nitrogen)
* :conf_master:`gitfs_refspecs` (new in 2017.7.0)
.. note::
pygit2 only supports disabling SSL verification in versions 0.23.2 and
@ -459,7 +459,7 @@ Given the above configuration, the following is true:
Custom Refspecs
===============
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
GitFS will by default fetch remote branches and tags. However, sometimes it can
be useful to fetch custom refs (such as those created for `GitHub pull