mirror of
https://github.com/ansible-collections/community.docker.git
synced 2026-09-14 03:40:33 +00:00
deploy: b774837183
This commit is contained in:
felixfontein
@@ -5,7 +5,7 @@
|
||||
<meta content="2.6.1" name="antsibull-docs" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>community.docker.docker_compose module – Manage multi-container Docker applications with Docker Compose. — Community.Docker Collection documentation</title>
|
||||
<title>community.docker.docker_compose module – Manage multi-container Docker applications with Docker Compose V1 — Community.Docker Collection documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=c5b67dd2" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
@@ -24,7 +24,7 @@
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="community.docker.docker_config module – Manage docker configs." href="docker_config_module.html" />
|
||||
<link rel="next" title="community.docker.docker_compose_v2 module – Manage multi-container Docker applications with Docker Compose CLI plugin" href="docker_compose_v2_module.html" />
|
||||
<link rel="prev" title="community.docker.current_container_facts module – Return facts about whether the module runs in a container" href="current_container_facts_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
|
||||
|
||||
|
||||
@@ -80,12 +80,13 @@
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">community.docker.docker_compose module – Manage multi-container Docker applications with Docker Compose.</a><ul>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">community.docker.docker_compose module – Manage multi-container Docker applications with Docker Compose V1</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#synopsis">Synopsis</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#parameters">Parameters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#attributes">Attributes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#notes">Notes</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>
|
||||
@@ -94,6 +95,7 @@
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_compose_v2_module.html">community.docker.docker_compose_v2 module – Manage multi-container Docker applications with Docker Compose CLI plugin</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_config_module.html">community.docker.docker_config module – Manage docker configs.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_container_module.html">community.docker.docker_container module – manage Docker containers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
|
||||
@@ -101,8 +103,13 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_container_info_module.html">community.docker.docker_container_info module – Retrieves facts about docker container</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_host_info_module.html">community.docker.docker_host_info module – Retrieves facts about docker host and lists of objects of the services.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_image_module.html">community.docker.docker_image module – Manage docker images</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_image_build_module.html">community.docker.docker_image_build module – Build Docker images using Docker buildx</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_image_info_module.html">community.docker.docker_image_info module – Inspect docker images</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_image_load_module.html">community.docker.docker_image_load module – Load docker image(s) from archives</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_image_pull_module.html">community.docker.docker_image_pull module – Pull Docker images from registries</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_image_push_module.html">community.docker.docker_image_push module – Push Docker images to registries</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_image_remove_module.html">community.docker.docker_image_remove module – Remove Docker images</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_image_tag_module.html">community.docker.docker_image_tag module – Tag Docker images with new names and/or tags</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_login_module.html">community.docker.docker_login module – Log into a Docker registry.</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_network_module.html">community.docker.docker_network module – Manage Docker networks</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker_network_info_module.html">community.docker.docker_network_info module – Retrieves facts about docker network</a></li>
|
||||
@@ -147,7 +154,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_compose module – Manage multi-container Docker applications with Docker Compose.</li>
|
||||
<li class="breadcrumb-item active">community.docker.docker_compose module – Manage multi-container Docker applications with Docker Compose V1</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<!-- User defined GitHub URL -->
|
||||
<a href="https://github.com/ansible-collections/community.docker/edit/main/plugins/modules/docker_compose.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>
|
||||
@@ -160,8 +167,8 @@
|
||||
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<span class="target" id="ansible-collections-community-docker-docker-compose-module"></span><section id="community-docker-docker-compose-module-manage-multi-container-docker-applications-with-docker-compose">
|
||||
<h1>community.docker.docker_compose module – Manage multi-container Docker applications with Docker Compose.<a class="headerlink" href="#community-docker-docker-compose-module-manage-multi-container-docker-applications-with-docker-compose" title="Link to this heading"></a></h1>
|
||||
<span class="target" id="ansible-collections-community-docker-docker-compose-module"></span><section id="community-docker-docker-compose-module-manage-multi-container-docker-applications-with-docker-compose-v1">
|
||||
<h1>community.docker.docker_compose module – Manage multi-container Docker applications with Docker Compose V1<a class="headerlink" href="#community-docker-docker-compose-module-manage-multi-container-docker-applications-with-docker-compose-v1" 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.6.0).</p>
|
||||
@@ -179,14 +186,15 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#attributes" id="id4">Attributes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#notes" id="id5">Notes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id6">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id7">Return Values</a></p></li>
|
||||
<li><p><a class="reference internal" href="#see-also" id="id6">See Also</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id7">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id8">Return Values</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Uses Docker Compose to start, shutdown and scale services. <strong>This module requires docker-compose < 2.0.0.</strong></p></li>
|
||||
<li><p>Uses Docker Compose to start, shutdown and scale services. <strong>This module requires docker-compose < 2.0.0.</strong> Use the <a class="reference internal" href="docker_compose_v2_module.html#ansible-collections-community-docker-docker-compose-v2-module"><span class="std std-ref">community.docker.docker_compose_v2</span></a> module for using the modern Docker compose CLI plugin.</p></li>
|
||||
<li><p>Configuration can be read from a <code class="docutils literal notranslate"><span class="pre">docker-compose.yml</span></code> or <code class="docutils literal notranslate"><span class="pre">docker-compose.yaml</span></code> file or inline using the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-docker-docker-compose-module-parameter-definition"><span class="std std-ref"><span class="pre">definition</span></span></a></strong></code> option.</p></li>
|
||||
<li><p>See the examples for more details.</p></li>
|
||||
<li><p>Supports check mode.</p></li>
|
||||
@@ -314,7 +322,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the TCP connection string. For example, <code class="ansible-value docutils literal notranslate"><span class="pre">tcp://192.0.2.23:2376</span></code>. If TLS is used to encrypt the connection, the module will automatically replace <code class="docutils literal notranslate"><span class="pre">tcp</span></code> in the connection URL with <code class="docutils literal notranslate"><span class="pre">https</span></code>.</p>
|
||||
<p>If the value is not specified in the task, the value of environment variable <a class="reference internal" href="docsite/scenario_guide.html#envvar-DOCKER_HOST"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">DOCKER_HOST</span></code></a> will be used instead. If the environment variable is not set, the default value will be used.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"unix://var/run/docker.sock"</span></code></p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"unix:///var/run/docker.sock"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -629,8 +637,18 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section id="see-also">
|
||||
<h2><a class="toc-backref" href="#id6" 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_compose_v2_module.html#ansible-collections-community-docker-docker-compose-v2-module"><span class="std std-ref">community.docker.docker_compose_v2</span></a></dt><dd><p>Manage multi-container Docker applications with Docker Compose CLI plugin.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
|
||||
<h2><a class="toc-backref" href="#id7" 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"># Examples use the django example at https://docs.docker.com/compose/django. Follow it to create the</span>
|
||||
<span class="c1"># flask directory</span>
|
||||
|
||||
@@ -793,7 +811,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
</div>
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id7" 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="#id8" 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>
|
||||
@@ -1065,7 +1083,7 @@ see <a class="reference internal" href="#ansible-collections-community-docker-do
|
||||
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="current_container_facts_module.html" class="btn btn-neutral float-left" title="community.docker.current_container_facts module – Return facts about whether the module runs in a container" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="docker_config_module.html" class="btn btn-neutral float-right" title="community.docker.docker_config module – Manage docker configs." accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="docker_compose_v2_module.html" class="btn btn-neutral float-right" title="community.docker.docker_compose_v2 module – Manage multi-container Docker applications with Docker Compose CLI plugin" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
Reference in New Issue
Block a user