valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-09 01:36:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #49779 from rallytime/deprecations-dockermod

Browse Source 
Remove deprecated options from the dockermod execution module
This commit is contained in:
Nicole Thomas 2018-09-26 16:02:35 -04:00 committed by GitHub
commit 12b7240c49
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 35 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/topics/releases/neon.rst
View File

@ -174,3 +174,31 @@ GCE Driver
The GCE salt cloud driver can now be used with GCE instance credentials by
setting the configuration paramaters ``service_account_private_key`` and
``service_account_private_email`` to an empty string.
Deprecations
============
Module Deprecations
-------------------
- The :py:mod:`dockermod <salt.modules.dockermod>` module has been
changed as follows:
- Support for the ``tags`` kwarg has been removed from the
:py:func:`dockermod.resolve_tag <salt.modules.dockermod.resolve_tag>`
function.
- Support for the ``network_id`` kwarg has been removed from the
:py:func:`dockermod.connect_container_to_network <salt.modules.dockermod.connect_container_to_network>`
function. Please use ``net_id`` instead.
- Support for the ``name`` kwarg has been removed from the
:py:func:`dockermod.sls_build <salt.modules.dockermod.sls_build>`
function. Please use ``repository`` and ``tag`` instead.
- Support for the ``image`` kwarg has been removed from the following
functions. In all cases, please use both the ``repository`` and ``tag``
options instead:
- :py:func:`dockermod.build <salt.modules.dockermod.build>`
- :py:func:`dockermod.commit <salt.modules.dockermod.commit>`
- :py:func:`dockermod.import <salt.modules.dockermod.import_>`
- :py:func:`dockermod.load <salt.modules.dockermod.load>`
- :py:func:`dockermod.tag <salt.modules.dockermod.tag_>`

84
salt/modules/dockermod.py
View File

@ -1915,7 +1915,7 @@ def resolve_image_id(name):
return False
def resolve_tag(name, tags=None, **kwargs):
def resolve_tag(name, **kwargs):
'''
.. versionadded:: 2017.7.2
.. versionchanged:: 2018.3.0
@ -1945,7 +1945,6 @@ def resolve_tag(name, tags=None, **kwargs):
tags
.. deprecated:: 2018.3.0
Ignored if passed, will be removed in the Neon release.
CLI Examples:
@ -1960,13 +1959,6 @@ def resolve_tag(name, tags=None, **kwargs):
if kwargs:
__utils__['args.invalid_kwargs'](kwargs)
if tags is not None:
__utils__['versions.warn_until'](
'Neon',
'The \'tags\' argument to docker.resolve_tag is deprecated. It no '
'longer is used, and will be removed in the Neon release.'
)
try:
inspect_result = inspect_image(name)
tags = inspect_result['RepoTags']
@ -3887,8 +3879,7 @@ def build(path=None,
api_response=False,
fileobj=None,
dockerfile=None,
buildargs=None,
image=None):
buildargs=None):
'''
.. versionchanged:: 2018.3.0
If the built image should be tagged, then the repository and tag must
@ -3976,14 +3967,6 @@ def build(path=None,
'''
_prep_pull()
if image is not None:
__utils__['versions.warn_until'](
'Neon',
'The \'image\' argument to docker.build has been deprecated, '
'please use \'repository\' instead.'
)
respository = image
if repository or tag:
if not repository and tag:
# Have to have both or neither
@ -4068,8 +4051,7 @@ def commit(name,
repository,
tag='latest',
message=None,
author=None,
image=None):
author=None):
'''
.. versionchanged:: 2018.3.0
The repository and tag must now be passed separately using the
@ -4118,14 +4100,6 @@ def commit(name,
salt myminion docker.commit mycontainer myuser/myimage mytag
'''
if image is not None:
__utils__['versions.warn_until'](
'Neon',
'The \'image\' argument to docker.commit has been deprecated, '
'please use \'repository\' instead.'
)
respository = image
if not isinstance(repository, six.string_types):
repository = six.text_type(repository)
if not isinstance(tag, six.string_types):
@ -4151,7 +4125,6 @@ def commit(name,
if image_id is None:
raise CommandExecutionError('No image ID was returned in API response')
ret['Image'] = image
ret['Id'] = image_id
return ret
@ -4216,8 +4189,7 @@ def dangling(prune=False, force=False):
def import_(source,
repository,
tag='latest',
api_response=False,
image=None):
api_response=False):
'''
.. versionchanged:: 2018.3.0
The repository and tag must now be passed separately using the
@ -4269,14 +4241,6 @@ def import_(source,
salt myminion docker.import /tmp/cent7-minimal.tar.xz myuser/centos:7
salt myminion docker.import salt://dockerimages/cent7-minimal.tar.xz myuser/centos:7
'''
if image is not None:
__utils__['versions.warn_until'](
'Neon',
'The \'image\' argument to docker.import has been deprecated, '
'please use \'repository\' instead.'
)
respository = image
if not isinstance(repository, six.string_types):
repository = six.text_type(repository)
if not isinstance(tag, six.string_types):
@ -4325,7 +4289,7 @@ def import_(source,
return ret
def load(path, repository=None, tag=None, image=None):
def load(path, repository=None, tag=None):
'''
.. versionchanged:: 2018.3.0
If the loaded image should be tagged, then the repository and tag must
@ -4387,14 +4351,6 @@ def load(path, repository=None, tag=None, image=None):
salt myminion docker.load /path/to/image.tar
salt myminion docker.load salt://path/to/docker/saved/image.tar repository=myuser/myimage tag=mytag
'''
if image is not None:
__utils__['versions.warn_until'](
'Neon',
'The \'image\' argument to docker.load has been deprecated, '
'please use \'repository\' instead.'
)
respository = image
if (repository or tag) and not (repository and tag):
# Have to have both or neither
raise SaltInvocationError(
@ -4953,7 +4909,7 @@ def save(name,
return ret
def tag_(name, repository, tag='latest', force=False, image=None):
def tag_(name, repository, tag='latest', force=False):
'''
.. versionchanged:: 2018.3.0
The repository and tag must now be passed separately using the
@ -4989,14 +4945,6 @@ def tag_(name, repository, tag='latest', force=False, image=None):
salt myminion docker.tag 0123456789ab myrepo/mycontainer mytag
'''
if image is not None:
__utils__['versions.warn_until'](
'Neon',
'The \'image\' argument to docker.tag has been deprecated, '
'please use \'repository\' instead.'
)
respository = image
if not isinstance(repository, six.string_types):
repository = six.text_type(repository)
if not isinstance(tag, six.string_types):
@ -5392,15 +5340,6 @@ def connect_container_to_network(container, net_id, **kwargs):
salt myminion docker.connect_container_to_network web-1 1f9d2454d0872b68dd9e8744c6e7a4c66b86f10abaccc21e14f7f014f729b2bc
'''
kwargs = __utils__['args.clean_kwargs'](**kwargs)
network_id = kwargs.pop('network_id', None)
if network_id is not None:
__utils__['versions.warn_until'](
'Neon',
'The \'network_id\' argument to docker.build has been deprecated, '
'please use \'net_id\' instead.'
)
net_id = network_id
log.debug(
'Connecting container \'%s\' to network \'%s\' with the following '
'configuration: %s', container, net_id, kwargs
@ -5411,7 +5350,7 @@ def connect_container_to_network(container, net_id, **kwargs):
**kwargs)
log.debug(
'Successfully connected container \'%s\' to network \'%s\'',
container, network_id
container, net_id
)
_clear_context()
return True
@ -6954,15 +6893,6 @@ def sls_build(repository,
salt myminion docker.sls_build imgname base=mybase mods=rails,web
'''
name = kwargs.pop('name', None)
if name is not None:
__utils__['versions.warn_until'](
'Neon',
'The \'name\' argument to docker.sls_build has been deprecated, '
'please use \'repository\' instead.'
)
repository = name
create_kwargs = __utils__['args.clean_kwargs'](**copy.deepcopy(kwargs))
for key in ('image', 'name', 'cmd', 'interactive', 'tty', 'extra_filerefs'):
try: