ericsysmin.docker.docker role – Ansible role to install and configure Docker

Note

This role is part of the ericsysmin.docker collection (version 1.0.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install ericsysmin.docker.

To use it in a playbook, specify: ericsysmin.docker.docker.

Entry point main – Ansible role to install and configure Docker

Synopsis

  • Installation of Docker following Docker-Engine install procedures as documented by Docker.

  • It will manage kernel versions as well, verifying the that the correct kernel for Docker support is installed.

Parameters

Parameter

Comments

docker_api_cors_header

string

Set CORS headers in the remote API

docker_authorization_plugins

string

Authorization plugins to load

docker_bip

string

Specify network bridge IP

docker_block_device

string

The device name used for the storage driver.

docker_bridge

string

Attach containers to a network bridge

docker_cgroup_parent

string

Set parent cgroup for all containers

docker_channel

string

What release channel of Docker to install.

Default: "stable"

docker_cluster_advertise

string

Address or interface name to advertise

docker_cluster_store

string

Set cluster store options

docker_cluster_store_opts

string

Please see dockerd manual for info

docker_debug

string

Enable debug mode

docker_default_gateway

string

Container default gateway IPv4 address

docker_default_gateway_v6

string

Container default gateway IPv6 address

docker_default_runtime

string

Default OCI runtime for containers

docker_default_ulimits

string

Default ulimits for containers

docker_disable_legacy_registry

string

Disable contacting legacy registries

docker_dns

string

DNS server to use

docker_dns_opts

string

DNS options to use

string

DNS search domains to use

docker_edition

string

Specifies either ce, or ee edition of Docker.

Default: "ce"

docker_ee_url

string

Docker EE URL from the Docker Store

docker_ee_version

string

Docker EE version for EE repository

Default: 17.03

docker_exec_opts

string

Runtime execution options

docker_exec_root

string

Root directory for execution state files

docker_fixed_cidr

string

IPv4 subnet for fixed IPs

docker_fixed_cidr_v6

string

IPv6 subnet for fixed IPs

docker_graph

string

Root of the Docker runtime

docker_group

string

Group for the unix socket

docker_hosts

string

Daemon socket(s) to connect to

docker_http_proxy

string

Set the Docker service to use HTTP_PROXY

docker_https_proxy

string

Set the Docker service to use HTTPS_PROXY

docker_icc

string

Enable inter-container communication

docker_insecure_registries

string

Enable insecure registry communication

docker_ip

string

Default IP when binding container ports

docker_ip_forward

string

Enable net.ipv4.ip_forward

docker_ip_masq

string

Enable IP masquerading

docker_iptables

string

Enable addition of iptables rules

docker_ipv6

string

Enable IPv6 networking

docker_labels

string

Set key=value labels to the daemon

docker_live_restore

string

Enables keeping containers alive during daemon downtime

docker_log_driver

string

Default driver for container logs

docker_log_level

string

Set the logging level

docker_log_opts

string

Default log driver options for containers

docker_max_concurrent_downloads

string

Set the max concurrent downloads for each pull

docker_max_concurrent_uploads

string

Set the max concurrent uploads for each push

docker_mount_opts

string

The mount options when mounting filesystems

docker_mtu

string

Set the containers network MTU

docker_no_proxy_params

string

Do not proxy for Docker service params

docker_oom_score_adjust

string

Set the oom_score_adj for the daemon

docker_pidfile

string

Path to use for daemon PID file

docker_raw_logs

string

Full timestamps without ANSI coloring

docker_registry_mirrors

string

Preferred Docker registry mirror

docker_repo

string

Defines how Ansible manages the repository

Options are other and docker

Default: "docker"

docker_runtimes

string

Register an additional OCI compatible runtime

docker_selinux_enabled

string

Enable selinux support

docker_storage_driver

string

Storage driver to use

docker_storage_opts

string

Storage driver options

docker_swarm_default_advertise_addr

string

Set default address or interface for swarm advertised address

docker_tls

string

Use TLS; implied by –tlsverify

docker_tlscacert

string

Trust certs signed only by this CA

docker_tlscert

string

Path to TLS certificate file

docker_tlskey

string

Path to TLS key file

docker_tlsverify

string

Use TLS and verify the remote

docker_userland_proxy

string

Use userland proxy for loopback traffic

docker_userns_remap

string

User/Group setting for user namespaces

docker_users

string

A list of system users to be added to the docker group (so they can use Docker on the server)

Authors

  • Eric Anderson