mirror of
https://github.com/ansible-collections/community.docker.git
synced 2025-12-16 11:58:43 +00:00
284 lines
23 KiB
HTML
284 lines
23 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<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 — Community.Docker Collection documentation</title>
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" />
|
||
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
|
||
<!--[if lt IE 9]>
|
||
<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/doctools.js"></script>
|
||
<script src="_static/sphinx_highlight.js"></script>
|
||
<script src="_static/js/theme.js"></script>
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="Docker Guide" href="docsite/scenario_guide.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
|
||
|
||
|
||
|
||
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
|
||
|
||
<div class="DocSite-globalNav ansibleNav">
|
||
<ul>
|
||
<li><a href="https://www.ansible.com/ansiblefest" target="_blank">AnsibleFest</a></li>
|
||
<li><a href="https://www.ansible.com/tower" target="_blank">Products</a></li>
|
||
<li><a href="https://www.ansible.com/community" target="_blank">Community</a></li>
|
||
<li><a href="https://www.ansible.com/webinars-training" target="_blank">Webinars & Training</a></li>
|
||
<li><a href="https://www.ansible.com/blog" target="_blank">Blog</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<a class="DocSite-nav" href="https://ansible-collections.github.io/community.docker/branch/main/" style="padding-bottom: 30px;">
|
||
|
||
<img class="DocSiteNav-logo"
|
||
src="_static/images/Ansible-Mark-RGB_White.png"
|
||
alt="Ansible Logo">
|
||
<div class="DocSiteNav-title">Community.Docker Collection Docs</div>
|
||
</a>
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="#" class="icon icon-home">
|
||
Community.Docker Collection
|
||
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files -->
|
||
|
||
<div class="version">
|
||
|
||
|
||
|
||
</div>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<label class="sr-only" for="q">Search docs:</label>
|
||
<input type="text" class="st-default-search-input" id="q" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="docsite/scenario_guide.html">Docker Guide</a></li>
|
||
</ul>
|
||
<ul>
|
||
<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"><a class="reference internal" href="docker_compose_module.html">community.docker.docker_compose module – Manage multi-container Docker applications with Docker Compose.</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>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_container_exec_module.html">community.docker.docker_container_exec module – Execute command in a docker container</a></li>
|
||
<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_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_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>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_node_module.html">community.docker.docker_node module – Manage Docker Swarm node</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_node_info_module.html">community.docker.docker_node_info module – Retrieves facts about docker swarm node from Swarm Manager</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_plugin_module.html">community.docker.docker_plugin module – Manage Docker plugins</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_prune_module.html">community.docker.docker_prune module – Allows to prune various docker objects</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_secret_module.html">community.docker.docker_secret module – Manage docker secrets.</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_stack_module.html">community.docker.docker_stack module – docker stack module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_stack_info_module.html">community.docker.docker_stack_info module – Return information on a docker stack</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_stack_task_info_module.html">community.docker.docker_stack_task_info module – Return information of the tasks on a docker stack</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_swarm_module.html">community.docker.docker_swarm module – Manage Swarm cluster</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_swarm_info_module.html">community.docker.docker_swarm_info module – Retrieves facts about Docker Swarm cluster.</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_swarm_service_module.html">community.docker.docker_swarm_service module – docker swarm service</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_swarm_service_info_module.html">community.docker.docker_swarm_service_info module – Retrieves information about docker services from a Swarm Manager</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_volume_module.html">community.docker.docker_volume module – Manage Docker volumes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_volume_info_module.html">community.docker.docker_volume_info module – Retrieve facts about Docker volumes</a></li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_connection.html">community.docker.docker connection – Run tasks in docker containers</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_api_connection.html">community.docker.docker_api connection – Run tasks in docker containers</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="nsenter_connection.html">community.docker.nsenter connection – execute on host running controller container</a></li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_containers_inventory.html">community.docker.docker_containers inventory – Ansible dynamic inventory plugin for Docker containers</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_machine_inventory.html">community.docker.docker_machine inventory – Docker Machine inventory source</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker_swarm_inventory.html">community.docker.docker_swarm inventory – Ansible dynamic inventory plugin for Docker swarm nodes.</a></li>
|
||
</ul>
|
||
<!-- extra nav elements for Ansible beyond RTD Sphinx Theme -->
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="#">Community.Docker Collection</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item active">Community.Docker</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
|
||
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="community-docker">
|
||
<span id="plugins-in-community-docker"></span><h1>Community.Docker<a class="headerlink" href="#community-docker" title="Permalink to this heading"></a></h1>
|
||
<p>Collection version 3.4.2</p>
|
||
<nav class="contents local" id="contents">
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="#description" id="id1">Description</a></p></li>
|
||
<li><p><a class="reference internal" href="#communication" id="id2">Communication</a></p></li>
|
||
<li><p><a class="reference internal" href="#scenario-guide" id="id3">Scenario Guide</a></p></li>
|
||
<li><p><a class="reference internal" href="#plugin-index" id="id4">Plugin Index</a></p></li>
|
||
</ul>
|
||
</nav>
|
||
<section id="description">
|
||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Description</a><a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
|
||
<p>Modules and plugins for working with Docker</p>
|
||
<p><strong>Author:</strong></p>
|
||
<ul class="simple">
|
||
<li><p>Ansible Docker Working Group</p></li>
|
||
</ul>
|
||
<p><strong>Supported ansible-core versions:</strong></p>
|
||
<ul class="simple">
|
||
<li><p>2.11.0 or newer</p></li>
|
||
</ul>
|
||
<p class="ansible-links">
|
||
<a href="https://github.com/ansible-collections/community.docker/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
||
<a href="https://github.com/ansible-collections/community.docker" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
||
<a href="https://github.com/ansible-collections/community.docker/issues/new?assignees=&labels=&template=bug_report.md" aria-role="button" target="_blank" rel="noopener external">Submit a bug report</a>
|
||
<a href="https://github.com/ansible-collections/community.docker/issues/new?assignees=&labels=&template=feature_request.md" aria-role="button" target="_blank" rel="noopener external">Request a feature</a>
|
||
</p></section>
|
||
<section id="communication">
|
||
<span id="communication-for-community-docker"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Communication</a><a class="headerlink" href="#communication" title="Permalink to this heading"></a></h2>
|
||
<ul class="simple">
|
||
<li><p>Matrix room <code class="docutils literal notranslate"><span class="pre">#users:ansible.im</span></code>: <a class="reference external" href="https://matrix.to/#/#users:ansible.im">General usage and support questions</a>.</p></li>
|
||
<li><p>IRC channel <code class="docutils literal notranslate"><span class="pre">#ansible</span></code> (Libera network):
|
||
<a class="reference external" href="https://web.libera.chat/?channel=#ansible">General usage and support questions</a>.</p></li>
|
||
<li><p>Mailing list: <a class="reference external" href="https://groups.google.com/g/ansible-project">Ansible Project List</a>.
|
||
(<a class="reference external" href="mailto:ansible-project+subscribe%40googlegroups.com?subject=subscribe">Subscribe</a>)</p></li>
|
||
</ul>
|
||
<div class="toctree-wrapper compound">
|
||
</div>
|
||
</section>
|
||
<section id="scenario-guide">
|
||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Scenario Guide</a><a class="headerlink" href="#scenario-guide" title="Permalink to this heading"></a></h2>
|
||
<div class="toctree-wrapper compound">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="docsite/scenario_guide.html">Docker Guide</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="plugin-index">
|
||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Plugin Index</a><a class="headerlink" href="#plugin-index" title="Permalink to this heading"></a></h2>
|
||
<p>These are the plugins in the community.docker collection:</p>
|
||
<section id="modules">
|
||
<h3>Modules<a class="headerlink" href="#modules" title="Permalink to this heading"></a></h3>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="current_container_facts_module.html#ansible-collections-community-docker-current-container-facts-module"><span class="std std-ref">current_container_facts module</span></a> – Return facts about whether the module runs in a container</p></li>
|
||
<li><p><a class="reference internal" href="docker_compose_module.html#ansible-collections-community-docker-docker-compose-module"><span class="std std-ref">docker_compose module</span></a> – Manage multi-container Docker applications with Docker Compose.</p></li>
|
||
<li><p><a class="reference internal" href="docker_config_module.html#ansible-collections-community-docker-docker-config-module"><span class="std std-ref">docker_config module</span></a> – Manage docker configs.</p></li>
|
||
<li><p><a class="reference internal" href="docker_container_module.html#ansible-collections-community-docker-docker-container-module"><span class="std std-ref">docker_container module</span></a> – manage Docker containers</p></li>
|
||
<li><p><a class="reference internal" href="docker_container_copy_into_module.html#ansible-collections-community-docker-docker-container-copy-into-module"><span class="std std-ref">docker_container_copy_into module</span></a> – Copy a file into a Docker container</p></li>
|
||
<li><p><a class="reference internal" href="docker_container_exec_module.html#ansible-collections-community-docker-docker-container-exec-module"><span class="std std-ref">docker_container_exec module</span></a> – Execute command in a docker container</p></li>
|
||
<li><p><a class="reference internal" href="docker_container_info_module.html#ansible-collections-community-docker-docker-container-info-module"><span class="std std-ref">docker_container_info module</span></a> – Retrieves facts about docker container</p></li>
|
||
<li><p><a class="reference internal" href="docker_host_info_module.html#ansible-collections-community-docker-docker-host-info-module"><span class="std std-ref">docker_host_info module</span></a> – Retrieves facts about docker host and lists of objects of the services.</p></li>
|
||
<li><p><a class="reference internal" href="docker_image_module.html#ansible-collections-community-docker-docker-image-module"><span class="std std-ref">docker_image module</span></a> – Manage docker images</p></li>
|
||
<li><p><a class="reference internal" href="docker_image_info_module.html#ansible-collections-community-docker-docker-image-info-module"><span class="std std-ref">docker_image_info module</span></a> – Inspect docker images</p></li>
|
||
<li><p><a class="reference internal" href="docker_image_load_module.html#ansible-collections-community-docker-docker-image-load-module"><span class="std std-ref">docker_image_load module</span></a> – Load docker image(s) from archives</p></li>
|
||
<li><p><a class="reference internal" href="docker_login_module.html#ansible-collections-community-docker-docker-login-module"><span class="std std-ref">docker_login module</span></a> – Log into a Docker registry.</p></li>
|
||
<li><p><a class="reference internal" href="docker_network_module.html#ansible-collections-community-docker-docker-network-module"><span class="std std-ref">docker_network module</span></a> – Manage Docker networks</p></li>
|
||
<li><p><a class="reference internal" href="docker_network_info_module.html#ansible-collections-community-docker-docker-network-info-module"><span class="std std-ref">docker_network_info module</span></a> – Retrieves facts about docker network</p></li>
|
||
<li><p><a class="reference internal" href="docker_node_module.html#ansible-collections-community-docker-docker-node-module"><span class="std std-ref">docker_node module</span></a> – Manage Docker Swarm node</p></li>
|
||
<li><p><a class="reference internal" href="docker_node_info_module.html#ansible-collections-community-docker-docker-node-info-module"><span class="std std-ref">docker_node_info module</span></a> – Retrieves facts about docker swarm node from Swarm Manager</p></li>
|
||
<li><p><a class="reference internal" href="docker_plugin_module.html#ansible-collections-community-docker-docker-plugin-module"><span class="std std-ref">docker_plugin module</span></a> – Manage Docker plugins</p></li>
|
||
<li><p><a class="reference internal" href="docker_prune_module.html#ansible-collections-community-docker-docker-prune-module"><span class="std std-ref">docker_prune module</span></a> – Allows to prune various docker objects</p></li>
|
||
<li><p><a class="reference internal" href="docker_secret_module.html#ansible-collections-community-docker-docker-secret-module"><span class="std std-ref">docker_secret module</span></a> – Manage docker secrets.</p></li>
|
||
<li><p><a class="reference internal" href="docker_stack_module.html#ansible-collections-community-docker-docker-stack-module"><span class="std std-ref">docker_stack module</span></a> – docker stack module</p></li>
|
||
<li><p><a class="reference internal" href="docker_stack_info_module.html#ansible-collections-community-docker-docker-stack-info-module"><span class="std std-ref">docker_stack_info module</span></a> – Return information on a docker stack</p></li>
|
||
<li><p><a class="reference internal" href="docker_stack_task_info_module.html#ansible-collections-community-docker-docker-stack-task-info-module"><span class="std std-ref">docker_stack_task_info module</span></a> – Return information of the tasks on a docker stack</p></li>
|
||
<li><p><a class="reference internal" href="docker_swarm_module.html#ansible-collections-community-docker-docker-swarm-module"><span class="std std-ref">docker_swarm module</span></a> – Manage Swarm cluster</p></li>
|
||
<li><p><a class="reference internal" href="docker_swarm_info_module.html#ansible-collections-community-docker-docker-swarm-info-module"><span class="std std-ref">docker_swarm_info module</span></a> – Retrieves facts about Docker Swarm cluster.</p></li>
|
||
<li><p><a class="reference internal" href="docker_swarm_service_module.html#ansible-collections-community-docker-docker-swarm-service-module"><span class="std std-ref">docker_swarm_service module</span></a> – docker swarm service</p></li>
|
||
<li><p><a class="reference internal" href="docker_swarm_service_info_module.html#ansible-collections-community-docker-docker-swarm-service-info-module"><span class="std std-ref">docker_swarm_service_info module</span></a> – Retrieves information about docker services from a Swarm Manager</p></li>
|
||
<li><p><a class="reference internal" href="docker_volume_module.html#ansible-collections-community-docker-docker-volume-module"><span class="std std-ref">docker_volume module</span></a> – Manage Docker volumes</p></li>
|
||
<li><p><a class="reference internal" href="docker_volume_info_module.html#ansible-collections-community-docker-docker-volume-info-module"><span class="std std-ref">docker_volume_info module</span></a> – Retrieve facts about Docker volumes</p></li>
|
||
</ul>
|
||
<div class="toctree-wrapper compound">
|
||
</div>
|
||
</section>
|
||
<section id="connection-plugins">
|
||
<h3>Connection Plugins<a class="headerlink" href="#connection-plugins" title="Permalink to this heading"></a></h3>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="docker_connection.html#ansible-collections-community-docker-docker-connection"><span class="std std-ref">docker connection</span></a> – Run tasks in docker containers</p></li>
|
||
<li><p><a class="reference internal" href="docker_api_connection.html#ansible-collections-community-docker-docker-api-connection"><span class="std std-ref">docker_api connection</span></a> – Run tasks in docker containers</p></li>
|
||
<li><p><a class="reference internal" href="nsenter_connection.html#ansible-collections-community-docker-nsenter-connection"><span class="std std-ref">nsenter connection</span></a> – execute on host running controller container</p></li>
|
||
</ul>
|
||
<div class="toctree-wrapper compound">
|
||
</div>
|
||
</section>
|
||
<section id="inventory-plugins">
|
||
<h3>Inventory Plugins<a class="headerlink" href="#inventory-plugins" title="Permalink to this heading"></a></h3>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="docker_containers_inventory.html#ansible-collections-community-docker-docker-containers-inventory"><span class="std std-ref">docker_containers inventory</span></a> – Ansible dynamic inventory plugin for Docker containers</p></li>
|
||
<li><p><a class="reference internal" href="docker_machine_inventory.html#ansible-collections-community-docker-docker-machine-inventory"><span class="std std-ref">docker_machine inventory</span></a> – Docker Machine inventory source</p></li>
|
||
<li><p><a class="reference internal" href="docker_swarm_inventory.html#ansible-collections-community-docker-docker-swarm-inventory"><span class="std std-ref">docker_swarm inventory</span></a> – Ansible dynamic inventory plugin for Docker swarm nodes.</p></li>
|
||
</ul>
|
||
<div class="toctree-wrapper compound">
|
||
</div>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="docsite/scenario_guide.html" class="btn btn-neutral float-right" title="Docker Guide" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright Community.Docker Contributors.</p>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script><!-- extra footer elements for Ansible beyond RTD Sphinx Theme -->
|
||
|
||
</body>
|
||
</html> |