Merged PR 873: add dronescheduler readiness/liveness probe

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

solve: #133008

Author: ferantivero

charts/dronescheduler/templates/dronescheduler-deploy.yaml

@@ -46,6 +46,38 @@ spec:
       - name: fabrikam-dronescheduler
         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 }}
@@ -66,4 +98,4 @@ spec:
           value: 169.254.169.254
       ports:
         - name: service
-          containerPort: 8080
+          containerPort: 8080

charts/dronescheduler/values.yaml

@@ -14,6 +14,20 @@ keyvault:
 cosmosdb:
   id:
   collectionid:
+readinessProbe:
+  httpGet:
+    path: /healthz
+    port: 8080
+  initialDelaySeconds: 40
+  periodSeconds: 15
+  timeoutSeconds: 2
+  failureThreshold: 5
+livenessProbe:
+  httpGet:
+    path: /healthz
+    port: 8080
+  initialDelaySeconds: 50
+  periodSeconds: 15
 reason: unknown
 telemetry:
   level: "Error"
@@ -22,4 +36,4 @@ tags:
   prod: false
   qa: false
   staging: false
-current: false
+current: false

src/shipping/dronescheduler/Fabrikam.DroneDelivery.DroneSchedulerService/Startup.cs

@@ -4,11 +4,13 @@
 // ------------------------------------------------------------
 
 using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Diagnostics.HealthChecks;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Diagnostics.HealthChecks;
 using Microsoft.Extensions.Logging;
 using Microsoft.FeatureManagement;
 using Fabrikam.DroneDelivery.DroneSchedulerService.Models;
@@ -21,6 +23,8 @@ namespace Fabrikam.DroneDelivery.DroneSchedulerService
 {
     public class Startup
     {
+        private const string HealCheckName = "ReadinessLiveness";
+
         public Startup(IConfiguration configuration)
         {
             Configuration = configuration;
@@ -42,6 +46,11 @@ public void ConfigureServices(IServiceCollection services)
             // Add framework services.
             services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
 
+            // Add health check
+            services.AddHealthChecks().AddCheck(
+                    HealCheckName,
+                    () => HealthCheckResult.Healthy("OK"));
+
             // Register the Swagger generator, defining one or more Swagger documents
             services.AddSwaggerGen(c =>
             {
@@ -62,6 +71,9 @@ public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerF
               .ReadFrom.Configuration(Configuration)
               .CreateLogger();
 
+            // Map health checks
+            app.UseHealthChecks("/healthz");
+
             app.UseMvc();
 
             // Enable middleware to serve generated Swagger as a JSON endpoint.