README.md

@@ -1,6 +1,6 @@
 # Ansible Role: Docker
 
-[![CI](https://github.com/geerlingguy/ansible-role-docker/actions/workflows/ci.yml/badge.svg)](https://github.com/geerlingguy/ansible-role-docker/actions/workflows/ci.yml)
+[![CI](https://github.com/geerlingguy/ansible-role-docker/workflows/CI/badge.svg?event=push)](https://github.com/geerlingguy/ansible-role-docker/actions?query=workflow%3ACI)
 
 An Ansible Role that installs [Docker](https://www.docker.com) on Linux.
 
@@ -35,18 +35,11 @@ docker_obsolete_packages:
   - docker.io
   - docker-engine
   - docker-doc
-  - docker-compose
-  - docker-compose-v2
   - podman-docker
   - containerd
   - runc
 ```
 
-`docker_obsolete_packages` for different os-family:
-
-- [`RedHat.yaml`](./vars/RedHat.yml)
-- [`Debian.yaml`](./vars/Debian.yml)
-
 A list of packages to be uninstalled prior to running this role. See [Docker's installation instructions](https://docs.docker.com/engine/install/debian/#uninstall-old-versions) for an up-to-date list of old packages that should be removed.
 
 ```yaml
@@ -68,8 +61,8 @@ Docker Compose Plugin installation options. These differ from the below in that
 
 ```yaml
 docker_install_compose: false
-docker_compose_version: "v2.32.1"
+docker_compose_version: "2.29.2"
-docker_compose_arch: "{{ ansible_facts.architecture }}"
+docker_compose_arch: "{{ ansible_architecture }}"
 docker_compose_url: "https://github.com/docker/compose/releases/download/{{ docker_compose_version }}/docker-compose-linux-{{ docker_compose_arch }}"
 docker_compose_path: /usr/local/bin/docker-compose
 ```
@@ -90,10 +83,10 @@ The main Docker repo URL, common between Debian and RHEL systems.
 
 ```yaml
 docker_apt_release_channel: stable
-docker_apt_arch: "{{ 'arm64' if ansible_facts.architecture == 'aarch64' else 'amd64' }}"
+docker_apt_arch: "{{ 'arm64' if ansible_architecture == 'aarch64' else 'amd64' }}"
-docker_apt_repository: "deb [arch={{ docker_apt_arch }}{{' signed-by=/etc/apt/keyrings/docker.asc' if add_repository_key is not failed}}] {{ docker_repo_url }}/{{ ansible_facts.distribution | lower }} {{ ansible_facts.distribution_release }} {{ docker_apt_release_channel }}"
+docker_apt_repository: "deb [arch={{ docker_apt_arch }}] {{ docker_repo_url }}/{{ ansible_distribution | lower }} {{ ansible_distribution_release }} {{ docker_apt_release_channel }}"
 docker_apt_ignore_key_error: True
-docker_apt_gpg_key: "{{ docker_repo_url }}/{{ ansible_facts.distribution | lower }}/gpg"
+docker_apt_gpg_key: "{{ docker_repo_url }}/{{ ansible_distribution | lower }}/gpg"
 docker_apt_filename: "docker"
 ```
 
@@ -103,10 +96,10 @@ You can change `docker_apt_gpg_key` to a different url if you are behind a firew
 Usually in combination with changing `docker_apt_repository` as well. `docker_apt_filename` controls the name of the source list file created in `sources.list.d`. If you are upgrading from an older (<7.0.0) version of this role, you should change this to the name of the existing file (e.g. `download_docker_com_linux_debian` on Debian) to avoid conflicting lists.
 
 ```yaml
-docker_yum_repo_url: "{{ docker_repo_url }}/{{ (ansible_facts.distribution == 'Fedora') | ternary('fedora','centos') }}/docker-{{ docker_edition }}.repo"
+docker_yum_repo_url: "{{ docker_repo_url }}/{{ (ansible_distribution == 'Fedora') | ternary('fedora','centos') }}/docker-{{ docker_edition }}.repo"
 docker_yum_repo_enable_nightly: '0'
 docker_yum_repo_enable_test: '0'
-docker_yum_gpg_key: "{{ docker_repo_url }}/{{ (ansible_facts.distribution == 'Fedora') | ternary('fedora', 'centos') }}/gpg"
+docker_yum_gpg_key: "{{ docker_repo_url }}/centos/gpg"
 ```
 
 (Used only for RedHat/CentOS.) You can enable the Nightly or Test repo by setting the respective vars to `1`.

defaults/main.yml

@@ -13,8 +13,6 @@ docker_obsolete_packages:
   - docker.io
   - docker-engine
   - docker-doc
-  - docker-compose
-  - docker-compose-v2
   - podman-docker
   - containerd
   - runc
@@ -32,8 +30,8 @@ docker_compose_package_state: present
 
 # Docker Compose options.
 docker_install_compose: false
-docker_compose_version: "v2.32.1"
+docker_compose_version: "v2.29.2"
-docker_compose_arch: "{{ ansible_facts.architecture }}"
+docker_compose_arch: "{{ ansible_architecture }}"
 docker_compose_url: "https://github.com/docker/compose/releases/download/{{ docker_compose_version }}/docker-compose-linux-{{ docker_compose_arch }}"
 docker_compose_path: /usr/local/bin/docker-compose
 
@@ -47,19 +45,19 @@ docker_repo_url: https://download.docker.com/linux
 docker_apt_release_channel: stable
 # docker_apt_ansible_distribution is a workaround for Ubuntu variants which can't be identified as such by Ansible,
 # and is only necessary until Docker officially supports them.
-docker_apt_ansible_distribution: "{{ 'ubuntu' if ansible_facts.distribution in ['Pop!_OS', 'Linux Mint'] else ansible_facts.distribution }}"
+docker_apt_ansible_distribution: "{{ 'ubuntu' if ansible_distribution in ['Pop!_OS', 'Linux Mint'] else ansible_distribution }}"
-docker_apt_arch: "{{ 'arm64' if ansible_facts.architecture == 'aarch64' else 'armhf' if ansible_facts.architecture == 'armv7l' else 'amd64' }}"
+docker_apt_arch: "{{ 'arm64' if ansible_architecture == 'aarch64' else 'armhf' if ansible_architecture == 'armv7l' else 'amd64' }}"
-docker_apt_repository: "deb [arch={{ docker_apt_arch }} signed-by=/etc/apt/keyrings/docker.asc] {{ docker_repo_url }}/{{ docker_apt_ansible_distribution | lower }} {{ ansible_facts.distribution_release }} {{ docker_apt_release_channel }}"
+docker_apt_repository: "deb [arch={{ docker_apt_arch }} signed-by=/etc/apt/keyrings/docker.asc] {{ docker_repo_url }}/{{ docker_apt_ansible_distribution | lower }} {{ ansible_distribution_release }} {{ docker_apt_release_channel }}"
 docker_apt_ignore_key_error: true
 docker_apt_gpg_key: "{{ docker_repo_url }}/{{ docker_apt_ansible_distribution | lower }}/gpg"
 docker_apt_gpg_key_checksum: "sha256:1500c1f56fa9e26b9b8f42452a553675796ade0807cdce11975eb98170b3a570"
 docker_apt_filename: "docker"
 
 # Used only for RedHat/CentOS/Fedora.
-docker_yum_repo_url: "{{ docker_repo_url }}/{{ (ansible_facts.distribution == 'Fedora') | ternary('fedora','centos') }}/docker-{{ docker_edition }}.repo"
+docker_yum_repo_url: "{{ docker_repo_url }}/{{ (ansible_distribution == 'Fedora') | ternary('fedora','centos') }}/docker-{{ docker_edition }}.repo"
 docker_yum_repo_enable_nightly: '0'
 docker_yum_repo_enable_test: '0'
-docker_yum_gpg_key: "{{ docker_repo_url }}/{{ (ansible_facts.distribution == 'Fedora') | ternary('fedora', 'centos') }}/gpg"
+docker_yum_gpg_key: "{{ docker_repo_url }}/centos/gpg"
 
 # A list of users who will be added to the docker group.
 docker_users: []

handlers/main.yml

@@ -1,11 +1,7 @@
 ---
 - name: restart docker
-  ansible.builtin.service:
+  service:
     name: docker
     state: "{{ docker_restart_handler_state }}"
   ignore_errors: "{{ ansible_check_mode }}"
   when: docker_service_manage | bool
-
-- name: apt update
-  ansible.builtin.apt:
-    update_cache: true

molecule/default/converge.yml

@@ -1,12 +1,12 @@
 ---
 - name: Converge
   hosts: all
-  # become: true
+  become: true
 
   pre_tasks:
     - name: Update apt cache.
       apt: update_cache=yes cache_valid_time=600
-      when: ansible_facts.os_family == 'Debian'
+      when: ansible_os_family == 'Debian'
 
     - name: Wait for systemd to complete initialization.  # noqa 303
       command: systemctl is-system-running
@@ -16,7 +16,7 @@
         'degraded' in systemctl_status.stdout
       retries: 30
       delay: 5
-      when: ansible_facts.service_mgr == 'systemd'
+      when: ansible_service_mgr == 'systemd'
       changed_when: false
       failed_when: systemctl_status.rc > 1
 

molecule/default/verify.yml

@@ -1,51 +0,0 @@
----
-- name: Verify Docker Role
-  hosts: all
-  tasks:
-    - name: Verify Docker binary is available
-      command: docker version
-      register: docker_version_result
-      changed_when: false
-      failed_when: docker_version_result.rc != 0
-
-    - name: Show Docker version details
-      debug:
-        msg: >
-          Docker Version Output:
-          {{ docker_version_result.stdout_lines | join('\n') }}
-
-    - name: Verify Docker service is running
-      command: systemctl is-active docker
-      register: docker_service_status
-      when: ansible_facts.service_mgr == 'systemd'
-      changed_when: false
-      failed_when: docker_service_status.stdout.strip() != "active"
-
-    - name: Display Docker service status
-      debug:
-        msg: "Docker service is {{ docker_service_status.stdout.strip() }}"
-      when: ansible_facts.service_mgr == 'systemd'
-
-    - name: Pull the 'hello-world' image
-      command: docker pull hello-world
-      register: docker_pull_result
-      changed_when: true
-      failed_when: docker_pull_result.rc != 0
-
-    - name: Show result of pulling the 'hello-world' image
-      debug:
-        msg: >
-          Pulling 'hello-world' completed with output:
-          {{ docker_pull_result.stdout_lines | join('\n') }}
-
-    - name: Run a test container (hello-world)
-      command: docker run --rm hello-world
-      register: docker_run_result
-      changed_when: true
-      failed_when: docker_run_result.rc != 0
-
-    - name: Display test container output
-      debug:
-        msg: >
-          Running 'hello-world' container completed with output:
-          {{ docker_run_result.stdout_lines | join('\n') }}

tasks/main.yml

@@ -4,17 +4,17 @@
   vars:
     params:
       files:
-        - '{{ansible_facts.distribution}}.yml'
+        - '{{ansible_distribution}}.yml'
-        - '{{ansible_facts.os_family}}.yml'
+        - '{{ansible_os_family}}.yml'
         - main.yml
       paths:
         - 'vars'
 
 - include_tasks: setup-RedHat.yml
-  when: ansible_facts.os_family == 'RedHat'
+  when: ansible_os_family == 'RedHat'
 
 - include_tasks: setup-Debian.yml
-  when: ansible_facts.os_family == 'Debian'
+  when: ansible_os_family == 'Debian'
 
 - name: Install Docker packages.
   package:
@@ -22,7 +22,7 @@
     state: "{{ docker_packages_state }}"
   notify: restart docker
   ignore_errors: "{{ ansible_check_mode }}"
-  when: "ansible_version.full is version_compare('2.12', '<') or ansible_facts.os_family not in ['RedHat', 'Debian']"
+  when: "ansible_version.full is version_compare('2.12', '<') or ansible_os_family not in ['RedHat', 'Debian']"
 
 - name: Install Docker packages (with downgrade option).
   package:
@@ -31,7 +31,7 @@
     allow_downgrade: true
   notify: restart docker
   ignore_errors: "{{ ansible_check_mode }}"
-  when: "ansible_version.full is version_compare('2.12', '>=') and ansible_facts.os_family in ['RedHat', 'Debian']"
+  when: "ansible_version.full is version_compare('2.12', '>=') and ansible_os_family in ['RedHat', 'Debian']"
 
 - name: Install docker-compose plugin.
   package:
@@ -39,7 +39,7 @@
     state: "{{ docker_compose_package_state }}"
   notify: restart docker
   ignore_errors: "{{ ansible_check_mode }}"
-  when: "docker_install_compose_plugin | bool == true and (ansible_version.full is version_compare('2.12', '<') or ansible_facts.os_family not in ['RedHat', 'Debian'])"
+  when: "docker_install_compose_plugin | bool == true and (ansible_version.full is version_compare('2.12', '<') or ansible_os_family not in ['RedHat', 'Debian'])"
 
 - name: Install docker-compose-plugin (with downgrade option).
   package:
@@ -48,7 +48,7 @@
     allow_downgrade: true
   notify: restart docker
   ignore_errors: "{{ ansible_check_mode }}"
-  when: "docker_install_compose_plugin | bool == true and ansible_version.full is version_compare('2.12', '>=') and ansible_facts.os_family in ['RedHat', 'Debian']"
+  when: "docker_install_compose_plugin | bool == true and ansible_version.full is version_compare('2.12', '>=') and ansible_os_family in ['RedHat', 'Debian']"
 
 - name: Ensure /etc/docker/ directory exists.
   file:

tasks/setup-Debian.yml

@@ -4,40 +4,58 @@
     path: /etc/apt/trusted.gpg.d/docker.asc
     state: absent
 
-- name: Ensure old apt source list is not present in /etc/apt/sources.list.d
+- name: Ensure the repo referencing the previous trusted.gpg.d key is not present
-  ansible.builtin.file:
+  apt_repository:
-    path: "/etc/apt/sources.list.d/download_docker_com_linux_{{ docker_apt_ansible_distribution | lower }}.list"
+    repo: "deb [arch={{ docker_apt_arch }} signed-by=/etc/apt/trusted.gpg.d/docker.asc] {{ docker_repo_url }}/{{ docker_apt_ansible_distribution | lower }} {{ ansible_distribution_release }} {{ docker_apt_release_channel }}"
     state: absent
+    filename: "{{ docker_apt_filename }}"
+    update_cache: true
+  when: docker_add_repo | bool
 
-# See https://docs.docker.com/engine/install/debian/#uninstall-old-versions
+- # See https://docs.docker.com/engine/install/debian/#uninstall-old-versions
-- name: Ensure old versions of Docker are not installed.
+  name: Ensure old versions of Docker are not installed.
-  ansible.builtin.package:
+  package:
     name: "{{ docker_obsolete_packages }}"
     state: absent
 
-- name: Ensure legacy repo file is not present.
-  ansible.builtin.file:
-    path: "/etc/apt/sources.list.d/docker.list"
-    state: absent
-
 - name: Ensure dependencies are installed.
-  ansible.builtin.apt:
+  apt:
     name:
       - apt-transport-https
       - ca-certificates
-      - python3-debian
     state: present
+  when: docker_add_repo | bool
 
-- name: Add or remove Docker repository.
+- name: Ensure directory exists for /etc/apt/keyrings
-  ansible.builtin.deb822_repository:
+  file:
-    name: docker
+    path: /etc/apt/keyrings
-    types: deb
+    state: directory
-    uris: "{{ docker_repo_url }}/{{ ansible_facts.distribution | lower }}"
+    mode: '0755'
-    suites: "{{ ansible_facts.distribution_release }}"
-    components: "{{ docker_apt_release_channel }}"
-    signed_by: "{{ docker_apt_gpg_key }}"
-    state: "{{ 'present' if docker_add_repo | bool else 'absent' }}"
-  notify: apt update
 
-- name: Ensure handlers are notified immediately to update the apt cache.
+- name: Add Docker apt key.
-  ansible.builtin.meta: flush_handlers
+  ansible.builtin.get_url:
+    url: "{{ docker_apt_gpg_key }}"
+    dest: /etc/apt/keyrings/docker.asc
+    mode: '0644'
+    force: false
+    checksum: "{{ docker_apt_gpg_key_checksum | default(omit) }}"
+  register: add_repository_key
+  ignore_errors: "{{ docker_apt_ignore_key_error }}"
+  when: docker_add_repo | bool
+
+- name: Ensure curl is present (on older systems without SNI).
+  package: name=curl state=present
+  when: add_repository_key is failed and docker_add_repo | bool
+
+- name: Add Docker apt key (alternative for older systems without SNI).
+  shell: >
+    curl -sSL {{ docker_apt_gpg_key }} | apt-key add -
+  when: add_repository_key is failed and docker_add_repo | bool
+
+- name: Add Docker repository.
+  apt_repository:
+    repo: "{{ docker_apt_repository }}"
+    state: present
+    filename: "{{ docker_apt_filename }}"
+    update_cache: true
+  when: docker_add_repo | bool

tasks/setup-RedHat.yml

@@ -1,7 +1,10 @@
 ---
 - name: Ensure old versions of Docker are not installed.
   package:
-    name: "{{ docker_obsolete_packages }}"
+    name:
+      - docker
+      - docker-common
+      - docker-engine
     state: absent
 
 - name: Add Docker GPG key.
@@ -55,4 +58,4 @@
       package:
         name: containerd.io
         state: present
-  when: ansible_facts.distribution_major_version | int == 8
+  when: ansible_distribution_major_version | int == 8

vars/Alpine.yml

@@ -1,3 +1,2 @@
 ---
 docker_packages: "docker"
-docker_compose_package: docker-cli-compose

vars/Debian.yml

@@ -1,14 +0,0 @@
----
-# Used only for Debian/Ubuntu (Debian OS-Family)
-# https://docs.docker.com/engine/install/debian/#uninstall-old-versions
-
-docker_obsolete_packages:
-  - docker
-  - docker.io
-  - docker-engine
-  - docker-doc
-  - docker-compose
-  - docker-compose-v2
-  - podman-docker
-  - containerd
-  - runc

vars/RedHat.yml

@@ -1,14 +0,0 @@
----
-# Used only for Fedora/Rocky (RedHat OS-Family)
-# https://docs.docker.com/engine/install/fedora/#uninstall-old-versions
-# https://docs.docker.com/engine/install/centos/#uninstall-old-versions
-
-docker_obsolete_packages:
-  - docker
-  - docker-client
-  - docker-client-latest
-  - docker-common
-  - docker-latest
-  - docker-latest-logrotate
-  - docker-logrotate
-  - docker-engine