Add Resource Health Status (#136)

Also, we can tidy up the common API conversion routines using the power
of interface type assertion to simplify every handler in the system.

Author: spjmurray

Makefile

@@ -29,7 +29,7 @@ CONTROLLER_TOOLS_VERSION=v0.17.3
 # This should be kept in sync with the Kubenetes library versions defined in go.mod.
 CODEGEN_VERSION := $(shell grep k8s.io/apimachinery go.mod | awk '{ print $$2; }')
 
-OPENAPI_CODEGEN_VERSION=v1.16.2
+OPENAPI_CODEGEN_VERSION=v2.4.1
 
 OPENAPI_FILES = pkg/openapi/types.go pkg/openapi/schema.go
 
@@ -68,11 +68,11 @@ test-unit:
 	go tool cover -html cover.out -o cover.html
 
 pkg/openapi/types.go: pkg/openapi/common.spec.yaml
-	@go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen@$(OPENAPI_CODEGEN_VERSION)
+	@go install github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen@$(OPENAPI_CODEGEN_VERSION)
 	oapi-codegen -generate types,skip-prune -package openapi -o $@ $<
 
 pkg/openapi/schema.go: pkg/openapi/common.spec.yaml
-	@go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen@$(OPENAPI_CODEGEN_VERSION)
+	@go install github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen@$(OPENAPI_CODEGEN_VERSION)
 	oapi-codegen -generate spec,skip-prune -package openapi -o $@ $<
 
 # Create any CRDs defined into the target directory.

charts/core/Chart.yaml

@@ -4,8 +4,8 @@ description: A Helm chart for deploying Unikorn Core
 
 type: application
 
-version: v1.1.0-rc1
-appVersion: v1.1.0-rc1
+version: v1.1.0-rc2
+appVersion: v1.1.0-rc2
 
 icon: https://assets.unikorn-cloud.org/images/logos/dark-on-light/icon.svg
 

pkg/apis/unikorn/v1alpha1/types.go

@@ -275,13 +275,17 @@ const (
 	// resource is not ready, or is known to be in a bad state and should
 	// not be used.  When true, while not guaranteed to be fully functional.
 	ConditionAvailable ConditionType = "Available"
+	// ConditionHealthy if defined describes the current healthiness of
+	// the resource.
+	ConditionHealthy ConditionType = "Healthy"
 )
 
 // ConditionReason defines the possible reasons of a resource
 // condition.  These are generic and may be used by any condition.
 // +kubebuilder:validation:Enum=Provisioning;Provisioned;Cancelled;Errored;Deprovisioning;Deprovisioned
 type ConditionReason string
 
+// Condition reasons for ConditionAvailable.
 const (
 	// ConditionReasonProvisioning is used for the Available condition
 	// to indicate that a resource has been seen, it has no pre-existing condition
@@ -306,6 +310,16 @@ const (
 	ConditionReasonDeprovisioned ConditionReason = "Deprovisioned"
 )
 
+// Condition reasons for ConditionHealthy.
+const (
+	// ConditionReasonHealthy means all subresources associated with the
+	// resource are in a healthy state.
+	ConditionReasonHealthy ConditionReason = "Healthy"
+	// ConditionReasonDegraded means some subresources associated with the
+	// resource are degraded e.g. a deployment not correctly scaled etc.
+	ConditionReasonDegraded ConditionReason = "Degraded"
+)
+
 // Condition is a generic condition type for use across all resource types.
 // It's generic so that the underlying controller-manager functionality can
 // be shared across all resources.

pkg/openapi/common.spec.yaml

@@ -116,20 +116,30 @@ components:
       - provisioned
       - deprovisioning
       - error
+    resourceHealthStatus:
+      description: The health state of a resource.
+      type: string
+      enum:
+      - unknown
+      - healthy
+      - degraded
     resourceReadMetadata:
       description: Resource metadata valid for all reads.
       allOf:
       - $ref: '#/components/schemas/staticResourceMetadata'
       - type: object
         required:
         - provisioningStatus
+        - healthStatus
         properties:
           deletionTime:
             description: The time the resource was deleted.
             type: string
             format: date-time
           provisioningStatus:
             $ref: '#/components/schemas/resourceProvisioningStatus'
+          healthStatus:
+            $ref: '#/components/schemas/resourceHealthStatus'
     organizationScopedResourceReadMetadata:
       allOf:
       - $ref: '#/components/schemas/resourceReadMetadata'

pkg/openapi/schema.go

@@ -34,10 +34,22 @@ var (
 	ErrAnnotation = errors.New("a required annotation was missing")
 )
 
-// ConvertStatusCondition translates from Kubernetes status conditions to API ones.
-func ConvertStatusCondition(in *unikornv1.Condition) openapi.ResourceProvisioningStatus {
+// convertStatusCondition translates from Kubernetes status conditions to API ones.
+func convertStatusCondition(in any) openapi.ResourceProvisioningStatus {
+	// Not a resource with status conditions, consider it provisioned.
+	reader, ok := in.(unikornv1.StatusConditionReader)
+	if !ok {
+		return openapi.ResourceProvisioningStatusProvisioned
+	}
+
+	// No condition yet, it's unknown.
+	condition, err := reader.StatusConditionRead(unikornv1.ConditionAvailable)
+	if err != nil {
+		return openapi.ResourceProvisioningStatusUnknown
+	}
+
 	//nolint:exhaustive
-	switch in.Reason {
+	switch condition.Reason {
 	case unikornv1.ConditionReasonProvisioning:
 		return openapi.ResourceProvisioningStatusProvisioning
 	case unikornv1.ConditionReasonProvisioned:
@@ -46,21 +58,47 @@ func ConvertStatusCondition(in *unikornv1.Condition) openapi.ResourceProvisionin
 		return openapi.ResourceProvisioningStatusError
 	case unikornv1.ConditionReasonDeprovisioning:
 		return openapi.ResourceProvisioningStatusDeprovisioning
-	default:
-		return openapi.ResourceProvisioningStatusUnknown
 	}
+
+	return openapi.ResourceProvisioningStatusUnknown
+}
+
+// convertHealthCondition translates from Kubernetes heath conditions to API ones.
+func convertHealthCondition(in any) openapi.ResourceHealthStatus {
+	// Not a resource with status conditions, consider it healthy.
+	reader, ok := in.(unikornv1.StatusConditionReader)
+	if !ok {
+		return openapi.ResourceHealthStatusHealthy
+	}
+
+	// No condition yet, it's unknown.
+	condition, err := reader.StatusConditionRead(unikornv1.ConditionHealthy)
+	if err != nil {
+		return openapi.ResourceHealthStatusUnknown
+	}
+
+	//nolint:exhaustive
+	switch condition.Reason {
+	case unikornv1.ConditionReasonHealthy:
+		return openapi.ResourceHealthStatusHealthy
+	case unikornv1.ConditionReasonDegraded:
+		return openapi.ResourceHealthStatusDegraded
+	}
+
+	return openapi.ResourceHealthStatusUnknown
 }
 
 // ResourceReadMetadata extracts generic metadata from a resource for GET APIs.
-func ResourceReadMetadata(in metav1.Object, tags unikornv1.TagList, status openapi.ResourceProvisioningStatus) openapi.ResourceReadMetadata {
+func ResourceReadMetadata(in metav1.Object, tags unikornv1.TagList) openapi.ResourceReadMetadata {
 	labels := in.GetLabels()
 	annotations := in.GetAnnotations()
 
 	out := openapi.ResourceReadMetadata{
 		Id:                 in.GetName(),
 		Name:               labels[constants.NameLabel],
 		CreationTime:       in.GetCreationTimestamp().Time,
-		ProvisioningStatus: status,
+		ProvisioningStatus: convertStatusCondition(in),
+		HealthStatus:       convertHealthCondition(in),
 	}
 
 	if v, ok := annotations[constants.DescriptionAnnotation]; ok {
@@ -95,10 +133,10 @@ func ResourceReadMetadata(in metav1.Object, tags unikornv1.TagList, status opena
 
 // OrganizationScopedResourceReadMetadata extracts organization scoped metdata from a resource
 // for GET APIS.
-func OrganizationScopedResourceReadMetadata(in metav1.Object, tags unikornv1.TagList, status openapi.ResourceProvisioningStatus) openapi.OrganizationScopedResourceReadMetadata {
+func OrganizationScopedResourceReadMetadata(in metav1.Object, tags unikornv1.TagList) openapi.OrganizationScopedResourceReadMetadata {
 	labels := in.GetLabels()
 
-	temp := ResourceReadMetadata(in, tags, status)
+	temp := ResourceReadMetadata(in, tags)
 
 	out := openapi.OrganizationScopedResourceReadMetadata{
 		Id:                 temp.Id,
@@ -109,6 +147,7 @@ func OrganizationScopedResourceReadMetadata(in metav1.Object, tags unikornv1.Tag
 		ModifiedBy:         temp.ModifiedBy,
 		ModifiedTime:       temp.ModifiedTime,
 		ProvisioningStatus: temp.ProvisioningStatus,
+		HealthStatus:       temp.HealthStatus,
 		Tags:               temp.Tags,
 		OrganizationId:     labels[constants.OrganizationLabel],
 	}
@@ -118,10 +157,10 @@ func OrganizationScopedResourceReadMetadata(in metav1.Object, tags unikornv1.Tag
 
 // ProjectScopedResourceReadMetadata extracts project scoped metdata from a resource for
 // GET APIs.
-func ProjectScopedResourceReadMetadata(in metav1.Object, tags unikornv1.TagList, status openapi.ResourceProvisioningStatus) openapi.ProjectScopedResourceReadMetadata {
+func ProjectScopedResourceReadMetadata(in metav1.Object, tags unikornv1.TagList) openapi.ProjectScopedResourceReadMetadata {
 	labels := in.GetLabels()
 
-	temp := OrganizationScopedResourceReadMetadata(in, tags, status)
+	temp := OrganizationScopedResourceReadMetadata(in, tags)
 
 	out := openapi.ProjectScopedResourceReadMetadata{
 		Id:                 temp.Id,
@@ -132,6 +171,7 @@ func ProjectScopedResourceReadMetadata(in metav1.Object, tags unikornv1.TagList,
 		ModifiedBy:         temp.ModifiedBy,
 		ModifiedTime:       temp.ModifiedTime,
 		ProvisioningStatus: temp.ProvisioningStatus,
+		HealthStatus:       temp.HealthStatus,
 		Tags:               temp.Tags,
 		OrganizationId:     temp.OrganizationId,
 		ProjectId:          labels[constants.ProjectLabel],