ansible-collections/community.docker
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.docker.git synced 2026-09-14 03:40:33 +00:00
Code Packages Projects Releases Wiki Activity

deploy: 78801088ae

Browse Source
This commit is contained in:
felixfontein
2023-10-07 12:06:46 +00:00
parent 477838a852
commit 7709893e1b
40 changed files with 65 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files
branch/main/docker_stack_info_module.html
+22 -11
View File
@@ -5,7 +5,7 @@
<meta content="2.5.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>community.docker.docker_stack_info module – Return information on a docker stack &mdash; Community.Docker Collection documentation</title>
<title>community.docker.docker_stack_info module – Return information on all docker stacks &mdash; Community.Docker Collection documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" />
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" />
@@ -99,9 +99,10 @@
<li class="toctree-l1"><a class="reference internal" href="docker_prune_module.html">community.docker.docker_prune module – Allows to prune various docker objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="docker_secret_module.html">community.docker.docker_secret module – Manage docker secrets.</a></li>
<li class="toctree-l1"><a class="reference internal" href="docker_stack_module.html">community.docker.docker_stack module – docker stack module</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">community.docker.docker_stack_info module – Return information on a docker stack</a><ul>
<li class="toctree-l1 current"><a class="current reference internal" href="#">community.docker.docker_stack_info module – Return information on all docker stacks</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#synopsis">Synopsis</a></li>
<li class="toctree-l2"><a class="reference internal" href="#attributes">Attributes</a></li>
<li class="toctree-l2"><a class="reference internal" href="#see-also">See Also</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><ul>
<li class="toctree-l3"><a class="reference internal" href="#authors">Authors</a></li>
@@ -144,7 +145,7 @@
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">community.docker.docker_stack_info module – Return information on a docker stack</li>
<li class="breadcrumb-item active">community.docker.docker_stack_info module – Return information on all docker stacks</li>
<li class="wy-breadcrumbs-aside">
<!-- User defined GitHub URL -->
<a href="https://github.com/ansible-collections/community.docker/edit/main/plugins/modules/docker_stack_info.py?description=%23%23%23%23%23%20SUMMARY%0A%3C!—%20Your%20description%20here%20–%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr" class="fa fa-github"> Edit on GitHub</a>
@@ -157,8 +158,8 @@
<div itemprop="articleBody">
<span class="target" id="ansible-collections-community-docker-docker-stack-info-module"></span><section id="community-docker-docker-stack-info-module-return-information-on-a-docker-stack">
<h1>community.docker.docker_stack_info module – Return information on a docker stack<a class="headerlink" href="#community-docker-docker-stack-info-module-return-information-on-a-docker-stack" title="Link to this heading"></a></h1>
<span class="target" id="ansible-collections-community-docker-docker-stack-info-module"></span><section id="community-docker-docker-stack-info-module-return-information-on-all-docker-stacks">
<h1>community.docker.docker_stack_info module – Return information on all docker stacks<a class="headerlink" href="#community-docker-docker-stack-info-module-return-information-on-all-docker-stacks" title="Link to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/docker/">community.docker collection</a> (version 3.5.0).</p>
@@ -171,8 +172,9 @@ To check whether it is installed, run <code class="code docutils literal notrans
<ul class="simple">
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
<li><p><a class="reference internal" href="#attributes" id="id2">Attributes</a></p></li>
<li><p><a class="reference internal" href="#examples" id="id3">Examples</a></p></li>
<li><p><a class="reference internal" href="#return-values" id="id4">Return Values</a></p></li>
<li><p><a class="reference internal" href="#see-also" id="id3">See Also</a></p></li>
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
<li><p><a class="reference internal" href="#return-values" id="id5">Return Values</a></p></li>
</ul>
</nav>
<section id="synopsis">
@@ -212,8 +214,18 @@ To check whether it is installed, run <code class="code docutils literal notrans
</tbody>
</table>
</section>
<section id="see-also">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Link to this heading"></a></h2>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="docker_stack_task_info_module.html#ansible-collections-community-docker-docker-stack-task-info-module"><span class="std std-ref">community.docker.docker_stack_task_info</span></a></dt><dd><p>To retrieve detailed information about the services under a specific stack use the <a class="reference internal" href="docker_stack_task_info_module.html#ansible-collections-community-docker-docker-stack-task-info-module"><span class="std std-ref">community.docker.docker_stack_task_info</span></a> module.</p>
</dd>
</dl>
</div>
</section>
<section id="examples">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<h2><a class="toc-backref" href="#id4" 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">Shows stack info</span>
<span class="w"> </span><span class="nt">community.docker.docker_stack_info</span><span class="p">:</span>
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">result</span>
@@ -225,7 +237,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div>
</section>
<section id="return-values">
<h2><a class="toc-backref" href="#id4" 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="#id5" 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>
@@ -238,8 +250,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<div class="ansibleOptionAnchor" id="return-results"></div><p class="ansible-option-title" id="ansible-collections-community-docker-docker-stack-info-module-return-results"><strong>results</strong></p>
<a class="ansibleOptionLink" href="#return-results" title="Permalink to this return value"></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>List of dictionaries containing the list of stacks or tasks associated
to a stack name.</p>
<td><div class="ansible-option-cell"><p>List of dictionaries containing the list of stacks on the target node</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">[{&quot;name&quot;:</span> <span class="pre">&quot;grafana&quot;,</span> <span class="pre">&quot;namespace&quot;:</span> <span class="pre">&quot;default&quot;,</span> <span class="pre">&quot;orchestrator&quot;:</span> <span class="pre">&quot;Kubernetes&quot;,</span> <span class="pre">&quot;services&quot;:</span> <span class="pre">&quot;2&quot;}]</span></code></p>
</div></td>