deploy: f69536ef3b

pr/1020/docker_compose_v2_exec_module.html

@@ -568,7 +568,8 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
 <li><p>If you need to evaluate environment variables of the container in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-compose-v2-exec-module-parameter-command"><span class="std std-ref"><span class="pre">command</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-compose-v2-exec-module-parameter-argv"><span class="std std-ref"><span class="pre">argv</span></span></a></strong></code>, you need to pass the command through a shell, like <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-docker-docker-compose-v2-exec-module-parameter-command"><span class="std std-ref"><span class="pre">command=/bin/sh</span> <span class="pre">-c</span> <span class="pre">&quot;echo</span> <span class="pre">$ENV_VARIABLE&quot;</span></span></a></code>.</p></li>
 <li><p>The Docker compose CLI plugin has no stable output format (see for example <a class="reference external" href="https://github.com/docker/compose/issues/10872">https://github.com/docker/compose/issues/10872</a>),
 and for the main operations also no machine friendly output format. The module tries to accomodate this with various
-version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin. Currently the module is tested with multiple plugin versions between 2.18.1 and 2.23.3. The exact list of plugin versions
+version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin.
+Currently the module is tested with multiple plugin versions between 2.18.1 and 2.23.3. The exact list of plugin versions
 will change over time. New releases of the Docker compose CLI plugin can break this module at any time.</p></li>
 <li><p>Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_HOST"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_HOST</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_TLS_HOSTNAME"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_TLS_HOSTNAME</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_API_VERSION"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_API_VERSION</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_CERT_PATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_CERT_PATH</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_TLS"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_TLS</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_TLS_VERIFY"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_TLS_VERIFY</span></code></a> and <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_TIMEOUT"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_TIMEOUT</span></code></a>. 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 <a class="reference external" href="https://docs.docker.com/machine/reference/env/">https://docs.docker.com/machine/reference/env/</a> for more details.</p></li>
 <li><p>This module does <strong>not</strong> use the <a class="reference external" href="https://docker-py.readthedocs.io/en/stable/">Docker SDK for Python</a> to communicate with the Docker daemon. It directly calls the Docker CLI program.</p></li>

pr/1020/docker_compose_v2_module.html

@@ -633,7 +633,8 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
 <ul class="simple">
 <li><p>The Docker compose CLI plugin has no stable output format (see for example <a class="reference external" href="https://github.com/docker/compose/issues/10872">https://github.com/docker/compose/issues/10872</a>),
 and for the main operations also no machine friendly output format. The module tries to accomodate this with various
-version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin. Currently the module is tested with multiple plugin versions between 2.18.1 and 2.23.3. The exact list of plugin versions
+version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin.
+Currently the module is tested with multiple plugin versions between 2.18.1 and 2.23.3. The exact list of plugin versions
 will change over time. New releases of the Docker compose CLI plugin can break this module at any time.</p></li>
 <li><p>Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_HOST"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_HOST</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_TLS_HOSTNAME"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_TLS_HOSTNAME</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_API_VERSION"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_API_VERSION</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_CERT_PATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_CERT_PATH</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_TLS"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_TLS</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_TLS_VERIFY"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_TLS_VERIFY</span></code></a> and <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_TIMEOUT"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_TIMEOUT</span></code></a>. 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 <a class="reference external" href="https://docs.docker.com/machine/reference/env/">https://docs.docker.com/machine/reference/env/</a> for more details.</p></li>
 <li><p>This module does <strong>not</strong> use the <a class="reference external" href="https://docker-py.readthedocs.io/en/stable/">Docker SDK for Python</a> to communicate with the Docker daemon. It directly calls the Docker CLI program.</p></li>

pr/1020/docker_compose_v2_pull_module.html

@@ -493,7 +493,8 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
 <ul class="simple">
 <li><p>The Docker compose CLI plugin has no stable output format (see for example <a class="reference external" href="https://github.com/docker/compose/issues/10872">https://github.com/docker/compose/issues/10872</a>),
 and for the main operations also no machine friendly output format. The module tries to accomodate this with various
-version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin. Currently the module is tested with multiple plugin versions between 2.18.1 and 2.23.3. The exact list of plugin versions
+version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin.
+Currently the module is tested with multiple plugin versions between 2.18.1 and 2.23.3. The exact list of plugin versions
 will change over time. New releases of the Docker compose CLI plugin can break this module at any time.</p></li>
 <li><p>Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_HOST"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_HOST</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_TLS_HOSTNAME"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_TLS_HOSTNAME</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_API_VERSION"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_API_VERSION</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_CERT_PATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_CERT_PATH</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_TLS"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_TLS</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_TLS_VERIFY"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_TLS_VERIFY</span></code></a> and <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_TIMEOUT"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_TIMEOUT</span></code></a>. 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 <a class="reference external" href="https://docs.docker.com/machine/reference/env/">https://docs.docker.com/machine/reference/env/</a> for more details.</p></li>
 <li><p>This module does <strong>not</strong> use the <a class="reference external" href="https://docker-py.readthedocs.io/en/stable/">Docker SDK for Python</a> to communicate with the Docker daemon. It directly calls the Docker CLI program.</p></li>

pr/1020/docker_compose_v2_run_module.html

@@ -697,7 +697,8 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
 <li><p>If you need to evaluate environment variables of the container in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-compose-v2-run-module-parameter-command"><span class="std std-ref"><span class="pre">command</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-compose-v2-run-module-parameter-argv"><span class="std std-ref"><span class="pre">argv</span></span></a></strong></code>, you need to pass the command through a shell, like <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-docker-docker-compose-v2-run-module-parameter-command"><span class="std std-ref"><span class="pre">command=/bin/sh</span> <span class="pre">-c</span> <span class="pre">&quot;echo</span> <span class="pre">$ENV_VARIABLE&quot;</span></span></a></code>.</p></li>
 <li><p>The Docker compose CLI plugin has no stable output format (see for example <a class="reference external" href="https://github.com/docker/compose/issues/10872">https://github.com/docker/compose/issues/10872</a>),
 and for the main operations also no machine friendly output format. The module tries to accomodate this with various
-version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin. Currently the module is tested with multiple plugin versions between 2.18.1 and 2.23.3. The exact list of plugin versions
+version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin.
+Currently the module is tested with multiple plugin versions between 2.18.1 and 2.23.3. The exact list of plugin versions
 will change over time. New releases of the Docker compose CLI plugin can break this module at any time.</p></li>
 <li><p>Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_HOST"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_HOST</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_TLS_HOSTNAME"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_TLS_HOSTNAME</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_API_VERSION"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_API_VERSION</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_CERT_PATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_CERT_PATH</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_TLS"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_TLS</span></code></a>, <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_TLS_VERIFY"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_TLS_VERIFY</span></code></a> and <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_TIMEOUT"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_TIMEOUT</span></code></a>. 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 <a class="reference external" href="https://docs.docker.com/machine/reference/env/">https://docs.docker.com/machine/reference/env/</a> for more details.</p></li>
 <li><p>This module does <strong>not</strong> use the <a class="reference external" href="https://docker-py.readthedocs.io/en/stable/">Docker SDK for Python</a> to communicate with the Docker daemon. It directly calls the Docker CLI program.</p></li>

pr/1020/docker_container_module.html

@@ -1961,8 +1961,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
 <span class="w">        </span><span class="nt">count</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">-1</span><span class="w"> </span><span class="c1"># this means we want all</span>
 <span class="w">        </span><span class="nt">capabilities</span><span class="p">:</span>
 <span class="w">        </span><span class="c1"># We have one OR condition: &#39;gpu&#39; AND &#39;utility&#39;</span>
-<span class="w">          </span><span class="p p-Indicator">-</span>
-<span class="w">              </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gpu</span>
+<span class="w">          </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">gpu</span>
 <span class="w">            </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">utility</span>
 <span class="w">        </span><span class="c1"># See https://github.com/NVIDIA/nvidia-container-runtime#supported-driver-capabilities</span>
 <span class="w">        </span><span class="c1"># for a list of capabilities supported by the nvidia driver</span>

pr/1020/docker_image_pull_module.html

@@ -297,7 +297,8 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
 <div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-image-pull-module-parameter-name"><strong>name</strong></p>
 <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
 </div></td>
-<td><div class="ansible-option-cell"><p>Image name. Name format must be one of <code class="ansible-value docutils literal notranslate"><span class="pre">name</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">repository/name</span></code>, or <code class="ansible-value docutils literal notranslate"><span class="pre">registry_server:port/name</span></code>. - The name can optionally include the tag by appending <code class="ansible-value docutils literal notranslate"><span class="pre">:tag_name</span></code>, or it can contain a digest by appending <code class="ansible-value docutils literal notranslate"><span class="pre">&#64;hash:digest</span></code>.</p>
+<td><div class="ansible-option-cell"><p>Image name. Name format must be one of <code class="ansible-value docutils literal notranslate"><span class="pre">name</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">repository/name</span></code>, or <code class="ansible-value docutils literal notranslate"><span class="pre">registry_server:port/name</span></code>.</p>
+<p>The name can optionally include the tag by appending <code class="ansible-value docutils literal notranslate"><span class="pre">:tag_name</span></code>, or it can contain a digest by appending <code class="ansible-value docutils literal notranslate"><span class="pre">&#64;hash:digest</span></code>.</p>
 </div></td>
 </tr>
 <tr class="row-odd"><td><div class="ansible-option-cell">

pr/1020/docker_image_push_module.html

@@ -297,7 +297,8 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
 <div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-image-push-module-parameter-name"><strong>name</strong></p>
 <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
 </div></td>
-<td><div class="ansible-option-cell"><p>Image name. Name format must be one of <code class="ansible-value docutils literal notranslate"><span class="pre">name</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">repository/name</span></code>, or <code class="ansible-value docutils literal notranslate"><span class="pre">registry_server:port/name</span></code>. - The name can optionally include the tag by appending <code class="ansible-value docutils literal notranslate"><span class="pre">:tag_name</span></code>, or it can contain a digest by appending <code class="ansible-value docutils literal notranslate"><span class="pre">&#64;hash:digest</span></code>.</p>
+<td><div class="ansible-option-cell"><p>Image name. Name format must be one of <code class="ansible-value docutils literal notranslate"><span class="pre">name</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">repository/name</span></code>, or <code class="ansible-value docutils literal notranslate"><span class="pre">registry_server:port/name</span></code>.</p>
+<p>The name can optionally include the tag by appending <code class="ansible-value docutils literal notranslate"><span class="pre">:tag_name</span></code>, or it can contain a digest by appending <code class="ansible-value docutils literal notranslate"><span class="pre">&#64;hash:digest</span></code>.</p>
 </div></td>
 </tr>
 <tr class="row-odd"><td><div class="ansible-option-cell">

pr/1020/docker_volume_module.html

@@ -303,7 +303,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
 <div class="ansibleOptionAnchor" id="parameter-driver_options"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-volume-module-parameter-driver-options"><strong>driver_options</strong></p>
 <a class="ansibleOptionLink" href="#parameter-driver_options" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
 </div></td>
-<td><div class="ansible-option-cell"><p>Dictionary of volume settings. Consult docker docs for valid options and values: <a class="reference external" href="https://docs.docker.com/engine/reference/commandline/volume_create/#driver-specific-options">https://docs.docker.com/engine/reference/commandline/volume_create/#driver-specific-options</a>.</p>
+<td><div class="ansible-option-cell"><p>Dictionary of volume settings. Consult the Docker documentation for valid options and values: <a class="reference external" href="https://docs.docker.com/engine/reference/commandline/volume_create/#driver-specific-options">https://docs.docker.com/engine/reference/commandline/volume_create/#driver-specific-options</a>.</p>
 <p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">{}</span></code></p>
 </div></td>
 </tr>