ansible-collections/community.docker
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.docker.git synced 2025-12-16 20:08:41 +00:00
Code Packages Projects Releases Wiki Activity

Rewrite docker_plugin to not use the Docker SDK for Python (#429)

Browse Source 
* Rewrite the docker_plugin module to use the low-level client from Docker SDK for Python.

* Rewrite to no longer use the Docker SDK for Python.

* Remove Docker SDK for Python version from tests.
This commit is contained in:
Felix Fontein 2022-07-14 16:29:37 +02:00 committed by GitHub
parent c00b4ec9be
commit 04121b5882
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 49 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
changelogs/fragments/429-docker_plugin.yml Normal file
View File

@ -0,0 +1,4 @@
major_changes:
- docker_plugin - no longer uses the Docker SDK for Python. It requires ``requests`` to be installed,
and depending on the features used has some more requirements. If the Docker SDK for Python is installed,
these requirements are likely met (https://github.com/ansible-collections/community.docker/pull/429).

84
plugins/modules/docker_plugin.py
View File

@ -61,16 +61,13 @@ options:
default: 0
extends_documentation_fragment:
- community.docker.docker
- community.docker.docker.docker_py_2_documentation
- community.docker.docker.api_documentation
author:
- Sakar Mehra (@sakar97)
- Vladimir Porshkevich (@porshkevich)
requirements:
- "python >= 2.7"
- "L(Docker SDK for Python,https://docker-py.readthedocs.io/en/stable/) >= 2.6.0"
- "Docker API >= 1.25"
'''
@ -121,22 +118,19 @@ import traceback
from ansible.module_utils.common.text.converters import to_native
try:
from docker.errors import APIError, NotFound, DockerException
from docker import DockerClient
except ImportError:
# missing Docker SDK for Python handled in ansible.module_utils.docker_common
pass
from ansible_collections.community.docker.plugins.module_utils.common import (
from ansible_collections.community.docker.plugins.module_utils.common_api import (
AnsibleDockerClient,
RequestException
)
from ansible_collections.community.docker.plugins.module_utils.util import (
DockerBaseClass,
DifferenceTracker,
)
from ansible_collections.community.docker.plugins.module_utils._api import auth
from ansible_collections.community.docker.plugins.module_utils._api.errors import APIError, DockerException, NotFound
class TaskParameters(DockerBaseClass):
def __init__(self, client):
@ -166,9 +160,6 @@ class DockerPluginManager(object):
def __init__(self, client):
self.client = client
self.dclient = DockerClient(**self.client._connect_params)
self.dclient.api = client
self.parameters = TaskParameters(client)
self.preferred_name = self.parameters.alias or self.parameters.plugin_name
self.check_mode = self.client.check_mode
@ -198,17 +189,12 @@ class DockerPluginManager(object):
def get_existing_plugin(self):
try:
plugin = self.dclient.plugins.get(self.preferred_name)
return self.client.get_json('/plugins/{0}/json', self.preferred_name)
except NotFound:
return None
except APIError as e:
self.client.fail(to_native(e))
if plugin is None:
return None
else:
return plugin
def has_different_config(self):
"""
Return the list of differences between the current parameters and the existing plugin.
@ -217,20 +203,19 @@ class DockerPluginManager(object):
"""
differences = DifferenceTracker()
if self.parameters.plugin_options:
if not self.existing_plugin.settings:
differences.add('plugin_options', parameters=self.parameters.plugin_options, active=self.existing_plugin.settings['Env'])
settings = self.existing_plugin.get('Settings')
if not settings:
differences.add('plugin_options', parameters=self.parameters.plugin_options, active=settings)
else:
existing_options_list = self.existing_plugin.settings['Env']
existing_options = parse_options(existing_options_list)
existing_options = parse_options(settings.get('Env'))
for key, value in self.parameters.plugin_options.items():
options_count = 0
if ((not existing_options.get(key) and value) or
not value or
value != existing_options[key]):
differences.add('plugin_options.%s' % key,
parameter=value,
active=self.existing_plugin.settings['Env'][options_count])
active=existing_options.get(key))
return differences
@ -238,11 +223,28 @@ class DockerPluginManager(object):
if not self.existing_plugin:
if not self.check_mode:
try:
self.existing_plugin = self.dclient.plugins.install(
self.parameters.plugin_name, self.parameters.alias
)
# Get privileges
headers = {}
registry, repo_name = auth.resolve_repository_name(self.parameters.plugin_name)
header = auth.get_config_header(self.client, registry)
if header:
headers['X-Registry-Auth'] = header
privileges = self.client.get_json('/plugins/privileges', params={'remote': self.parameters.plugin_name}, headers=headers)
# Pull plugin
params = {
'remote': self.parameters.plugin_name,
}
if self.parameters.alias:
params['name'] = self.parameters.alias
response = self.client._post_json(self.client._url('/plugins/pull'), params=params, headers=headers, data=privileges, stream=True)
self.client._raise_for_status(response)
for data in self.client._stream_helper(response, decode=True):
pass
# Inspect and configure plugin
self.existing_plugin = self.client.get_json('/plugins/{0}/json', self.preferred_name)
if self.parameters.plugin_options:
self.existing_plugin.configure(prepare_options(self.parameters.plugin_options))
data = prepare_options(self.parameters.plugin_options)
self.client.post_json('/plugins/{0}/set', self.preferred_name, data=['{0}={1}'.format(k, v) for k, v in data.items()])
except APIError as e:
self.client.fail(to_native(e))
@ -254,7 +256,7 @@ class DockerPluginManager(object):
if self.existing_plugin:
if not self.check_mode:
try:
self.existing_plugin.remove(force)
self.client.delete_call('/plugins/{0}', self.preferred_name, params={'force': force})
except APIError as e:
self.client.fail(to_native(e))
@ -267,7 +269,8 @@ class DockerPluginManager(object):
if not differences.empty:
if not self.check_mode:
try:
self.existing_plugin.configure(prepare_options(self.parameters.plugin_options))
data = prepare_options(self.parameters.plugin_options)
self.client.post_json('/plugins/{0}/set', self.preferred_name, data=['{0}={1}'.format(k, v) for k, v in data.items()])
except APIError as e:
self.client.fail(to_native(e))
self.actions.append("Updated plugin %s settings" % self.preferred_name)
@ -299,10 +302,10 @@ class DockerPluginManager(object):
def enable(self):
timeout = self.parameters.enable_timeout
if self.existing_plugin:
if not self.existing_plugin.enabled:
if not self.existing_plugin.get('Enabled'):
if not self.check_mode:
try:
self.existing_plugin.enable(timeout)
self.client.post_json('/plugins/{0}/enable', self.preferred_name, params={'timeout': timeout})
except APIError as e:
self.client.fail(to_native(e))
self.actions.append("Enabled plugin %s" % self.preferred_name)
@ -311,7 +314,7 @@ class DockerPluginManager(object):
self.install_plugin()
if not self.check_mode:
try:
self.existing_plugin.enable(timeout)
self.client.post_json('/plugins/{0}/enable', self.preferred_name, params={'timeout': timeout})
except APIError as e:
self.client.fail(to_native(e))
self.actions.append("Enabled plugin %s" % self.preferred_name)
@ -319,10 +322,10 @@ class DockerPluginManager(object):
def disable(self):
if self.existing_plugin:
if self.existing_plugin.enabled:
if self.existing_plugin.get('Enabled'):
if not self.check_mode:
try:
self.existing_plugin.disable()
self.client.post_json('/plugins/{0}/disable', self.preferred_name)
except APIError as e:
self.client.fail(to_native(e))
self.actions.append("Disable plugin %s" % self.preferred_name)
@ -336,7 +339,7 @@ class DockerPluginManager(object):
'actions': self.actions,
'changed': self.changed,
'diff': self.diff,
'plugin': self.client.inspect_plugin(self.preferred_name) if self.parameters.state != 'absent' else {}
'plugin': self.client.get_json('/plugins/{0}/json', self.preferred_name) if self.parameters.state != 'absent' else {}
}
return dict((k, v) for k, v in result.items() if v is not None)
@ -354,7 +357,6 @@ def main():
client = AnsibleDockerClient(
argument_spec=argument_spec,
supports_check_mode=True,
min_docker_version='2.6.0',
)
try:
@ -364,7 +366,7 @@ def main():
client.fail('An unexpected docker error occurred: {0}'.format(to_native(e)), exception=traceback.format_exc())
except RequestException as e:
client.fail(
'An unexpected requests error occurred when Docker SDK for Python tried to talk to the docker daemon: {0}'.format(to_native(e)),
'An unexpected requests error occurred when trying to talk to the Docker daemon: {0}'.format(to_native(e)),
exception=traceback.format_exc())

4
tests/integration/targets/docker_plugin/tasks/main.yaml
View File

@ -18,7 +18,7 @@
state: absent
with_items: "{{ plugin_names }}"
when: docker_py_version is version('1.10.0', '>=') and docker_api_version is version('1.25', '>=')
when: docker_api_version is version('1.25', '>=')
- fail: msg="Too old docker / docker-py version to run docker_plugin tests!"
when: not(docker_py_version is version('1.10.0', '>=') and docker_api_version is version('1.25', '>=')) and (ansible_distribution != 'CentOS' or ansible_distribution_major_version|int > 6)
when: not(docker_api_version is version('1.25', '>=')) and (ansible_distribution != 'CentOS' or ansible_distribution_major_version|int > 6)