Merged PR 878: add package readiness/liveness probe

- add /healthz endpoint for readiness and liveness
- add liveness/readiness probe cfg

solved: #133005

Author: ferantivero

charts/package/templates/package-deploy.yaml

@@ -41,6 +41,38 @@ spec:
       - name: &package-container_name fabrikam-package
         image: {{ .Values.dockerregistry }}{{ .Values.dockerregistrynamespace }}/{{ .Values.image.repository }}:{{ .Values.image.tag }}
         imagePullPolicy: {{ .Values.image.pullPolicy }}
+        readinessProbe:
+          httpGet:
+            path: {{ required "readinessProbe.httpGet.path is required" .Values.readinessProbe.httpGet.path }}
+            port: {{ required "readinessProbe.httpGet.port is required" .Values.readinessProbe.httpGet.port }}
+{{- if .Values.readinessProbe.initialDelaySeconds }}
+          initialDelaySeconds: {{ .Values.readinessProbe.initialDelaySeconds }}
+{{- end }}
+{{- if .Values.readinessProbe.periodSeconds }}
+          periodSeconds: {{ .Values.readinessProbe.periodSeconds }}
+{{- end }}
+{{- if .Values.readinessProbe.timeoutSeconds }}
+          timeoutSeconds: {{ .Values.readinessProbe.timeoutSeconds }}
+{{- end }}
+{{- if .Values.readinessProbe.failureThreshold }}
+          failureThreshold: {{ .Values.readinessProbe.failureThreshold }}
+{{- end }}
+        livenessProbe:
+          httpGet:
+            path: {{ required "livenessProbe.httpGet.path is required" .Values.livenessProbe.httpGet.path }}
+            port: {{ required "livenessProbe.httpGet.port is required" .Values.livenessProbe.httpGet.port }}
+{{- if .Values.livenessProbe.initialDelaySeconds }}
+          initialDelaySeconds: {{ .Values.livenessProbe.initialDelaySeconds }}
+{{- end }}
+{{- if .Values.livenessProbe.periodSeconds }}
+          periodSeconds: {{ .Values.livenessProbe.periodSeconds }}
+{{- end }}
+{{- if .Values.livenessProbe.timeoutSeconds }}
+          timeoutSeconds: {{ .Values.livenessProbe.timeoutSeconds }}
+{{- end }}
+{{- if .Values.livenessProbe.failureThreshold }}
+          failureThreshold: {{ .Values.livenessProbe.failureThreshold }}
+{{- end }}
         resources:
           requests:
             cpu:   {{ required "A valid .Values.resources.requests.cpu entry required!" .Values.resources.requests.cpu }}

charts/package/values.yaml

@@ -8,6 +8,20 @@ image:
   tag:
   pullPolicy: IfNotPresent
 reason: unknown
+readinessProbe:
+  httpGet:
+    path: /healthz
+    port: 80
+  initialDelaySeconds: 40
+  periodSeconds: 15
+  timeoutSeconds: 2
+  failureThreshold: 5
+livenessProbe:
+  httpGet:
+    path: /healthz
+    port: 80
+  initialDelaySeconds: 50
+  periodSeconds: 15
 log:
   level: error
 cosmosDb:
@@ -17,4 +31,4 @@ tags:
   prod: false
   qa: false
   staging: false
-current: false
+current: false

src/shipping/package/app/server.ts

@@ -3,6 +3,7 @@
 // Licensed under the MIT License (MIT). See License.txt in the repo root for license information.
 // ------------------------------------------------------------
 
+const _ = require('koa-route');
 import * as Koa from 'koa';
 import * as bodyParser from "koa-bodyparser";
 
@@ -40,6 +41,15 @@ export class PackageService {
     // Configure logging
     app.use(logger(Settings.logLevel()));
 
+    // Add simple health check endpoint
+    app.use(_.get('/healthz', (ctx) => {
+        var logger : ILogger = ctx.state.logger;
+        logger.info('Readiness/Liveness Probe Status: %s', "OK");
+
+        ctx.status = 200;
+        ctx.body = {status: 'OK'};
+    }));
+
     // Configure global exception handling
     // Use: ctx.throw('Error Message', 500);
     //   in the controller methods to set the status code and exception message