WIP: feat(docker): add support for redhat targets

galaxy.yml

@@ -18,3 +18,4 @@ tags:
   - minio
   - nginx
   - restic
+  - docker

playbooks/bootstrap.yml

@@ -0,0 +1,78 @@
+---
+- name: Bootstrap everything needed for an ansible connection
+  hosts: "{{ target_hosts | default('all', true) }}"
+  become: "{{ target_host_become | default(true, false) }}"
+  gather_facts: false
+  pre_tasks:
+    - name: Gather information about the target system id
+      ansible.builtin.raw: "cat /etc/os-release | grep '^ID=' | cut -d '=' -f2"
+      register: target_host_os_info
+      check_mode: false
+      changed_when: false
+    - name: Set /etc/os-release system id
+      ansible.builtin.set_fact:
+        target_host_system_id: "{{ target_host_os_info.stdout_lines | first | trim }}"
+      delegate_to: localhost
+    - name: Gather information about the target system version
+      ansible.builtin.raw: "cat /etc/os-release | grep '^VERSION_ID=' | cut -d '=' -f2"
+      register: target_host_os_info_version
+      check_mode: false
+      changed_when: false
+    - name: Set /etc/os-release system version id
+      ansible.builtin.set_fact:
+        target_host_system_version_id: "{{ target_host_os_info_version.stdout_lines | first | trim }}"
+      delegate_to: localhost
+
+  tasks:
+    - name: Ensure apt bootstrap packages are installed
+      ansible.builtin.raw: "apt install {{ apt_bootstrap_packages | join(' ') }}"
+      register: target_host_apt_info
+      when: target_host_system_id in targets_using_apt
+      changed_when:
+        - "'0 upgraded' not in target_host_apt_info.stdout_lines | last"
+        - "'0 newly installed' not in target_host_apt_info.stdout_lines | last"
+    - name: Ensure dnf < 4 bootstrap packages are installed
+      ansible.builtin.raw: "dnf install --assumeyes {{ dnf4_bootstrap_packages | join(' ') }}"
+      register: target_host_dnf_info
+      when:
+        - target_host_system_id in targets_using_dnf4.keys()
+        - target_host_system_version_id | int < targets_using_dnf4[target_host_system_id]
+      changed_when:
+        - "(target_host_dnf_info.stdout_lines | last) != 'Nothing to do.'"
+    - name: Ensure dnf5 bootstrap packages are installed
+      ansible.builtin.raw: "dnf install --assumeyes {{ dnf5_bootstrap_packages | join(' ') }}"
+      register: target_host_dnf_info
+      when:
+        - target_host_system_id in targets_using_dnf5.keys()
+        - target_host_system_version_id | int >= targets_using_dnf5[target_host_system_id]
+      changed_when:
+        - "(target_host_dnf_info.stdout_lines | last) != 'Nothing to do.'"
+    - name: Sort hosts into os-specific groups
+      ansible.builtin.group_by:
+        key: >-2
+          {{ (os_group_prefix
+             | default(false, true)
+             | ternary(os_group_prefix | default('') + (os_group_seperator | default('_')), ''))
+             + target_host_system_id }}
+      when: target_hosts_sort_into_system_ids | default(false, true)
+      changed_when: false
+      delegate_to: localhost
+  vars:
+    targets_using_apt:
+      - debian
+      - ubuntu
+    apt_bootstrap_packages:
+      - python3
+      - python3-apt
+    # default package manager is dnf5 since fedora 41
+    # https://fedoraproject.org/wiki/Changes/SwitchToDnf5#Current_status
+    targets_using_dnf4:
+      fedora: 41
+    targets_using_dnf5:
+      fedora: 41
+    dnf4_bootstrap_packages:
+      - python3
+      - python3-dnf
+      - python3-libdnf
+    dnf5_bootstrap_packages:
+      - python3-libdnf5

playbooks/docker.yml

@@ -0,0 +1,6 @@
+---
+- name: Install and configure docker daemon
+  hosts: "{{ docker_hosts | default('docker', true) }}"
+  become: "{{ docker_become | default(false, true) }}"
+  roles:
+    - role: finallycoffee.base.docker

playbooks/packages.yml

@@ -0,0 +1,24 @@
+---
+- name: Install system packages on the remote
+  hosts: "{{ target_hosts | default('all', true) }}"
+  become: "{{ target_host_become | default(true, true) }}"
+  gather_facts: "{{ target_host_gather_facts | default(true, true) }}"
+  tasks:
+    - name: Install packages (apt)
+      ansible.builtin.apt:
+        package: "{{ package.name }}"
+        state: "{{ package.state | default('present') }}"
+      loop: "{{ system_packages | default([], true) }}"
+      loop_control:
+        loop_var: package
+        label: "{{ package.name }}"
+      when: ansible_facts['pkg_mgr'] == 'apt'
+    - name: Install packages (dnf)
+      ansible.builtin.dnf:
+        name: "{{ package.name }}"
+        state: "{{ package.state | default('present') }}"
+      loop: "{{ system_packages | default([], true) }}"
+      loop_control:
+        loop_var: package
+        label: "{{ package.name }}"
+      when: ansible_facts['pkg_mgr'] in ['dnf', 'dnf5', 'yum']

roles/docker/README.md

@@ -0,0 +1,13 @@
+# `finallycoffee.base.docker` ansible role
+
+Install and configure the docker daemon.
+
+## Configuration
+
+- `docker_daemon_config` - configuration for the docker daemon
+- `docker_remove_legacy_packages` - clean up old versions of docker (see https://docs.docker.com/engine/install/debian/#uninstall-old-versions)
+
+## Plugins
+
+- `docker_plugin_buildx_enable` - enable the buildx plugin
+- `docker_plugin_compose_enable` - enable docker compose

roles/docker/defaults/main/debian.yml

@@ -0,0 +1,31 @@
+---
+docker_apt_key_url: "https://download.docker.com/linux/debian/gpg"
+docker_apt_key_id: "9DC858229FC7DD38854AE2D88D81803C0EBFCD88"
+
+docker_apt_arch: amd64
+docker_apt_release_channel: stable
+docker_apt_repository_url: "https://download.docker.com/linux/debian"
+docker_apt_repository: >-2
+  deb [arch={{ docker_apt_arch }}] {{ docker_apt_repository_url }} {{ ansible_distribution_release }} {{ docker_apt_release_channel }}
+docker_apt_cli_package: "docker-ce-cli"
+docker_apt_plugin_buildx_package: "docker-buildx-plugin"
+docker_apt_plugin_compose_package: "docker-compose-plugin"
+docker_apt_base_packages:
+  - "docker-ce"
+  - "docker-ce-cli"
+  - "containerd.io"
+docker_apt_packages: >-2
+  {{
+    docker_apt_base_packages
+    + (docker_plugin_buildx_enable | default(false)
+      | ternary([ docker_apt_plugin_buildx_package ], []))
+    + (docker_plugin_compose_enable | default(false)
+      | ternary([ docker_apt_plugin_compose_package ], []))
+  }}
+docker_apt_legacy_packages:
+  - "docker.io"
+  - "docker-compose"
+  - "docker-doc"
+  - "podman-docker"
+  - "containerd"
+  - "runc"

roles/docker/defaults/main/fedora.yml

@@ -0,0 +1,34 @@
+---
+docker_fedora_repo_name: "docker-ce-stable"
+docker_fedora_repo_description: "Docker CE Stable - $basearch"
+docker_fedora_repo_url: "https://download.docker.com/linux/fedora/$releasever/$basearch/stable"
+docker_fedora_repo_validate_certs: true
+docker_fedora_repo_gpg_check: true
+docker_fedora_repo_gpg_key: "https://download.docker.com/linux/fedora/gpg"
+
+docker_fedora_cli_package: "docker-ce-cli"
+docker_fedora_plugin_buildx_package: "docker-buildx-plugin"
+docker_fedora_plugin_compose_package: "docker-compose-plugin"
+docker_fedora_base_packages:
+  - "docker-ce"
+  - "docker-ce-cli"
+  - "containerd.io"
+docker_fedora_packages: >-2
+  {{
+    docker_fedora_base_packages
+    + (docker_plugin_buildx_enable | default(false)
+      | ternary([ docker_fedora_plugin_buildx_package ], []))
+    + (docker_plugin_compose_enable | default(false)
+      | ternary([ docker_fedora_plugin_compose_package ], []))
+  }}
+docker_fedora_legacy_packages:
+  - "docker"
+  - "docker-client"
+  - "docker-client-latest"
+  - "docker-common"
+  - "docker-latest"
+  - "docker-latest-logrotate"
+  - "docker-logrotate"
+  - "docker-selinux"
+  - "docker-engine-selinux"
+  - "docker-engine"

roles/docker/defaults/main/main.yml

@@ -0,0 +1,13 @@
+---
+docker_state: "present"
+
+docker_daemon_config: {}
+docker_daemon_config_file: "/etc/docker/daemon.json"
+docker_daemon_config_file_mode: "0644"
+docker_daemon_config_owner: root
+docker_daemon_config_group: "{{ docker_daemon_config_owner }}"
+
+docker_plugin_buildx_enable: false
+docker_plugin_compose_enable: false
+
+docker_remove_legacy_packages: true

roles/docker/defaults/main/rhel.yml

@@ -0,0 +1,34 @@
+---
+docker_rhel_repo_name: "docker-ce-stable"
+docker_rhel_repo_description: "Docker CE Stable - $basearch"
+docker_rhel_repo_url: "https://download.docker.com/linux/rhel/$releasever/$basearch/stable"
+docker_rhel_repo_validate_certs: true
+docker_rhel_repo_gpg_check: true
+docker_rhel_repo_gpg_key: "https://download.docker.com/linux/rhel/gpg"
+
+docker_rhel_cli_package: "docker-ce-cli"
+docker_rhel_plugin_buildx_package: "docker-buildx-plugin"
+docker_rhel_plugin_compose_package: "docker-compose-plugin"
+docker_rhel_base_packages:
+  - "docker-ce"
+  - "docker-ce-cli"
+  - "containerd.io"
+docker_rhel_packages: >-2
+  {{
+    docker_fedora_base_packages
+    + (docker_plugin_buildx_enable | default(false)
+      | ternary([ docker_rhel_plugin_buildx_package ], []))
+    + (docker_plugin_compose_enable | default(false)
+      | ternary([ docker_rhel_plugin_compose_package ], []))
+  }}
+docker_rhel_legacy_packages:
+  - "docker"
+  - "docker-client"
+  - "docker-client-latest"
+  - "docker-common"
+  - "docker-latest"
+  - "docker-latest-logrotate"
+  - "docker-logrotate"
+  - "docker-engine"
+  - "podman"
+  - "runc"

roles/docker/defaults/main/systemd.yml

@@ -0,0 +1,5 @@
+---
+docker_systemd_service_name: "docker.service"
+docker_systemd_service_state: >-2
+  {{ (docker_state == 'present') | ternary('started', 'stopped') }}
+docker_systemd_service_enabled: "{{ (docker_state == 'present') }}"

roles/docker/handlers/main.yml

@@ -0,0 +1,6 @@
+---
+- name: Restart docker daemon
+  ansible.builtin.systemd_service:
+    name: "{{ docker_systemd_service_name }}"
+    state: "restarted"
+  listen: "docker-restart"

roles/docker/tasks/configure.yml

@@ -0,0 +1,18 @@
+---
+- name: Ensure config directory '{{ docker_daemon_config_file | dirname }}' is present
+  ansible.builtin.file:
+    path: "{{ docker_daemon_config_file | dirname }}"
+    state: "directory"
+    mode: "0755"
+    owner: "{{ docker_daemon_config_owner }}"
+    group: "{{ docker_daemon_config_group }}"
+
+- name: Configure docker daemon using '{{ docker_daemon_config_file }}'
+  ansible.builtin.copy:
+    content: "{{ docker_daemon_config | to_nice_json }}"
+    dest: "{{ docker_daemon_config_file }}"
+    mode: "{{ docker_daemon_config_file_mode }}"
+    owner: "{{ docker_daemon_config_owner }}"
+    group: "{{ docker_daemon_config_group }}"
+  when: docker_daemon_config | string | length > 0
+  notify: docker-restart

roles/docker/tasks/install-debian.yml

@@ -0,0 +1,30 @@
+---
+- name: Ensure legacy docker packages are removed
+  ansible.builtin.apt:
+    name: "{{ docker_apt_legacy_packages }}"
+    state: absent
+  when: docker_remove_legacy_packages
+
+- name: Add apt key for docker repository
+  ansible.builtin.apt_key:
+    id: "{{ docker_apt_key_id }}"
+    url: "{{ docker_apt_key_url }}"
+    state: "{{ docker_state }}"
+
+- name: Add apt repository for docker
+  ansible.builtin.apt_repository:
+    repo: "{{ docker_apt_repository }}"
+    state: "{{ docker_state }}"
+  register: docker_apt_repository_info
+
+- name: Update apt cache if repository was newly added
+  ansible.builtin.apt:
+    update_cache: true
+  when:
+    - docker_state == 'present'
+    - docker_apt_repository_info.changed
+
+- name: Install apt packages for docker
+  ansible.builtin.apt:
+    name: "{{ docker_apt_packages }}"
+    state: "{{ docker_state }}"

roles/docker/tasks/install-fedora.yml

@@ -0,0 +1,21 @@
+---
+- name: Ensure legacy docker packages are removed
+  ansible.builtin.dnf:
+    name: "{{ docker_fedora_legacy_packages }}"
+    state: "removed"
+  when: docker_remove_legacy_packages
+
+- name: Ensure dnf repository for docker is {{ docker_state }}
+  ansible.builtin.yum_repository:
+    name: "{{ docker_fedora_repo_name }}"
+    description: "{{ docker_fedora_repo_description }}"
+    baseurl: "{{ docker_fedora_repo_url }}"
+    validate_certs: "{{ docker_fedora_repo_validate_certs }}" 
+    gpgkey: "{{ docker_fedora_repo_gpg_key }}"
+    gpgcheck: "{{ docker_fedora_repo_gpg_check }}"
+    state: "{{ docker_state }}"
+
+- name: Install dnf packages for docker
+  ansible.builtin.dnf:
+    name: "{{ docker_fedora_packages }}"
+    state: "{{ docker_state }}"

roles/docker/tasks/install-redhat.yml

@@ -0,0 +1,21 @@
+---
+- name: Ensure legacy docker packages are removed
+  ansible.builtin.dnf:
+    name: "{{ docker_rhel_legacy_packages }}"
+    state: absent
+  when: docker_remove_legacy_packages
+
+- name: Add dnf repository for docker
+  ansible.builtin.yum_repository:
+    name: "{{ docker_rhel_repo_name }}"
+    description: "{{ docker_rhel_repo_description }}"
+    baseurl: "{{ docker_rhel_repo_url }}"
+    validate_certs: "{{ docker_rhel_repo_validate_certs }}"
+    gpgkey: "{{ docker_rhel_repo_gpg_key }}"
+    gpgcheck: "{{ docker_rhel_repo_gpg_check }}"
+    state: "{{ docker_state }}"
+
+- name: Install dnf packages for docker
+  ansible.builtin.dnf:
+    name: "{{ docker_rhel_packages }}"
+    state: "{{ docker_state }}"

roles/docker/tasks/main.yml

@@ -0,0 +1,29 @@
+---
+- name: Check if target OS is supported
+  ansible.builtin.fail:
+    msg: >-2
+      OS '{{ docker_os }}' is not supported!
+  when: docker_os not in docker_supported_oses
+  vars:
+    docker_os: "{{ ansible_distribution | lower }}"
+
+- name: Ensure docker is {{ docker_state }} on {{ ansible_distribution }}
+  ansible.builtin.include_tasks:
+    file: "install-{{ ansible_distribution | lower }}.yml"
+
+- name: Configure docker daemon
+  ansible.builtin.include_tasks:
+    file: "configure.yml"
+  when: docker_state == 'present'
+
+- name: Ensure docker daemon is {{ docker_systemd_service_enabled | ternary('enabled', 'disabled') }}
+  ansible.builtin.systemd_service:
+    name: "{{ docker_systemd_service_name }}"
+    enabled: "{{ docker_systemd_service_enabled }}"
+  when: ansible_facts['service_mgr'] == 'systemd'
+
+- name: Ensure docker daemon is {{ docker_systemd_service_state }}
+  ansible.builtin.systemd_service:
+    name: "{{ docker_systemd_service_name }}"
+    state: "{{ docker_systemd_service_state }}"
+  when: ansible_facts['service_mgr'] == 'systemd'

roles/docker/vars/main.yml

@@ -0,0 +1,6 @@
+---
+docker_supported_oses:
+  - 'debian'
+  - 'fedora'
+docker_supported_os_families:
+  - 'rhel'