mirror of
https://github.com/ansible-collections/community.docker.git
synced 2026-09-15 12:22:16 +00:00
deploy: 2925334a1a
This commit is contained in:
@@ -85,15 +85,13 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_compose_v2_pull_module.html">community.docker.docker_compose_v2_pull module – Pull a Docker compose project</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_config_module.html">community.docker.docker_config module – Manage docker configs.</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">community.docker.docker_container module – manage Docker containers</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#deprecated">DEPRECATED</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#synopsis">Synopsis</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#parameters">Parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#attributes">Attributes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#notes">Notes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#return-values">Return Values</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#status">Status</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#return-values">Return Values</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#authors">Authors</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#collection-links">Collection links</a></li>
|
||||
</ul>
|
||||
@@ -184,40 +182,24 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</div>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#deprecated" id="id1">DEPRECATED</a></p></li>
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id2">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id3">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id4">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#attributes" id="id5">Attributes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#notes" id="id6">Notes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id7">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id8">Return Values</a></p></li>
|
||||
<li><p><a class="reference internal" href="#status" id="id9">Status</a></p></li>
|
||||
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
||||
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#attributes" id="id4">Attributes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#notes" id="id5">Notes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id6">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id7">Return Values</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="deprecated">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">DEPRECATED</a><a class="headerlink" href="#deprecated" title="Link to this heading"></a></h2>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Removed in<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>version 4.0.0</p>
|
||||
</dd>
|
||||
<dt class="field-even">Why<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>This module uses docker-compose v1, which is End of Life since July 2022.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Alternative<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>Migrate to <a class="reference internal" href="docker_compose_v2_module.html#ansible-collections-community-docker-docker-compose-v2-module"><span class="std std-ref">community.docker.docker_compose_v2</span></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Manage the life cycle of Docker containers.</p></li>
|
||||
<li><p>Supports check mode. Run with <code class="docutils literal notranslate"><span class="pre">--check</span></code> and <code class="docutils literal notranslate"><span class="pre">--diff</span></code> to view config difference and list of actions to be taken.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-community-docker-docker-container-module-requirements"></span><h2><a class="toc-backref" href="#id3" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Link to this heading"></a></h2>
|
||||
<span id="ansible-collections-community-docker-docker-container-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Link to this heading"></a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Docker API >= 1.25</p></li>
|
||||
@@ -229,7 +211,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link to this heading"></a></h2>
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link to this heading"></a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
@@ -1665,7 +1647,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</table>
|
||||
</section>
|
||||
<section id="attributes">
|
||||
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Link to this heading"></a></h2>
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Link to this heading"></a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Attribute</p></th>
|
||||
@@ -1704,7 +1686,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</table>
|
||||
</section>
|
||||
<section id="notes">
|
||||
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Link to this heading"></a></h2>
|
||||
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Link to this heading"></a></h2>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul class="simple">
|
||||
@@ -1717,7 +1699,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</div>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id7" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
|
||||
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
|
||||
<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 a data container</span>
|
||||
<span class="w"> </span><span class="nt">community.docker.docker_container</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">mydata</span>
|
||||
@@ -1983,7 +1965,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</div>
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id8" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2>
|
||||
<h2><a class="toc-backref" href="#id7" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2>
|
||||
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
@@ -2015,14 +1997,6 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="status">
|
||||
<h2><a class="toc-backref" href="#id9" role="doc-backlink">Status</a><a class="headerlink" href="#status" title="Link to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>This module will be removed in version 4.0.0.
|
||||
<em>[deprecated]</em></p></li>
|
||||
<li><p>For more information see <a class="reference internal" href="#deprecated">DEPRECATED</a>.</p></li>
|
||||
</ul>
|
||||
<section id="authors">
|
||||
<h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
|
||||
Reference in New Issue
Block a user