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

deploy: c3aceebd7d

Browse Source
This commit is contained in:
felixfontein
2024-07-25 20:36:55 +00:00
parent 88adf1516a
commit 96e980debb
5 changed files with 120 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
branch/main/environment_variables.html
+19
View File
@@ -158,6 +158,16 @@
<span id="list-of-collection-env-vars"></span><h1>Index of all Collection Environment Variables<a class="headerlink" href="#index-of-all-collection-environment-variables" title="Link to this heading"></a></h1>
<p>The following index documents all environment variables declared by plugins in collections.
Environment variables used by the ansible-core configuration are documented in <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/config.html#ansible-configuration-settings" title="(in Ansible vdevel)"><span>Ansible Configuration Settings</span></a>.</p>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_DOCKER_PRIVILEGED">
<span class="sig-name descname"><span class="pre">ANSIBLE_DOCKER_PRIVILEGED</span></span><a class="headerlink" href="#envvar-ANSIBLE_DOCKER_PRIVILEGED" title="Link to this definition"></a></dt>
<dd><p>Whether commands should be run with extended privileges.</p>
<p><strong>Note</strong> that this allows command to potentially break out of the container. Use with care!</p>
<p><em>Used by:</em>
<a class="reference internal" href="docker_connection.html#ansible-collections-community-docker-docker-connection"><span class="std std-ref">community.docker.docker connection plugin</span></a>,
<a class="reference internal" href="docker_api_connection.html#ansible-collections-community-docker-docker-api-connection"><span class="std std-ref">community.docker.docker_api connection plugin</span></a></p>
</dd></dl>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_DOCKER_TIMEOUT">
<span class="sig-name descname"><span class="pre">ANSIBLE_DOCKER_TIMEOUT</span></span><a class="headerlink" href="#envvar-ANSIBLE_DOCKER_TIMEOUT" title="Link to this definition"></a></dt>
@@ -167,6 +177,15 @@ Environment variables used by the ansible-core configuration are documented in <
<a class="reference internal" href="docker_api_connection.html#ansible-collections-community-docker-docker-api-connection"><span class="std std-ref">community.docker.docker_api connection plugin</span></a></p>
</dd></dl>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_DOCKER_WORKING_DIR">
<span class="sig-name descname"><span class="pre">ANSIBLE_DOCKER_WORKING_DIR</span></span><a class="headerlink" href="#envvar-ANSIBLE_DOCKER_WORKING_DIR" title="Link to this definition"></a></dt>
<dd><p>See the documentations for the options where this environment variable is used.</p>
<p><em>Used by:</em>
<a class="reference internal" href="docker_connection.html#ansible-collections-community-docker-docker-connection"><span class="std std-ref">community.docker.docker connection plugin</span></a>,
<a class="reference internal" href="docker_api_connection.html#ansible-collections-community-docker-docker-api-connection"><span class="std std-ref">community.docker.docker_api connection plugin</span></a></p>
</dd></dl>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_INVENTORY_USE_EXTRA_VARS">
<span class="sig-name descname"><span class="pre">ANSIBLE_INVENTORY_USE_EXTRA_VARS</span></span><a class="headerlink" href="#envvar-ANSIBLE_INVENTORY_USE_EXTRA_VARS" title="Link to this definition"></a></dt>