svc-mgmt: add health endpoint to control service - opensource implementation

Add implementation for the /health endpoint on the open source control service.

GitOrigin-RevId: a47b33c6f3e052fb2b871b0cbcc4edd6bd6a357a

Author: kmavromati

go/cs/BUILD.bazel

@@ -19,6 +19,7 @@ go_library(
         "//go/cs/segreg/grpc:go_default_library",
         "//go/cs/segreq:go_default_library",
         "//go/cs/segreq/grpc:go_default_library",
+        "//go/lib/addr:go_default_library",
         "//go/lib/common:go_default_library",
         "//go/lib/infra/infraenv:go_default_library",
         "//go/lib/infra/modules/segfetcher/grpc:go_default_library",
@@ -44,6 +45,7 @@ go_library(
         "//go/pkg/command:go_default_library",
         "//go/pkg/cs:go_default_library",
         "//go/pkg/cs/api:go_default_library",
+        "//go/pkg/cs/trust:go_default_library",
         "//go/pkg/cs/trust/grpc:go_default_library",
         "//go/pkg/cs/trust/metrics:go_default_library",
         "//go/pkg/discovery:go_default_library",

go/cs/main.go

@@ -42,6 +42,7 @@ import (
 	segreggrpc "github.com/scionproto/scion/go/cs/segreg/grpc"
 	"github.com/scionproto/scion/go/cs/segreq"
 	segreqgrpc "github.com/scionproto/scion/go/cs/segreq/grpc"
+	"github.com/scionproto/scion/go/lib/addr"
 	"github.com/scionproto/scion/go/lib/common"
 	"github.com/scionproto/scion/go/lib/infra/infraenv"
 	segfetchergrpc "github.com/scionproto/scion/go/lib/infra/modules/segfetcher/grpc"
@@ -67,6 +68,7 @@ import (
 	"github.com/scionproto/scion/go/pkg/command"
 	"github.com/scionproto/scion/go/pkg/cs"
 	"github.com/scionproto/scion/go/pkg/cs/api"
+	cstrust "github.com/scionproto/scion/go/pkg/cs/trust"
 	cstrustgrpc "github.com/scionproto/scion/go/pkg/cs/trust/grpc"
 	cstrustmetrics "github.com/scionproto/scion/go/pkg/cs/trust/metrics"
 	"github.com/scionproto/scion/go/pkg/discovery"
@@ -563,6 +565,11 @@ func realMain(ctx context.Context) error {
 			LogLevel: service.NewLogLevelStatusPage().Handler,
 			Signer:   signer,
 			Topology: topo.HandleHTTP,
+			Healther: &healther{
+				Signer:  signer,
+				TrustDB: trustDB,
+				ISD:     topo.IA().I,
+			},
 		}
 		log.Info("Exposing API", "addr", globalCfg.API.Addr)
 		s := http.Server{
@@ -709,3 +716,41 @@ func adaptInterfaceMap(in map[common.IFIDType]topology.IFInfo) map[uint16]ifstat
 	}
 	return converted
 }
+
+type healther struct {
+	Signer  cstrust.RenewingSigner
+	TrustDB storage.TrustDB
+	ISD     addr.ISD
+}
+
+func (h *healther) GetSignerHealth(ctx context.Context) api.SignerHealthData {
+	signer, err := h.Signer.SignerGen.Generate(ctx)
+	if err != nil {
+		return api.SignerHealthData{
+			SignerMissing:       true,
+			SignerMissingDetail: err.Error(),
+		}
+	}
+	return api.SignerHealthData{
+		Expiration: signer.Expiration,
+		InGrace:    signer.InGrace,
+	}
+}
+
+func (h *healther) GetTRCHealth(ctx context.Context) api.TRCHealthData {
+	trc, err := h.TrustDB.SignedTRC(ctx, cppki.TRCID{ISD: h.ISD})
+	if err != nil {
+		return api.TRCHealthData{
+			TRCNotFound:       true,
+			TRCNotFoundDetail: err.Error(),
+		}
+	}
+	if trc.IsZero() {
+		return api.TRCHealthData{
+			TRCNotFound: true,
+		}
+	}
+	return api.TRCHealthData{
+		TRCID: trc.TRC.ID,
+	}
+}

go/pkg/api/health/api/BUILD.bazel

@@ -0,0 +1,25 @@
+load("//lint:go.bzl", "go_library")
+load("@com_github_scionproto_scion//rules_openapi:defs.bzl", "openapi_generate_go")
+
+openapi_generate_go(
+    name = "api_generated",
+    src = "//spec:health",
+    server = True,
+    spec = False,
+)
+
+# exclude the *.gen.go files in the workspace it's only for editor compatibility.
+# gazelle:exclude *.gen.go
+go_library(
+    name = "go_default_library",
+    srcs = [
+        "helpers.go",
+        ":api_generated",  # keep
+    ],
+    importpath = "github.com/scionproto/scion/go/pkg/api/health/api",
+    visibility = ["//visibility:public"],
+    deps = [
+        "@com_github_go_chi_chi_v5//:go_default_library",  # keep
+        "@com_github_pkg_errors//:go_default_library",  # keep
+    ],
+)

go/pkg/api/health/api/client.gen.go

@@ -0,0 +1,29 @@
+// Copyright 2021 Anapaya Systems
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package api
+
+// AggregateHealthStatus returns the least healthy status of the input.
+func AggregateHealthStatus(checksStatus []Status) Status {
+	lowestStatus := StatusPassing
+	for _, checkStatus := range checksStatus {
+		switch checkStatus {
+		case StatusFailing:
+			return StatusFailing
+		case StatusDegraded:
+			lowestStatus = StatusDegraded
+		}
+	}
+	return lowestStatus
+}