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

Make all doc fragments, module utils, and plugin utils private.

Browse Source
This commit is contained in:
Felix Fontein 2025-10-06 23:17:26 +02:00
parent bb39e67c8f
commit 76261290bb
106 changed files with 477 additions and 303 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
changelogs/fragments/1144-private.yml Normal file
View File

@ -0,0 +1,3 @@
breaking_changes:
- "All doc fragments, module utils, and plugin utils are from now on private. They can change at any time, and have breaking changes even in bugfix releases
(https://github.com/ansible-collections/community.docker/pull/1144)."

2
plugins/connection/docker.py
View File

@ -125,7 +125,7 @@ from ansible.module_utils.common.process import get_bin_path
from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text
from ansible.plugins.connection import BUFSIZE, ConnectionBase from ansible.plugins.connection import BUFSIZE, ConnectionBase
from ansible.utils.display import Display from ansible.utils.display import Display
from ansible_collections.community.docker.plugins.module_utils.version import ( from ansible_collections.community.docker.plugins.module_utils._version import (
LooseVersion, LooseVersion,
) )

14
plugins/connection/docker_api.py
View File

@ -19,8 +19,8 @@ notes:
- Does B(not work with TCP TLS sockets)! This is caused by the inability to send C(close_notify) without closing the connection - Does B(not work with TCP TLS sockets)! This is caused by the inability to send C(close_notify) without closing the connection
with Python's C(SSLSocket)s. See U(https://github.com/ansible-collections/community.docker/issues/605) for more information. with Python's C(SSLSocket)s. See U(https://github.com/ansible-collections/community.docker/issues/605) for more information.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.docker.var_names - community.docker._docker.var_names
options: options:
remote_user: remote_user:
type: str type: str
@ -117,22 +117,22 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor
DockerException, DockerException,
NotFound, NotFound,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.copy import ( from ansible_collections.community.docker.plugins.module_utils._copy import (
DockerFileCopyError, DockerFileCopyError,
DockerFileNotFound, DockerFileNotFound,
fetch_file, fetch_file,
put_file, put_file,
) )
from ansible_collections.community.docker.plugins.module_utils.version import ( from ansible_collections.community.docker.plugins.module_utils._version import (
LooseVersion, LooseVersion,
) )
from ansible_collections.community.docker.plugins.plugin_utils.common_api import ( from ansible_collections.community.docker.plugins.plugin_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
) )
from ansible_collections.community.docker.plugins.plugin_utils.socket_handler import ( from ansible_collections.community.docker.plugins.plugin_utils._socket_handler import (
DockerSocketHandler, DockerSocketHandler,
) )

3
plugins/doc_fragments/attributes.py → plugins/doc_fragments/_attributes.py
View File

@ -4,6 +4,9 @@
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations

3
plugins/doc_fragments/compose_v2.py → plugins/doc_fragments/_compose_v2.py
View File

@ -4,6 +4,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations

3
plugins/doc_fragments/docker.py → plugins/doc_fragments/_docker.py
View File

@ -4,6 +4,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations

12
plugins/inventory/docker_containers.py
View File

@ -18,7 +18,7 @@ author:
- Felix Fontein (@felixfontein) - Felix Fontein (@felixfontein)
extends_documentation_fragment: extends_documentation_fragment:
- ansible.builtin.constructed - ansible.builtin.constructed
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.library_inventory_filtering_v1.inventory_filter - community.library_inventory_filtering_v1.inventory_filter
description: description:
- Reads inventories from the Docker API. - Reads inventories from the Docker API.
@ -177,16 +177,18 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor
APIError, APIError,
DockerException, DockerException,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DOCKER_COMMON_ARGS_VARS, DOCKER_COMMON_ARGS_VARS,
) )
from ansible_collections.community.docker.plugins.plugin_utils.common_api import ( from ansible_collections.community.docker.plugins.plugin_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
) )
from ansible_collections.community.docker.plugins.plugin_utils.unsafe import make_unsafe from ansible_collections.community.docker.plugins.plugin_utils._unsafe import (
make_unsafe,
)
from ansible_collections.community.library_inventory_filtering_v1.plugins.plugin_utils.inventory_filter import ( from ansible_collections.community.library_inventory_filtering_v1.plugins.plugin_utils.inventory_filter import (
filter_host, filter_host,
parse_filters, parse_filters,

4
plugins/inventory/docker_machine.py
View File

@ -108,7 +108,9 @@ from ansible.module_utils.common.process import get_bin_path
from ansible.module_utils.common.text.converters import to_native, to_text from ansible.module_utils.common.text.converters import to_native, to_text
from ansible.plugins.inventory import BaseInventoryPlugin, Cacheable, Constructable from ansible.plugins.inventory import BaseInventoryPlugin, Cacheable, Constructable
from ansible.utils.display import Display from ansible.utils.display import Display
from ansible_collections.community.docker.plugins.plugin_utils.unsafe import make_unsafe from ansible_collections.community.docker.plugins.plugin_utils._unsafe import (
make_unsafe,
)
from ansible_collections.community.library_inventory_filtering_v1.plugins.plugin_utils.inventory_filter import ( from ansible_collections.community.library_inventory_filtering_v1.plugins.plugin_utils.inventory_filter import (
filter_host, filter_host,
parse_filters, parse_filters,

8
plugins/inventory/docker_swarm.py
View File

@ -152,13 +152,15 @@ keyed_groups:
from ansible.errors import AnsibleError from ansible.errors import AnsibleError
from ansible.parsing.utils.addresses import parse_address from ansible.parsing.utils.addresses import parse_address
from ansible.plugins.inventory import BaseInventoryPlugin, Constructable from ansible.plugins.inventory import BaseInventoryPlugin, Constructable
from ansible_collections.community.docker.plugins.module_utils.common import ( from ansible_collections.community.docker.plugins.module_utils._common import (
get_connect_params, get_connect_params,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
update_tls_hostname, update_tls_hostname,
) )
from ansible_collections.community.docker.plugins.plugin_utils.unsafe import make_unsafe from ansible_collections.community.docker.plugins.plugin_utils._unsafe import (
make_unsafe,
)
from ansible_collections.community.library_inventory_filtering_v1.plugins.plugin_utils.inventory_filter import ( from ansible_collections.community.library_inventory_filtering_v1.plugins.plugin_utils.inventory_filter import (
filter_host, filter_host,
parse_filters, parse_filters,

3
plugins/module_utils/_api/_import_helper.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import traceback import traceback

3
plugins/module_utils/_api/api/client.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import json import json

3
plugins/module_utils/_api/api/daemon.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import os import os

3
plugins/module_utils/_api/auth.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import base64 import base64

3
plugins/module_utils/_api/constants.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import sys import sys

3
plugins/module_utils/_api/context/api.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import json import json

3
plugins/module_utils/_api/context/config.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import hashlib import hashlib

3
plugins/module_utils/_api/context/context.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import json import json

3
plugins/module_utils/_api/credentials/constants.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations

3
plugins/module_utils/_api/credentials/errors.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations

3
plugins/module_utils/_api/credentials/store.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import errno import errno

3
plugins/module_utils/_api/credentials/utils.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import os import os

3
plugins/module_utils/_api/errors.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
from ansible.module_utils.common.text.converters import to_native from ansible.module_utils.common.text.converters import to_native

3
plugins/module_utils/_api/tls.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import os import os

3
plugins/module_utils/_api/transport/basehttpadapter.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
from .._import_helper import HTTPAdapter as _HTTPAdapter from .._import_helper import HTTPAdapter as _HTTPAdapter

3
plugins/module_utils/_api/transport/npipeconn.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
from queue import Empty from queue import Empty

3
plugins/module_utils/_api/transport/npipesocket.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import functools import functools

3
plugins/module_utils/_api/transport/sshconn.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import logging import logging

5
plugins/module_utils/_api/transport/ssladapter.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
@ -15,7 +18,7 @@ from __future__ import annotations
https://github.com/kennethreitz/requests/pull/799 https://github.com/kennethreitz/requests/pull/799
""" """
from ansible_collections.community.docker.plugins.module_utils.version import ( from ansible_collections.community.docker.plugins.module_utils._version import (
LooseVersion, LooseVersion,
) )

3
plugins/module_utils/_api/transport/unixconn.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import socket import socket

3
plugins/module_utils/_api/types/daemon.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import socket import socket

3
plugins/module_utils/_api/utils/build.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import io import io

3
plugins/module_utils/_api/utils/config.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import json import json

3
plugins/module_utils/_api/utils/decorators.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import functools import functools

3
plugins/module_utils/_api/utils/fnmatch.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations

3
plugins/module_utils/_api/utils/json_stream.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import json import json

3
plugins/module_utils/_api/utils/ports.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import re import re

3
plugins/module_utils/_api/utils/proxy.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
from .utils import format_environment from .utils import format_environment

3
plugins/module_utils/_api/utils/socket.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import errno import errno

5
plugins/module_utils/_api/utils/utils.py
View File

@ -7,6 +7,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import base64 import base64
@ -18,7 +21,7 @@ import shlex
import string import string
from urllib.parse import urlparse, urlunparse from urllib.parse import urlparse, urlunparse
from ansible_collections.community.docker.plugins.module_utils.version import ( from ansible_collections.community.docker.plugins.module_utils._version import (
StrictVersion, StrictVersion,
) )

35
plugins/module_utils/common.py → plugins/module_utils/_common.py
View File

@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import abc import abc
@ -14,7 +17,7 @@ from collections.abc import Mapping, Sequence
from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.basic import AnsibleModule, missing_required_lib
from ansible.module_utils.parsing.convert_bool import BOOLEANS_FALSE, BOOLEANS_TRUE from ansible.module_utils.parsing.convert_bool import BOOLEANS_FALSE, BOOLEANS_TRUE
from ansible_collections.community.docker.plugins.module_utils.version import ( from ansible_collections.community.docker.plugins.module_utils._version import (
LooseVersion, LooseVersion,
) )
@ -81,49 +84,49 @@ except ImportError:
# pylint: disable=unused-import # pylint: disable=unused-import
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
BYTE_SUFFIXES, # TODO: remove BYTE_SUFFIXES, # TODO: remove
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DEFAULT_DOCKER_REGISTRY, # TODO: remove DEFAULT_DOCKER_REGISTRY, # TODO: remove
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DEFAULT_TLS_HOSTNAME, # TODO: remove DEFAULT_TLS_HOSTNAME, # TODO: remove
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DOCKER_COMMON_ARGS_VARS, # TODO: remove DOCKER_COMMON_ARGS_VARS, # TODO: remove
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DifferenceTracker, # TODO: remove DifferenceTracker, # TODO: remove
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DockerBaseClass, # TODO: remove DockerBaseClass, # TODO: remove
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
clean_dict_booleans_for_docker_api, # TODO: remove clean_dict_booleans_for_docker_api, # TODO: remove
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
compare_dict_allow_more_present, # TODO: remove compare_dict_allow_more_present, # TODO: remove
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
compare_generic, # TODO: remove compare_generic, # TODO: remove
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
convert_duration_to_nanosecond, # TODO: remove convert_duration_to_nanosecond, # TODO: remove
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
is_image_name_id, # TODO: remove is_image_name_id, # TODO: remove
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
is_valid_tag, # TODO: remove is_valid_tag, # TODO: remove
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
omit_none_from_dict, # TODO: remove omit_none_from_dict, # TODO: remove
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
parse_healthcheck, # TODO: remove parse_healthcheck, # TODO: remove
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( # noqa: F401 from ansible_collections.community.docker.plugins.module_utils._util import ( # noqa: F401
DEFAULT_DOCKER_HOST, DEFAULT_DOCKER_HOST,
DEFAULT_TIMEOUT_SECONDS, DEFAULT_TIMEOUT_SECONDS,
DEFAULT_TLS, DEFAULT_TLS,

15
plugins/module_utils/common_api.py → plugins/module_utils/_common_api.py
View File

@ -3,6 +3,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import abc import abc
@ -12,7 +15,7 @@ from collections.abc import Mapping, Sequence
from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.basic import AnsibleModule, missing_required_lib
from ansible.module_utils.parsing.convert_bool import BOOLEANS_FALSE, BOOLEANS_TRUE from ansible.module_utils.parsing.convert_bool import BOOLEANS_FALSE, BOOLEANS_TRUE
from ansible_collections.community.docker.plugins.module_utils.version import ( from ansible_collections.community.docker.plugins.module_utils._version import (
LooseVersion, LooseVersion,
) )
@ -45,19 +48,19 @@ from ansible_collections.community.docker.plugins.module_utils._api.utils.utils
) )
# pylint: disable=unused-import # pylint: disable=unused-import
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DEFAULT_DOCKER_REGISTRY, # TODO: remove DEFAULT_DOCKER_REGISTRY, # TODO: remove
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DEFAULT_TLS_HOSTNAME, # TODO: remove DEFAULT_TLS_HOSTNAME, # TODO: remove
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
is_image_name_id, # TODO: remove is_image_name_id, # TODO: remove
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
is_valid_tag, # TODO: remove is_valid_tag, # TODO: remove
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( # noqa: F401 from ansible_collections.community.docker.plugins.module_utils._util import ( # noqa: F401
DEFAULT_DOCKER_HOST, DEFAULT_DOCKER_HOST,
DEFAULT_TIMEOUT_SECONDS, DEFAULT_TIMEOUT_SECONDS,
DEFAULT_TLS, DEFAULT_TLS,

7
plugins/module_utils/common_cli.py → plugins/module_utils/_common_cli.py
View File

@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import abc import abc
@ -14,7 +17,7 @@ from ansible.module_utils.common.text.converters import to_native
from ansible_collections.community.docker.plugins.module_utils._api.auth import ( from ansible_collections.community.docker.plugins.module_utils._api.auth import (
resolve_repository_name, resolve_repository_name,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( # noqa: F401, pylint: disable=unused-import from ansible_collections.community.docker.plugins.module_utils._util import ( # noqa: F401, pylint: disable=unused-import
DEFAULT_DOCKER_HOST, DEFAULT_DOCKER_HOST,
DEFAULT_TLS, DEFAULT_TLS,
DEFAULT_TLS_VERIFY, DEFAULT_TLS_VERIFY,
@ -22,7 +25,7 @@ from ansible_collections.community.docker.plugins.module_utils.util import ( #
DOCKER_REQUIRED_TOGETHER, DOCKER_REQUIRED_TOGETHER,
sanitize_result, sanitize_result,
) )
from ansible_collections.community.docker.plugins.module_utils.version import ( from ansible_collections.community.docker.plugins.module_utils._version import (
LooseVersion, LooseVersion,
) )

7
plugins/module_utils/compose_v2.py → plugins/module_utils/_compose_v2.py
View File

@ -3,6 +3,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import json import json
@ -22,10 +25,10 @@ from ansible_collections.community.docker.plugins.module_utils._logfmt import (
from ansible_collections.community.docker.plugins.module_utils._logfmt import ( from ansible_collections.community.docker.plugins.module_utils._logfmt import (
parse_line as _parse_logfmt_line, parse_line as _parse_logfmt_line,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DockerBaseClass, DockerBaseClass,
) )
from ansible_collections.community.docker.plugins.module_utils.version import ( from ansible_collections.community.docker.plugins.module_utils._version import (
LooseVersion, LooseVersion,
) )

3
plugins/module_utils/copy.py → plugins/module_utils/_copy.py
View File

@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import base64 import base64

3
plugins/module_utils/image_archive.py → plugins/module_utils/_image_archive.py
View File

@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import json import json

3
plugins/module_utils/_logfmt.py
View File

@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
""" """
Parse go logfmt messages. Parse go logfmt messages.

5
plugins/module_utils/module_container/base.py → plugins/module_utils/_module_container/base.py
View File

@ -3,6 +3,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import abc import abc
@ -19,7 +22,7 @@ from ansible_collections.community.docker.plugins.module_utils._api.utils.utils
from ansible_collections.community.docker.plugins.module_utils._platform import ( from ansible_collections.community.docker.plugins.module_utils._platform import (
compare_platform_strings, compare_platform_strings,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
clean_dict_booleans_for_docker_api, clean_dict_booleans_for_docker_api,
compare_generic, compare_generic,
normalize_healthcheck, normalize_healthcheck,

19
plugins/module_utils/module_container/docker_api.py → plugins/module_utils/_module_container/docker_api.py
View File

@ -3,6 +3,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import json import json
@ -19,15 +22,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.utils.utils
convert_port_bindings, convert_port_bindings,
normalize_links, normalize_links,
) )
from ansible_collections.community.docker.plugins.module_utils._platform import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
compose_platform_string,
normalize_platform_string,
)
from ansible_collections.community.docker.plugins.module_utils.common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.module_container.base import ( from ansible_collections.community.docker.plugins.module_utils._module_container.base import (
OPTION_AUTO_REMOVE, OPTION_AUTO_REMOVE,
OPTION_BLKIO_WEIGHT, OPTION_BLKIO_WEIGHT,
OPTION_CAP_DROP, OPTION_CAP_DROP,
@ -102,11 +101,15 @@ from ansible_collections.community.docker.plugins.module_utils.module_container.
Engine, Engine,
EngineDriver, EngineDriver,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._platform import (
compose_platform_string,
normalize_platform_string,
)
from ansible_collections.community.docker.plugins.module_utils._util import (
normalize_healthcheck_test, normalize_healthcheck_test,
omit_none_from_dict, omit_none_from_dict,
) )
from ansible_collections.community.docker.plugins.module_utils.version import ( from ansible_collections.community.docker.plugins.module_utils._version import (
LooseVersion, LooseVersion,
) )

5
plugins/module_utils/module_container/module.py → plugins/module_utils/_module_container/module.py
View File

@ -3,6 +3,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import re import re
@ -12,7 +15,7 @@ from ansible.module_utils.common.text.converters import to_text
from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import (
parse_repository_tag, parse_repository_tag,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DifferenceTracker, DifferenceTracker,
DockerBaseClass, DockerBaseClass,
compare_generic, compare_generic,

3
plugins/module_utils/_platform.py
View File

@ -8,6 +8,9 @@
# It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection)
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import re import re

3
plugins/module_utils/_scramble.py
View File

@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import base64 import base64

3
plugins/module_utils/selectors.py → plugins/module_utils/_selectors.py
View File

@ -4,6 +4,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
"""Provide selectors import.""" """Provide selectors import."""
from __future__ import annotations from __future__ import annotations

5
plugins/module_utils/socket_handler.py → plugins/module_utils/_socket_handler.py
View File

@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import os import os
@ -12,7 +15,7 @@ import struct
from ansible_collections.community.docker.plugins.module_utils._api.utils import ( from ansible_collections.community.docker.plugins.module_utils._api.utils import (
socket as docker_socket, socket as docker_socket,
) )
from ansible_collections.community.docker.plugins.module_utils.socket_helper import ( from ansible_collections.community.docker.plugins.module_utils._socket_helper import (
make_unblocking, make_unblocking,
shutdown_writing, shutdown_writing,
write_to_socket, write_to_socket,

3
plugins/module_utils/socket_helper.py → plugins/module_utils/_socket_helper.py
View File

@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import fcntl import fcntl

7
plugins/module_utils/swarm.py → plugins/module_utils/_swarm.py
View File

@ -3,6 +3,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import json import json
@ -15,10 +18,10 @@ except ImportError:
# missing Docker SDK for Python handled in ansible.module_utils.docker.common # missing Docker SDK for Python handled in ansible.module_utils.docker.common
pass pass
from ansible_collections.community.docker.plugins.module_utils.common import ( from ansible_collections.community.docker.plugins.module_utils._common import (
AnsibleDockerClient, AnsibleDockerClient,
) )
from ansible_collections.community.docker.plugins.module_utils.version import ( from ansible_collections.community.docker.plugins.module_utils._version import (
LooseVersion, LooseVersion,
) )

3
plugins/module_utils/util.py → plugins/module_utils/_util.py
View File

@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import json import json

3
plugins/module_utils/version.py → plugins/module_utils/_version.py
View File

@ -4,6 +4,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
"""Provide version object to compare version numbers.""" """Provide version object to compare version numbers."""
from __future__ import annotations from __future__ import annotations

8
plugins/modules/current_container_facts.py
View File

@ -19,10 +19,10 @@ description:
author: author:
- Felix Fontein (@felixfontein) - Felix Fontein (@felixfontein)
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.facts - community.docker._attributes.facts
- community.docker.attributes.facts_module - community.docker._attributes.facts_module
- community.docker.attributes.idempotent_not_modify_state - community.docker._attributes.idempotent_not_modify_state
""" """
EXAMPLES = r""" EXAMPLES = r"""

16
plugins/modules/docker_compose_v2.py
View File

@ -19,11 +19,11 @@ version_added: 3.6.0
description: description:
- Uses Docker Compose to start or shutdown services. - Uses Docker Compose to start or shutdown services.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.compose_v2 - community.docker._compose_v2
- community.docker.compose_v2.minimum_version - community.docker._compose_v2.minimum_version
- community.docker.docker.cli_documentation - community.docker._docker.cli_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -439,16 +439,16 @@ actions:
import traceback import traceback
from ansible.module_utils.common.validation import check_type_int from ansible.module_utils.common.validation import check_type_int
from ansible_collections.community.docker.plugins.module_utils.common_cli import ( from ansible_collections.community.docker.plugins.module_utils._common_cli import (
AnsibleModuleDockerClient, AnsibleModuleDockerClient,
DockerException, DockerException,
) )
from ansible_collections.community.docker.plugins.module_utils.compose_v2 import ( from ansible_collections.community.docker.plugins.module_utils._compose_v2 import (
BaseComposeManager, BaseComposeManager,
common_compose_argspec_ex, common_compose_argspec_ex,
is_failed, is_failed,
) )
from ansible_collections.community.docker.plugins.module_utils.version import ( from ansible_collections.community.docker.plugins.module_utils._version import (
LooseVersion, LooseVersion,
) )

14
plugins/modules/docker_compose_v2_exec.py
View File

@ -18,11 +18,11 @@ description:
- Uses Docker Compose to run a command in a service's container. - Uses Docker Compose to run a command in a service's container.
- This can be used to run one-off commands in an existing service's container, and encapsulates C(docker compose exec). - This can be used to run one-off commands in an existing service's container, and encapsulates C(docker compose exec).
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.compose_v2 - community.docker._compose_v2
- community.docker.compose_v2.minimum_version - community.docker._compose_v2.minimum_version
- community.docker.docker.cli_documentation - community.docker._docker.cli_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -168,11 +168,11 @@ import shlex
import traceback import traceback
from ansible.module_utils.common.text.converters import to_text from ansible.module_utils.common.text.converters import to_text
from ansible_collections.community.docker.plugins.module_utils.common_cli import ( from ansible_collections.community.docker.plugins.module_utils._common_cli import (
AnsibleModuleDockerClient, AnsibleModuleDockerClient,
DockerException, DockerException,
) )
from ansible_collections.community.docker.plugins.module_utils.compose_v2 import ( from ansible_collections.community.docker.plugins.module_utils._compose_v2 import (
BaseComposeManager, BaseComposeManager,
common_compose_argspec_ex, common_compose_argspec_ex,
) )

16
plugins/modules/docker_compose_v2_pull.py
View File

@ -17,11 +17,11 @@ version_added: 3.6.0
description: description:
- Uses Docker Compose to pull images for a project. - Uses Docker Compose to pull images for a project.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.compose_v2 - community.docker._compose_v2
- community.docker.compose_v2.minimum_version - community.docker._compose_v2.minimum_version
- community.docker.docker.cli_documentation - community.docker._docker.cli_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -112,15 +112,15 @@ actions:
import traceback import traceback
from ansible_collections.community.docker.plugins.module_utils.common_cli import ( from ansible_collections.community.docker.plugins.module_utils._common_cli import (
AnsibleModuleDockerClient, AnsibleModuleDockerClient,
DockerException, DockerException,
) )
from ansible_collections.community.docker.plugins.module_utils.compose_v2 import ( from ansible_collections.community.docker.plugins.module_utils._compose_v2 import (
BaseComposeManager, BaseComposeManager,
common_compose_argspec_ex, common_compose_argspec_ex,
) )
from ansible_collections.community.docker.plugins.module_utils.version import ( from ansible_collections.community.docker.plugins.module_utils._version import (
LooseVersion, LooseVersion,
) )

14
plugins/modules/docker_compose_v2_run.py
View File

@ -18,11 +18,11 @@ description:
- Uses Docker Compose to run a command in a new container for a service. - Uses Docker Compose to run a command in a new container for a service.
- This encapsulates C(docker compose run). - This encapsulates C(docker compose run).
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.compose_v2 - community.docker._compose_v2
- community.docker.compose_v2.minimum_version - community.docker._compose_v2.minimum_version
- community.docker.docker.cli_documentation - community.docker._docker.cli_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -241,11 +241,11 @@ import shlex
import traceback import traceback
from ansible.module_utils.common.text.converters import to_text from ansible.module_utils.common.text.converters import to_text
from ansible_collections.community.docker.plugins.module_utils.common_cli import ( from ansible_collections.community.docker.plugins.module_utils._common_cli import (
AnsibleModuleDockerClient, AnsibleModuleDockerClient,
DockerException, DockerException,
) )
from ansible_collections.community.docker.plugins.module_utils.compose_v2 import ( from ansible_collections.community.docker.plugins.module_utils._compose_v2 import (
BaseComposeManager, BaseComposeManager,
common_compose_argspec_ex, common_compose_argspec_ex,
) )

12
plugins/modules/docker_config.py
View File

@ -19,10 +19,10 @@ description:
the O(force) option is set. the O(force) option is set.
- Updates to configs are performed by removing the config and creating it again. - Updates to configs are performed by removing the config and creating it again.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker - community.docker._docker
- community.docker.docker.docker_py_2_documentation - community.docker._docker.docker_py_2_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -207,11 +207,11 @@ except ImportError:
pass pass
from ansible.module_utils.common.text.converters import to_bytes from ansible.module_utils.common.text.converters import to_bytes
from ansible_collections.community.docker.plugins.module_utils.common import ( from ansible_collections.community.docker.plugins.module_utils._common import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DockerBaseClass, DockerBaseClass,
compare_generic, compare_generic,
sanitize_labels, sanitize_labels,

10
plugins/modules/docker_container.py
View File

@ -23,9 +23,9 @@ notes:
(except O(image)). Therefore, always specify B(all) options relevant to the container. (except O(image)). Therefore, always specify B(all) options relevant to the container.
- When O(restart) is set to V(true), the module will only restart the container if no config changes are detected. - When O(restart) is set to V(true), the module will only restart the container if no config changes are detected.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -1331,10 +1331,10 @@ status:
sample: 0 sample: 0
""" """
from ansible_collections.community.docker.plugins.module_utils.module_container.docker_api import ( from ansible_collections.community.docker.plugins.module_utils._module_container.docker_api import (
DockerAPIEngineDriver, DockerAPIEngineDriver,
) )
from ansible_collections.community.docker.plugins.module_utils.module_container.module import ( from ansible_collections.community.docker.plugins.module_utils._module_container.module import (
run_module, run_module,
) )

18
plugins/modules/docker_container_copy_into.py
View File

@ -125,9 +125,9 @@ options:
type: bool type: bool
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
author: author:
- "Felix Fontein (@felixfontein)" - "Felix Fontein (@felixfontein)"
@ -177,15 +177,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor
DockerException, DockerException,
NotFound, NotFound,
) )
from ansible_collections.community.docker.plugins.module_utils._scramble import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
generate_insecure_key,
scramble,
)
from ansible_collections.community.docker.plugins.module_utils.common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.copy import ( from ansible_collections.community.docker.plugins.module_utils._copy import (
DockerFileCopyError, DockerFileCopyError,
DockerFileNotFound, DockerFileNotFound,
DockerUnexpectedError, DockerUnexpectedError,
@ -195,6 +191,10 @@ from ansible_collections.community.docker.plugins.module_utils.copy import (
put_file_content, put_file_content,
stat_file, stat_file,
) )
from ansible_collections.community.docker.plugins.module_utils._scramble import (
generate_insecure_key,
scramble,
)
def are_fileobjs_equal(f1, f2): def are_fileobjs_equal(f1, f2):

10
plugins/modules/docker_container_exec.py
View File

@ -17,9 +17,9 @@ version_added: 1.5.0
description: description:
- Executes a command in a Docker container. - Executes a command in a Docker container.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -176,11 +176,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor
from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import (
format_environment, format_environment,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.socket_handler import ( from ansible_collections.community.docker.plugins.module_utils._socket_handler import (
DockerSocketHandlerModule, DockerSocketHandlerModule,
) )

12
plugins/modules/docker_container_info.py
View File

@ -17,11 +17,11 @@ description:
- Essentially returns the output of C(docker inspect <name>), similar to what M(community.docker.docker_container) returns - Essentially returns the output of C(docker inspect <name>), similar to what M(community.docker.docker_container) returns
for a non-absent container. for a non-absent container.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
- community.docker.attributes.info_module - community.docker._attributes.info_module
- community.docker.attributes.idempotent_not_modify_state - community.docker._attributes.idempotent_not_modify_state
options: options:
name: name:
@ -80,7 +80,7 @@ import traceback
from ansible_collections.community.docker.plugins.module_utils._api.errors import ( from ansible_collections.community.docker.plugins.module_utils._api.errors import (
DockerException, DockerException,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )

6
plugins/modules/docker_context_info.py
View File

@ -19,9 +19,9 @@ description:
- This includes some generic information, as well as a RV(contexts[].config) dictionary that can be used for module defaults for all community.docker modules - This includes some generic information, as well as a RV(contexts[].config) dictionary that can be used for module defaults for all community.docker modules
that use the C(community.docker.docker) module defaults group. that use the C(community.docker.docker) module defaults group.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.info_module - community.docker._attributes.info_module
- community.docker.attributes.idempotent_not_modify_state - community.docker._attributes.idempotent_not_modify_state
options: options:
only_current: only_current:

12
plugins/modules/docker_host_info.py
View File

@ -20,10 +20,10 @@ description:
- The output differs depending on API version of the docker daemon. - The output differs depending on API version of the docker daemon.
- If the docker daemon cannot be contacted or does not meet the API version requirements, the module will fail. - If the docker daemon cannot be contacted or does not meet the API version requirements, the module will fail.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
- community.docker.attributes.idempotent_not_modify_state - community.docker._attributes.idempotent_not_modify_state
attributes: attributes:
check_mode: check_mode:
@ -220,11 +220,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor
from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import (
convert_filters, convert_filters,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DockerBaseClass, DockerBaseClass,
clean_dict_booleans_for_docker_api, clean_dict_booleans_for_docker_api,
) )

14
plugins/modules/docker_image.py
View File

@ -22,9 +22,9 @@ notes:
- Building images is done using Docker daemon's API. It is not possible to use BuildKit / buildx this way. Use M(community.docker.docker_image_build) - Building images is done using Docker daemon's API. It is not possible to use BuildKit / buildx this way. Use M(community.docker.docker_image_build)
to build images with BuildKit. to build images with BuildKit.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -390,22 +390,22 @@ from ansible_collections.community.docker.plugins.module_utils._api.utils.utils
format_extra_hosts, format_extra_hosts,
parse_repository_tag, parse_repository_tag,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.image_archive import ( from ansible_collections.community.docker.plugins.module_utils._image_archive import (
ImageArchiveInvalidException, ImageArchiveInvalidException,
api_image_id, api_image_id,
archived_image_manifest, archived_image_manifest,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DockerBaseClass, DockerBaseClass,
clean_dict_booleans_for_docker_api, clean_dict_booleans_for_docker_api,
is_image_name_id, is_image_name_id,
is_valid_tag, is_valid_tag,
) )
from ansible_collections.community.docker.plugins.module_utils.version import ( from ansible_collections.community.docker.plugins.module_utils._version import (
LooseVersion, LooseVersion,
) )

12
plugins/modules/docker_image_build.py
View File

@ -19,9 +19,9 @@ description:
- Note that the module is B(not idempotent) in the sense of classical Ansible modules. The only idempotence check is whether - Note that the module is B(not idempotent) in the sense of classical Ansible modules. The only idempotence check is whether
the built image already exists. This check can be disabled with the O(rebuild) option. the built image already exists. This check can be disabled with the O(rebuild) option.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.cli_documentation - community.docker._docker.cli_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -288,17 +288,17 @@ from ansible.module_utils.common.text.formatters import human_to_bytes
from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import (
parse_repository_tag, parse_repository_tag,
) )
from ansible_collections.community.docker.plugins.module_utils.common_cli import ( from ansible_collections.community.docker.plugins.module_utils._common_cli import (
AnsibleModuleDockerClient, AnsibleModuleDockerClient,
DockerException, DockerException,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DockerBaseClass, DockerBaseClass,
clean_dict_booleans_for_docker_api, clean_dict_booleans_for_docker_api,
is_image_name_id, is_image_name_id,
is_valid_tag, is_valid_tag,
) )
from ansible_collections.community.docker.plugins.module_utils.version import ( from ansible_collections.community.docker.plugins.module_utils._version import (
LooseVersion, LooseVersion,
) )

12
plugins/modules/docker_image_export.py
View File

@ -18,9 +18,9 @@ description:
- Creates an archive (tarball) from one or more Docker images. - Creates an archive (tarball) from one or more Docker images.
- This can be copied to another machine and loaded with M(community.docker.docker_image_load). - This can be copied to another machine and loaded with M(community.docker.docker_image_load).
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -104,16 +104,16 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor
from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import (
parse_repository_tag, parse_repository_tag,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.image_archive import ( from ansible_collections.community.docker.plugins.module_utils._image_archive import (
ImageArchiveInvalidException, ImageArchiveInvalidException,
api_image_id, api_image_id,
load_archived_image_manifest, load_archived_image_manifest,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DockerBaseClass, DockerBaseClass,
is_image_name_id, is_image_name_id,
is_valid_tag, is_valid_tag,

14
plugins/modules/docker_image_info.py
View File

@ -22,11 +22,11 @@ description:
notes: notes:
- This module was called C(docker_image_facts) before Ansible 2.8. The usage did not change. - This module was called C(docker_image_facts) before Ansible 2.8. The usage did not change.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
- community.docker.attributes.info_module - community.docker._attributes.info_module
- community.docker.attributes.idempotent_not_modify_state - community.docker._attributes.idempotent_not_modify_state
options: options:
name: name:
@ -144,11 +144,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor
from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import (
parse_repository_tag, parse_repository_tag,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DockerBaseClass, DockerBaseClass,
is_image_name_id, is_image_name_id,
) )

10
plugins/modules/docker_image_load.py
View File

@ -18,9 +18,9 @@ version_added: 1.3.0
description: description:
- Load one or multiple Docker images from a C(.tar) archive, and return information on the loaded image(s). - Load one or multiple Docker images from a C(.tar) archive, and return information on the loaded image(s).
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -85,11 +85,11 @@ import traceback
from ansible_collections.community.docker.plugins.module_utils._api.errors import ( from ansible_collections.community.docker.plugins.module_utils._api.errors import (
DockerException, DockerException,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DockerBaseClass, DockerBaseClass,
is_image_name_id, is_image_name_id,
) )

16
plugins/modules/docker_image_pull.py
View File

@ -17,9 +17,9 @@ version_added: 3.6.0
description: description:
- Pulls a Docker image from a registry. - Pulls a Docker image from a registry.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -98,16 +98,16 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor
from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import (
parse_repository_tag, parse_repository_tag,
) )
from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClient,
RequestException,
)
from ansible_collections.community.docker.plugins.module_utils._platform import ( from ansible_collections.community.docker.plugins.module_utils._platform import (
compare_platform_strings, compare_platform_strings,
compose_platform_string, compose_platform_string,
normalize_platform_string, normalize_platform_string,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._util import (
AnsibleDockerClient,
RequestException,
)
from ansible_collections.community.docker.plugins.module_utils.util import (
DockerBaseClass, DockerBaseClass,
is_image_name_id, is_image_name_id,
is_valid_tag, is_valid_tag,

10
plugins/modules/docker_image_push.py
View File

@ -17,9 +17,9 @@ version_added: 3.6.0
description: description:
- Pushes a Docker image to a registry. - Pushes a Docker image to a registry.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -84,11 +84,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor
from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import (
parse_repository_tag, parse_repository_tag,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DockerBaseClass, DockerBaseClass,
is_image_name_id, is_image_name_id,
is_valid_tag, is_valid_tag,

10
plugins/modules/docker_image_remove.py
View File

@ -17,9 +17,9 @@ version_added: 3.6.0
description: description:
- Remove Docker images from the Docker daemon. - Remove Docker images from the Docker daemon.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -106,11 +106,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor
from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import (
parse_repository_tag, parse_repository_tag,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DockerBaseClass, DockerBaseClass,
is_image_name_id, is_image_name_id,
is_valid_tag, is_valid_tag,

10
plugins/modules/docker_image_tag.py
View File

@ -17,9 +17,9 @@ version_added: 3.6.0
description: description:
- This module allows to tag Docker images with new names and/or tags. - This module allows to tag Docker images with new names and/or tags.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -109,11 +109,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor
from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import (
parse_repository_tag, parse_repository_tag,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DockerBaseClass, DockerBaseClass,
is_image_name_id, is_image_name_id,
is_valid_tag, is_valid_tag,

10
plugins/modules/docker_login.py
View File

@ -21,9 +21,9 @@ description:
needing to provide credentials. needing to provide credentials.
- Running in check mode will perform the authentication without updating the config file. - Running in check mode will perform the authentication without updating the config file.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -135,11 +135,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.credentials.
from ansible_collections.community.docker.plugins.module_utils._api.errors import ( from ansible_collections.community.docker.plugins.module_utils._api.errors import (
DockerException, DockerException,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DEFAULT_DOCKER_REGISTRY, DEFAULT_DOCKER_REGISTRY,
DockerBaseClass, DockerBaseClass,
) )

10
plugins/modules/docker_network.py
View File

@ -14,9 +14,9 @@ description:
- Create/remove Docker networks and connect containers to them. - Create/remove Docker networks and connect containers to them.
- Performs largely the same function as the C(docker network) CLI subcommand. - Performs largely the same function as the C(docker network) CLI subcommand.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -289,11 +289,11 @@ from ansible.module_utils.common.text.converters import to_native
from ansible_collections.community.docker.plugins.module_utils._api.errors import ( from ansible_collections.community.docker.plugins.module_utils._api.errors import (
DockerException, DockerException,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DifferenceTracker, DifferenceTracker,
DockerBaseClass, DockerBaseClass,
clean_dict_booleans_for_docker_api, clean_dict_booleans_for_docker_api,

12
plugins/modules/docker_network_info.py
View File

@ -17,11 +17,11 @@ description:
- Essentially returns the output of C(docker network inspect <name>), similar to what M(community.docker.docker_network) - Essentially returns the output of C(docker network inspect <name>), similar to what M(community.docker.docker_network)
returns for a non-absent network. returns for a non-absent network.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
- community.docker.attributes.info_module - community.docker._attributes.info_module
- community.docker.attributes.idempotent_not_modify_state - community.docker._attributes.idempotent_not_modify_state
options: options:
name: name:
@ -101,7 +101,7 @@ import traceback
from ansible_collections.community.docker.plugins.module_utils._api.errors import ( from ansible_collections.community.docker.plugins.module_utils._api.errors import (
DockerException, DockerException,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )

14
plugins/modules/docker_node.py
View File

@ -14,10 +14,10 @@ description:
- Manages the Docker nodes through a Swarm Manager. - Manages the Docker nodes through a Swarm Manager.
- This module allows to change the node's role, its availability, and to modify, add or remove node labels. - This module allows to change the node's role, its availability, and to modify, add or remove node labels.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker - community.docker._docker
- community.docker.docker.docker_py_1_documentation - community.docker._docker.docker_py_1_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -143,14 +143,14 @@ except ImportError:
pass pass
from ansible.module_utils.common.text.converters import to_native from ansible.module_utils.common.text.converters import to_native
from ansible_collections.community.docker.plugins.module_utils.common import ( from ansible_collections.community.docker.plugins.module_utils._common import (
DockerBaseClass, DockerBaseClass,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.swarm import ( from ansible_collections.community.docker.plugins.module_utils._swarm import (
AnsibleDockerSwarmClient, AnsibleDockerSwarmClient,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
sanitize_labels, sanitize_labels,
) )

16
plugins/modules/docker_node_info.py
View File

@ -17,12 +17,12 @@ description:
- Essentially returns the output of C(docker node inspect <name>). - Essentially returns the output of C(docker node inspect <name>).
- Must be executed on a host running as Swarm Manager, otherwise the module will fail. - Must be executed on a host running as Swarm Manager, otherwise the module will fail.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker - community.docker._docker
- community.docker.docker.docker_py_1_documentation - community.docker._docker.docker_py_1_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
- community.docker.attributes.info_module - community.docker._attributes.info_module
- community.docker.attributes.idempotent_not_modify_state - community.docker._attributes.idempotent_not_modify_state
options: options:
name: name:
@ -88,10 +88,10 @@ nodes:
import traceback import traceback
from ansible_collections.community.docker.plugins.module_utils.common import ( from ansible_collections.community.docker.plugins.module_utils._common import (
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.swarm import ( from ansible_collections.community.docker.plugins.module_utils._swarm import (
AnsibleDockerSwarmClient, AnsibleDockerSwarmClient,
) )

10
plugins/modules/docker_plugin.py
View File

@ -19,9 +19,9 @@ description:
notes: notes:
- The C(--grant-all-permissions) CLI flag is true by default in this module. - The C(--grant-all-permissions) CLI flag is true by default in this module.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -137,11 +137,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor
DockerException, DockerException,
NotFound, NotFound,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DifferenceTracker, DifferenceTracker,
DockerBaseClass, DockerBaseClass,
) )

10
plugins/modules/docker_prune.py
View File

@ -16,9 +16,9 @@ description:
- Allows to run C(docker container prune), C(docker image prune), C(docker network prune) and C(docker volume prune) through - Allows to run C(docker container prune), C(docker image prune), C(docker network prune) and C(docker volume prune) through
the Docker API. the Docker API.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -237,11 +237,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor
from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import (
convert_filters, convert_filters,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
clean_dict_booleans_for_docker_api, clean_dict_booleans_for_docker_api,
) )

12
plugins/modules/docker_secret.py
View File

@ -19,10 +19,10 @@ description:
the O(force) option is set. the O(force) option is set.
- Updates to secrets are performed by removing the secret and creating it again. - Updates to secrets are performed by removing the secret and creating it again.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker - community.docker._docker
- community.docker.docker.docker_py_2_documentation - community.docker._docker.docker_py_2_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -199,11 +199,11 @@ except ImportError:
pass pass
from ansible.module_utils.common.text.converters import to_bytes from ansible.module_utils.common.text.converters import to_bytes
from ansible_collections.community.docker.plugins.module_utils.common import ( from ansible_collections.community.docker.plugins.module_utils._common import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DockerBaseClass, DockerBaseClass,
compare_generic, compare_generic,
sanitize_labels, sanitize_labels,

8
plugins/modules/docker_stack.py
View File

@ -15,9 +15,9 @@ short_description: docker stack module
description: description:
- Manage docker stacks using the C(docker stack) command on the target node (see examples). - Manage docker stacks using the C(docker stack) command on the target node (see examples).
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.cli_documentation - community.docker._docker.cli_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
support: none support: none
@ -162,7 +162,7 @@ import traceback
from time import sleep from time import sleep
from ansible.module_utils.common.text.converters import to_native from ansible.module_utils.common.text.converters import to_native
from ansible_collections.community.docker.plugins.module_utils.common_cli import ( from ansible_collections.community.docker.plugins.module_utils._common_cli import (
AnsibleModuleDockerClient, AnsibleModuleDockerClient,
DockerException, DockerException,
) )

12
plugins/modules/docker_stack_info.py
View File

@ -17,11 +17,11 @@ description:
requirements: requirements:
- Docker CLI tool C(docker) - Docker CLI tool C(docker)
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.cli_documentation - community.docker._docker.cli_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
- community.docker.attributes.info_module - community.docker._attributes.info_module
- community.docker.attributes.idempotent_not_modify_state - community.docker._attributes.idempotent_not_modify_state
attributes: attributes:
action_group: action_group:
version_added: 3.6.0 version_added: 3.6.0
@ -79,7 +79,7 @@ import json
import traceback import traceback
from ansible.module_utils.common.text.converters import to_native from ansible.module_utils.common.text.converters import to_native
from ansible_collections.community.docker.plugins.module_utils.common_cli import ( from ansible_collections.community.docker.plugins.module_utils._common_cli import (
AnsibleModuleDockerClient, AnsibleModuleDockerClient,
DockerException, DockerException,
) )

12
plugins/modules/docker_stack_task_info.py
View File

@ -15,11 +15,11 @@ short_description: Return information of the tasks on a docker stack
description: description:
- Retrieve information on docker stacks tasks using the C(docker stack) command on the target node (see examples). - Retrieve information on docker stacks tasks using the C(docker stack) command on the target node (see examples).
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.cli_documentation - community.docker._docker.cli_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
- community.docker.attributes.info_module - community.docker._attributes.info_module
- community.docker.attributes.idempotent_not_modify_state - community.docker._attributes.idempotent_not_modify_state
attributes: attributes:
action_group: action_group:
version_added: 3.6.0 version_added: 3.6.0
@ -87,7 +87,7 @@ import json
import traceback import traceback
from ansible.module_utils.common.text.converters import to_native from ansible.module_utils.common.text.converters import to_native
from ansible_collections.community.docker.plugins.module_utils.common_cli import ( from ansible_collections.community.docker.plugins.module_utils._common_cli import (
AnsibleModuleDockerClient, AnsibleModuleDockerClient,
DockerException, DockerException,
) )

14
plugins/modules/docker_swarm.py
View File

@ -14,10 +14,10 @@ description:
- Create a new Swarm cluster. - Create a new Swarm cluster.
- Add/Remove nodes or managers to an existing cluster. - Add/Remove nodes or managers to an existing cluster.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker - community.docker._docker
- community.docker.docker.docker_py_1_documentation - community.docker._docker.docker_py_1_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -300,14 +300,14 @@ except ImportError:
# missing Docker SDK for Python handled in ansible.module_utils.docker.common # missing Docker SDK for Python handled in ansible.module_utils.docker.common
pass pass
from ansible_collections.community.docker.plugins.module_utils.common import ( from ansible_collections.community.docker.plugins.module_utils._common import (
DockerBaseClass, DockerBaseClass,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.swarm import ( from ansible_collections.community.docker.plugins.module_utils._swarm import (
AnsibleDockerSwarmClient, AnsibleDockerSwarmClient,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DifferenceTracker, DifferenceTracker,
sanitize_labels, sanitize_labels,
) )

18
plugins/modules/docker_swarm_info.py
View File

@ -23,12 +23,12 @@ author:
- Piotr Wojciechowski (@WojciechowskiPiotr) - Piotr Wojciechowski (@WojciechowskiPiotr)
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker - community.docker._docker
- community.docker.docker.docker_py_1_documentation - community.docker._docker.docker_py_1_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
- community.docker.attributes.info_module - community.docker._attributes.info_module
- community.docker.attributes.idempotent_not_modify_state - community.docker._attributes.idempotent_not_modify_state
options: options:
nodes: nodes:
@ -194,13 +194,13 @@ except ImportError:
# missing Docker SDK for Python handled in ansible.module_utils.docker_common # missing Docker SDK for Python handled in ansible.module_utils.docker_common
pass pass
from ansible_collections.community.docker.plugins.module_utils.common import ( from ansible_collections.community.docker.plugins.module_utils._common import (
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.swarm import ( from ansible_collections.community.docker.plugins.module_utils._swarm import (
AnsibleDockerSwarmClient, AnsibleDockerSwarmClient,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DockerBaseClass, DockerBaseClass,
clean_dict_booleans_for_docker_api, clean_dict_booleans_for_docker_api,
) )

14
plugins/modules/docker_swarm_service.py
View File

@ -19,10 +19,10 @@ description:
- Manages docker services through a swarm manager node. - Manages docker services through a swarm manager node.
- This modules does not support updating services in a stack. - This modules does not support updating services in a stack.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker - community.docker._docker
- community.docker.docker.docker_py_2_documentation - community.docker._docker.docker_py_2_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -856,11 +856,11 @@ import traceback
from ansible.module_utils.basic import human_to_bytes from ansible.module_utils.basic import human_to_bytes
from ansible.module_utils.common.text.converters import to_text from ansible.module_utils.common.text.converters import to_text
from ansible_collections.community.docker.plugins.module_utils.common import ( from ansible_collections.community.docker.plugins.module_utils._common import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DifferenceTracker, DifferenceTracker,
DockerBaseClass, DockerBaseClass,
clean_dict_booleans_for_docker_api, clean_dict_booleans_for_docker_api,
@ -868,7 +868,7 @@ from ansible_collections.community.docker.plugins.module_utils.util import (
parse_healthcheck, parse_healthcheck,
sanitize_labels, sanitize_labels,
) )
from ansible_collections.community.docker.plugins.module_utils.version import ( from ansible_collections.community.docker.plugins.module_utils._version import (
LooseVersion, LooseVersion,
) )

16
plugins/modules/docker_swarm_service_info.py
View File

@ -17,12 +17,12 @@ description:
- Essentially returns the output of C(docker service inspect <name>). - Essentially returns the output of C(docker service inspect <name>).
- Must be executed on a host running as Swarm Manager, otherwise the module will fail. - Must be executed on a host running as Swarm Manager, otherwise the module will fail.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker - community.docker._docker
- community.docker.docker.docker_py_1_documentation - community.docker._docker.docker_py_1_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
- community.docker.attributes.info_module - community.docker._attributes.info_module
- community.docker.attributes.idempotent_not_modify_state - community.docker._attributes.idempotent_not_modify_state
options: options:
name: name:
@ -71,10 +71,10 @@ except ImportError:
# missing Docker SDK for Python handled in ansible.module_utils.docker.common # missing Docker SDK for Python handled in ansible.module_utils.docker.common
pass pass
from ansible_collections.community.docker.plugins.module_utils.common import ( from ansible_collections.community.docker.plugins.module_utils._common import (
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.swarm import ( from ansible_collections.community.docker.plugins.module_utils._swarm import (
AnsibleDockerSwarmClient, AnsibleDockerSwarmClient,
) )

10
plugins/modules/docker_volume.py
View File

@ -15,9 +15,9 @@ description:
- Create/remove Docker volumes. - Create/remove Docker volumes.
- Performs largely the same function as the C(docker volume) CLI subcommand. - Performs largely the same function as the C(docker volume) CLI subcommand.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
attributes: attributes:
check_mode: check_mode:
@ -124,11 +124,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor
APIError, APIError,
DockerException, DockerException,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DifferenceTracker, DifferenceTracker,
DockerBaseClass, DockerBaseClass,
sanitize_labels, sanitize_labels,

12
plugins/modules/docker_volume_info.py
View File

@ -14,11 +14,11 @@ short_description: Retrieve facts about Docker volumes
description: description:
- Performs largely the same function as the C(docker volume inspect) CLI subcommand. - Performs largely the same function as the C(docker volume inspect) CLI subcommand.
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.docker.api_documentation - community.docker._docker.api_documentation
- community.docker.attributes - community.docker._attributes
- community.docker.attributes.actiongroup_docker - community.docker._attributes.actiongroup_docker
- community.docker.attributes.info_module - community.docker._attributes.info_module
- community.docker.attributes.idempotent_not_modify_state - community.docker._attributes.idempotent_not_modify_state
options: options:
name: name:
@ -76,7 +76,7 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor
DockerException, DockerException,
NotFound, NotFound,
) )
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClient, AnsibleDockerClient,
RequestException, RequestException,
) )

7
plugins/plugin_utils/common.py → plugins/plugin_utils/_common.py
View File

@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
@ -10,10 +13,10 @@ __metaclass__ = type
from ansible.errors import AnsibleConnectionFailure from ansible.errors import AnsibleConnectionFailure
from ansible.utils.display import Display from ansible.utils.display import Display
from ansible_collections.community.docker.plugins.module_utils.common import ( from ansible_collections.community.docker.plugins.module_utils._common import (
AnsibleDockerClientBase, AnsibleDockerClientBase,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DOCKER_COMMON_ARGS, DOCKER_COMMON_ARGS,
) )

7
plugins/plugin_utils/common_api.py → plugins/plugin_utils/_common_api.py
View File

@ -2,14 +2,17 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
from ansible.errors import AnsibleConnectionFailure from ansible.errors import AnsibleConnectionFailure
from ansible.utils.display import Display from ansible.utils.display import Display
from ansible_collections.community.docker.plugins.module_utils.common_api import ( from ansible_collections.community.docker.plugins.module_utils._common_api import (
AnsibleDockerClientBase, AnsibleDockerClientBase,
) )
from ansible_collections.community.docker.plugins.module_utils.util import ( from ansible_collections.community.docker.plugins.module_utils._util import (
DOCKER_COMMON_ARGS, DOCKER_COMMON_ARGS,
) )

5
plugins/plugin_utils/socket_handler.py → plugins/plugin_utils/_socket_handler.py
View File

@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
@ -10,7 +13,7 @@ __metaclass__ = type
import selectors import selectors
from ansible_collections.community.docker.plugins.module_utils.socket_handler import ( from ansible_collections.community.docker.plugins.module_utils._socket_handler import (
DockerSocketHandlerBase, DockerSocketHandlerBase,
) )

3
plugins/plugin_utils/unsafe.py → plugins/plugin_utils/_unsafe.py
View File

@ -2,6 +2,9 @@
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import annotations from __future__ import annotations
import re import re

2
tests/unit/plugins/module_utils/compose_v2_test_cases.py
View File

@ -7,7 +7,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
from ansible_collections.community.docker.plugins.module_utils.compose_v2 import ( from ansible_collections.community.docker.plugins.module_utils._compose_v2 import (
Event, Event,
) )

Some files were not shown because too many files have changed in this diff Show More