mirror of
https://github.com/ansible-collections/community.docker.git
synced 2025-12-16 11:58:43 +00:00
deploy: f69536ef3b
This commit is contained in:
felixfontein
parent
ccede63cc2
commit
bcdc5b92b5
@ -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">"echo</span> <span class="pre">$ENV_VARIABLE"</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>
|
||||
|
||||
@ -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>
|
||||
|
||||
@ -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>
|
||||
|
||||
@ -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">"echo</span> <span class="pre">$ENV_VARIABLE"</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>
|
||||
|
||||
@ -515,9 +515,9 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create config foo (from a file on the control machine)</span>
|
||||
<span class="w"> </span><span class="nt">community.docker.docker_config</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foo</span>
|
||||
<span class="w"> </span><span class="c1"># If the file is JSON or binary, Ansible might modify it (because</span>
|
||||
<span class="w"> </span><span class="c1"># it is first decoded and later re-encoded). Base64-encoding the</span>
|
||||
<span class="w"> </span><span class="c1"># file directly after reading it prevents this to happen.</span>
|
||||
<span class="w"> </span><span class="c1"># If the file is JSON or binary, Ansible might modify it (because</span>
|
||||
<span class="w"> </span><span class="c1"># it is first decoded and later re-encoded). Base64-encoding the</span>
|
||||
<span class="w"> </span><span class="c1"># file directly after reading it prevents this to happen.</span>
|
||||
<span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'file'</span><span class="o">,</span> <span class="s1">'/path/to/config/file'</span><span class="o">)</span> <span class="o">|</span> <span class="nf">b64encode</span> <span class="cp">}}</span><span class="s">"</span>
|
||||
<span class="w"> </span><span class="nt">data_is_b64</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span>
|
||||
@ -544,7 +544,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<span class="w"> </span><span class="nt">labels</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">bar</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">baz</span>
|
||||
<span class="w"> </span><span class="nt">one</span><span class="p">:</span><span class="w"> </span><span class="s">'1'</span>
|
||||
<span class="w"> </span><span class="c1"># Adding a new label will cause a remove/create of the config</span>
|
||||
<span class="w"> </span><span class="c1"># Adding a new label will cause a remove/create of the config</span>
|
||||
<span class="w"> </span><span class="nt">two</span><span class="p">:</span><span class="w"> </span><span class="s">'2'</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span>
|
||||
|
||||
@ -555,7 +555,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<span class="w"> </span><span class="nt">labels</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">bar</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">baz</span>
|
||||
<span class="w"> </span><span class="nt">one</span><span class="p">:</span><span class="w"> </span><span class="s">'1'</span>
|
||||
<span class="w"> </span><span class="c1"># Even though 'two' is missing, there is no change to the existing config</span>
|
||||
<span class="w"> </span><span class="c1"># Even though 'two' is missing, there is no change to the existing config</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Update an existing label</span>
|
||||
|
||||
@ -1743,16 +1743,16 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<span class="w"> </span><span class="nt">devices</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"/dev/sda:/dev/xvda:rwm"</span>
|
||||
<span class="w"> </span><span class="nt">ports</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="c1"># Publish container port 9000 as host port 8080</span>
|
||||
<span class="w"> </span><span class="c1"># Publish container port 9000 as host port 8080</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"8080:9000"</span>
|
||||
<span class="w"> </span><span class="c1"># Publish container UDP port 9001 as host port 8081 on interface 127.0.0.1</span>
|
||||
<span class="w"> </span><span class="c1"># Publish container UDP port 9001 as host port 8081 on interface 127.0.0.1</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"127.0.0.1:8081:9001/udp"</span>
|
||||
<span class="w"> </span><span class="c1"># Publish container port 9002 as a random host port</span>
|
||||
<span class="w"> </span><span class="c1"># Publish container port 9002 as a random host port</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"9002"</span>
|
||||
<span class="w"> </span><span class="c1"># Publish container port 9003 as a free host port in range 8000-8100</span>
|
||||
<span class="w"> </span><span class="c1"># (the host port will be selected by the Docker daemon)</span>
|
||||
<span class="w"> </span><span class="c1"># Publish container port 9003 as a free host port in range 8000-8100</span>
|
||||
<span class="w"> </span><span class="c1"># (the host port will be selected by the Docker daemon)</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"8000-8100:9003"</span>
|
||||
<span class="w"> </span><span class="c1"># Publish container ports 9010-9020 to host ports 7000-7010</span>
|
||||
<span class="w"> </span><span class="c1"># Publish container ports 9010-9020 to host ports 7000-7010</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"7000-7010:9010-9020"</span>
|
||||
<span class="w"> </span><span class="nt">env</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">SECRET_KEY</span><span class="p">:</span><span class="w"> </span><span class="s">"ssssh"</span>
|
||||
@ -1792,8 +1792,8 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<span class="w"> </span><span class="nt">log_options</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">syslog-address</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tcp://my-syslog-server:514</span>
|
||||
<span class="w"> </span><span class="nt">syslog-facility</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">daemon</span>
|
||||
<span class="w"> </span><span class="c1"># NOTE: in Docker 1.13+ the "syslog-tag" option was renamed to "tag" for</span>
|
||||
<span class="w"> </span><span class="c1"># older docker installs, use "syslog-tag" instead</span>
|
||||
<span class="w"> </span><span class="c1"># NOTE: in Docker 1.13+ the "syslog-tag" option was renamed to "tag" for</span>
|
||||
<span class="w"> </span><span class="c1"># older docker installs, use "syslog-tag" instead</span>
|
||||
<span class="w"> </span><span class="nt">tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">myservice</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create db container and connect to network</span>
|
||||
@ -1903,8 +1903,8 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx:1.13</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">started</span>
|
||||
<span class="w"> </span><span class="nt">healthcheck</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="c1"># Check if nginx server is healthy by curl'ing the server.</span>
|
||||
<span class="w"> </span><span class="c1"># If this fails or timeouts, the healthcheck fails.</span>
|
||||
<span class="w"> </span><span class="c1"># Check if nginx server is healthy by curl'ing the server.</span>
|
||||
<span class="w"> </span><span class="c1"># If this fails or timeouts, the healthcheck fails.</span>
|
||||
<span class="w"> </span><span class="nt">test</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">"CMD"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"curl"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"--fail"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"http://nginx.host.com"</span><span class="p p-Indicator">]</span>
|
||||
<span class="w"> </span><span class="nt">interval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1m30s</span>
|
||||
<span class="w"> </span><span class="nt">timeout</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10s</span>
|
||||
@ -1918,7 +1918,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx:1.13</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">started</span>
|
||||
<span class="w"> </span><span class="nt">healthcheck</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="c1"># The "NONE" check needs to be specified</span>
|
||||
<span class="w"> </span><span class="c1"># The "NONE" check needs to be specified</span>
|
||||
<span class="w"> </span><span class="nt">test</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">"NONE"</span><span class="p p-Indicator">]</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create a tmpfs with a size and mode</span>
|
||||
@ -1938,11 +1938,11 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ubuntu:18.04</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">started</span>
|
||||
<span class="w"> </span><span class="nt">device_read_bps</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="c1"># Limit read rate for /dev/sda to 20 mebibytes per second</span>
|
||||
<span class="w"> </span><span class="c1"># Limit read rate for /dev/sda to 20 mebibytes per second</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/dev/sda</span>
|
||||
<span class="w"> </span><span class="nt">rate</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">20M</span>
|
||||
<span class="w"> </span><span class="nt">device_read_iops</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="c1"># Limit read rate for /dev/sdb to 300 IO per second</span>
|
||||
<span class="w"> </span><span class="c1"># Limit read rate for /dev/sdb to 300 IO per second</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/dev/sdb</span>
|
||||
<span class="w"> </span><span class="nt">rate</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">300</span>
|
||||
|
||||
@ -1961,9 +1961,8 @@ 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: 'gpu' AND 'utility'</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="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>
|
||||
|
||||
@ -1973,8 +1972,8 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ubuntu:18.04</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">started</span>
|
||||
<span class="w"> </span><span class="nt">storage_opts</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="c1"># Limit root filesystem to 12 MB - note that this requires special storage backends</span>
|
||||
<span class="w"> </span><span class="c1"># (https://fabianlee.org/2020/01/15/docker-use-overlay2-with-an-xfs-backing-filesystem-to-limit-rootfs-size/)</span>
|
||||
<span class="w"> </span><span class="c1"># Limit root filesystem to 12 MB - note that this requires special storage backends</span>
|
||||
<span class="w"> </span><span class="c1"># (https://fabianlee.org/2020/01/15/docker-use-overlay2-with-an-xfs-backing-filesystem-to-limit-rootfs-size/)</span>
|
||||
<span class="w"> </span><span class="nt">size</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">12m</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
|
||||
@ -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">@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">@hash:digest</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@ -460,7 +461,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Pull an image</span>
|
||||
<span class="w"> </span><span class="nt">community.docker.docker_image_pull</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pacur/centos-7</span>
|
||||
<span class="w"> </span><span class="c1"># Select platform for pulling. If not specified, will pull whatever docker prefers.</span>
|
||||
<span class="w"> </span><span class="c1"># Select platform for pulling. If not specified, will pull whatever docker prefers.</span>
|
||||
<span class="w"> </span><span class="nt">platform</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">amd64</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
|
||||
@ -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">@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">@hash:digest</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
|
||||
@ -533,23 +533,23 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<span class="w"> </span><span class="nt">community.docker.docker_prune</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">containers</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">containers_filters</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="c1"># only consider containers created more than 24 hours ago</span>
|
||||
<span class="w"> </span><span class="c1"># only consider containers created more than 24 hours ago</span>
|
||||
<span class="w"> </span><span class="nt">until</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">24h</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Prune containers with labels</span>
|
||||
<span class="w"> </span><span class="nt">community.docker.docker_prune</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">containers</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">containers_filters</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="c1"># Prune containers whose "foo" label has value "bar", and</span>
|
||||
<span class="w"> </span><span class="c1"># whose "bam" label has value "baz". If you only want to</span>
|
||||
<span class="w"> </span><span class="c1"># compare one label, you can provide it as a string instead</span>
|
||||
<span class="w"> </span><span class="c1"># of a list with one element.</span>
|
||||
<span class="w"> </span><span class="c1"># Prune containers whose "foo" label has value "bar", and</span>
|
||||
<span class="w"> </span><span class="c1"># whose "bam" label has value "baz". If you only want to</span>
|
||||
<span class="w"> </span><span class="c1"># compare one label, you can provide it as a string instead</span>
|
||||
<span class="w"> </span><span class="c1"># of a list with one element.</span>
|
||||
<span class="w"> </span><span class="nt">label</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foo=bar</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bam=baz</span>
|
||||
<span class="w"> </span><span class="c1"># Prune containers whose label "bar" does *not* have value</span>
|
||||
<span class="w"> </span><span class="c1"># "baz". If you want to avoid more than one label, you can</span>
|
||||
<span class="w"> </span><span class="c1"># provide a list of multiple label-value pairs.</span>
|
||||
<span class="w"> </span><span class="c1"># Prune containers whose label "bar" does *not* have value</span>
|
||||
<span class="w"> </span><span class="c1"># "baz". If you want to avoid more than one label, you can</span>
|
||||
<span class="w"> </span><span class="c1"># provide a list of multiple label-value pairs.</span>
|
||||
<span class="w"> </span><span class="s">"label!"</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bar=baz</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Prune everything</span>
|
||||
|
||||
@ -503,9 +503,9 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Create secret foo (from a file on the control machine)</span>
|
||||
<span class="w"> </span><span class="nt">community.docker.docker_secret</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">foo</span>
|
||||
<span class="w"> </span><span class="c1"># If the file is JSON or binary, Ansible might modify it (because</span>
|
||||
<span class="w"> </span><span class="c1"># it is first decoded and later re-encoded). Base64-encoding the</span>
|
||||
<span class="w"> </span><span class="c1"># file directly after reading it prevents this to happen.</span>
|
||||
<span class="w"> </span><span class="c1"># If the file is JSON or binary, Ansible might modify it (because</span>
|
||||
<span class="w"> </span><span class="c1"># it is first decoded and later re-encoded). Base64-encoding the</span>
|
||||
<span class="w"> </span><span class="c1"># file directly after reading it prevents this to happen.</span>
|
||||
<span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'file'</span><span class="o">,</span> <span class="s1">'/path/to/secret/file'</span><span class="o">)</span> <span class="o">|</span> <span class="nf">b64encode</span> <span class="cp">}}</span><span class="s">"</span>
|
||||
<span class="w"> </span><span class="nt">data_is_b64</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span>
|
||||
@ -532,7 +532,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<span class="w"> </span><span class="nt">labels</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">bar</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">baz</span>
|
||||
<span class="w"> </span><span class="nt">one</span><span class="p">:</span><span class="w"> </span><span class="s">'1'</span>
|
||||
<span class="w"> </span><span class="c1"># Adding a new label will cause a remove/create of the secret</span>
|
||||
<span class="w"> </span><span class="c1"># Adding a new label will cause a remove/create of the secret</span>
|
||||
<span class="w"> </span><span class="nt">two</span><span class="p">:</span><span class="w"> </span><span class="s">'2'</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span>
|
||||
|
||||
@ -543,7 +543,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<span class="w"> </span><span class="nt">labels</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">bar</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">baz</span>
|
||||
<span class="w"> </span><span class="nt">one</span><span class="p">:</span><span class="w"> </span><span class="s">'1'</span>
|
||||
<span class="w"> </span><span class="c1"># Even though 'two' is missing, there is no change to the existing secret</span>
|
||||
<span class="w"> </span><span class="c1"># Even though 'two' is missing, there is no change to the existing secret</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Update an existing label</span>
|
||||
|
||||
@ -1442,8 +1442,8 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">myservice</span>
|
||||
<span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nginx:1.13</span>
|
||||
<span class="w"> </span><span class="nt">healthcheck</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="c1"># Check if nginx server is healthy by curl'ing the server.</span>
|
||||
<span class="w"> </span><span class="c1"># If this fails or timeouts, the healthcheck fails.</span>
|
||||
<span class="w"> </span><span class="c1"># Check if nginx server is healthy by curl'ing the server.</span>
|
||||
<span class="w"> </span><span class="c1"># If this fails or timeouts, the healthcheck fails.</span>
|
||||
<span class="w"> </span><span class="nt">test</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">"CMD"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"curl"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"--fail"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"http://nginx.host.com"</span><span class="p p-Indicator">]</span>
|
||||
<span class="w"> </span><span class="nt">interval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1m30s</span>
|
||||
<span class="w"> </span><span class="nt">timeout</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10s</span>
|
||||
|
||||
@ -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>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user