This commit is contained in:
felixfontein 2025-01-25 21:27:38 +00:00
parent 1998669710
commit c5b95593c2
4 changed files with 4 additions and 4 deletions

View File

@ -575,7 +575,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<ul class="simple"> <ul class="simple">
<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>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>. The same needs to be done in case you want to use glob patterns or other shell features such as redirects.</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>), <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 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. version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin.

View File

@ -704,7 +704,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<ul class="simple"> <ul class="simple">
<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>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>. The same needs to be done in case you want to use glob patterns or other shell features such as redirects.</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>), <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 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. version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin.

View File

@ -512,7 +512,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<ul class="simple"> <ul class="simple">
<li><p>Does <strong>not work with TCP TLS sockets</strong> when using <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-exec-module-parameter-stdin"><span class="std std-ref"><span class="pre">stdin</span></span></a></strong></code>. This is caused by the inability to send <code class="docutils literal notranslate"><span class="pre">close_notify</span></code> without closing the connection with Pythons <code class="docutils literal notranslate"><span class="pre">SSLSocket</span></code>s. See <a class="reference external" href="https://github.com/ansible-collections/community.docker/issues/605">https://github.com/ansible-collections/community.docker/issues/605</a> for more information.</p></li> <li><p>Does <strong>not work with TCP TLS sockets</strong> when using <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-exec-module-parameter-stdin"><span class="std std-ref"><span class="pre">stdin</span></span></a></strong></code>. This is caused by the inability to send <code class="docutils literal notranslate"><span class="pre">close_notify</span></code> without closing the connection with Pythons <code class="docutils literal notranslate"><span class="pre">SSLSocket</span></code>s. See <a class="reference external" href="https://github.com/ansible-collections/community.docker/issues/605">https://github.com/ansible-collections/community.docker/issues/605</a> for more information.</p></li>
<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-container-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-container-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-container-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>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-container-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-container-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-container-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>. The same needs to be done in case you want to use glob patterns or other shell features such as redirects.</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>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 uses code derived from the Docker SDK or Python that is included in this collection.</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 uses code derived from the Docker SDK or Python that is included in this collection.</p></li>
</ul> </ul>

File diff suppressed because one or more lines are too long