Community.Docker

Collection version 5.2.1

Description
Communication
Changelog
Scenario Guide
Plugin Index

Description

Modules and plugins for working with Docker

Author:

Ansible Docker Working Group

Supported ansible-core versions:

2.17.0 or newer

Communication

Forum: Ansible Forum: General usage and support questions.
Forum: Ansible Forum: Discussions about Docker.
Forum: Ansible Forum: Discussions about Docker Compose.
Forum: Ansible Forum: Discussions about Docker Swarm.
Matrix room #users:ansible.im: General usage and support questions.
IRC channel #ansible (Libera network): General usage and support questions.

Changelog

Community.Docker Release Notes

Scenario Guide

Docker Guide

Plugin Index

These are the plugins in the community.docker collection:

Modules

current_container_facts module – Return facts about whether the module runs in a container
docker_compose_v2 module – Manage multi-container Docker applications with Docker Compose CLI plugin
docker_compose_v2_exec module – Run command in a container of a Compose service
docker_compose_v2_pull module – Pull a Docker compose project
docker_compose_v2_run module – Run command in a new container of a Compose service
docker_config module – Manage docker configs
docker_container module – manage Docker containers
docker_container_copy_into module – Copy a file into a Docker container
docker_container_exec module – Execute command in a docker container
docker_container_info module – Retrieves facts about docker container
docker_context_info module – Retrieve information on Docker contexts for the current user
docker_host_info module – Retrieves facts about docker host and lists of objects of the services
docker_image module – Manage docker images
docker_image_build module – Build Docker images using Docker buildx
docker_image_export module – Export (archive) Docker images
docker_image_info module – Inspect docker images
docker_image_load module – Load docker image(s) from archives
docker_image_pull module – Pull Docker images from registries
docker_image_push module – Push Docker images to registries
docker_image_remove module – Remove Docker images
docker_image_tag module – Tag Docker images with new names and/or tags
docker_login module – Log into a Docker registry
docker_network module – Manage Docker networks
docker_network_info module – Retrieves facts about docker network
docker_node module – Manage Docker Swarm node
docker_node_info module – Retrieves facts about docker swarm node from Swarm Manager
docker_plugin module – Manage Docker plugins
docker_prune module – Allows to prune various docker objects
docker_secret module – Manage docker secrets
docker_stack module – docker stack module
docker_stack_info module – Return information on all docker stacks
docker_stack_task_info module – Return information of the tasks on a docker stack
docker_swarm module – Manage Swarm cluster
docker_swarm_info module – Retrieves facts about Docker Swarm cluster
docker_swarm_service module – docker swarm service
docker_swarm_service_info module – Retrieves information about docker services from a Swarm Manager
docker_volume module – Manage Docker volumes
docker_volume_info module – Retrieve facts about Docker volumes

Connection Plugins

docker connection – Run tasks in docker containers
docker_api connection – Run tasks in docker containers
nsenter connection – execute on host running controller container

Inventory Plugins

docker_containers inventory – Ansible dynamic inventory plugin for Docker containers
docker_machine inventory – Docker Machine inventory source
docker_swarm inventory – Ansible dynamic inventory plugin for Docker swarm nodes