Add support to docker-compose (#65)

Author: atosatto

.yamllint

@@ -1,33 +1,18 @@
 ---
-# Based on ansible-lint config
+
 extends: default
 
 rules:
+
+  # Disable line-length and truthy values reporting
+  line-length: disable
+  truthy: disable
+
+  # Max 1 space to separate the elements in brakets
   braces:
     max-spaces-inside: 1
-    level: error
+
+  # Max 1 space in empty brackets
   brackets:
-    max-spaces-inside: 1
-    level: error
-  colons:
-    max-spaces-after: -1
-    level: error
-  commas:
-    max-spaces-after: -1
-    level: error
-  comments: disable
-  comments-indentation: disable
-  document-start: disable
-  empty-lines:
-    max: 3
-    level: error
-  hyphens:
-    level: error
-  indentation: disable
-  key-duplicates: enable
-  line-length: disable
-  new-line-at-end-of-file: disable
-  new-lines:
-    type: unix
-  trailing-spaces: disable
-  truthy: disable
+    min-spaces-inside-empty: 0
+    max-spaces-inside-empty: 1

README.md

@@ -6,13 +6,15 @@ Ansible Role: Docker
 [![Ansible Role](http://img.shields.io/badge/galaxy-atosatto.docker--swarm-blue.svg?style=flat-square)](https://galaxy.ansible.com/atosatto/docker-swarm)
 [![GitHub tag](https://img.shields.io/github/tag/atosatto/ansible-dockerswarm.svg)](https://github.com/atosatto/ansible-dockerswarm/tags)
 
-Setup Docker on RHEL/CentOS and Debian/Ubuntu servers.
+Setup Docker on RHEL/CentOS and Debian/Ubuntu servers. <br />
 The role supports Docker Engine's "Swarm Mode" (https://docs.docker.com/engine/swarm/) to create a cluster of Docker nodes.
 
 Requirements
 ------------
 
 An Ansible 2.7 or higher installation.
+This role makes use of the Ansible `json_filter` that requires `jmespath` to be installed on the Ansible machine.
+See the `requirements.txt` file for further details on the specific version of `jmespath` required by the role.
 
 Dependencies
 ------------
@@ -34,12 +36,12 @@ To skip the configuration of the repository and use the system repositories set
 
 Name of the package providing the Docker daemon.
 
-      docker_package_version: ""
+    docker_package_version: ""
 
 Version of the Docker package to be installed on the target hosts.
 When set to `""` the latest available version will be installed.
 
-      docker_package_state: present
+    docker_package_state: present
 
 Set it to `latest` to force the upgrade of the installed Docker packages.
 
@@ -92,6 +94,11 @@ the default containerd service definition.
 
 State of the containerd service.
 
+    docker_compose_version: ""
+
+Version of docker-compose to be installed via python-pip.
+When set to `""` the latest available version will be installed.
+
     docker_group_name: "docker"
     docker_group_users:
       - "{{ ansible_user }}"
@@ -118,6 +125,7 @@ Listen port for the Swarm raft API.
     skip_group: false
     skip_swarm: false
     skip_docker_py: false
+    skip_docker_compose: false
 
 Switches allowing to disable specific functionalities of the role.
 If you want to use this role to install `docker-engine` without enabling `swarm-mode` set `skip_swarm: true`.

defaults/main.yml

@@ -66,6 +66,14 @@ containerd_service_state: "started"
 # Whether the containerd service should start on boot
 containerd_service_enabled: "yes"
 
+##
+# Docker Compose
+##
+
+# Version of the docker-compose package to be installed.
+# By default, the latest available version will be installed.
+docker_compose_version: ""
+
 ##
 # Docker Users
 ##
@@ -102,3 +110,4 @@ skip_engine: false      # if true, skips the docker engine installation
 skip_group: false       # if true, does not add the docker_admin_users to the docker_group_name
 skip_swarm: false       # if true, skips the swarm setup
 skip_docker_py: false   # if true, skips the installation of docker-py
+skip_docker_compose: false  # if true, skips the installation of docker-compose

molecule/resources/tests/test_docker_compose.py

@@ -0,0 +1,15 @@
+import os
+import testinfra.utils.ansible_runner
+
+testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
+    os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all')
+
+
+def test_docker_compose_installed(host):
+
+    f = host.file('/usr/local/bin/docker-compose')
+
+    assert f.exists
+    assert f.user == 'root'
+    assert f.group == 'root'
+    assert f.mode == 0o755

molecule/swarm-singlenode/molecule.yml

@@ -41,4 +41,4 @@ verifier:
   additional_files_or_dirs:
     - ../../resources/tests/
   lint:
-    name: flake8   # Will use the rules defined in .flake8
+    name: flake8  # Will use the rules defined in .flake8

requirements.txt

@@ -0,0 +1 @@
+jmespath==0.9.3

tasks/main.yml

@@ -19,7 +19,8 @@
     name: "{{ item }}"
     state: present
   with_items: "{{ python_pip_packages }}"
-  when: (not skip_docker_py) or (ansible_os_family == 'Debian'
+  when: (not skip_docker_py) or (not skip_docker_compose)
+    or (ansible_os_family == 'Debian'
     and ansible_python_version is version_compare('2.6.0', '>=')
     and ansible_python_version is version_compare('2.7.9', '<'))
 
@@ -65,6 +66,10 @@
 - include_tasks: setup-docker-py.yml
   when: not skip_docker_py
 
+# Install docker-compose
+- include_tasks: setup-docker-compose.yml
+  when: not skip_docker_compose
+
 # Adds the Docker admin users to the Docker group
 - include_tasks: setup-docker-group.yml
   when: not skip_group

tasks/setup-containerd.yml

@@ -29,23 +29,23 @@
 
 - block:
 
-  - name: Create the systemd overrides directory for containerd.
-    file:
-      name: "/etc/systemd/system/containerd.service.d"
-      state: directory
-
-  - name: Override the systemd unit for containerd.
-    template:
-      src: containerd-override.conf.j2
-      dest: "/etc/systemd/system/containerd.service.d/override.conf"
-    register: _containerd_systemd_override
-
-  - name: Reload systemd and restart containerd.
-    service:
-      name: containerd
-      state: "{% if containerd_service_state != 'stopped' %}restarted{% else %}stopped{% endif %}"
-      daemon_reload: yes
-    when: _containerd_systemd_override.changed
+    - name: Create the systemd overrides directory for containerd.
+      file:
+        name: "/etc/systemd/system/containerd.service.d"
+        state: directory
+
+    - name: Override the systemd unit for containerd.
+      template:
+        src: containerd-override.conf.j2
+        dest: "/etc/systemd/system/containerd.service.d/override.conf"
+      register: _containerd_systemd_override
+
+    - name: Reload systemd and restart containerd.
+      service:
+        name: containerd
+        state: "{% if containerd_service_state != 'stopped' %}restarted{% else %}stopped{% endif %}"
+        daemon_reload: yes
+      when: _containerd_systemd_override.changed
 
   when: containerd_service_override | length > 0
     and ansible_service_mgr == 'systemd'

tasks/setup-docker-compose.yml

@@ -0,0 +1,25 @@
+---
+
+- block:
+
+  - name: Get information on the latest docker-compose release from Github.
+    uri:
+      url: "https://api.github.com/repos/docker/compose/releases/latest"
+      method: GET
+    register: _docker_compose_github_release
+    check_mode: no
+    until: _docker_compose_github_release.status == 200
+    retries: 5
+    delay: 15
+
+  - name: Extract the name of the latest docker-compose release tag.
+    set_fact:
+      docker_compose_version: "{{ _docker_compose_github_release['json'] | json_query('tag_name') }}"
+
+  when: docker_compose_version | length == 0
+
+- name: Download docker-compose.
+  get_url:
+    url: "https://github.com/docker/compose/releases/download/{{ docker_compose_version }}/docker-compose-{{ ansible_system }}-{{ ansible_userspace_architecture }}"  # noqa 204
+    dest: "/usr/local/bin/docker-compose"
+    mode: '0755'

tasks/setup-docker-engine.yml

@@ -2,12 +2,12 @@
 
 - block:
 
-    - name: Prefix the Docker package version with the correct separator on RedHat
+    - name: Prefix the Docker package version with the correct separator on RedHat.
       set_fact:
         _docker_package_version: "-{{ docker_package_version }}"
       when: ansible_os_family == 'RedHat'
 
-    - name: Prefix the Docker package version with the correct separator on Debian
+    - name: Prefix the Docker package version with the correct separator on Debian.
       set_fact:
         _docker_package_version: "={{ docker_package_version }}"
       when: ansible_os_family == 'Debian'
@@ -21,28 +21,28 @@
 
 - block:
 
-  - name: Create the systemd overrides directory for Docker.
-    file:
-      name: "/etc/systemd/system/docker.service.d"
-      state: directory
+    - name: Create the systemd overrides directory for Docker.
+      file:
+        name: "/etc/systemd/system/docker.service.d"
+        state: directory
 
-  - name: Override the systemd unit for Docker.
-    template:
-      src: docker-override.conf.j2
-      dest: "/etc/systemd/system/docker.service.d/override.conf"
-    register: _docker_systemd_override
+    - name: Override the systemd unit for Docker.
+      template:
+        src: docker-override.conf.j2
+        dest: "/etc/systemd/system/docker.service.d/override.conf"
+      register: _docker_systemd_override
 
-  - name: Reload systemd and restart Docker.
-    service:
-      name: docker
-      state: "{% if docker_service_state != 'stopped' %}restarted{% else %}stopped{% endif %}"
-      daemon_reload: yes
-    when: _docker_systemd_override.changed
+    - name: Reload systemd and restart Docker.
+      service:
+        name: docker
+        state: "{% if docker_service_state != 'stopped' %}restarted{% else %}stopped{% endif %}"
+        daemon_reload: yes
+      when: _docker_systemd_override.changed
 
   when: docker_service_override | length > 0
     and ansible_service_mgr == 'systemd'
 
-- name: Make sure the Docker daemon configuration directory exists
+- name: Make sure the Docker daemon configuration directory exists.
   file:
     path: /etc/docker
     owner: root

tasks/setup-docker-group.yml

@@ -1,6 +1,6 @@
 ---
 
-- name: Add the Docker administrators to the Docker group
+- name: Add the Docker administrators to the Docker group.
   user:
     name: "{{ item }}"
     groups: "{{ docker_group_name }}"

tasks/setup-docker-py.yml

@@ -1,17 +1,6 @@
 ---
 
-# Specified version because of https://github.com/ansible/ansible/issues/17495
-- name: Install docker-py 1.9.0.
-  pip:
-    name: docker-py
-    version: 1.9.0
-    state: present
-  when: ansible_version is defined
-    and ansible_version.full is version_compare('2.2.0.0', '<')
-
 - name: Install docker-py.
   pip:
     name: docker-py
     state: present
-  when: (ansible_version is not defined) or (ansible_version is defined
-    and ansible_version.full is version_compare('2.2.0.0', '>='))

tox.ini

@@ -12,6 +12,7 @@ ANSIBLE=
 [testenv]
 passenv = *
 deps =
+    -rrequirements.txt
     -rtest-requirements.txt
     ansible27: ansible<2.8
     ansible28: ansible<2.9

vars/Debian.yml

@@ -8,4 +8,4 @@ python_sni_support_packages:
   - libssl-dev
   - libffi-dev
 
-default_docker_dependencies: [ ]
+default_docker_dependencies: []