Add Readiness and liveness probs to the helm chart

Author: zakariamaaraki

.idea/workspace.xml

@@ -41,8 +41,23 @@ spec:
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           ports:
             - name: http
-              containerPort: 8082
+              containerPort: {{ .Values.image.port }}
               protocol: TCP
+              # check for lifetime liveness, restarts if not status 200
+          {{ if .Values.kafka.enabled }}
+          livenessProbe:
+            httpGet:
+              path: {{ .Values.health.liveness }}
+              port: {{ .Values.image.port }}
+            initialDelaySeconds: 20
+            periodSeconds: 10
+          {{ end }}
+          readinessProbe:
+            httpGet:
+              path: {{ .Values.health.readiness }}
+              port: {{ .Values.image.port }}
+            initialDelaySeconds: 20
+            periodSeconds: 10
           envFrom:
             - configMapRef:
                 name: {{ .Release.Name }}-config
@@ -51,7 +66,7 @@ spec:
           volumeMounts:
             - mountPath: /var/run # volume used for docker
               name: executions-volume
-            - mountPath: /compiler
+            - mountPath: {{ .Values.compiler.path }}
               name: compilation-volume
           resources:
             {{- toYaml .Values.resources | nindent 12 }}
@@ -63,7 +78,7 @@ spec:
             type: DirectoryOrCreate
         - name: compilation-volume
           hostPath:
-            path: /compiler
+            path: {{ .Values.compiler.path }}
             type: DirectoryOrCreate
       {{- with .Values.nodeSelector }}
       nodeSelector:

k8s/compiler/templates/deployment.yaml

@@ -8,7 +8,7 @@ spec:
   type: {{ .Values.service.type }}
   ports:
     - port: {{ .Values.service.port }}
-      targetPort: 8082
+      targetPort: {{ .Values.image.port }}
       protocol: TCP
       name: http
   selector:

k8s/compiler/templates/service.yaml

@@ -1,6 +1,4 @@
 # Default values for compiler.
-# This is a YAML-formatted file.
-# Declare variables to be passed into your templates.
 
 replicaCount: 1
 
@@ -9,14 +7,18 @@ image:
   pullPolicy: Never
   # Overrides the image tag whose default is the chart appVersion.
   tag: "latest"
+  port: 8082
 
-# init container
+# Init container
 initContainerImage:
   repository: environment
   pullPolicy: Never
-  # Overrides the image tag whose default is the chart appVersion.
   tag: "latest"
 
+health:
+  liveness: /health/kafkaStreams # check if Kafka streams is broken
+  readiness: /health/containerization # check if the containerization system used by the compiler is broken
+
 imagePullSecrets: []
 nameOverride: ""
 fullnameOverride: ""
@@ -37,6 +39,7 @@ securityContext:
   # runAsUser: 1000
 
 compiler:
+  path: "/compiler" # !! Note: Should be the same as the WORKDIR specified in the dockerfile
   deleteDockerImage: true
   maxExecutionMemory: 1000
   minExecutionMemory: 100

k8s/compiler/values.yaml

@@ -1,6 +1,4 @@
 # Default values for monitoring.
-# This is a YAML-formatted file.
-# Declare variables to be passed into your templates.
 
 prometheus:
   targetService:

k8s/monitoring/values.yaml

@@ -9,16 +9,20 @@
  * The type Container health indicator.
  */
 @Component
-public class ContainerHealthIndicator implements HealthIndicator {
+public class ContainerizationHealthIndicator implements HealthIndicator {
 
-    private ContainerService containerService;
+    private final ContainerService containerService;
+    
+    private static final String BROKEN_STATE = "Container Down";
+    
+    private static final String UP_STATE = "Containerization UP";
 
     /**
      * Instantiates a new Container health indicator.
      *
      * @param containerService the container service
      */
-    public ContainerHealthIndicator(ContainerService containerService) {
+    public ContainerizationHealthIndicator(ContainerService containerService) {
         super();
         this.containerService = containerService;
     }
@@ -28,11 +32,12 @@ public Health health() {
         if (containerService.isUp()) {
             return Health.up()
                     .withDetail("Containerization", containerService.getContainerizationName())
+                    .withDetail("State", UP_STATE)
                     .build();
         }
         return Health.down()
                 .withDetail("Containerization", containerService.getContainerizationName())
-                .withDetail("State", "Container Down")
+                .withDetail("State", BROKEN_STATE)
                 .build();
     }
 }

src/main/java/com/cp/compiler/healthchecks/ContainerHealthIndicator.java src/main/java/com/cp/compiler/healthchecks/ContainerizationHealthIndicator.java

@@ -10,8 +10,8 @@
 /**
  * The type Kafka streams health indicator.
  */
-//Note that class name prefix before `HealthIndicator` will be camel-cased
-//and used as a health component name, `kafkaStreams` here
+// Note that class name prefix before `HealthIndicator` will be camel-cased
+// and used as a health component name, `kafkaStreams` here
 @Profile("kafka")
 @Component
 public class KafkaStreamsHealthIndicator implements HealthIndicator {
@@ -34,8 +34,7 @@ public Health health() {
 
         // CREATED, RUNNING or REBALANCING
         if (kafkaStreamsState == KafkaStreams.State.CREATED || kafkaStreamsState.isRunningOrRebalancing()) {
-            //set details if you need one
-            return Health.up().build();
+            return Health.up().withDetail("State", kafkaStreamsState.name()).build();
         }
 
         // ERROR, NOT_RUNNING, PENDING_SHUTDOWN,

src/main/java/com/cp/compiler/healthchecks/KafkaStreamsHealthIndicator.java

@@ -1,6 +1,6 @@
 package com.cp.compiler.healths;
 
-import com.cp.compiler.healthchecks.ContainerHealthIndicator;
+import com.cp.compiler.healthchecks.ContainerizationHealthIndicator;
 import com.cp.compiler.services.containers.ContainerService;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
@@ -22,7 +22,7 @@ class ContainerHealthIndicatorTests {
     @Test
     void shouldReturnHealthUp() {
         // Given
-        var healthIndicator = new ContainerHealthIndicator(containerService);
+        var healthIndicator = new ContainerizationHealthIndicator(containerService);
         Mockito.when(containerService.isUp()).thenReturn(true);
         Mockito.when(containerService.getContainerizationName()).thenReturn("Docker");
 
@@ -31,12 +31,13 @@ void shouldReturnHealthUp() {
 
         // Then
         Assertions.assertEquals(Health.up().build().getStatus(), health.getStatus());
+        Assertions.assertNotNull(health.getDetails());
     }
 
     @Test
     void shouldReturnHealthDown() {
         // Given
-        var healthIndicator = new ContainerHealthIndicator(containerService);
+        var healthIndicator = new ContainerizationHealthIndicator(containerService);
         Mockito.when(containerService.isUp()).thenReturn(false);
         Mockito.when(containerService.getContainerizationName()).thenReturn("Docker");
 
@@ -45,5 +46,6 @@ void shouldReturnHealthDown() {
 
         // Then
         Assertions.assertEquals(Health.down().build().getStatus(), health.getStatus());
+        Assertions.assertNotNull(health.getDetails());
     }
 }

src/test/java/com/cp/compiler/healths/ContainerHealthIndicatorTests.java

@@ -35,6 +35,7 @@ void shouldReturnHealthUpWhenKafkaStreamsIsInCreatedState() {
 
         // Then
         Assertions.assertEquals(Health.up().build().getStatus(), health.getStatus());
+        Assertions.assertNotNull(health.getDetails());
     }
 
     @Test
@@ -49,6 +50,7 @@ void shouldReturnHealthUpWhenKafkaStreamsIsInRunningState() {
 
         // Then
         Assertions.assertEquals(Health.up().build().getStatus(), health.getStatus());
+        Assertions.assertNotNull(health.getDetails());
     }
 
     @Test
@@ -63,6 +65,7 @@ void shouldReturnHealthUpWhenKafkaStreamsIsInRebalancingState() {
 
         // Then
         Assertions.assertEquals(Health.up().build().getStatus(), health.getStatus());
+        Assertions.assertNotNull(health.getDetails());
     }
 
     @Test
@@ -77,6 +80,7 @@ void shouldReturnHealthDownWhenKafkaStreamsIsInErrorState() {
 
         // Then
         Assertions.assertEquals(Health.down().build().getStatus(), health.getStatus());
+        Assertions.assertNotNull(health.getDetails());
     }
 
     @Test
@@ -91,6 +95,7 @@ void shouldReturnHealthDownWhenKafkaStreamsIsInNotRunningState() {
 
         // Then
         Assertions.assertEquals(Health.down().build().getStatus(), health.getStatus());
+        Assertions.assertNotNull(health.getDetails());
     }
 
     @Test
@@ -105,5 +110,6 @@ void shouldReturnHealthDownWhenKafkaStreamsIsInPendingState() {
 
         // Then
         Assertions.assertEquals(Health.down().build().getStatus(), health.getStatus());
+        Assertions.assertNotNull(health.getDetails());
     }
 }