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

deploy: eb186f0098

Browse Source
This commit is contained in:
felixfontein
2023-02-08 09:21:56 +00:00
parent 9b875acc86
commit 25534b3cbb
49 changed files with 718 additions and 13703 deletions
Download Patch File Download Diff File Expand all files Collapse all files
branch/main/current_container_facts_module.html
+16 -14
View File
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>community.docker.current_container_facts module – Return facts about whether the module runs in a container &mdash; Community.Docker Collection documentation</title>
@@ -14,10 +14,8 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
@@ -53,7 +51,11 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Community.Docker Collection
<a href="index.html" class="icon icon-home">
Community.Docker Collection
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files -->
<div class="version">
@@ -139,7 +141,7 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a></li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">community.docker.current_container_facts module – Return facts about whether the module runs in a container</li>
<li class="wy-breadcrumbs-aside">
<!-- User defined GitHub URL -->
@@ -162,24 +164,24 @@
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">community.docker.current_container_facts</span></code>.</p>
</div>
<p class="ansible-version-added">New in community.docker 1.1.0</p>
<div class="contents local topic" id="contents">
<nav class="contents local" id="contents">
<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="#returned-facts" id="id4">Returned Facts</a></p></li>
</ul>
</div>
</nav>
<section id="synopsis">
<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p>Return facts about whether the module runs in a Docker or podman container.</p></li>
<li><p>This module attempts a best-effort detection. There might be special cases where it does not work; if you encounter one, <a class="reference external" href="https://github.com/ansible-collections/community.docker/issues/new?assignees%3D%26labels%3D%26template%3Dbug_report.md">please file an issue</a>.</p></li>
</ul>
</section>
<section id="attributes">
<h2><a class="toc-backref" href="#id2">Attributes</a><a class="headerlink" href="#attributes" title="Permalink to this heading"></a></h2>
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Permalink to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%">
<thead>
<tr class="row-odd"><th class="head"><p>Attribute</p></th>
<th class="head"><p>Support</p></th>
@@ -217,7 +219,7 @@
</table>
</section>
<section id="examples">
<h2><a class="toc-backref" href="#id3">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id3" role="doc-backlink">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="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">Get facts on current container</span>
<span class="w"> </span><span class="nt">community.docker.current_container_facts</span><span class="p">:</span>
@@ -229,9 +231,9 @@
</div>
</section>
<section id="returned-facts">
<h2><a class="toc-backref" href="#id4">Returned Facts</a><a class="headerlink" href="#returned-facts" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Returned Facts</a><a class="headerlink" href="#returned-facts" title="Permalink to this heading"></a></h2>
<p>Facts returned by this module are added/updated in the <code class="docutils literal notranslate"><span class="pre">hostvars</span></code> host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.</p>
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
<table class="ansible-option-table docutils align-default" style="width: 100%">
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>Description</p></th>