mirror of
https://github.com/ansible-collections/community.docker.git
synced 2026-09-13 19:29:54 +00:00
deploy: 3470e5effb
This commit is contained in:
@@ -434,8 +434,8 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<p class="ansible-option-line"><span class="ansible-option-configuration">Configuration:</span></p>
|
||||
<ul>
|
||||
<li><p>INI entry:</p>
|
||||
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">[</span><span class="nv">inventory_plugins</span><span class="p p-Indicator">]</span><span class="w"></span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">use_extra_vars = false</span><span class="w"></span>
|
||||
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">[</span><span class="nv">inventory_plugins</span><span class="p p-Indicator">]</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">use_extra_vars = false</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
@@ -488,43 +488,43 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id4">Examples</a><a class="headerlink" href="#examples" title="Permalink 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="w"></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="w"></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><span class="w"></span>
|
||||
<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>
|
||||
|
||||
<span class="c1"># Minimal example using remote docker</span><span class="w"></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="w"></span>
|
||||
<span class="nt">docker_host</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tcp://my-docker-host:2375</span><span class="w"></span>
|
||||
<span class="c1"># Minimal example using remote 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">tcp://my-docker-host:2375</span>
|
||||
|
||||
<span class="c1"># Example using remote docker with unverified TLS</span><span class="w"></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="w"></span>
|
||||
<span class="nt">docker_host</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tcp://my-docker-host:2376</span><span class="w"></span>
|
||||
<span class="nt">tls</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
|
||||
<span class="c1"># Example using remote docker with unverified TLS</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">tcp://my-docker-host:2376</span>
|
||||
<span class="nt">tls</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
|
||||
<span class="c1"># Example using remote docker with verified TLS and client certificate verification</span><span class="w"></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="w"></span>
|
||||
<span class="nt">docker_host</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tcp://my-docker-host:2376</span><span class="w"></span>
|
||||
<span class="nt">validate_certs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
|
||||
<span class="nt">ca_cert</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/somewhere/ca.pem</span><span class="w"></span>
|
||||
<span class="nt">client_key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/somewhere/key.pem</span><span class="w"></span>
|
||||
<span class="nt">client_cert</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/somewhere/cert.pem</span><span class="w"></span>
|
||||
<span class="c1"># Example using remote docker with verified TLS and client certificate verification</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">tcp://my-docker-host:2376</span>
|
||||
<span class="nt">validate_certs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="nt">ca_cert</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/somewhere/ca.pem</span>
|
||||
<span class="nt">client_key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/somewhere/key.pem</span>
|
||||
<span class="nt">client_cert</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/somewhere/cert.pem</span>
|
||||
|
||||
<span class="c1"># Example using constructed features to create groups and set ansible_host</span><span class="w"></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="w"></span>
|
||||
<span class="nt">docker_host</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tcp://my-docker-host:2375</span><span class="w"></span>
|
||||
<span class="nt">strict</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">False</span><span class="w"></span>
|
||||
<span class="nt">keyed_groups</span><span class="p">:</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="c1"># add for example x86_64 hosts to an arch_x86_64 group</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">arch</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">'Description.Platform.Architecture'</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="c1"># add for example linux hosts to an os_linux group</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">os</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">'Description.Platform.OS'</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="c1"># create a group per node label</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="c1"># for exomple a node labeled w/ "production" ends up in group "label_production"</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="c1"># hint: labels containing special characters will be converted to safe names</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">'Spec.Labels'</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">label</span><span class="w"></span>
|
||||
<span class="c1"># Example using constructed features to create groups and set ansible_host</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">tcp://my-docker-host:2375</span>
|
||||
<span class="nt">strict</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">False</span>
|
||||
<span class="nt">keyed_groups</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="c1"># add for example x86_64 hosts to an arch_x86_64 group</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">arch</span>
|
||||
<span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">'Description.Platform.Architecture'</span>
|
||||
<span class="w"> </span><span class="c1"># add for example linux hosts to an os_linux group</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">os</span>
|
||||
<span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">'Description.Platform.OS'</span>
|
||||
<span class="w"> </span><span class="c1"># create a group per node label</span>
|
||||
<span class="w"> </span><span class="c1"># for exomple a node labeled w/ "production" ends up in group "label_production"</span>
|
||||
<span class="w"> </span><span class="c1"># hint: labels containing special characters will be converted to safe names</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">'Spec.Labels'</span>
|
||||
<span class="w"> </span><span class="nt">prefix</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">label</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="authors">
|
||||
|
||||
Reference in New Issue
Block a user