deploy: 29ff1241ce

branch/main/docker_containers_inventory.html

@@ -615,19 +615,23 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
 </section>
 <section id="examples">
 <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 daemon</span>
+<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="nn">---</span>
+<span class="c1"># Minimal example using local Docker daemon</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_containers</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="nn">---</span>
 <span class="c1"># Minimal example using remote Docker daemon</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_containers</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="nn">---</span>
 <span class="c1"># Example using remote Docker daemon 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_containers</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="nn">---</span>
 <span class="c1"># Example using remote Docker daemon 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_containers</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>
@@ -636,6 +640,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
 <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="nn">---</span>
 <span class="c1"># Example using constructed features to create groups</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_containers</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>
@@ -648,6 +653,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
 <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="l l-Scalar l-Scalar-Plain">docker_platform</span>
 
+<span class="nn">---</span>
 <span class="c1"># Example using SSH connection with an explicit fallback for when port 22 has not been</span>
 <span class="c1"># exported: use container name as ansible_ssh_host and 22 as ansible_ssh_port</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_containers</span>
@@ -656,6 +662,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
 <span class="w">  </span><span class="nt">ansible_ssh_host</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ansible_ssh_host | default(docker_name[1:], true)</span>
 <span class="w">  </span><span class="nt">ansible_ssh_port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ansible_ssh_port | default(22, true)</span>
 
+<span class="nn">---</span>
 <span class="c1"># Only consider containers which have a label &#39;foo&#39;, or whose name starts with &#39;a&#39;</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_containers</span>
 <span class="nt">filters</span><span class="p">:</span>

branch/main/docker_machine_inventory.html

@@ -439,9 +439,11 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
 </section>
 <section id="examples">
 <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</span>
+<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="nn">---</span>
+<span class="c1"># Minimal example</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_machine</span>
 
+<span class="nn">---</span>
 <span class="c1"># Example using constructed features to create a group per Docker Machine driver</span>
 <span class="c1"># (https://docs.docker.com/machine/drivers/), for example:</span>
 <span class="c1">#   $ docker-machine create --driver digitalocean ... mymachine</span>
@@ -454,18 +456,23 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
 <span class="c1">#       ]</span>
 <span class="c1">#     ...</span>
 <span class="c1">#   }</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_machine</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="p p-Indicator">-</span><span class="w"> </span><span class="nt">separator</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;&#39;</span>
 <span class="w">    </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docker_machine_node_attributes.DriverName</span>
 
+<span class="nn">---</span>
 <span class="c1"># Example grouping hosts by Digital Machine tag</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_machine</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="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">tag</span>
 <span class="w">    </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;dm_tags&#39;</span>
 
+<span class="nn">---</span>
 <span class="c1"># Example using compose to override the default SSH behaviour of asking the user to accept the remote host key</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_machine</span>
 <span class="nt">compose</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">ansible_ssh_common_args</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;&quot;-o</span><span class="nv"> </span><span class="s">StrictHostKeyChecking=accept-new&quot;&#39;</span>
 </pre></div>

branch/main/docker_swarm_inventory.html

@@ -536,19 +536,23 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
 </section>
 <section id="examples">
 <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>
+<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="nn">---</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="nn">---</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="nn">---</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="nn">---</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>
@@ -557,6 +561,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
 <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="nn">---</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>