From 993a0e6df8410a056fe384f055264204480be66f Mon Sep 17 00:00:00 2001 From: felixfontein Date: Tue, 11 Nov 2025 09:09:19 +0000 Subject: [PATCH] deploy: 94d22f758b0a2b5f8f144d0f4669a5d1a04674dc --- branch/main/docker_api_connection.html | 4 ++-- branch/main/docker_compose_v2_exec_module.html | 2 +- branch/main/docker_compose_v2_module.html | 2 +- branch/main/docker_compose_v2_pull_module.html | 2 +- branch/main/docker_compose_v2_run_module.html | 2 +- branch/main/docker_config_module.html | 4 ++-- branch/main/docker_connection.html | 4 ++-- branch/main/docker_container_copy_into_module.html | 8 ++++---- branch/main/docker_container_exec_module.html | 2 +- branch/main/docker_container_info_module.html | 2 +- branch/main/docker_container_module.html | 4 ++-- branch/main/docker_context_info_module.html | 2 +- branch/main/docker_host_info_module.html | 2 +- branch/main/docker_image_build_module.html | 2 +- branch/main/docker_image_export_module.html | 2 +- branch/main/docker_image_info_module.html | 2 +- branch/main/docker_image_load_module.html | 2 +- branch/main/docker_image_module.html | 2 +- branch/main/docker_image_pull_module.html | 2 +- branch/main/docker_image_push_module.html | 2 +- branch/main/docker_image_remove_module.html | 2 +- branch/main/docker_image_tag_module.html | 2 +- branch/main/docker_login_module.html | 2 +- branch/main/docker_network_info_module.html | 2 +- branch/main/docker_network_module.html | 2 +- branch/main/docker_node_info_module.html | 4 ++-- branch/main/docker_node_module.html | 4 ++-- branch/main/docker_plugin_module.html | 2 +- branch/main/docker_prune_module.html | 2 +- branch/main/docker_secret_module.html | 4 ++-- branch/main/docker_stack_info_module.html | 2 +- branch/main/docker_stack_module.html | 2 +- branch/main/docker_stack_task_info_module.html | 2 +- branch/main/docker_swarm_info_module.html | 4 ++-- branch/main/docker_swarm_module.html | 4 ++-- branch/main/docker_swarm_service_info_module.html | 4 ++-- branch/main/docker_swarm_service_module.html | 4 ++-- branch/main/docker_volume_info_module.html | 2 +- branch/main/docker_volume_module.html | 2 +- branch/main/docsite/scenario_guide.html | 8 ++++---- branch/main/environment_variables.html | 2 +- 41 files changed, 58 insertions(+), 58 deletions(-) diff --git a/branch/main/docker_api_connection.html b/branch/main/docker_api_connection.html index 496ab19d..07d6d8cd 100644 --- a/branch/main/docker_api_connection.html +++ b/branch/main/docker_api_connection.html @@ -300,7 +300,7 @@ see added in community.docker 2.2.0

-

  • Environment variable: ANSIBLE_TIMEOUT

    • +

  • Environment variable: ANSIBLE_TIMEOUT

  • Environment variable: ANSIBLE_DOCKER_TIMEOUT

    added in community.docker 2.2.0

    • @@ -403,7 +403,7 @@ see ANSIBLE_REMOTE_USER

    +

  • Environment variable: ANSIBLE_REMOTE_USER

  • CLI argument: --user

  • Keyword: remote_user

  • Variable: ansible_user

    • diff --git a/branch/main/docker_compose_v2_exec_module.html b/branch/main/docker_compose_v2_exec_module.html index 698e25ec..6eff2594 100644 --- a/branch/main/docker_compose_v2_exec_module.html +++ b/branch/main/docker_compose_v2_exec_module.html @@ -629,7 +629,7 @@ will change over time. New releases of the Docker compose CLI plugin can break t

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    diff --git a/branch/main/docker_compose_v2_module.html b/branch/main/docker_compose_v2_module.html index 965acc66..fbd2b146 100644 --- a/branch/main/docker_compose_v2_module.html +++ b/branch/main/docker_compose_v2_module.html @@ -759,7 +759,7 @@ will change over time. New releases of the Docker compose CLI plugin can break t

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key
    diff --git a/branch/main/docker_compose_v2_pull_module.html b/branch/main/docker_compose_v2_pull_module.html index 647e9bfd..b6a9b651 100644 --- a/branch/main/docker_compose_v2_pull_module.html +++ b/branch/main/docker_compose_v2_pull_module.html @@ -532,7 +532,7 @@ will change over time. New releases of the Docker compose CLI plugin can break t

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key
    diff --git a/branch/main/docker_compose_v2_run_module.html b/branch/main/docker_compose_v2_run_module.html index 09a88478..5198d31b 100644 --- a/branch/main/docker_compose_v2_run_module.html +++ b/branch/main/docker_compose_v2_run_module.html @@ -758,7 +758,7 @@ will change over time. New releases of the Docker compose CLI plugin can break t

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key
    diff --git a/branch/main/docker_config_module.html b/branch/main/docker_config_module.html index e9311745..31332fea 100644 --- a/branch/main/docker_config_module.html +++ b/branch/main/docker_config_module.html @@ -514,7 +514,7 @@ see Note

     @@ -594,7 +594,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key
    diff --git a/branch/main/docker_connection.html b/branch/main/docker_connection.html index 1cf29d00..1764c938 100644 --- a/branch/main/docker_connection.html +++ b/branch/main/docker_connection.html @@ -217,7 +217,7 @@ To check whether it is installed, run added in community.docker 2.2.0

    -

  • Environment variable: ANSIBLE_TIMEOUT

    • +

  • Environment variable: ANSIBLE_TIMEOUT

  • Environment variable: ANSIBLE_DOCKER_TIMEOUT

    added in community.docker 2.2.0

    • @@ -312,7 +312,7 @@ To check whether it is installed, run ANSIBLE_REMOTE_USER

    +

  • Environment variable: ANSIBLE_REMOTE_USER

  • CLI argument: --user

  • Keyword: remote_user

  • Variable: ansible_user

    • diff --git a/branch/main/docker_container_copy_into_module.html b/branch/main/docker_container_copy_into_module.html index cde83de4..52e8455f 100644 --- a/branch/main/docker_container_copy_into_module.html +++ b/branch/main/docker_container_copy_into_module.html @@ -204,7 +204,7 @@ see

    Note

    -

    This module has a corresponding action plugin.

    +

    This module has a corresponding action plugin.

    @@ -405,7 +405,7 @@ Parses the value of

  • "modern": Parses the value of mode as an octal string, or takes the integer value if an integer has been provided.

    -

    This is how ansible.builtin.copy treats its mode option.

    +

    This is how ansible.builtin.copy treats its mode option.

  • "octal_string_only": Rejects everything that is not a string that can be parsed as an octal number.

    @@ -524,7 +524,7 @@ Rejects everything that is not a string that can be parsed as an octal number.
    • @@ -575,7 +575,7 @@ Rejects everything that is not a string that can be parsed as an octal number.

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    Support: full

    Additional data will need to be transferred to compute diffs.

    -

    The module uses the MAX_FILE_SIZE_FOR_DIFF ansible-core configuration to determine for how large files diffs should be computed.

    +

    The module uses the MAX_FILE_SIZE_FOR_DIFF ansible-core configuration to determine for how large files diffs should be computed.

    Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

    diff --git a/branch/main/docker_container_exec_module.html b/branch/main/docker_container_exec_module.html index d07c7882..05f7ddd2 100644 --- a/branch/main/docker_container_exec_module.html +++ b/branch/main/docker_container_exec_module.html @@ -550,7 +550,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_container_info_module.html b/branch/main/docker_container_info_module.html index c6580bec..3ea6afc8 100644 --- a/branch/main/docker_container_info_module.html +++ b/branch/main/docker_container_info_module.html @@ -441,7 +441,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_container_module.html b/branch/main/docker_container_module.html index 27ba088f..3f2ab1d6 100644 --- a/branch/main/docker_container_module.html +++ b/branch/main/docker_container_module.html @@ -1440,7 +1440,7 @@ see

    List of ports to publish from the container to the host.

    Use docker CLI syntax: 8000, 9000:8000, or 0.0.0.0:9000:8000, where 8000 is a container port, 9000 is a host port, and 0.0.0.0 is a host interface.

    Port ranges can be used for source and destination ports. If two ranges with different lengths are specified, the shorter range will be used. Since community.general 0.2.0, if the source port range has length 1, the port will not be assigned to the first port of the destination range, but to a free port in that range. This is the same behavior as for docker command line utility.

    -

    Bind addresses must be either IPv4 or IPv6 addresses. Hostnames are not allowed. This is different from the docker command line utility. Use the community.general.dig lookup to resolve hostnames.

    +

    Bind addresses must be either IPv4 or IPv6 addresses. Hostnames are not allowed. This is different from the docker command line utility. Use the community.general.dig lookup to resolve hostnames.

    If networks parameter is provided, will inspect each network to see if there exists a bridge network with optional parameter com.docker.network.bridge.host_binding_ipv4. If such a network is found, then published ports where no host IP address is specified will be bound to the host IP pointed to by com.docker.network.bridge.host_binding_ipv4. Note that the first bridge network with a com.docker.network.bridge.host_binding_ipv4 value encountered in the list of networks is the one that will be used.

    The value all was allowed in earlier versions of this module. Support for it was removed in community.docker 3.0.0. Use the publish_all_ports option instead.

    @@ -2097,7 +2097,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_context_info_module.html b/branch/main/docker_context_info_module.html index 86c3b81d..74fc00e1 100644 --- a/branch/main/docker_context_info_module.html +++ b/branch/main/docker_context_info_module.html @@ -310,7 +310,7 @@ To check whether it is installed, run

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_host_info_module.html b/branch/main/docker_host_info_module.html index 2a6160ec..79dbaf14 100644 --- a/branch/main/docker_host_info_module.html +++ b/branch/main/docker_host_info_module.html @@ -588,7 +588,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_image_build_module.html b/branch/main/docker_image_build_module.html index d0af1307..25251c69 100644 --- a/branch/main/docker_image_build_module.html +++ b/branch/main/docker_image_build_module.html @@ -699,7 +699,7 @@ Provides the secret from a given value

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_image_export_module.html b/branch/main/docker_image_export_module.html index 273b5d25..bb803ca8 100644 --- a/branch/main/docker_image_export_module.html +++ b/branch/main/docker_image_export_module.html @@ -483,7 +483,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_image_info_module.html b/branch/main/docker_image_info_module.html index 4bf30af9..6b8afc74 100644 --- a/branch/main/docker_image_info_module.html +++ b/branch/main/docker_image_info_module.html @@ -445,7 +445,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_image_load_module.html b/branch/main/docker_image_load_module.html index 999a39d6..3edefbf1 100644 --- a/branch/main/docker_image_load_module.html +++ b/branch/main/docker_image_load_module.html @@ -450,7 +450,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_image_module.html b/branch/main/docker_image_module.html index a0b612d4..4d91ac7a 100644 --- a/branch/main/docker_image_module.html +++ b/branch/main/docker_image_module.html @@ -845,7 +845,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_image_pull_module.html b/branch/main/docker_image_pull_module.html index 928d27fa..4b06a327 100644 --- a/branch/main/docker_image_pull_module.html +++ b/branch/main/docker_image_pull_module.html @@ -478,7 +478,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_image_push_module.html b/branch/main/docker_image_push_module.html index 361b17c2..cab1c191 100644 --- a/branch/main/docker_image_push_module.html +++ b/branch/main/docker_image_push_module.html @@ -454,7 +454,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_image_remove_module.html b/branch/main/docker_image_remove_module.html index 937c220c..2bca04a9 100644 --- a/branch/main/docker_image_remove_module.html +++ b/branch/main/docker_image_remove_module.html @@ -477,7 +477,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_image_tag_module.html b/branch/main/docker_image_tag_module.html index 36a802bf..e53ba6e4 100644 --- a/branch/main/docker_image_tag_module.html +++ b/branch/main/docker_image_tag_module.html @@ -476,7 +476,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_login_module.html b/branch/main/docker_login_module.html index b9e6192c..e10f92f8 100644 --- a/branch/main/docker_login_module.html +++ b/branch/main/docker_login_module.html @@ -505,7 +505,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_network_info_module.html b/branch/main/docker_network_info_module.html index 0a5ae2d7..d2487c0a 100644 --- a/branch/main/docker_network_info_module.html +++ b/branch/main/docker_network_info_module.html @@ -441,7 +441,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_network_module.html b/branch/main/docker_network_module.html index 014733a9..0837cc1f 100644 --- a/branch/main/docker_network_module.html +++ b/branch/main/docker_network_module.html @@ -719,7 +719,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_node_info_module.html b/branch/main/docker_node_info_module.html index c9f71267..085df5c2 100644 --- a/branch/main/docker_node_info_module.html +++ b/branch/main/docker_node_info_module.html @@ -434,7 +434,7 @@ see Note

     @@ -468,7 +468,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_node_module.html b/branch/main/docker_node_module.html index f56de8f1..44eea732 100644 --- a/branch/main/docker_node_module.html +++ b/branch/main/docker_node_module.html @@ -471,7 +471,7 @@ see Note

     @@ -519,7 +519,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_plugin_module.html b/branch/main/docker_plugin_module.html index 7aade601..ab2b7c20 100644 --- a/branch/main/docker_plugin_module.html +++ b/branch/main/docker_plugin_module.html @@ -505,7 +505,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_prune_module.html b/branch/main/docker_prune_module.html index 488c3c75..400d0b8a 100644 --- a/branch/main/docker_prune_module.html +++ b/branch/main/docker_prune_module.html @@ -584,7 +584,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_secret_module.html b/branch/main/docker_secret_module.html index 6451dd71..81bd1ee6 100644 --- a/branch/main/docker_secret_module.html +++ b/branch/main/docker_secret_module.html @@ -502,7 +502,7 @@ see Note

     @@ -582,7 +582,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_stack_info_module.html b/branch/main/docker_stack_info_module.html index c352d238..e37f10d9 100644 --- a/branch/main/docker_stack_info_module.html +++ b/branch/main/docker_stack_info_module.html @@ -424,7 +424,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_stack_module.html b/branch/main/docker_stack_module.html index f81f4d75..e0b867a2 100644 --- a/branch/main/docker_stack_module.html +++ b/branch/main/docker_stack_module.html @@ -522,7 +522,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_stack_task_info_module.html b/branch/main/docker_stack_task_info_module.html index 7a4e058f..9cad2d64 100644 --- a/branch/main/docker_stack_task_info_module.html +++ b/branch/main/docker_stack_task_info_module.html @@ -420,7 +420,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_swarm_info_module.html b/branch/main/docker_swarm_info_module.html index 9bddbaaa..44d3e3b2 100644 --- a/branch/main/docker_swarm_info_module.html +++ b/branch/main/docker_swarm_info_module.html @@ -499,7 +499,7 @@ see Note

     @@ -555,7 +555,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_swarm_module.html b/branch/main/docker_swarm_module.html index 86d5ba47..5cfed510 100644 --- a/branch/main/docker_swarm_module.html +++ b/branch/main/docker_swarm_module.html @@ -667,7 +667,7 @@ see Note

     @@ -721,7 +721,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_swarm_service_info_module.html b/branch/main/docker_swarm_service_info_module.html index 0683ceee..e48bf455 100644 --- a/branch/main/docker_swarm_service_info_module.html +++ b/branch/main/docker_swarm_service_info_module.html @@ -416,7 +416,7 @@ see Note

     @@ -434,7 +434,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_swarm_service_module.html b/branch/main/docker_swarm_service_module.html index 7890da70..6b6ceafb 100644 --- a/branch/main/docker_swarm_service_module.html +++ b/branch/main/docker_swarm_service_module.html @@ -1317,7 +1317,7 @@ see

  • Images will only resolve to the latest digest when using Docker API >= 1.30 and Docker SDK for Python >= 3.2.0. When using older versions use force_update=true to trigger the swarm to resolve a new image.

  • Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_TLS, DOCKER_TLS_VERIFY and DOCKER_TIMEOUT. If you are using docker machine, run the script shipped with the product that sets up the environment. It will set these variables for you. See https://docs.docker.com/machine/reference/env/ for more details.

    • -

  • When connecting to Docker daemon with TLS, you might need to install additional Python packages. For the Docker SDK for Python, version 2.4 or newer, this can be done by installing docker[tls] with ansible.builtin.pip.

    • +

  • When connecting to Docker daemon with TLS, you might need to install additional Python packages. For the Docker SDK for Python, version 2.4 or newer, this can be done by installing docker[tls] with ansible.builtin.pip.

  • Note that the Docker SDK for Python only allows to specify the path to the Docker configuration for very few functions. In general, it will use $HOME/.docker/config.json if the DOCKER_CONFIG environment variable is not specified, and use $DOCKER_CONFIG/config.json otherwise.

  • This module uses the Docker SDK for Python to communicate with the Docker daemon.

    • @@ -1482,7 +1482,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_volume_info_module.html b/branch/main/docker_volume_info_module.html index 499513c8..3c565b01 100644 --- a/branch/main/docker_volume_info_module.html +++ b/branch/main/docker_volume_info_module.html @@ -441,7 +441,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docker_volume_module.html b/branch/main/docker_volume_module.html index 5afd494c..0ca2045c 100644 --- a/branch/main/docker_volume_module.html +++ b/branch/main/docker_volume_module.html @@ -494,7 +494,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/docsite/scenario_guide.html b/branch/main/docsite/scenario_guide.html index 91d95cd4..66d805e3 100644 --- a/branch/main/docsite/scenario_guide.html +++ b/branch/main/docsite/scenario_guide.html @@ -193,7 +193,7 @@

    Requirements

    -

    Most of the modules and plugins in community.docker require the Docker SDK for Python. The SDK needs to be installed on the machines where the modules and plugins are executed, and for the Python version(s) with which the modules and plugins are executed. You can use the community.general.python_requirements_info module to make sure that the Docker SDK for Python is installed on the correct machine and for the Python version used by Ansible.

    +

    Most of the modules and plugins in community.docker require the Docker SDK for Python. The SDK needs to be installed on the machines where the modules and plugins are executed, and for the Python version(s) with which the modules and plugins are executed. You can use the community.general.python_requirements_info module to make sure that the Docker SDK for Python is installed on the correct machine and for the Python version used by Ansible.

    Note that plugins (inventory plugins and connection plugins) are always executed in the context of Ansible itself. If you use a plugin that requires the Docker SDK for Python, you need to install it on the machine running ansible or ansible-playbook and for the same Python interpreter used by Ansible. To see which Python is used, run ansible --version.

    You can install the Docker SDK for Python for Python 3.6 or later as follows:

    $ pip install docker
@@ -239,7 +239,7 @@

    Module default group

    -

    To avoid having to specify common parameters for all the modules in every task, you can use the community.docker.docker module defaults group, or its short name docker.

    +

    To avoid having to specify common parameters for all the modules in every task, you can use the community.docker.docker module defaults group, or its short name docker.

    Note

    Module default groups only work for modules, not for plugins (connection and inventory plugins).

    @@ -342,11 +342,11 @@ by Docker SDK for Python.

    For working with a plain Docker daemon, that is without Swarm, there are connection plugins, an inventory plugin, and several modules available:

    -
    docker connection plugin

    The community.docker.docker connection plugin uses the Docker CLI utility to connect to Docker containers and execute modules in them. It essentially wraps docker exec and docker cp. This connection plugin is supported by the ansible.posix.synchronize module.

    +
    docker connection plugin

    The community.docker.docker connection plugin uses the Docker CLI utility to connect to Docker containers and execute modules in them. It essentially wraps docker exec and docker cp. This connection plugin is supported by the ansible.posix.synchronize module.

    docker_api connection plugin

    The community.docker.docker_api connection plugin talks directly to the Docker daemon to connect to Docker containers and execute modules in them.

    -
    docker_containers inventory plugin

    The community.docker.docker_containers inventory plugin allows you to dynamically add Docker containers from a Docker Daemon to your Ansible inventory. See Working with dynamic inventory for details on dynamic inventories.

    +
    docker_containers inventory plugin

    The community.docker.docker_containers inventory plugin allows you to dynamically add Docker containers from a Docker Daemon to your Ansible inventory. See Working with dynamic inventory for details on dynamic inventories.

    The docker inventory script is deprecated. Please use the inventory plugin instead. The inventory plugin has several compatibility options. If you need to collect Docker containers from multiple Docker daemons, you need to add every Docker daemon as an individual inventory source.

    docker_host_info module

    The community.docker.docker_host_info module allows you to retrieve information on a Docker daemon, such as all containers, images, volumes, networks and so on.

    diff --git a/branch/main/environment_variables.html b/branch/main/environment_variables.html index 4da5cf38..0914d0b8 100644 --- a/branch/main/environment_variables.html +++ b/branch/main/environment_variables.html @@ -157,7 +157,7 @@

    Index of all Collection Environment Variables

    The following index documents all environment variables declared by plugins in collections. -Environment variables used by the ansible-core configuration are documented in Ansible Configuration Settings.

    +Environment variables used by the ansible-core configuration are documented in Ansible Configuration Settings.

    ANSIBLE_DOCKER_PRIVILEGED

    Key