Merge pull request #55875 from frogunder/update_neon_reference

update neon reference
This commit is contained in:
Daniel Wozniak 2020-01-17 10:33:19 -07:00 committed by GitHub
commit 914cced821
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
56 changed files with 130 additions and 128 deletions

View file

@ -4266,7 +4266,7 @@ explanation <git-pillar-multiple-remotes>` from the git_pillar documentation.
``git_pillar_update_interval``
******************************
.. versionadded:: neon
.. versionadded:: 3000
Default: ``60``

View file

@ -657,7 +657,7 @@ FQDN (for instance, Solaris).
``minion_id_remove_domain``
---------------------------
.. versionadded:: Neon
.. versionadded:: 3000
Default: ``False``
@ -813,7 +813,7 @@ matches, and regular expressions are supported.
Some states and execution modules depend on grains. Filtering may cause
them to be unavailable or run unreliably.
.. versionadded:: Neon
.. versionadded:: 3000
.. code-block:: yaml

View file

@ -938,7 +938,7 @@ For example:
In the above case, ``some_check`` will be run prior to _each_ name -- once for
``first_deploy_cmd`` and a second time for ``second_deploy_cmd``.
.. versionchanged:: Neon
.. versionchanged:: 3000
The ``unless`` requisite can take a module as a dictionary field in unless.
The dictionary must contain an argument ``fun`` which is the module that is
being run, and everything else must be passed in under the args key or will
@ -1006,7 +1006,7 @@ concept of ``True`` and ``False``.
The above example ensures that the stop_volume and delete modules only run
if the gluster commands return a 0 ret value.
.. versionchanged:: Neon
.. versionchanged:: 3000
The ``onlyif`` requisite can take a module as a dictionary field in onlyif.
The dictionary must contain an argument ``fun`` which is the module that is
being run, and everything else must be passed in under the args key or will

View file

@ -56,7 +56,7 @@ will be notified about style and lint issues before you ever open a PR.
Salt Coding Style
-----------------
After the Neon release, SaltStack is `joining the ranks <SEP 15_>`_ of projects
After the 3000 release, SaltStack is `joining the ranks <SEP 15_>`_ of projects
in adopting the `Black code formatter <Black_>`_ in order to ease the adoption
of a unified code formatting style.

View file

@ -27,7 +27,7 @@ Salt engines are configured under an ``engines`` top-level section in your Salt
port: 5959
proto: tcp
.. versionadded:: Neon
.. versionadded:: 3000
Multiple copies of a particular Salt engine can be configured by including the ``engine_module`` parameter in the engine configuration.

View file

@ -1024,7 +1024,7 @@ Returns:
``set_dict_key_value``
----------------------
..versionadded:: Neon
..versionadded:: 3000
Allows you to set a value in a nested dictionary without having to worry if all the nested keys actually exist.
Missing keys will be automatically created if they do not exist.
@ -1057,7 +1057,7 @@ Example 2:
``append_dict_key_value``
-------------------------
..versionadded:: Neon
..versionadded:: 3000
Allows you to append to a list nested (deep) in a dictionary without having to worry if all the nested keys (or the list itself) actually exist.
Missing keys will automatically be created if they do not exist.
@ -1091,7 +1091,7 @@ Example 2:
``extend_dict_key_value``
-------------------------
..versionadded:: Neon
..versionadded:: 3000
Allows you to extend a list nested (deep) in a dictionary without having to worry if all the nested keys (or the list itself) actually exist.
Missing keys will automatically be created if they do not exist.
@ -1124,7 +1124,7 @@ Example 2:
``update_dict_key_value``
-------------------------
..versionadded:: Neon
..versionadded:: 3000
Allows you to update a dictionary nested (deep) in another dictionary without having to worry if all the nested keys actually exist.
Missing keys will automatically be created if they do not exist.
@ -1349,7 +1349,7 @@ Returns:
``json_query``
--------------
.. versionadded:: Neon
.. versionadded:: 3000
A port of Ansible ``json_query`` Jinja filter to make queries against JSON data using `JMESPath language`_.
Could be used to filter ``pillar`` data, ``yaml`` maps, and together with :jinja_ref:`http_query`.
@ -1395,7 +1395,7 @@ Returns:
``to_snake_case``
-----------------
.. versionadded:: Neon
.. versionadded:: 3000
Converts a string from camelCase (or CamelCase) to snake_case.
@ -1415,7 +1415,7 @@ Returns:
``to_camelcase``
----------------
.. versionadded:: Neon
.. versionadded:: 3000
Converts a string from snake_case to camelCase (or UpperCamelCase if so indicated).

View file

@ -4,10 +4,10 @@
Matchers
========
.. versionadded:: Neon
.. versionadded:: 3000
Matchers are modules that provide Salt's targeting abilities. As of the
Neon release, matchers can be dynamically loaded. Currently new matchers
3000 release, matchers can be dynamically loaded. Currently new matchers
cannot be created because the required plumbing for the CLI does not exist yet.
Existing matchers may have their functionality altered or extended.
@ -22,7 +22,7 @@ take a ``delimiter`` argument and should default to ``DEFAULT_TARGET_DELIM``.
Like other Salt loadable modules, modules that override built-in functionality
can be placed in ``file_roots`` in a special directory and then copied to the
minion through the normal sync process. :py:func:`saltutil.sync_all <salt.modules.saltutil.sync_all>`
will transfer all loadable modules, and the Neon release introduces
will transfer all loadable modules, and the 3000 release introduces
:py:func:`saltutil.sync_matchers <salt.modules.saltutil.sync_matchers>`. For matchers, the directory is
``/srv/salt/_matchers`` (assuming your ``file_roots`` is set to the default
``/srv/salt``).

View file

@ -49,7 +49,7 @@ filters to help narrow down the results. In the above example IP addresses
are only returned if they are on a eth0 interface and in the 10.0.0.0/8 IP
range.
.. versionchanged:: Sodium
.. versionchanged:: 3000
The format to define mine_functions has been changed to allow the same format
as used for module.run. The old format (above) will still be supported.
@ -73,7 +73,7 @@ as used for module.run. The old format (above) will still be supported.
Minion-side Access Control
--------------------------
.. versionadded:: Sodium
.. versionadded:: 3000
Mine functions can be targeted to only be available to specific minions. This
uses the same targeting parameters as :ref:`targeting` but with keywords ``allow_tgt``
@ -114,7 +114,7 @@ positional and key-value arguments is not supported.
- mine_function: grains.get
- ip_interfaces
.. versionchanged:: Sodium
.. versionchanged:: 3000
With the addition of the module.run-like format for defining mine_functions, the
method of adding aliases remains similar. Just add a ``mine_function`` kwarg with

View file

@ -197,7 +197,7 @@ Several Jinja Filters Renamed
The following Jinja filters (originally added in 2017.7.0) have been renamed
due to the fact that they were inaccurately named when initially added. The
original names will be supported until the Neon release of Salt.
original names will be supported until the 3000 release of Salt.
- :jinja_ref:`rand_str` renamed to :jinja_ref:`random_hash`
- :jinja_ref:`jinja_decode_dict` renamed to :jinja_ref:`jinja_encode_dict`
@ -1624,7 +1624,7 @@ NaCL Module and Runner changes
==============================
In addition to argument changes in both the NaCL module and runner for future
removal in the Neon release, the default "box_type" has changed from
removal in the 3000 release, the default "box_type" has changed from
``secretbox`` to ``sealedbox``. SecretBox is data encrypted using private key
``sk`` and Sealedbox is encrypted using public key ``pk``.
@ -1634,7 +1634,7 @@ removal in the Neon release, the default "box_type" has changed from
The Salt utility functions from ``salt.utils`` (typically used by those
developing extension modules for Salt) have been moved into different modules,
grouped logically based on their functionality. The old function names will
continue to work until the ``Neon`` release of Salt (due around Q1 2019).
continue to work until the ``3000`` release of Salt (due around Q1 2019).
The renamed functions are:
@ -1919,7 +1919,7 @@ Grain Deprecations
------------------
- For ``smartos``, some grains have been deprecated. These grains will be
removed in Neon:
removed in 3000:
- The ``hypervisor_uuid`` grain has been replaced with
``mdata:sdc:server_uuid``
@ -1974,5 +1974,5 @@ RAET transport
We haven't been doing development on RAET for quite some time and decided that
2018.3.0 is the time to announce the deprecation. RAET support will be removed
in Neon. Please consider to move to ``zeromq`` or ``tcp`` transport instead of
in 3000. Please consider to move to ``zeromq`` or ``tcp`` transport instead of
``raet``.

View file

@ -77,7 +77,7 @@ This test case has also been tested with the ``yaml`` and ``json`` filters succe
The :jinja_ref:`json_encode_dict` and :jinja_ref:`json_encode_list` filters
do not actually dump the results to JSON. Since ``tojson`` accomplishes
what those filters were designed to do, they are now deprecated and will be
removed in the Neon release. The ``tojson`` filter should be used in all
removed in the 3000 release. The ``tojson`` filter should be used in all
cases where :jinja_ref:`json_encode_dict` and :jinja_ref:`json_encode_list`
would have been used.

View file

@ -1,8 +1,9 @@
:orphan:
.. _release-3000:
==================================
Salt Release Notes - Codename Neon
==================================
=======================================
Salt 3000 Release Notes - Codename Neon
=======================================
Saltcheck Updates
=================

View file

@ -20,6 +20,7 @@ Previous Releases
:maxdepth: 1
:glob:
3000*
2019.2.*
2018.3.*
2017.7.*

View file

@ -36,7 +36,7 @@ Assigned codenames:
- Nitrogen: ``2017.7.0``
- Oxygen: ``2018.3.0``
- Fluorine: ``2019.2.0``
- Neon: ``TBD``
- Neon: ``3000``
- Sodium: ``TBD``
Example

View file

@ -5,7 +5,7 @@ Slots
=====
.. versionadded:: 2018.3.0
.. versionchanged:: Neon
.. versionchanged:: 3000
.. note:: This functionality is under development and could be changed in the
future releases
@ -34,7 +34,7 @@ Slot syntax looks close to the simple python function call.
__slot__:salt:<module>.<function>(<args>, ..., <kwargs...>, ...)
For the Neon release, this syntax has been updated to support parsing functions
For the 3000 release, this syntax has been updated to support parsing functions
which return dictionaries and for appending text to the slot result.
.. code-block:: text

View file

@ -2,7 +2,7 @@
'''
Beacon to monitor certificate expiration dates from files on the filesystem.
.. versionadded:: Sodium
.. versionadded:: 3000
:maintainer: <devops@eitr.tech>
:maturity: new

View file

@ -3,7 +3,7 @@
An engine that reads messages from the salt event bus and pushes
them onto a fluent endpoint.
.. versionadded:: neon
.. versionadded:: 3000
:Configuration:

View file

@ -2,7 +2,7 @@
'''
Grains for NVMe Qualified Names (NQN).
.. versionadded:: Flourine
.. versionadded:: 3000
To enable these grains set `nvme_grains: True`.

View file

@ -2,7 +2,7 @@
'''
Azure (ARM) DNS Execution Module
.. versionadded:: Sodium
.. versionadded:: 3000
:maintainer: <devops@eitr.tech>
:maturity: new
@ -80,7 +80,7 @@ def __virtual__():
def record_set_create_or_update(name, zone_name, resource_group, record_type, **kwargs):
'''
.. versionadded:: Sodium
.. versionadded:: 3000
Creates or updates a record set within a DNS zone.
@ -132,7 +132,7 @@ def record_set_create_or_update(name, zone_name, resource_group, record_type, **
def record_set_delete(name, zone_name, resource_group, record_type, **kwargs):
'''
.. versionadded:: Sodium
.. versionadded:: 3000
Deletes a record set from a DNS zone. This operation cannot be undone.
@ -172,7 +172,7 @@ def record_set_delete(name, zone_name, resource_group, record_type, **kwargs):
def record_set_get(name, zone_name, resource_group, record_type, **kwargs):
'''
.. versionadded:: Sodium
.. versionadded:: 3000
Get a dictionary representing a record set's properties.
@ -211,7 +211,7 @@ def record_set_get(name, zone_name, resource_group, record_type, **kwargs):
def record_sets_list_by_type(zone_name, resource_group, record_type, top=None, recordsetnamesuffix=None, **kwargs):
'''
.. versionadded:: Sodium
.. versionadded:: 3000
Lists the record sets of a specified type in a DNS zone.
@ -259,7 +259,7 @@ def record_sets_list_by_type(zone_name, resource_group, record_type, top=None, r
def record_sets_list_by_dns_zone(zone_name, resource_group, top=None, recordsetnamesuffix=None, **kwargs):
'''
.. versionadded:: Sodium
.. versionadded:: 3000
Lists all record sets in a DNS zone.
@ -303,7 +303,7 @@ def record_sets_list_by_dns_zone(zone_name, resource_group, top=None, recordsetn
def zone_create_or_update(name, resource_group, **kwargs):
'''
.. versionadded:: Sodium
.. versionadded:: 3000
Creates or updates a DNS zone. Does not modify DNS records within the zone.
@ -356,7 +356,7 @@ def zone_create_or_update(name, resource_group, **kwargs):
def zone_delete(name, resource_group, **kwargs):
'''
.. versionadded:: Sodium
.. versionadded:: 3000
Delete a DNS zone within a resource group.
@ -389,7 +389,7 @@ def zone_delete(name, resource_group, **kwargs):
def zone_get(name, resource_group, **kwargs):
'''
.. versionadded:: Sodium
.. versionadded:: 3000
Get a dictionary representing a DNS zone's properties, but not the
record sets within the zone.
@ -422,7 +422,7 @@ def zone_get(name, resource_group, **kwargs):
def zones_list_by_resource_group(resource_group, top=None, **kwargs):
'''
.. versionadded:: Sodium
.. versionadded:: 3000
Lists the DNS zones in a resource group.
@ -459,7 +459,7 @@ def zones_list_by_resource_group(resource_group, top=None, **kwargs):
def zones_list(top=None, **kwargs):
'''
.. versionadded:: Sodium
.. versionadded:: 3000
Lists the DNS zones in all resource groups in a subscription.

View file

@ -38,7 +38,7 @@ def get_parameter(name, withdecryption=False, resp_json=False, region=None, key=
'''
Retrives a parameter from SSM Parameter Store
.. versionadded:: Neon
.. versionadded:: 3000
.. code-block:: text
@ -71,7 +71,7 @@ def put_parameter(Name,
'''
Sets a parameter in the SSM parameter store
.. versionadded:: Neon
.. versionadded:: 3000
.. code-block:: text
@ -104,7 +104,7 @@ def delete_parameter(Name, region=None, key=None, keyid=None, profile=None):
'''
Removes a parameter from the SSM parameter store
.. versionadded:: Neon
.. versionadded:: 3000
.. code-block:: text
salt-call boto_ssm.delete_parameter test-param

View file

@ -2980,7 +2980,7 @@ def run_chroot(root,
:param list binds: List of directories that will be exported inside
the chroot with the bind option.
.. versionadded:: Sodium
.. versionadded:: 3000
:param dict env: Environment variables to be set prior to execution.

View file

@ -176,7 +176,7 @@ def option(
Shorthand to omit all of the above and return matches only from the
"sane defaults".
.. versionadded:: Neon
.. versionadded:: 3000
wildcard : False
If used, this will perform pattern matching on keys. Note that this
@ -189,7 +189,7 @@ def option(
{'foo.bar': True, 'foo.baz': False}
.. versionadded:: Neon
.. versionadded:: 3000
CLI Example:

View file

@ -253,7 +253,7 @@ def _create_pbuilders(env, runas='root'):
idiosyncrasies can be found :ref:`here <yaml-idiosyncrasies>`.
runas : root
.. versionadded:: fluorine
.. versionadded:: 2019.2.1
User to create the files and directories
@ -364,7 +364,7 @@ def make_src_pkg(dest_dir, spec, sources, env=None, saltenv='base', runas='root'
runas : root
.. versionadded:: fluorine
.. versionadded:: 2019.2.1
User to create the files and directories

View file

@ -129,7 +129,7 @@ def migrate(settings_module,
Execute the Django-Admin migrate command (requires Django 1.7 or higher).
.. versionadded:: Neon
.. versionadded:: 3000
settings_module
Specifies the settings module to use.

View file

@ -59,7 +59,7 @@ any of the following locations:
in Minion config file in order to work)
.. important::
Versions prior to Neon require that Docker credentials are configured in
Versions prior to 3000 require that Docker credentials are configured in
Pillar data. Be advised that Pillar data is still recommended though,
because this keeps the configuration from being stored on the Minion.
@ -1054,7 +1054,7 @@ def compare_container_networks(first, second):
than waiting for a new Salt release one can just set
:conf_minion:`docker.compare_container_networks`.
.. versionchanged:: Neon
.. versionchanged:: 3000
This config option can now also be set in pillar data and grains.
Additionally, it can be set in the master config file, provided that
:conf_minion:`pillar_opts` is enabled on the minion.

View file

@ -267,7 +267,7 @@ def cluster_stats(nodes=None, hosts=None, profile=None):
def cluster_get_settings(flat_settings=False, include_defaults=False, hosts=None, profile=None):
'''
.. versionadded:: Neon
.. versionadded:: 3000
Return Elasticsearch cluster settings.
@ -291,7 +291,7 @@ def cluster_get_settings(flat_settings=False, include_defaults=False, hosts=None
def cluster_put_settings(body=None, flat_settings=False, hosts=None, profile=None):
'''
.. versionadded:: Neon
.. versionadded:: 3000
Set Elasticsearch cluster settings.
@ -693,7 +693,7 @@ def index_close(index, allow_no_indices=True, expand_wildcards='open', ignore_un
def index_get_settings(hosts=None, profile=None, **kwargs):
'''
.. versionadded:: Neon
.. versionadded:: 3000
Check for the existence of an index and if it exists, return its settings
http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html
@ -742,7 +742,7 @@ def index_get_settings(hosts=None, profile=None, **kwargs):
def index_put_settings(body=None, hosts=None, profile=None, source=None, **kwargs):
'''
.. versionadded:: Neon
.. versionadded:: 3000
Update existing index settings
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html
@ -1383,7 +1383,7 @@ def snapshot_delete(repository, snapshot, hosts=None, profile=None):
def flush_synced(hosts=None, profile=None, **kwargs):
'''
.. versionadded:: Neon
.. versionadded:: 3000
Perform a normal flush, then add a generated unique marker (sync_id) to all shards.
http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-synced-flush.html

View file

@ -3776,7 +3776,7 @@ def remove(path):
salt '*' file.remove /tmp/foo
.. versionchanged:: Neon
.. versionchanged:: 3000
The method now works on all types of file system entries, not just
files, directories and symlinks.
'''

View file

@ -242,7 +242,7 @@ def restore(name=None, clean=False, **kwargs):
clean
If True remove the frozen information YAML from the cache
.. version-added:: Neon
.. version-added:: 3000
CLI Example:

View file

@ -3056,7 +3056,7 @@ def merge(cwd,
.. _`sshd(8)`: http://www.man7.org/linux/man-pages/man8/sshd.8.html#AUTHORIZED_KEYS_FILE_FORMAT
.. versionadded:: 2018.3.5,2019.2.1,Neon
.. versionadded:: 2018.3.5,2019.2.1,3000
ignore_retcode : False
If ``True``, do not log an error to the minion log if the git command
@ -4245,7 +4245,7 @@ def reset(cwd,
.. _`sshd(8)`: http://www.man7.org/linux/man-pages/man8/sshd.8.html#AUTHORIZED_KEYS_FILE_FORMAT
.. versionadded:: 2018.3.5,2019.2.1,Neon
.. versionadded:: 2018.3.5,2019.2.1,3000
ignore_retcode : False
If ``True``, do not log an error to the minion log if the git command

View file

@ -1066,7 +1066,7 @@ def verify(text=None,
- always
- auto
.. versionadded:: fluorine
.. versionadded:: 2019.2.0
CLI Example:

View file

@ -121,7 +121,7 @@ def base64_encodestring(instr):
a newline ('\\n') character after every 76 characters and always
at the end of the encoded byte-like object.
.. versionadded:: Neon
.. versionadded:: 3000
CLI Example:
@ -169,7 +169,7 @@ def base64_decodestring(instr):
'''
Decode a base64-encoded byte-like object using the "modern" Python interface
.. versionadded:: Neon
.. versionadded:: 3000
CLI Example:
@ -265,7 +265,7 @@ def hmac_signature(string, shared_secret, challenge_hmac):
def hmac_compute(string, shared_secret):
'''
.. versionadded:: Sodium
.. versionadded:: 3000
Compute a HMAC SHA256 digest using a string and secret.

View file

@ -475,7 +475,7 @@ def create_stack(name=None, template_file=None, environment=None,
.. versionadded:: 2017.7.5,2018.3.1
The spelling mistake in parameter `enviroment` was corrected to `environment`.
The `enviroment` spelling mistake has been removed in Salt Neon.
The `enviroment` spelling mistake has been removed in Salt 3000.
'''
h_client = _auth(profile)
@ -669,7 +669,7 @@ def update_stack(name=None, template_file=None, environment=None,
.. versionadded:: 2017.7.5,2018.3.1
The spelling mistake in parameter `enviroment` was corrected to `environment`.
The `enviroment` spelling mistake has been removed in Salt Neon.
The `enviroment` spelling mistake has been removed in Salt 3000.
'''
h_client = _auth(profile)

View file

@ -3,7 +3,7 @@
Module for checking jinja maps and verifying the result of loading JSON/YAML
files
.. versionadded:: Neon
.. versionadded:: 3000
'''
from __future__ import absolute_import, print_function, unicode_literals

View file

@ -222,7 +222,7 @@ def send(name, *args, **kwargs):
:rtype: bool
:return: Whether executing the function and storing the information was succesful.
.. versionchanged:: Sodium
.. versionchanged:: 3000
Added ``allow_tgt``- and ``allow_tgt_type``-parameters to specify which
minions are allowed to access this function.

View file

@ -269,7 +269,7 @@ def list_upstreams(runas=None):
salt '*' rabbitmq.list_upstreams
.. versionadded:: Neon
.. versionadded:: 3000
'''
if runas is None and not salt.utils.platform.is_windows():
runas = salt.utils.user.get_user()
@ -329,7 +329,7 @@ def upstream_exists(name, runas=None):
salt '*' rabbitmq.upstream_exists rabbit_upstream
.. versionadded:: Neon
.. versionadded:: 3000
'''
if runas is None and not salt.utils.platform.is_windows():
runas = salt.utils.user.get_user()
@ -1223,7 +1223,7 @@ def set_upstream(
salt '*' rabbitmq.set_upstream upstream_name ack_mode=on-confirm max_hops=1 \
trust_user_id=True uri=amqp://hostname
.. versionadded:: Neon
.. versionadded:: 3000
'''
if runas is None and not salt.utils.platform.is_windows():
runas = salt.utils.user.get_user()
@ -1262,7 +1262,7 @@ def delete_upstream(name, runas=None):
salt '*' rabbitmq.delete_upstream upstream_name
.. versionadded:: Neon
.. versionadded:: 3000
'''
if runas is None and not salt.utils.platform.is_windows():
runas = salt.utils.user.get_user()

View file

@ -2,7 +2,7 @@
'''
Access Salt's elemental release code-names.
.. versionadded:: Neon
.. versionadded:: 3000
Salt's feature release schedule is based on the Periodic Table, as described
in the :ref:`Version Numbers <version-numbers>` documentation.

View file

@ -20,7 +20,7 @@ folder, and should be named the same as the associated state. The ``id`` of a te
same manner as in salt state files and should be unique and descriptive.
.. versionadded:: Neon
.. versionadded:: 3000
The ``saltcheck-tests`` folder can be customized using the ``saltcheck_test_location`` minion
configuration setting. This setting is a relative path from the formula's ``salt://`` path
to the test files.
@ -375,7 +375,7 @@ def report_highstate_tests(saltenv=None):
salt '*' saltcheck.report_highstate_tests
.. versionadded:: Neon
.. versionadded:: 3000
'''
if not saltenv:
if 'saltenv' in __opts__ and __opts__['saltenv']:

View file

@ -922,7 +922,7 @@ def sync_pillar(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blackl
def sync_executors(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None):
'''
.. versionadded:: Neon
.. versionadded:: 3000
Sync executors from ``salt://_executors`` to the minion

View file

@ -1351,7 +1351,7 @@ def init(name,
'cmdline': 'console=ttyS0 ks=http://example.com/f8-i386/os/'
}
.. versionadded:: neon
.. versionadded:: 3000
.. _init-nic-def:
@ -1833,7 +1833,7 @@ def update(name,
'cmdline': 'console=ttyS0 ks=http://example.com/f8-i386/os/'
}
.. versionadded:: neon
.. versionadded:: 3000
:return:
@ -4429,7 +4429,7 @@ def network_define(name,
a possible DHCP configuration. The structure is documented
in net-define-ip_.
..versionadded:: Neon
.. versionadded:: 3000
:type ipv4_config: dict or None
:param ipv6_config: IP v6 configuration
@ -4437,7 +4437,7 @@ def network_define(name,
a possible DHCP configuration. The structure is documented
in net-define-ip_.
..versionadded:: Neon
.. versionadded:: 3000
:type ipv6_config: dict or None
:param connection: libvirt connection URI, overriding defaults
@ -4593,7 +4593,7 @@ def network_get_xml(name, **kwargs):
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: Neon
.. versionadded:: 3000
CLI Example:
@ -4751,7 +4751,7 @@ def pool_capabilities(**kwargs):
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: Neon
.. versionadded:: 3000
CLI Example:
@ -4909,7 +4909,7 @@ def pool_define(name,
:param source_initiator:
Initiator IQN for libiscsi-direct pool types. (Default: ``None``)
.. versionadded:: neon
.. versionadded:: 3000
:param source_adapter:
SCSI source definition. The value is a dictionary with ``type``, ``name``, ``parent``,
``managed``, ``parent_wwnn``, ``parent_wwpn``, ``parent_fabric_wwn``, ``wwnn``, ``wwpn``
@ -4956,7 +4956,7 @@ def pool_define(name,
}
}
Since neon, instead the source authentication can only contain ``username``
Since 3000, instead the source authentication can only contain ``username``
and ``password`` properties. In this case the libvirt secret will be defined and used.
For Ceph authentications a base64 encoded key is expected.
@ -5129,7 +5129,7 @@ def pool_update(name,
:param source_initiator:
Initiator IQN for libiscsi-direct pool types. (Default: ``None``)
.. versionadded:: neon
.. versionadded:: 3000
:param source_adapter:
SCSI source definition. The value is a dictionary with ``type``, ``name``, ``parent``,
``managed``, ``parent_wwnn``, ``parent_wwpn``, ``parent_fabric_wwn``, ``wwnn``, ``wwpn``
@ -5176,7 +5176,7 @@ def pool_update(name,
}
}
Since neon, instead the source authentication can only contain ``username``
Since 3000, instead the source authentication can only contain ``username``
and ``password`` properties. In this case the libvirt secret will be defined and used.
For Ceph authentications a base64 encoded key is expected.
@ -5207,7 +5207,7 @@ def pool_update(name,
salt '*' virt.pool_update myshare netfs source_format=cifs \
source_dir=samba_share source_hosts="['example.com']" target=/mnt/cifs
.. versionadded:: neon
.. versionadded:: 3000
'''
# Get the current definition to compare the two
conn = __get_conn(**kwargs)
@ -5361,7 +5361,7 @@ def pool_get_xml(name, **kwargs):
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: Neon
.. versionadded:: 3000
CLI Example:
@ -5636,7 +5636,7 @@ def volume_infos(pool=None, volume=None, **kwargs):
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: Neon
.. versionadded:: 3000
CLI Example:
@ -5708,7 +5708,7 @@ def volume_delete(pool, volume, **kwargs):
:param username: username to connect with, overriding defaults
:param password: password to connect with, overriding defaults
.. versionadded:: Neon
.. versionadded:: 3000
CLI Example:

View file

@ -1391,7 +1391,7 @@ def create_certificate(
for ignore in list(_STATE_INTERNAL_KEYWORDS) + \
['listen_in', 'prerequired', '__prerequired__']:
kwargs.pop(ignore, None)
# TODO: Make timeout configurable in Neon
# TODO: Make timeout configurable in 3000
certs = __salt__['publish.publish'](
tgt=ca_server,
fun='x509.sign_remote_certificate',

View file

@ -2,7 +2,7 @@
'''
XML file manager
.. versionadded:: Neon
.. versionadded:: 3000
'''
from __future__ import absolute_import, print_function, unicode_literals

View file

@ -355,7 +355,7 @@ When ``__env__`` is specified as the branch name, ``all_saltenvs`` per-remote co
git_pillar_update_interval
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. versionadded:: neon
.. versionadded:: 3000
This option defines the default update interval (in seconds) for git_pillar
remotes. The update is handled within the global loop, hence

View file

@ -612,7 +612,7 @@ def sync_serializers(saltenv='base', extmod_whitelist=None, extmod_blacklist=Non
def sync_executors(saltenv='base', extmod_whitelist=None, extmod_blacklist=None):
'''
.. versionadded:: Neon
.. versionadded:: 3000
Sync executor modules from ``salt://_executors`` to the master

View file

@ -437,7 +437,7 @@ def extracted(name,
minions ``hash_type`` config option to the same one that you're going
to pass via ``source_hash`` argument.
.. versionadded:: Neon
.. versionadded:: 3000
skip_verify : False
If ``True``, hash verification of remote file sources (``http://``,
@ -553,7 +553,7 @@ def extracted(name,
then re-create that directory before extracting. Note that ``clean``
and ``clean_parent`` are mutually exclusive.
.. versionadded:: Neon
.. versionadded:: 3000
user
The user to own each extracted file. Not available on Windows.

View file

@ -2,7 +2,7 @@
'''
Azure (ARM) DNS State Module
.. versionadded:: Sodium
.. versionadded:: 3000
:maintainer: <devops@eitr.tech>
:maturity: new
@ -132,7 +132,7 @@ def zone_present(name, resource_group, etag=None, if_match=None, if_none_match=N
registration_virtual_networks=None, resolution_virtual_networks=None,
tags=None, zone_type='Public', connection_auth=None, **kwargs):
'''
.. versionadded:: Sodium
.. versionadded:: 3000
Ensure a DNS zone exists.
@ -299,7 +299,7 @@ def zone_present(name, resource_group, etag=None, if_match=None, if_none_match=N
def zone_absent(name, resource_group, connection_auth=None):
'''
.. versionadded:: Sodium
.. versionadded:: 3000
Ensure a DNS zone does not exist in the resource group.
@ -365,7 +365,7 @@ def record_set_present(name, zone_name, resource_group, record_type, if_match=No
ns_records=None, ptr_records=None, srv_records=None, txt_records=None, cname_record=None,
soa_record=None, caa_records=None, connection_auth=None, **kwargs):
'''
.. versionadded:: Sodium
.. versionadded:: 3000
Ensure a record set exists in a DNS zone.
@ -618,7 +618,7 @@ def record_set_present(name, zone_name, resource_group, record_type, if_match=No
def record_set_absent(name, zone_name, resource_group, connection_auth=None):
'''
.. versionadded:: Sodium
.. versionadded:: 3000
Ensure a record set does not exist in the DNS zone.

View file

@ -31,9 +31,9 @@ Management of the Salt beacons
- 0.1
- 1.0
.. versionadded:: Neon
.. versionadded:: 3000
Beginning in the Neon release, multiple copies of a beacon can be configured
Beginning in the 3000 release, multiple copies of a beacon can be configured
using the ``beacon_module`` parameter.
inotify_infs:

View file

@ -1627,7 +1627,7 @@ def symlink(
will be deleted to make room for the symlink, unless
backupname is set, when it will be renamed
.. versionchanged:: Neon
.. versionchanged:: 3000
Force will now remove all types of existing file system entries,
not just files, directories and symlinks.

View file

@ -36,7 +36,7 @@ mysql:
.. versionadded:: 2017.7.5,2018.3.1
The spelling mistake in parameter `enviroment` was corrected to `environment`.
The `enviroment` spelling mistake has been removed in Salt Neon.
The `enviroment` spelling mistake has been removed in Salt 3000.
'''
# Import Python libs
@ -131,7 +131,7 @@ def deployed(name, template=None, environment=None, params=None, poll=5,
.. versionadded:: 2017.7.5,2018.3.1
The spelling mistake in parameter `enviroment` was corrected to `environment`.
The `enviroment` spelling mistake has been removed in Salt Neon.
The `enviroment` spelling mistake has been removed in Salt 3000.
'''
log.debug(

View file

@ -57,7 +57,7 @@ def query(name, match=None, match_type='string', status=None, status_type='strin
complex pattern matching is required. Additionally, if a list of strings representing
statuses is given, the type ``list`` can be used.
.. versionadded:: Neon
.. versionadded:: 3000
.. note::

View file

@ -15,7 +15,7 @@ Example:
- ack_mode: on-confirm
- max_hops: 1
.. versionadded:: Neon
.. versionadded:: 3000
'''
# Import python libs
@ -110,7 +110,7 @@ def present(name,
:param str queue: The name of the upstream queue. Default is to use the same
name as the federated queue.
.. versionadded:: Neon
.. versionadded:: 3000
'''
ret = {'name': name, 'result': False, 'comment': '', 'changes': {}}
@ -182,7 +182,7 @@ def absent(name, runas=None):
:param str name: The name of the upstream to remove
:param str runas: User to run the command
.. versionadded:: Neon
.. versionadded:: 3000
'''
ret = {'name': name, 'result': False, 'comment': '', 'changes': {}}

View file

@ -7,7 +7,7 @@ This state wraps the saltutil execution modules to make them easier to run
from a states. Rather than needing to to use ``module.run`` this state allows for
improved change detection.
.. versionadded: Neon
.. versionadded: 3000
'''
from __future__ import absolute_import, unicode_literals, print_function

View file

@ -521,7 +521,7 @@ def manage(
fingerprint_hash_type=None,
**kwargs):
'''
.. versionadded:: Neon
.. versionadded:: 3000
Ensures that only the specified ssh_keys are present for the specified user

View file

@ -197,7 +197,7 @@ def configurable_test_state(name, changes=True, result=True, comment='', warning
String to fill the comment field with.
Default is ''
.. versionadded:: Neon
.. versionadded:: 3000
warnings:
A string (or a list of strings) to fill the warnings field with.

View file

@ -343,12 +343,12 @@ def running(name,
The default value is taken from the host capabilities, with a preference for ``hvm``.
Only used when creating a new virtual machine.
.. versionadded:: Neon
.. versionadded:: 3000
:param arch:
architecture of the virtual machine. The default value is taken from the host capabilities,
but ``x86_64`` is prefed over ``i686``. Only used when creating a new virtual machine.
.. versionadded:: Neon
.. versionadded:: 3000
:param boot:
Specifies kernel for the virtual machine, as well as boot parameters
@ -365,7 +365,7 @@ def running(name,
'cmdline': 'console=ttyS0 ks=http://example.com/f8-i386/os/'
}
.. versionadded:: neon
.. versionadded:: 3000
.. rubric:: Example States
@ -677,14 +677,14 @@ def network_running(name,
for more details on this dictionary.
(Default: None).
.. versionadded:: neon
.. versionadded:: 3000
:param ipv6_config:
IPv6 network configuration. See the :py:func`virt.network_define
<salt.modules.virt.network_define>` function corresponding parameter documentation
for more details on this dictionary.
(Default: None).
.. versionadded:: neon
.. versionadded:: 3000
:param autostart: Network autostart (default ``'True'``)
:param connection: libvirt connection URI, overriding defaults
@ -970,7 +970,7 @@ def pool_deleted(name,
uyuni_virt.pool_deleted:
- purge: True
.. versionadded:: Neon
.. versionadded:: 3000
'''
ret = {'name': name, 'changes': {}, 'result': True, 'comment': ''}

View file

@ -25,7 +25,7 @@ def __virtual__():
def value_present(name, xpath, value, **kwargs):
'''
.. versionadded:: Neon
.. versionadded:: 3000
Manages a given XML file

View file

@ -1044,7 +1044,7 @@ def filter_falsey(data, recurse_depth=None, ignore_types=()):
:return type(data)
.. version-added:: Neon
.. version-added:: 3000
'''
filter_element = (
functools.partial(filter_falsey,

View file

@ -105,7 +105,7 @@ class SaltStackVersion(object):
'Nitrogen' : (2017, 7),
'Oxygen' : (2018, 3),
'Fluorine' : (2019, 2),
'Neon' : (MAX_SIZE - 99, 0),
'Neon' : (3000, 0),
'Sodium' : (MAX_SIZE - 98, 0),
'Magnesium' : (MAX_SIZE - 97, 0),
'Aluminium' : (MAX_SIZE - 96, 0),