Slight tweaks on Ansible output

- Default docker_compose_deploy to empty list if undefined
- Add conditional check to avoid looping through an empty list

Makefile

@@ -0,0 +1,10 @@
+.PHONY: clean install
+
+all: install
+
+install:
+	vagrant up --no-destroy-on-error
+	sudo ./forward-ssh.sh
+
+clean:
+	vagrant destroy -f && rm -rf .vagrant

Vagrantfile

@@ -43,5 +43,6 @@ Vagrant.configure("2") do |config|
     ENV['ANSIBLE_ROLES_PATH'] = File.dirname(__FILE__) + "/roles"
     ansible.compatibility_mode = "2.0"
     ansible.playbook = "dev/" + PLAYBOOK + ".yml"
+    ansible.raw_arguments = ["--diff"]
   end
 end

ansible.cfg

@@ -1,6 +1,7 @@
 [defaults]
 inventory = ./environments/development
 interpreter_python = /usr/bin/python3
+roles_path = ./roles
 
 [connection]
 pipelining = true

dev/docker.yml

@@ -0,0 +1,8 @@
+- name: Install Docker Server
+  hosts: all
+  become: true
+  vars_files:
+    - host_vars/docker.yml
+  roles:
+    - base
+    - docker

dev/host_vars/docker.yml

@@ -0,0 +1,48 @@
+# base
+allow_reboot: false
+manage_network: false
+
+# Import my GPG key for git signature verification
+root_gpgkeys:
+  - name: kris@lamoureux.io
+    id: FBF673CEEC030F8AECA814E73EDA9C3441EDA925
+
+# docker
+docker_users:
+  - vagrant
+
+#docker_login_url: https://myregistry.example.com
+#docker_login_user: myuser
+#docker_login_pass: YOUR_PASSWD
+
+docker_compose_env_nolog: false # dev only setting
+docker_compose_deploy:
+  # Traefik
+  - name: traefik
+    url: https://github.com/krislamo/traefik
+    version: 31ee724feebc1d5f91cb17ffd6892c352537f194
+    enabled: true
+    accept_newhostkey: true # Consider verifying manually instead
+    trusted_keys:
+      - FBF673CEEC030F8AECA814E73EDA9C3441EDA925
+    env:
+      ENABLE: true
+
+  # Traefik 2 (no other external compose to test currently)
+  - name: traefik2
+    url: https://github.com/krislamo/traefik
+    version: 31ee724feebc1d5f91cb17ffd6892c352537f194
+    enabled: true
+    accept_newhostkey: true # Consider verifying manually instead
+    trusted_keys:
+      - FBF673CEEC030F8AECA814E73EDA9C3441EDA925
+    env:
+      ENABLE: true
+      VERSION: "2.10"
+      DOMAIN: traefik2.local.krislamo.org
+      NAME: traefik2
+      ROUTER: traefik2
+      NETWORK: traefik2
+      WEB_PORT: 127.0.0.1:8000:80
+      WEBSECURE_PORT: 127.0.0.1:4443:443
+      LOCAL_PORT: 127.0.0.1:8444:8443

forward-ssh.sh

@@ -3,6 +3,12 @@
 # Finds the SSH private key under ./.vagrant and connects to
 # the Vagrant box, port forwarding localhost ports: 8443, 80, 443
 
+# Root check
+if [ "$EUID" -ne 0 ]; then
+  echo "[ERROR]: Please run script as root"
+  exit 1
+fi
+
 # Clean environment
 unset PRIVATE_KEY
 unset HOST_IP
@@ -11,16 +17,26 @@ unset PKILL_ANSWER
 
 # Function to create the SSH tunnel
 function ssh_connect {
-  printf "[INFO]: Starting new vagrant SSH tunnel on PID "
+  read -rp "Start a new vagrant SSH tunnel? [y/N] " PSTART_ANSWER
-  sudo ssh -fNT -i "$PRIVATE_KEY" \
+  echo
-    -L 8443:localhost:8443 \
+  case "$PSTART_ANSWER" in
-    -L 80:localhost:80 \
+    [yY])
-    -L 443:localhost:443 \
+      printf "[INFO]: Starting new vagrant SSH tunnel on PID "
-    -o UserKnownHostsFile=/dev/null \
+      sudo -u "$USER" ssh -fNT -i "$PRIVATE_KEY" \
-    -o StrictHostKeyChecking=no \
+        -L 8443:localhost:8443 \
-      vagrant@"$HOST_IP" 2>/dev/null
+        -L 80:localhost:80 \
-  sleep 2
+        -L 443:localhost:443 \
-  pgrep -f "$MATCH_PATTERN"
+        -o UserKnownHostsFile=/dev/null \
+        -o StrictHostKeyChecking=no \
+        vagrant@"$HOST_IP" 2>/dev/null
+      sleep 2
+      pgrep -f "$MATCH_PATTERN"
+      ;;
+    *)
+      echo "[INFO]: Delined to start a new vagrant SSH tunnel"
+      exit 0
+      ;;
+  esac
 }
 
 # Check for valid PRIVATE_KEY location
@@ -56,7 +72,7 @@ else
   case "$PKILL_ANSWER" in
     [yY])
       echo "[WARNING]: Killing old vagrant SSH tunnel(s): "
-      pgrep -f "$MATCH_PATTERN" | tee >(xargs sudo kill -15)
+      pgrep -f "$MATCH_PATTERN" | tee >(xargs kill -15)
       echo
       if [ "$(pgrep -afc "$MATCH_PATTERN")" -eq 0 ]; then
         ssh_connect

roles/base/defaults/main.yml

@@ -2,6 +2,7 @@ allow_reboot: true
 manage_firewall: true
 manage_network: false
 network_type: static
+locale_default: en_US.UTF-8
 
 packages:
   - apache2-utils

roles/base/tasks/system.yml

@@ -4,6 +4,61 @@
     state: present
     update_cache: true
 
+- name: Install GPG
+  ansible.builtin.apt:
+    name: gpg
+    state: present
+
+- name: Check for existing GPG keys
+  command: "gpg --list-keys {{ item.id }} 2>/dev/null"
+  register: gpg_check
+  loop: "{{ root_gpgkeys }}"
+  failed_when: false
+  changed_when: false
+  when: root_gpgkeys is defined
+
+- name: Import GPG keys
+  command: "gpg --keyserver {{ item.item.server | default('keys.openpgp.org') }} --recv-key {{ item.item.id }}"
+  register: gpg_check_import
+  loop: "{{ gpg_check.results }}"
+  loop_control:
+    label: "{{ item.item }}"
+  when: root_gpgkeys is defined and item.rc != 0
+
+- name: Check GPG key imports
+  fail:
+    msg: "{{ item.stderr }}"
+  loop: "{{ gpg_check_import.results }}"
+  loop_control:
+    label: "{{ item.item.item }}"
+  when: (item.skipped | default(false) == false) and ('imported' not in item.stderr)
+
+- name: Install NTPsec
+  ansible.builtin.apt:
+    name: ntpsec
+    state: present
+
+- name: Install locales
+  ansible.builtin.apt:
+    name: locales
+    state: present
+
+- name: Generate locale
+  community.general.locale_gen:
+    name: "{{ locale_default }}"
+    state: present
+  register: locale_gen_output
+
+- name: Set the default locale
+  ansible.builtin.lineinfile:
+    path: /etc/default/locale
+    regexp: "^LANG="
+    line: "LANG={{ locale_default }}"
+
+- name: Reconfigure locales
+  ansible.builtin.command: dpkg-reconfigure -f noninteractive locales
+  when: locale_gen_output.changed
+
 - name: Manage root authorized_keys
   ansible.builtin.template:
     src: authorized_keys.j2

roles/docker/defaults/main.yml

@@ -3,4 +3,4 @@ docker_compose_service: compose
 docker_compose: /usr/bin/docker-compose
 docker_repos_keys: "{{ docker_repos_path }}/.keys"
 docker_repos_keytype: rsa
-docker_repos_path: /srv/compose_repos
+docker_repos_path: /srv/.compose_repos

roles/docker/handlers/main.yml

@@ -2,3 +2,29 @@
   ansible.builtin.systemd:
     daemon_reload: true
   listen: compose_systemd
+
+- name: Find which services had a docker-compose.yml updated
+  set_fact:
+    compose_restart_list: "{{ (compose_restart_list | default([])) + [item.item.name] }}"
+  loop: "{{ compose_update.results }}"
+  loop_control:
+    label: "{{ item.item.name }}"
+  when: item.changed
+  listen: compose_restart
+
+- name: Find which services had their .env updated
+  set_fact:
+    compose_restart_list: "{{ (compose_restart_list | default([])) + [item.item.name] }}"
+  loop: "{{ compose_env_update.results }}"
+  loop_control:
+    label: "{{ item.item.name }}"
+  when: item.changed
+  listen: compose_restart
+
+- name: Restart {{ docker_compose_service }} services
+  ansible.builtin.systemd:
+    state: restarted
+    name: "{{ docker_compose_service }}@{{ item }}"
+  loop: "{{ compose_restart_list | unique }}"
+  when: compose_restart_list is defined
+  listen: compose_restart

roles/docker/tasks/main.yml

@@ -4,6 +4,13 @@
     state: present
     update_cache: true
 
+- name: Login to private registry
+  community.docker.docker_login:
+    registry_url: "{{ docker_login_url | default('') }}"
+    username: "{{ docker_login_user }}"
+    password: "{{ docker_login_pass }}"
+  when: docker_login_user is defined and docker_login_pass is defined
+
 - name: Create docker-compose root
   ansible.builtin.file:
     path: "{{ docker_compose_root }}"
@@ -31,6 +38,7 @@
   community.crypto.openssh_keypair:
     path: "{{ docker_repos_keys }}/id_{{ docker_repos_keytype }}"
     type: "{{ docker_repos_keytype }}"
+    comment: "{{ ansible_hostname }}-deploy-key"
     mode: 0400
     state: present
   when: docker_compose_deploy is defined
@@ -39,11 +47,15 @@
   ansible.builtin.git:
     repo: "{{ item.url }}"
     dest: "{{ docker_repos_path }}/{{ item.name }}"
-    version: "{{ item.version | default('main') }}"
+    version: "{{ item.version }}"
-    force: true
+    accept_newhostkey: "{{ item.accept_newhostkey | default('false') }}"
+    gpg_whitelist: "{{ item.trusted_keys | default([]) }}"
+    verify_commit: "{{ true if (item.trusted_keys is defined and item.trusted_keys) else false }}"
     key_file: "{{ docker_repos_keys }}/id_{{ docker_repos_keytype }}"
-  when: docker_compose_deploy is defined
   loop: "{{ docker_compose_deploy }}"
+  loop_control:
+    label: "{{ item.url }}"
+  when: docker_compose_deploy is defined
 
 - name: Create directories for docker-compose projects using the systemd service
   ansible.builtin.file:
@@ -51,22 +63,33 @@
     state: directory
     mode: 0400
   loop: "{{ docker_compose_deploy }}"
+  loop_control:
+    label: "{{ item.name }}"
   when: docker_compose_deploy is defined
 
-- name: Copy docker-compose.yml files to their service directories
+- name: Synchronize docker-compose.yml
-  ansible.builtin.copy:
+  ansible.posix.synchronize:
     src: "{{ docker_repos_path }}/{{ item.name }}/{{ item.path | default('docker-compose.yml') }}"
     dest: "{{ docker_compose_root }}/{{ item.name }}/docker-compose.yml"
-    remote_src: yes
+  delegate_to: "{{ inventory_hostname }}"
-  loop: "{{ docker_compose_deploy }}"
+  register: compose_update
-  when: docker_compose_deploy is defined
+  notify: compose_restart
+  loop: "{{ docker_compose_deploy | default([]) }}"
+  loop_control:
+    label: "{{ item.name }}"
+  when: docker_compose_deploy is defined and docker_compose_deploy | length > 0
 
 - name: Set environment variables for docker-compose projects
   ansible.builtin.template:
     src: docker-compose-env.j2
     dest: "{{ docker_compose_root }}/{{ item.name }}/.env"
     mode: 0400
+  register: compose_env_update
+  notify: compose_restart
+  no_log: "{{ docker_compose_env_nolog | default('true') }}"
   loop: "{{ docker_compose_deploy }}"
+  loop_control:
+    label: "{{ item.name }}"
   when: docker_compose_deploy is defined and item.env is defined
 
 - name: Add users to docker group
@@ -89,4 +112,6 @@
     state: started
     enabled: true
   loop: "{{ docker_compose_deploy }}"
+  loop_control:
+    label: "{{ docker_compose_service }}@{{ item.name }}"
   when: item.enabled is defined and item.enabled is true

roles/docker/templates/docker-compose-env.j2

@@ -1,7 +1,10 @@
 # {{ ansible_managed }}
-
 {% if item.env is defined %}
-{% for kvpair in item.env.items() %}
+{% for key, value in item.env.items() %}
-{{ kvpair.0 }}={{ kvpair.1 }}
+{% if value is boolean %}
+{{ key }}={{ value | lower }}
+{% else %}
+{{ key }}={{ value }}
+{% endif %}
 {% endfor %}
 {% endif %}