Resources health checks

api/core/core.swagger.json

@@ -898,6 +898,17 @@
       },
       "title": "GroupVersionKind represents an objects Kubernetes API type data"
     },
+    "v1HealthStatus": {
+      "type": "object",
+      "properties": {
+        "status": {
+          "type": "string"
+        },
+        "message": {
+          "type": "string"
+        }
+      }
+    },
     "v1InventoryEntry": {
       "type": "object",
       "properties": {
@@ -910,6 +921,9 @@
         "clusterName": {
           "type": "string"
         },
+        "health": {
+          "$ref": "#/definitions/v1HealthStatus"
+        },
         "children": {
           "type": "array",
           "items": {
@@ -1105,6 +1119,9 @@
         },
         "info": {
           "type": "string"
+        },
+        "health": {
+          "$ref": "#/definitions/v1HealthStatus"
         }
       }
     },

api/core/types.proto

@@ -66,11 +66,17 @@ message NamespacedObjectReference {
     string namespace = 2;
 }
 
+message HealthStatus {
+    string status = 1;
+    string message = 2;
+}
+
 message InventoryEntry {
     string payload = 1;
     string tenant = 2;
     string clusterName = 3;
-    repeated InventoryEntry children = 4;
+    HealthStatus health = 4;
+    repeated InventoryEntry children = 5;
 }
 
 message Object {
@@ -80,6 +86,7 @@ message Object {
     string   uid                        = 4;
     repeated GroupVersionKind inventory = 5;
     string   info                       = 6;
+    HealthStatus health                 = 7;
 }
 
 message Deployment {

cmd/gitops-server/cmd/cmd.go

@@ -32,6 +32,7 @@ import (
 	"github.com/weaveworks/weave-gitops/core/nsaccess"
 	core "github.com/weaveworks/weave-gitops/core/server"
 	"github.com/weaveworks/weave-gitops/pkg/featureflags"
+	"github.com/weaveworks/weave-gitops/pkg/health"
 	"github.com/weaveworks/weave-gitops/pkg/kube"
 	"github.com/weaveworks/weave-gitops/pkg/server"
 	"github.com/weaveworks/weave-gitops/pkg/server/auth"
@@ -215,7 +216,9 @@ func runCmd(cmd *cobra.Command, args []string) error {
 	clustersManager := clustersmngr.NewClustersManager([]clustersmngr.ClusterFetcher{fetcher}, nsaccess.NewChecker(nsaccess.DefautltWegoAppRules), log)
 	clustersManager.Start(ctx)
 
-	coreConfig, err := core.NewCoreConfig(log, rest, clusterName, clustersManager)
+	healthChecker := health.NewHealthChecker()
+
+	coreConfig, err := core.NewCoreConfig(log, rest, clusterName, clustersManager, healthChecker)
 	if err != nil {
 		return fmt.Errorf("could not create core config: %w", err)
 	}

core/server/featureflags_test.go

@@ -13,6 +13,7 @@ import (
 	"github.com/weaveworks/weave-gitops/core/server"
 	pb "github.com/weaveworks/weave-gitops/pkg/api/core"
 	"github.com/weaveworks/weave-gitops/pkg/featureflags"
+	"github.com/weaveworks/weave-gitops/pkg/health"
 	"github.com/weaveworks/weave-gitops/pkg/kube"
 	"k8s.io/client-go/rest"
 )
@@ -36,7 +37,9 @@ func TestGetFeatureFlags(t *testing.T) {
 		fetcher.NewSingleClusterFetcher(cluster),
 	}, &nsChecker, logr.Discard())
 
-	cfg, err := server.NewCoreConfig(logr.Discard(), &rest.Config{}, "test", clustersManager)
+	hc := health.NewHealthChecker()
+
+	cfg, err := server.NewCoreConfig(logr.Discard(), &rest.Config{}, "test", clustersManager, hc)
 	Expect(err).NotTo(HaveOccurred())
 	coreSrv, err := server.NewCoreServer(cfg)
 	Expect(err).NotTo(HaveOccurred())

core/server/inventory.go

@@ -262,11 +262,20 @@ func (cs *coreServer) unstructuredToInventoryEntry(ctx context.Context, clusterN
 	clusterUserNss := cs.clustersManager.GetUserNamespaces(auth.Principal(ctx))
 	tenant := GetTenant(unstructuredObj.GetNamespace(), clusterName, clusterUserNss)
 
+	health, err := cs.healthChecker.Check(unstructuredObj)
+	if err != nil {
+		return nil, err
+	}
+
 	entry := &pb.InventoryEntry{
 		Payload:     string(bytes),
 		Tenant:      tenant,
 		ClusterName: clusterName,
 		Children:    children,
+		Health: &pb.HealthStatus{
+			Status:  string(health.Status),
+			Message: health.Message,
+		},
 	}
 
 	return entry, nil

core/server/server.go

@@ -9,6 +9,7 @@ import (
 	"github.com/weaveworks/weave-gitops/core/clustersmngr"
 	"github.com/weaveworks/weave-gitops/core/nsaccess"
 	pb "github.com/weaveworks/weave-gitops/pkg/api/core"
+	"github.com/weaveworks/weave-gitops/pkg/health"
 	"github.com/weaveworks/weave-gitops/pkg/services/crd"
 	"k8s.io/client-go/rest"
 )
@@ -36,6 +37,7 @@ type coreServer struct {
 	clustersManager clustersmngr.ClustersManager
 	primaryKinds    *PrimaryKinds
 	crd             crd.Fetcher
+	healthChecker   health.HealthChecker
 }
 
 type CoreServerConfig struct {
@@ -46,9 +48,10 @@ type CoreServerConfig struct {
 	ClustersManager clustersmngr.ClustersManager
 	PrimaryKinds    *PrimaryKinds
 	CRDService      crd.Fetcher
+	HealthChecker   health.HealthChecker
 }
 
-func NewCoreConfig(log logr.Logger, cfg *rest.Config, clusterName string, clustersManager clustersmngr.ClustersManager) (CoreServerConfig, error) {
+func NewCoreConfig(log logr.Logger, cfg *rest.Config, clusterName string, clustersManager clustersmngr.ClustersManager, healthChecker health.HealthChecker) (CoreServerConfig, error) {
 	kinds, err := DefaultPrimaryKinds()
 	if err != nil {
 		return CoreServerConfig{}, err
@@ -61,6 +64,7 @@ func NewCoreConfig(log logr.Logger, cfg *rest.Config, clusterName string, cluste
 		NSAccess:        nsaccess.NewChecker(nsaccess.DefautltWegoAppRules),
 		ClustersManager: clustersManager,
 		PrimaryKinds:    kinds,
+		HealthChecker:   healthChecker,
 	}, nil
 }
 
@@ -75,5 +79,6 @@ func NewCoreServer(cfg CoreServerConfig) (pb.CoreServer, error) {
 		clustersManager: cfg.ClustersManager,
 		primaryKinds:    cfg.PrimaryKinds,
 		crd:             cfg.CRDService,
+		healthChecker:   cfg.HealthChecker,
 	}, nil
 }

core/server/suite_test.go

@@ -15,6 +15,7 @@ import (
 	"github.com/weaveworks/weave-gitops/core/nsaccess/nsaccessfakes"
 	"github.com/weaveworks/weave-gitops/core/server"
 	pb "github.com/weaveworks/weave-gitops/pkg/api/core"
+	"github.com/weaveworks/weave-gitops/pkg/health"
 	"github.com/weaveworks/weave-gitops/pkg/kube"
 	"github.com/weaveworks/weave-gitops/pkg/server/auth"
 	"github.com/weaveworks/weave-gitops/pkg/services/crd"
@@ -71,8 +72,10 @@ func makeGRPCServer(cfg *rest.Config, t *testing.T) pb.CoreClient {
 
 	fetch := fetcher.NewSingleClusterFetcher(cluster)
 
+	hc := health.NewHealthChecker()
+
 	clustersManager := clustersmngr.NewClustersManager([]clustersmngr.ClusterFetcher{fetch}, &nsChecker, log)
-	coreCfg, err := server.NewCoreConfig(log, cfg, "foobar", clustersManager)
+	coreCfg, err := server.NewCoreConfig(log, cfg, "foobar", clustersManager, hc)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -184,7 +187,9 @@ func makeServerConfig(fakeClient client.Client, t *testing.T, clusterName string
 	// and the default options include the Flowcontrol setup which is not mocked out
 	clustersManager := clustersmngr.NewClustersManager([]clustersmngr.ClusterFetcher{fetcher}, &nsChecker, log)
 
-	coreCfg, err := server.NewCoreConfig(log, &rest.Config{}, "foobar", clustersManager)
+	hc := health.NewHealthChecker()
+
+	coreCfg, err := server.NewCoreConfig(log, &rest.Config{}, "foobar", clustersManager, hc)
 	if err != nil {
 		t.Fatal(err)
 	}