ansible-collections/community.docker
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.docker.git synced 2026-03-15 11:53:31 +00:00
Code Packages Projects Releases Wiki Activity

Only emit tls_hostname deprecation warning if TLS is actually used (#143)

Browse Source 
* Only emit tls_hostname deprecation warning if TLS is actually used.

* Linting.
This commit is contained in:
Felix Fontein 2021-05-17 13:24:50 +02:00 committed by GitHub
parent 3e6017bfb3
commit c20186901b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
changelogs/fragments/143-tls_hostname-deprecation.yml Normal file
View File

@ -0,0 +1,2 @@
bugfixes:
- "docker_* modules and plugins, except ``docker_swarm`` connection plugin and ``docker_compose`` and ``docker_stack*` modules - only emit ``tls_hostname`` deprecation message if TLS is actually used (https://github.com/ansible-collections/community.docker/pull/143)."

12
plugins/module_utils/common.py
View File

@ -172,11 +172,11 @@ class DockerBaseClass(object):
# log_file.write(msg + u'\n') # log_file.write(msg + u'\n')
def update_tls_hostname(result, old_behavior=False, deprecate_function=None): def update_tls_hostname(result, old_behavior=False, deprecate_function=None, uses_tls=True):
if result['tls_hostname'] is None: if result['tls_hostname'] is None:
if old_behavior: if old_behavior:
result['tls_hostname'] = DEFAULT_TLS_HOSTNAME result['tls_hostname'] = DEFAULT_TLS_HOSTNAME
if deprecate_function is not None: if uses_tls and deprecate_function is not None:
deprecate_function( deprecate_function(
'The default value "localhost" for tls_hostname is deprecated and will be removed in community.docker 2.0.0.' 'The default value "localhost" for tls_hostname is deprecated and will be removed in community.docker 2.0.0.'
' From then on, docker_host will be used to compute tls_hostname. If you want to keep using "localhost",' ' From then on, docker_host will be used to compute tls_hostname. If you want to keep using "localhost",'
@ -200,8 +200,12 @@ def _get_tls_config(fail_function, **kwargs):
fail_function("TLS config error: %s" % exc) fail_function("TLS config error: %s" % exc)
def is_using_tls(auth):
return auth['tls_verify'] or auth['tls']
def get_connect_params(auth, fail_function): def get_connect_params(auth, fail_function):
if auth['tls'] or auth['tls_verify']: if is_using_tls(auth):
auth['docker_host'] = auth['docker_host'].replace('tcp://', 'https://') auth['docker_host'] = auth['docker_host'].replace('tcp://', 'https://')
result = dict( result = dict(
@ -391,7 +395,7 @@ class AnsibleDockerClientBase(Client):
def depr(*args, **kwargs): def depr(*args, **kwargs):
self.deprecate(*args, **kwargs) self.deprecate(*args, **kwargs)
update_tls_hostname(result, old_behavior=True, deprecate_function=depr) update_tls_hostname(result, old_behavior=True, deprecate_function=depr, uses_tls=is_using_tls(result))
return result return result