Ansible Role: docker

This role will fully configure and install dockerd.

I have transferred this role to its own collection.
In future, I will not accept or process any further pull requests or issues here.

Please use the linked collection from now on!

Requirements & Dependencies

Ansible Collections

• bodsch.core

ansible-galaxy collection install bodsch.core

or

ansible-galaxy collection install --requirements-file collections.yml

• Connectivity to docker-ce package repository

Operating systems

Tested on

• ArchLinux
• ArtixLinux
• Debian based
  • Debian 10 / 11
  • Ubuntu 20.04 / 22.04

RedHat-based systems are no longer officially supported! May work, but does not have to.

Role Variables

The following variables can be used to customize the docker installation:

## choose centos docker repo channel enable status
docker_repo:
  channel:
    stable_enabled: true
    test_enabled: false
    nightly_enabled: false

## state of package (present, absent, etc.)
docker_state: present

## should docker daemon start on boot?
docker_service:
  enable: true
  ## name of docker service
  name: docker

## install docker-compose in version
docker_compose: {}
# as example:
# docker_compose:
#   install: true
#   version: 1.29.2

docker_users: []

docker_plugins: []

docker_client_config: []

docker_config: {}

docker_config_diff: true

docker_python_packages: []

Proxy related

should docker daemon use a proxy for outbound connections?

docker_proxy:
  enabled: false
  ## list of env variables we should set (comment out the ones you don't need)
  env:
    - "HTTP_PROXY=http://proxy.example.com:80/"
    - "HTTP_PROXY=https://proxy.example.com:443/"
    - "NO_PROXY=localhost,127.0.0.1,internalhub.example.com"

docker client configuration

Enable authentication for the Docker Registry.
Here it is possible to create a configuration for different users.
The password stored here is base64 encoded and not encrypted!
The creation of a corresponding string can be carried out as follows:

echo "jenkins$robot:rubbel-die-katz-du-dummschwätzer1" | base64
amVua2luczpydWJiZWwtZGllLWthdHotZHUtZHVtbXNjaHfDpHR6ZXIxCg==

docker_client_config:
  ## the location we should push client configuration
  - location: "/root/.docker/config.json"
    enabled: false
    auths:
      registry.gitfoo.tld:
        auth: amVua2luczpydWJiZWwtZGllLWthdHotZHUtZHVtbXNjaHfDpHR6ZXIxCg==

Alternatively, you can also enter your username and password.
The Ansible module will make a valid Base64 encoded string out of it.

docker_client_config:
    ## the location we should push client configuration
  - location: "/var/tmp/foo/config.json"
    enabled: false
    auths:
      "test.tld":
        username: "FOO-was-sonst"
        passwort: "ja-toll-schon-wieder-alles-scheisse!"

Since version 3.1.0 it is now also possible to configure the output format of docker ps or docker image. Here the fed parameters have to be defined as a list:

docker_client_config:
  ## the location we should push client configuration
  - location: "/root/.docker/config.json"
    enabled: false
    auths:
      registry.gitfoo.tld:
        auth: amVua2luczpydWJiZWwtZGllLWthdHotZHUtZHVtbXNjaHfDpHR6ZXIxCg==
    formats:
      ps:
        - ".ID"
        - ".Names"
        - ".Status"
        - ".Labels"
        - ".RunningFor"
        - ".Ports"
      images:
        - ".ID"
        - ".Size"
        - ".Repository"
        - ".Tag"
        - ".CreatedAt"

default dockerd configuration options

configuration reference

currently supported options:

Examples

docker_config:
  log_driver: ""
  log_opts: {}
  #  env: "os,customer"
  #  "max-file": "5"
  #  "max-size": "10m"
  max_concurrent_downloads: 3
  max_concurrent_uploads: 5
  debug: false
  log_level: ""
  bridge: ""
  bip: "172.16.0.1/24"
  fixed_cidr: "172.16.0.0/24"
  fixed_cidr_v6: ""
  default_gateway: ""
  default_gateway_v6: ""
  selinux_enabled: false
  experimental: false
  ip: "0.0.0.0"
  group: "{{ docker_group }}"
  insecure_registries: []

When creating the configuration, a diff to the original version can optionally be created and output.

To do this, the variable docker_config_diff must be set to true.

There are more examples in the molecule tests:

• default
• dockerd-with-plugin
• dockerd-with-tls
• update-config

docker_users options

Adds an existing user to the docker group.

Furthermore, it tries to set the access rights to the docker socker by means of setfacl.

docker_users:
  - jenkins

docker_plugins options

Install and activate custom plugins.

(Currently only tested with Loki!)

docker_plugins:
  - alias: loki
    source: grafana/loki-docker-driver
    version: 2.7.0
    state: present

python Support

Some of the modules in this role require suitable python extensions.
In recent times, there have been a few incompatibilities here, which is why this point is now also configurable.

The default configuration is as follows:

docker_python_packages:
  - name: docker
  - name: requests
  - name: urllib3

If other pip module versions are installed here, you can overwrite these defaults.
It is possible to add versions to each module:

docker_python_packages:
  - name: docker
    version: 6.1.1

If a version is specified, an attempt will be made to install exactly this version.
However, there is also the possibility to influence this behaviour via compare_direction.

docker_python_packages:
  - name: docker
    compare_direction: ">"
    version: 6.0.0

Or to define a corresponding window via versions:

docker_python_packages:
  - name: docker
  - name: requests
    versions:
      - ">= 2.27.0"
      - "< 2.29.0"
  - name: urllib3
    versions:
      - ">= 1.26.0"
      - "< 2.0.0"

Examples

Install latest docker stable release on your local centos server

- hosts: localhost
  roles:
     - role: docker

Install latest docker edge release on your local centos server

- hosts: localhost
  vars:
    docker_repo:
      channel:
        nightly_enabled: true
  roles:
     - role: docker

Advanced playbook with various variables applied

configuration reference

- hosts: localhost
  vars:
    docker_config:
      # store docker containers/images to /opt/docker
      data_root: /opt/docker
      # change default docker bridge subnet
      bip: 172.16.77.77/24
      # set default log driver to journald
      log_driver: journald
      # enable experimental mode
      experimental: true
      # expose docker api over socket file and tcp
      hosts:
        - unix:///var/run/docker.sock
        - tcp://0.0.0.0:2376
      # set default search domains
      dns_search:
        - lab1.linuxctl.com
        - lab2.linuxctl.com
      # configure logging options
      log_opts:
        "max-size": 10m
        "max-file": "3"
        labels: molecule
        env: "os,customer"

  roles:
    - role: docker

Author and License

• original docker role written by:

  • George Bolo | linuxctl.com

• modified:

  • Bodo Schulz

License

MIT

FREE SOFTWARE, HELL YEAH!