mirror of
https://github.com/ansible-collections/community.docker.git
synced 2025-12-16 11:58:43 +00:00
deploy: 4b7e74b75e
This commit is contained in:
felixfontein
parent
ccf5d23ded
commit
c56f242344
@ -737,6 +737,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<td><div class="ansible-option-cell"><p>Configure a check that is run to determine whether or not containers for this service are “healthy”.</p>
|
||||
<p>See the docs for the <a class="reference external" href="https://docs.docker.com/engine/reference/builder/#healthcheck">HEALTHCHECK Dockerfile instruction</a> for details on how healthchecks work.</p>
|
||||
<p><code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-healthcheck-interval"><span class="std std-ref"><span class="pre">healthcheck.interval</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-healthcheck-timeout"><span class="std std-ref"><span class="pre">healthcheck.timeout</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-healthcheck-start-period"><span class="std std-ref"><span class="pre">healthcheck.start_period</span></span></a></strong></code>, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-healthcheck-start-interval"><span class="std std-ref"><span class="pre">healthcheck.start_interval</span></span></a></strong></code> are specified as durations. They accept duration as a string in a format that look like: <code class="ansible-value docutils literal notranslate"><span class="pre">5h34m56s</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">1m30s</span></code>, and so on. The supported units are <code class="ansible-value docutils literal notranslate"><span class="pre">us</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">ms</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">s</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">m</span></code> and <code class="ansible-value docutils literal notranslate"><span class="pre">h</span></code>.</p>
|
||||
<p>See also <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-state"><span class="std std-ref"><span class="pre">state=healthy</span></span></a></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@ -803,13 +804,24 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-healthy_wait_timeout"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-healthy-wait-timeout"><strong>healthy_wait_timeout</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-healthy_wait_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">float</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.docker 3.11.0</em></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When waiting for the container to become healthy if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-state"><span class="std std-ref"><span class="pre">state=healthy</span></span></a></code>, this option controls how long the module waits until the container state becomes healthy.</p>
|
||||
<p>The timeout is specified in seconds. The default, <code class="ansible-value docutils literal notranslate"><span class="pre">300</span></code>, is 5 minutes.</p>
|
||||
<p>Set this to 0 or a negative value to wait indefinitely. Note that depending on the container this can result in the module not terminating.</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">300.0</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-hostname"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-hostname"><strong>hostname</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-hostname" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The container’s hostname.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-ignore_image"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-ignore-image"><strong>ignore_image</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-ignore_image" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
@ -823,7 +835,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-image"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-image"><strong>image</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-image" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -831,7 +843,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>Can also be an image ID. If this is the case, the image is assumed to be available locally. The <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-pull"><span class="std std-ref"><span class="pre">pull</span></span></a></strong></code> option is ignored for this case.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-image_comparison"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-image-comparison"><strong>image_comparison</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-image_comparison" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.docker 3.0.0</em></p>
|
||||
@ -847,7 +859,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-image_label_mismatch"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-image-label-mismatch"><strong>image_label_mismatch</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-image_label_mismatch" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.docker 2.6.0</em></p>
|
||||
@ -863,7 +875,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-image_name_mismatch"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-image-name-mismatch"><strong>image_name_mismatch</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-image_name_mismatch" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.docker 3.2.0</em></p>
|
||||
@ -880,7 +892,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-init"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-init"><strong>init</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-init" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
@ -893,7 +905,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-interactive"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-interactive"><strong>interactive</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-interactive" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
@ -906,7 +918,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-ipc_mode"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-ipc-mode"><strong>ipc_mode</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-ipc_mode" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -914,7 +926,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>Can be one of <code class="ansible-value docutils literal notranslate"><span class="pre">container:<name|id></span></code> to reuse another container’s IPC namespace or <code class="ansible-value docutils literal notranslate"><span class="pre">host</span></code> to use the host’s IPC namespace within the container.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-keep_volumes"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-keep-volumes"><strong>keep_volumes</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-keep_volumes" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
@ -926,7 +938,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-kernel_memory"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-kernel-memory"><strong>kernel_memory</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-kernel_memory" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -934,21 +946,21 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>Omitting the unit defaults to bytes.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-kill_signal"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-kill-signal"><strong>kill_signal</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-kill_signal" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Override default signal used to kill a running container.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-labels"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-labels"><strong>labels</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-labels" 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 key value pairs.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-links"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-links"><strong>links</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-links" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
@ -956,7 +968,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>Setting this will force container to be restarted.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-log_driver"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-log-driver"><strong>log_driver</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-log_driver" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -964,7 +976,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>See <a class="reference external" href="https://docs.docker.com/config/containers/logging/configure/">the Docker logging configuration documentation</a> for possible choices.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-log_options"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-log_opt"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-log-options"><span id="ansible-collections-community-docker-docker-container-module-parameter-log-opt"></span><strong>log_options</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-log_options" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: log_opt</span></p>
|
||||
@ -975,7 +987,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p><code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-log-driver"><span class="std std-ref"><span class="pre">log_driver</span></span></a></strong></code> needs to be specified for <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-log-options"><span class="std std-ref"><span class="pre">log_options</span></span></a></strong></code> to take effect, even if using the default <code class="ansible-value docutils literal notranslate"><span class="pre">json-file</span></code> driver.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-mac_address"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-mac-address"><strong>mac_address</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-mac_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -984,7 +996,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>Use <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-networks-mac-address"><span class="std std-ref"><span class="pre">networks[].mac_address</span></span></a></strong></code> instead.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-memory"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-memory"><strong>memory</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-memory" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -993,7 +1005,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>If <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-container-default-behavior"><span class="std std-ref"><span class="pre">container_default_behavior=compatibility</span></span></a></code>, this option has a default of <code class="ansible-value docutils literal notranslate"><span class="pre">"0"</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-memory_reservation"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-memory-reservation"><strong>memory_reservation</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-memory_reservation" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -1001,7 +1013,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>Omitting the unit defaults to bytes.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-memory_swap"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-memory-swap"><strong>memory_swap</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-memory_swap" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -1009,7 +1021,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>Omitting the unit defaults to bytes.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-memory_swappiness"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-memory-swappiness"><strong>memory_swappiness</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-memory_swappiness" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
@ -1017,14 +1029,14 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>If not set, the value will be remain the same if container exists and will be inherited from the host machine if it is (re-)created.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-mounts"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-mounts"><strong>mounts</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-mounts" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Specification for mounts to be added to the container. More powerful alternative to <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-volumes"><span class="std std-ref"><span class="pre">volumes</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-mounts/consistency"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-mounts-consistency"><strong>consistency</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-mounts/consistency" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -1038,14 +1050,14 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-mounts/labels"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-mounts-labels"><strong>labels</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-mounts/labels" 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-indent-desc"></div><div class="ansible-option-cell"><p>User-defined name and labels for the volume. Only valid for the <code class="ansible-value docutils literal notranslate"><span class="pre">volume</span></code> type.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-mounts/no_copy"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-mounts-no-copy"><strong>no_copy</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-mounts/no_copy" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
@ -1058,7 +1070,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-mounts/propagation"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-mounts-propagation"><strong>propagation</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-mounts/propagation" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -1074,7 +1086,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-mounts/read_only"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-mounts-read-only"><strong>read_only</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-mounts/read_only" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
@ -1086,7 +1098,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-mounts/source"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-mounts-source"><strong>source</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-mounts/source" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -1095,21 +1107,21 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>If not supplied when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-mounts-type"><span class="std std-ref"><span class="pre">mounts[].type=volume</span></span></a></code> an anonymous volume will be created.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-mounts/target"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-mounts-target"><strong>target</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-mounts/target" 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-indent-desc"></div><div class="ansible-option-cell"><p>Path inside the container.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-mounts/tmpfs_mode"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-mounts-tmpfs-mode"><strong>tmpfs_mode</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-mounts/tmpfs_mode" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The permission mode for the tmpfs mount.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-mounts/tmpfs_size"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-mounts-tmpfs-size"><strong>tmpfs_size</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-mounts/tmpfs_size" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -1118,7 +1130,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>Omitting the unit defaults to bytes.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-mounts/type"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-mounts-type"><strong>type</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-mounts/type" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -1133,7 +1145,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-mounts/volume_driver"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-mounts-volume-driver"><strong>volume_driver</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-mounts/volume_driver" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -1141,14 +1153,14 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>See <a class="reference external" href="https://docs.docker.com/storage/volumes/#use-a-volume-driver">here</a> for details.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-mounts/volume_options"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-mounts-volume-options"><strong>volume_options</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-mounts/volume_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-indent-desc"></div><div class="ansible-option-cell"><p>Dictionary of options specific to the chosen volume_driver. See <a class="reference external" href="https://docs.docker.com/storage/volumes/#use-a-volume-driver">here</a> for details.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-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>
|
||||
@ -1156,7 +1168,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>When identifying an existing container name may be a name or a long or short container ID.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-network_mode"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-network-mode"><strong>network_mode</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-network_mode" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -1164,7 +1176,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>Since community.docker 2.0.0, if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-networks-cli-compatible"><span class="std std-ref"><span class="pre">networks_cli_compatible=true</span></span></a></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-networks"><span class="std std-ref"><span class="pre">networks</span></span></a></strong></code> contains at least one network, the default value for <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-network-mode"><span class="std std-ref"><span class="pre">network_mode</span></span></a></strong></code> is the name of the first network in the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-networks"><span class="std std-ref"><span class="pre">networks</span></span></a></strong></code> list. You can prevent this by explicitly specifying a value for <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-network-mode"><span class="std std-ref"><span class="pre">network_mode</span></span></a></strong></code>, like the default value <code class="ansible-value docutils literal notranslate"><span class="pre">default</span></code> which will be used by Docker if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-network-mode"><span class="std std-ref"><span class="pre">network_mode</span></span></a></strong></code> is not specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-networks"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-networks"><strong>networks</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-networks" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span></p>
|
||||
</div></td>
|
||||
@ -1174,35 +1186,35 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>If <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-networks-cli-compatible"><span class="std std-ref"><span class="pre">networks_cli_compatible=false</span></span></a></code>, this will not remove the default network if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-networks"><span class="std std-ref"><span class="pre">networks</span></span></a></strong></code> is specified. This is different from the behavior of <code class="docutils literal notranslate"><span class="pre">docker</span> <span class="pre">run</span> <span class="pre">...</span></code>. You need to explicitly use <code class="docutils literal notranslate"><span class="pre">networks:</span> <span class="pre">strict</span></code> in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-comparisons"><span class="std std-ref"><span class="pre">comparisons</span></span></a></strong></code> to enforce the removal of the default network (and all other networks not explicitly mentioned in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-networks"><span class="std std-ref"><span class="pre">networks</span></span></a></strong></code>) in that case.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-networks/aliases"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-networks-aliases"><strong>aliases</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-networks/aliases" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>List of aliases for this container in this network. These names can be used in the network to reach this container.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-networks/ipv4_address"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-networks-ipv4-address"><strong>ipv4_address</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-networks/ipv4_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The container’s IPv4 address in this network.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-networks/ipv6_address"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-networks-ipv6-address"><strong>ipv6_address</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-networks/ipv6_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The container’s IPv6 address in this network.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-networks/links"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-networks-links"><strong>links</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-networks/links" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>A list of containers to link to.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-networks/mac_address"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-networks-mac-address"><strong>mac_address</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-networks/mac_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.docker 3.6.0</em></p>
|
||||
@ -1211,14 +1223,14 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>This is only available for Docker API version 1.44 and later.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-networks/name"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-networks-name"><strong>name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-networks/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-indent-desc"></div><div class="ansible-option-cell"><p>The network’s name.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-networks_cli_compatible"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-networks-cli-compatible"><strong>networks_cli_compatible</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-networks_cli_compatible" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
@ -1231,7 +1243,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-oom_killer"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-oom-killer"><strong>oom_killer</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-oom_killer" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
@ -1243,14 +1255,14 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-oom_score_adj"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-oom-score-adj"><strong>oom_score_adj</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-oom_score_adj" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>An integer value containing the score given to the container in order to tune OOM killer preferences.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-output_logs"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-output-logs"><strong>output_logs</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-output_logs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
@ -1263,7 +1275,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-paused"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-paused"><strong>paused</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-paused" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
@ -1276,14 +1288,14 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-pid_mode"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-pid-mode"><strong>pid_mode</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-pid_mode" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set the PID namespace mode for the container.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-pids_limit"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-pids-limit"><strong>pids_limit</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-pids_limit" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
@ -1291,7 +1303,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>Set <code class="ansible-value docutils literal notranslate"><span class="pre">-1</span></code> for unlimited PIDs.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-platform"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-platform"><strong>platform</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-platform" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.docker 3.0.0</em></p>
|
||||
@ -1300,7 +1312,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>Note that since community.docker 3.5.0, the module uses both the image’s metadata and the Docker daemon’s information to normalize platform strings similarly to how Docker itself is doing this. If you notice idempotency problems, <a class="reference external" href="https://github.com/ansible-collections/community.docker/issues/new?assignees=&labels=&projects=&template=bug_report.md">please create an issue in the community.docker GitHub repository</a>. For older community.docker versions, you can use the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-comparisons"><span class="std std-ref"><span class="pre">comparisons</span></span></a></strong></code> option with <code class="docutils literal notranslate"><span class="pre">platform:</span> <span class="pre">ignore</span></code> to prevent accidental recreation of the container due to this.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-privileged"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-privileged"><strong>privileged</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-privileged" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
@ -1313,7 +1325,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-publish_all_ports"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-publish-all-ports"><strong>publish_all_ports</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-publish_all_ports" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.docker 1.8.0</em></p>
|
||||
@ -1327,7 +1339,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-published_ports"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-ports"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-published-ports"><span id="ansible-collections-community-docker-docker-container-module-parameter-ports"></span><strong>published_ports</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-published_ports" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: ports</span></p>
|
||||
@ -1341,7 +1353,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>The value <code class="ansible-value docutils literal notranslate"><span class="pre">all</span></code> was allowed in earlier versions of this module. Support for it was removed in community.docker 3.0.0. Use the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-publish-all-ports"><span class="std std-ref"><span class="pre">publish_all_ports</span></span></a></strong></code> option instead.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-pull"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-pull"><strong>pull</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-pull" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">any</span></p>
|
||||
</div></td>
|
||||
@ -1360,7 +1372,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-pull_check_mode_behavior"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-pull-check-mode-behavior"><strong>pull_check_mode_behavior</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-pull_check_mode_behavior" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.docker 3.8.0</em></p>
|
||||
@ -1376,7 +1388,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-purge_networks"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-purge-networks"><strong>purge_networks</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-purge_networks" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
@ -1390,7 +1402,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-read_only"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-read-only"><strong>read_only</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-read_only" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
@ -1403,7 +1415,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-recreate"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-recreate"><strong>recreate</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-recreate" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
@ -1415,7 +1427,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-removal_wait_timeout"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-removal-wait-timeout"><strong>removal_wait_timeout</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-removal_wait_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">float</span></p>
|
||||
</div></td>
|
||||
@ -1423,7 +1435,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>By setting this option, the module will wait at most this many seconds for the container to be removed. If the container is still in the removal phase after this many seconds, the module will fail.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-restart"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-restart"><strong>restart</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-restart" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
@ -1435,7 +1447,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-restart_policy"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-restart-policy"><strong>restart_policy</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-restart_policy" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -1450,28 +1462,28 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-restart_retries"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-restart-retries"><strong>restart_retries</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-restart_retries" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Use with restart policy to control maximum number of restart attempts.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-runtime"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-runtime"><strong>runtime</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-runtime" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Runtime to use for the container.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-security_opts"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-security-opts"><strong>security_opts</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-security_opts" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>List of security options in the form of <code class="docutils literal notranslate"><span class="pre">"label:user:User"</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-shm_size"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-shm-size"><strong>shm_size</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-shm_size" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -1479,7 +1491,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>Omitting the unit defaults to bytes. If you omit the size entirely, Docker daemon uses <code class="ansible-value docutils literal notranslate"><span class="pre">64M</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-ssl_version"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-ssl-version"><strong>ssl_version</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-ssl_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -1487,13 +1499,14 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>If the value is not specified in the task, the value of environment variable <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_SSL_VERSION"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_SSL_VERSION</span></code></a> will be used instead.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-state"><strong>state</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p><code class="ansible-value docutils literal notranslate"><span class="pre">absent</span></code> - A container matching the specified name will be stopped and removed. Use <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-force-kill"><span class="std std-ref"><span class="pre">force_kill</span></span></a></strong></code> to kill the container rather than stopping it. Use <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-keep-volumes"><span class="std std-ref"><span class="pre">keep_volumes</span></span></a></strong></code> to retain anonymous volumes associated with the removed container.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code> - Asserts the existence of a container matching the name and any provided configuration parameters. If no container matches the name, a container will be created. If a container matches the name but the provided configuration does not match, the container will be updated, if it can be. If it cannot be updated, it will be removed and re-created with the requested config.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">started</span></code> - Asserts that the container is first <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>, and then if the container is not running moves it to a running state. Use <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-restart"><span class="std std-ref"><span class="pre">restart</span></span></a></strong></code> to force a matching container to be stopped and restarted.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">healthy</span></code> - Asserts that the container is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code> and <code class="ansible-value docutils literal notranslate"><span class="pre">started</span></code>, and is actually healthy as well. This means that the conditions defined in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-healthcheck"><span class="std std-ref"><span class="pre">healthcheck</span></span></a></strong></code> respectively in the image’s <code class="docutils literal notranslate"><span class="pre">HEALTHCHECK</span></code> (<a class="reference external" href="https://docs.docker.com/reference/dockerfile/#healthcheck">Docker reference for HEALTHCHECK</a>) are satisfied. The time waited can be controlled with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-healthy-wait-timeout"><span class="std std-ref"><span class="pre">healthy_wait_timeout</span></span></a></strong></code>. This state has been added in community.docker 3.11.0.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">stopped</span></code> - Asserts that the container is first <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>, and then if the container is running moves it to a stopped state.</p>
|
||||
<p>To control what will be taken into account when comparing configuration, see the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-comparisons"><span class="std std-ref"><span class="pre">comparisons</span></span></a></strong></code> option. To avoid that the image version will be taken into account, you can also use the <code class="ansible-value docutils literal notranslate"><span class="pre">image:</span> <span class="pre">ignore</span></code> in the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-comparisons"><span class="std std-ref"><span class="pre">comparisons</span></span></a></strong></code> option.</p>
|
||||
<p>Use the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-container-module-parameter-recreate"><span class="std std-ref"><span class="pre">recreate</span></span></a></strong></code> option to always force re-creation of a matching container, even if it is running.</p>
|
||||
@ -1503,19 +1516,20 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"absent"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"present"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"healthy"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"stopped"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">"started"</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-stop_signal"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-stop-signal"><strong>stop_signal</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-stop_signal" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Override default signal used to stop the container.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-stop_timeout"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-stop-timeout"><strong>stop_timeout</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-stop_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
@ -1523,7 +1537,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>When the container is stopped, will be used as a timeout for stopping the container. In case the container has a custom <code class="docutils literal notranslate"><span class="pre">StopTimeout</span></code> configuration, the behavior depends on the version of the docker daemon. New versions of the docker daemon will always use the container’s configured <code class="docutils literal notranslate"><span class="pre">StopTimeout</span></code> value if it has been configured.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-storage_opts"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-storage-opts"><strong>storage_opts</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-storage_opts" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.docker 1.3.0</em></p>
|
||||
@ -1531,14 +1545,14 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<td><div class="ansible-option-cell"><p>Storage driver options for this container as a key-value mapping.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-sysctls"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-sysctls"><strong>sysctls</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-sysctls" 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 key,value pairs.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-timeout"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-timeout"><strong>timeout</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
@ -1547,7 +1561,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">60</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-tls"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-tls"><strong>tls</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-tls" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
@ -1560,7 +1574,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-tls_hostname"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-tls-hostname"><strong>tls_hostname</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-tls_hostname" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -1569,14 +1583,14 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>Note that this option had a default value <code class="ansible-value docutils literal notranslate"><span class="pre">localhost</span></code> in older versions. It was removed in community.docker 3.0.0.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-tmpfs"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-tmpfs"><strong>tmpfs</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-tmpfs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Mount a tmpfs directory.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-tty"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-tty"><strong>tty</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-tty" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
@ -1589,14 +1603,14 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-ulimits"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-ulimits"><strong>ulimits</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-ulimits" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>List of ulimit options. A ulimit is specified as <code class="ansible-value docutils literal notranslate"><span class="pre">nofile:262144:262144</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-use_ssh_client"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-use-ssh-client"><strong>use_ssh_client</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-use_ssh_client" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.docker 1.5.0</em></p>
|
||||
@ -1609,7 +1623,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-user"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-user"><strong>user</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
@ -1617,21 +1631,21 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>Can be of the forms <code class="docutils literal notranslate"><span class="pre">user</span></code>, <code class="docutils literal notranslate"><span class="pre">user:group</span></code>, <code class="docutils literal notranslate"><span class="pre">uid</span></code>, <code class="docutils literal notranslate"><span class="pre">uid:gid</span></code>, <code class="docutils literal notranslate"><span class="pre">user:gid</span></code> or <code class="docutils literal notranslate"><span class="pre">uid:group</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-userns_mode"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-userns-mode"><strong>userns_mode</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-userns_mode" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set the user namespace mode for the container. Currently, the only valid value are <code class="ansible-value docutils literal notranslate"><span class="pre">host</span></code> and the empty string (<code class="ansible-value docutils literal notranslate"><span class="pre">""</span></code>).</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-uts"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-uts"><strong>uts</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-uts" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Set the UTS namespace mode for the container.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-validate_certs"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-tls_verify"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-validate-certs"><span id="ansible-collections-community-docker-docker-container-module-parameter-tls-verify"></span><strong>validate_certs</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: tls_verify</span></p>
|
||||
@ -1646,14 +1660,14 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-volume_driver"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-volume-driver"><strong>volume_driver</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-volume_driver" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The container volume driver.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-volumes"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-volumes"><strong>volumes</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-volumes" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
@ -1664,14 +1678,14 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p>Note that Ansible 2.7 and earlier only supported one mode, which had to be one of <code class="ansible-value docutils literal notranslate"><span class="pre">ro</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">rw</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">z</span></code>, and <code class="ansible-value docutils literal notranslate"><span class="pre">Z</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-volumes_from"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-volumes-from"><strong>volumes_from</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-volumes_from" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>List of container names or IDs to get volumes from.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-working_dir"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-container-module-parameter-working-dir"><strong>working_dir</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-working_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
|
||||
Binary file not shown.
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue
Block a user