feat(dl): add health checks

charts/cloudevents-server/Chart.yaml

@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.0
+version: 0.2.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

charts/dl/templates/deployment.yaml

@@ -43,11 +43,11 @@ spec:
               protocol: TCP
           livenessProbe:
             httpGet:
-              path: /
+              path: /livez
               port: http
           readinessProbe:
             httpGet:
-              path: /
+              path: /healthz
               port: http
           resources:
             {{- toYaml .Values.resources | nindent 12 }}

charts/dl/templates/tests/test-connection.yaml

@@ -11,5 +11,5 @@ spec:
     - name: wget
       image: busybox
       command: ['wget']
-      args: ['{{ include "dl.fullname" . }}:{{ .Values.service.port }}']
+      args: ['{{ include "dl.fullname" . }}:{{ .Values.service.port }}/healthz']
   restartPolicy: Never

dl/cmd/server/http.go

@@ -9,6 +9,8 @@ import (
 	"sync"
 	"time"
 
+	health "github.com/PingCAP-QE/ee-apps/dl/gen/health"
+	healthsvr "github.com/PingCAP-QE/ee-apps/dl/gen/http/health/server"
 	ks3svr "github.com/PingCAP-QE/ee-apps/dl/gen/http/ks3/server"
 	ocisvr "github.com/PingCAP-QE/ee-apps/dl/gen/http/oci/server"
 	ks3 "github.com/PingCAP-QE/ee-apps/dl/gen/ks3"
@@ -20,7 +22,7 @@ import (
 
 // handleHTTPServer starts configures and starts a HTTP server on the given
 // URL. It shuts down the server if any error is received in the error channel.
-func handleHTTPServer(ctx context.Context, u *url.URL, ociEndpoints *oci.Endpoints, ks3Endpoints *ks3.Endpoints, wg *sync.WaitGroup, errc chan error, logger *log.Logger, debug bool) {
+func handleHTTPServer(ctx context.Context, u *url.URL, healthEndpoints *health.Endpoints, ociEndpoints *oci.Endpoints, ks3Endpoints *ks3.Endpoints, wg *sync.WaitGroup, errc chan error, logger *log.Logger, debug bool) {
 
 	// Setup goa log adapter.
 	var (
@@ -51,22 +53,26 @@ func handleHTTPServer(ctx context.Context, u *url.URL, ociEndpoints *oci.Endpoin
 	// the service input and output data structures to HTTP requests and
 	// responses.
 	var (
-		ociServer *ocisvr.Server
-		ks3Server *ks3svr.Server
+		healthServer *healthsvr.Server
+		ociServer    *ocisvr.Server
+		ks3Server    *ks3svr.Server
 	)
 	{
 		eh := errorHandler(logger)
+		healthServer = healthsvr.New(healthEndpoints, mux, dec, enc, eh, nil)
 		ociServer = ocisvr.New(ociEndpoints, mux, dec, enc, eh, nil)
 		ks3Server = ks3svr.New(ks3Endpoints, mux, dec, enc, eh, nil)
 		if debug {
 			servers := goahttp.Servers{
+				healthServer,
 				ociServer,
 				ks3Server,
 			}
 			servers.Use(httpmdlwr.Debug(mux, os.Stdout))
 		}
 	}
 	// Configure the mux.
+	healthsvr.Mount(mux, healthServer)
 	ocisvr.Mount(mux, ociServer)
 	ks3svr.Mount(mux, ks3Server)
 
@@ -81,6 +87,9 @@ func handleHTTPServer(ctx context.Context, u *url.URL, ociEndpoints *oci.Endpoin
 	// Start HTTP server using default configuration, change the code to
 	// configure the server as required by your service.
 	srv := &http.Server{Addr: u.Host, Handler: handler, ReadHeaderTimeout: time.Second * 60}
+	for _, m := range healthServer.Mounts {
+		logger.Printf("HTTP %q mounted on %s %s", m.Method, m.Verb, m.Pattern)
+	}
 	for _, m := range ociServer.Mounts {
 		logger.Printf("HTTP %q mounted on %s %s", m.Method, m.Verb, m.Pattern)
 	}

dl/cmd/server/main.go

@@ -13,6 +13,7 @@ import (
 	"syscall"
 
 	dl "github.com/PingCAP-QE/ee-apps/dl"
+	health "github.com/PingCAP-QE/ee-apps/dl/gen/health"
 	ks3 "github.com/PingCAP-QE/ee-apps/dl/gen/ks3"
 	oci "github.com/PingCAP-QE/ee-apps/dl/gen/oci"
 )
@@ -40,21 +41,25 @@ func main() {
 
 	// Initialize the services.
 	var (
-		ociSvc oci.Service
-		ks3Svc ks3.Service
+		healthSvc health.Service
+		ociSvc    oci.Service
+		ks3Svc    ks3.Service
 	)
 	{
+		healthSvc = dl.NewHealth(logger)
 		ociSvc = dl.NewOci(logger)
 		ks3Svc = dl.NewKs3(logger, *ks3CfgPathF)
 	}
 
 	// Wrap the services in endpoints that can be invoked from other services
 	// potentially running in different processes.
 	var (
-		ociEndpoints *oci.Endpoints
-		ks3Endpoints *ks3.Endpoints
+		healthEndpoints *health.Endpoints
+		ociEndpoints    *oci.Endpoints
+		ks3Endpoints    *ks3.Endpoints
 	)
 	{
+		healthEndpoints = health.NewEndpoints(healthSvc)
 		ociEndpoints = oci.NewEndpoints(ociSvc)
 		ks3Endpoints = ks3.NewEndpoints(ks3Svc)
 	}
@@ -98,7 +103,7 @@ func main() {
 			} else if u.Port() == "" {
 				u.Host = net.JoinHostPort(u.Host, "80")
 			}
-			handleHTTPServer(ctx, u, ociEndpoints, ks3Endpoints, &wg, errc, logger, *dbgF)
+			handleHTTPServer(ctx, u, healthEndpoints, ociEndpoints, ks3Endpoints, &wg, errc, logger, *dbgF)
 		}
 
 	default:

dl/design/design.go

@@ -14,6 +14,24 @@ var _ = API("dl", func() {
 	})
 })
 
+var _ = Service("health", func() {
+	Description("Health service")
+
+	Method("healthz", func() {
+		Result(Boolean)
+		HTTP(func() {
+			GET("/healthz")
+		})
+	})
+
+	Method("livez", func() {
+		Result(Boolean)
+		HTTP(func() {
+			GET("/livez")
+		})
+	})
+})
+
 var _ = Service("oci", func() {
 	Description("OCI artifacts download service")