ansible-collections/community.docker
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.docker.git synced 2026-09-13 19:29:54 +00:00
Code Packages Projects Releases Wiki Activity

deploy: 1485adce29

Browse Source
This commit is contained in:
felixfontein
2024-10-04 08:18:56 +00:00
parent d9eff3a4e4
commit 39d079e8a6
4 changed files with 31 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
branch/main/docker_swarm_inventory.html
+14 -3
View File
@@ -132,6 +132,7 @@
<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="#notes">Notes</a></li>
<li class="toctree-l2"><a class="reference internal" href="#examples">Examples</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>
@@ -186,14 +187,15 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
<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="#examples" id="id4">Examples</a></p></li>
<li><p><a class="reference internal" href="#notes" id="id4">Notes</a></p></li>
<li><p><a class="reference internal" href="#examples" id="id5">Examples</a></p></li>
</ul>
</nav>
<section id="synopsis">
<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>Reads inventories from the Docker swarm API.</p></li>
<li><p>Uses a YAML configuration file docker_swarm.[yml|yaml].</p></li>
<li><p>Uses a YAML configuration file that ends with <code class="ansible-value docutils literal notranslate"><span class="pre">docker_swarm.(yml|yaml)</span></code>.</p></li>
<li><p>The plugin returns following groups of swarm nodes: <code class="docutils literal notranslate"><span class="pre">all</span></code> - all hosts; <code class="docutils literal notranslate"><span class="pre">workers</span></code> - all worker nodes; <code class="docutils literal notranslate"><span class="pre">managers</span></code> - all manager nodes; <code class="docutils literal notranslate"><span class="pre">leader</span></code> - the swarm leader node; <code class="docutils literal notranslate"><span class="pre">nonleaders</span></code> - all nodes except the swarm leader.</p></li>
</ul>
</section>
@@ -536,8 +538,17 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
</tbody>
</table>
</section>
<section id="notes">
<h2><a class="toc-backref" href="#id4" 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">
<li><p>The configuration file must be a YAML file whose filename ends with <code class="ansible-value docutils literal notranslate"><span class="pre">docker_swarm.yml</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">docker_swarm.yaml</span></code>. Other filenames will not be accepted.</p></li>
</ul>
</div>
</section>
<section id="examples">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<h2><a class="toc-backref" href="#id5" 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="c1"># Minimal example using local docker</span>
<span class="nt">plugin</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">community.docker.docker_swarm</span>
<span class="nt">docker_host</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">unix:///var/run/docker.sock</span>