From 66888bb7e090988ad0f48f75d63c57a774fb1613 Mon Sep 17 00:00:00 2001
From: LinPeiWen <591171850@qq.com>
Date: Wed, 3 Mar 2021 07:04:27 +0000
Subject: [PATCH] Use Docker healthchecks for redis services

This change enables the use of Docker healthchecks for redis services.
Implements: blueprint container-health-check

Change-Id: I0590c5b22ef8eb733211b029cdd73a055d58af11
---
 ansible/roles/redis/defaults/main.yml         | 28 +++++++++++++++++++
 ansible/roles/redis/handlers/main.yml         |  2 ++
 .../roles/redis/tasks/check-containers.yml    |  1 +
 ...althchecks-for-redis-12f8d528d1b8c0cb.yaml |  6 ++++
 4 files changed, 37 insertions(+)
 create mode 100644 releasenotes/notes/implement-docker-healthchecks-for-redis-12f8d528d1b8c0cb.yaml

diff --git a/ansible/roles/redis/defaults/main.yml b/ansible/roles/redis/defaults/main.yml
index 1e02f161ff..b9a29b0776 100644
--- a/ansible/roles/redis/defaults/main.yml
+++ b/ansible/roles/redis/defaults/main.yml
@@ -9,6 +9,7 @@ redis_services:
     image: "{{ redis_image_full }}"
     volumes: "{{ redis_default_volumes + redis_extra_volumes }}"
     dimensions: "{{ redis_dimensions }}"
+    healthcheck: "{{ redis_healthcheck }}"
   redis-sentinel:
     container_name: redis_sentinel
     group: redis
@@ -16,6 +17,7 @@ redis_services:
     image: "{{ redis_sentinel_image_full }}"
     volumes: "{{ redis_sentinel_default_volumes + redis_sentinel_extra_volumes }}"
     dimensions: "{{ redis_sentinel_dimensions }}"
+    healthcheck: "{{ redis_sentinel_healthcheck }}"
 
 ####################
 # Docker
@@ -31,6 +33,32 @@ redis_sentinel_image_full: "{{ redis_sentinel_image }}:{{ redis_tag }}"
 redis_dimensions: "{{ default_container_dimensions }}"
 redis_sentinel_dimensions: "{{ default_container_dimensions }}"
 
+redis_enable_healthchecks: "{{ enable_container_healthchecks }}"
+redis_healthcheck_interval: "{{ default_container_healthcheck_interval }}"
+redis_healthcheck_retries: "{{ default_container_healthcheck_retries }}"
+redis_healthcheck_start_period: "{{ default_container_healthcheck_start_period }}"
+redis_healthcheck_test: ["CMD-SHELL", "healthcheck_listen redis-server {{ redis_port }}"]
+redis_healthcheck_timeout: "{{ default_container_healthcheck_timeout }}"
+redis_healthcheck:
+  interval: "{{ redis_healthcheck_interval }}"
+  retries: "{{ redis_healthcheck_retries }}"
+  start_period: "{{ redis_healthcheck_start_period }}"
+  test: "{% if redis_enable_healthchecks | bool %}{{ redis_healthcheck_test }}{% else %}NONE{% endif %}"
+  timeout: "{{ redis_healthcheck_timeout }}"
+
+redis_sentinel_enable_healthchecks: "{{ enable_container_healthchecks }}"
+redis_sentinel_healthcheck_interval: "{{ default_container_healthcheck_interval }}"
+redis_sentinel_healthcheck_retries: "{{ default_container_healthcheck_retries }}"
+redis_sentinel_healthcheck_start_period: "{{ default_container_healthcheck_start_period }}"
+redis_sentinel_healthcheck_test: ["CMD-SHELL", "healthcheck_listen redis-sentinel {{ redis_sentinel_port }}"]
+redis_sentinel_healthcheck_timeout: "{{ default_container_healthcheck_timeout }}"
+redis_sentinel_healthcheck:
+  interval: "{{ redis_sentinel_healthcheck_interval }}"
+  retries: "{{ redis_sentinel_healthcheck_retries }}"
+  start_period: "{{ redis_sentinel_healthcheck_start_period }}"
+  test: "{% if redis_sentinel_enable_healthchecks | bool %}{{ redis_sentinel_healthcheck_test }}{% else %}NONE{% endif %}"
+  timeout: "{{ redis_sentinel_healthcheck_timeout }}"
+
 redis_default_volumes:
   - "{{ node_config_directory }}/redis/:{{ container_config_directory }}/:ro"
   - "/etc/localtime:/etc/localtime:ro"
diff --git a/ansible/roles/redis/handlers/main.yml b/ansible/roles/redis/handlers/main.yml
index 2b900c37db..f0d2de78ad 100644
--- a/ansible/roles/redis/handlers/main.yml
+++ b/ansible/roles/redis/handlers/main.yml
@@ -11,6 +11,7 @@
     image: "{{ service.image }}"
     volumes: "{{ service.volumes }}"
     dimensions: "{{ service.dimensions }}"
+    healthcheck: "{{ service.healthcheck | default(omit) }}"
   when:
     - kolla_action != "config"
 
@@ -26,5 +27,6 @@
     image: "{{ service.image }}"
     volumes: "{{ service.volumes }}"
     dimensions: "{{ service.dimensions }}"
+    healthcheck: "{{ service.healthcheck | default(omit) }}"
   when:
     - kolla_action != "config"
diff --git a/ansible/roles/redis/tasks/check-containers.yml b/ansible/roles/redis/tasks/check-containers.yml
index f7a64522bd..24e168b88a 100644
--- a/ansible/roles/redis/tasks/check-containers.yml
+++ b/ansible/roles/redis/tasks/check-containers.yml
@@ -8,6 +8,7 @@
     image: "{{ item.value.image }}"
     volumes: "{{ item.value.volumes }}"
     dimensions: "{{ item.value.dimensions }}"
+    healthcheck: "{{ item.value.healthcheck | default(omit) }}"
   when:
     - inventory_hostname in groups[item.value.group]
     - item.value.enabled | bool
diff --git a/releasenotes/notes/implement-docker-healthchecks-for-redis-12f8d528d1b8c0cb.yaml b/releasenotes/notes/implement-docker-healthchecks-for-redis-12f8d528d1b8c0cb.yaml
new file mode 100644
index 0000000000..089a963267
--- /dev/null
+++ b/releasenotes/notes/implement-docker-healthchecks-for-redis-12f8d528d1b8c0cb.yaml
@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Implements container healthchecks for redis services.
+    See `blueprint
+    <https://blueprints.launchpad.net/kolla-ansible/+spec/container-health-check>`__