++ add Error reason for GarbageCollection condition

Signed-off-by: Ivan Mikheykin <[email protected]>

Author: diafour

images/virtualization-artifact/pkg/common/annotations/annotations.go

@@ -192,6 +192,9 @@ const (
 	AnnDVCRDeploymentSwitchToGarbageCollectionMode = AnnAPIGroupV + "/dvcr-deployment-switch-to-garbage-collection"
 	// AnnDVCRGarbageCollectionDone is an annotation on maintenance secret that indicates the garbage collection process is done.
 	AnnDVCRGarbageCollectionDone = AnnAPIGroupV + "/dvcr-garbage-collection-done"
+
+	// AnnDVCRGarbageCollectionResult is an annotation on deployment dvcr with last garbage collection result JSON.
+	AnnDVCRGarbageCollectionResult = AnnAPIGroupV + "/dvcr-garbage-collection-result"
 )
 
 // AddAnnotation adds an annotation to an object

images/virtualization-artifact/pkg/controller/dvcr-garbage-collection/internal/life_cycle.go

@@ -25,9 +25,10 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 
+	"github.com/deckhouse/virtualization-controller/pkg/common/annotations"
 	dvcrcondition "github.com/deckhouse/virtualization-controller/pkg/controller/dvcr-garbage-collection/condition"
 	dvcrtypes "github.com/deckhouse/virtualization-controller/pkg/controller/dvcr-garbage-collection/types"
-	dvcr_deployment_condition "github.com/deckhouse/virtualization/api/core/v1alpha2/dvcr-deployment-condition"
+	dvcrdeploymentcondition "github.com/deckhouse/virtualization/api/core/v1alpha2/dvcr-deployment-condition"
 )
 
 type LifeCycleHandler struct {
@@ -51,7 +52,7 @@ func (h LifeCycleHandler) Handle(ctx context.Context, req reconcile.Request, dep
 
 	if req.Namespace == dvcrtypes.CronSourceNamespace && req.Name == dvcrtypes.CronSourceRunGC {
 		dvcrcondition.UpdateGarbageCollectionCondition(deploy,
-			dvcr_deployment_condition.InProgress,
+			dvcrdeploymentcondition.InProgress,
 			"Garbage collection initiated.",
 		)
 		return reconcile.Result{}, h.dvcrService.InitiateGarbageCollectionMode(ctx)
@@ -78,16 +79,21 @@ func (h LifeCycleHandler) Handle(ctx context.Context, req reconcile.Request, dep
 		}
 
 		if h.dvcrService.IsGarbageCollectionDone(secret) {
-			dvcrcondition.UpdateGarbageCollectionCondition(deploy,
-				dvcr_deployment_condition.Done,
-				"%s", string(secret.Data["result"]),
-			)
+			// Extract error or success message from the result.
+			reason, msg, err := h.dvcrService.ParseGarbageCollectionResult(secret)
+			if err != nil {
+				return reconcile.Result{}, err
+			}
+			dvcrcondition.UpdateGarbageCollectionCondition(deploy, reason, "%s", msg)
+			// Put full result JSON into annotation on deployment.
+			annotations.AddAnnotation(deploy, annotations.AnnDVCRGarbageCollectionResult, h.dvcrService.GetGarbageCollectionResult(secret))
+			// It is now possible to delete a secret.
 			return reconcile.Result{}, h.dvcrService.DeleteGarbageCollectionSecret(ctx)
 		}
 
 		if h.dvcrService.IsGarbageCollectionStarted(secret) {
 			dvcrcondition.UpdateGarbageCollectionCondition(deploy,
-				dvcr_deployment_condition.InProgress,
+				dvcrdeploymentcondition.InProgress,
 				"Wait for garbage collection to finish.",
 			)
 			// Wait for done annotation.
@@ -102,7 +108,7 @@ func (h LifeCycleHandler) Handle(ctx context.Context, req reconcile.Request, dep
 		remainInProvisioning := len(resourcesInProvisioning)
 		if remainInProvisioning > 0 {
 			dvcrcondition.UpdateGarbageCollectionCondition(deploy,
-				dvcr_deployment_condition.InProgress,
+				dvcrdeploymentcondition.InProgress,
 				"Wait for cvi/vi/vd finish provisioning: %d resources remain.", remainInProvisioning,
 			)
 			return reconcile.Result{RequeueAfter: time.Second * 20}, nil
@@ -113,7 +119,7 @@ func (h LifeCycleHandler) Handle(ctx context.Context, req reconcile.Request, dep
 			return reconcile.Result{}, fmt.Errorf("switch to garbage collection mode: %w", err)
 		}
 		dvcrcondition.UpdateGarbageCollectionCondition(deploy,
-			dvcr_deployment_condition.InProgress,
+			dvcrdeploymentcondition.InProgress,
 			"Wait for garbage collection to finish.",
 		)
 		return reconcile.Result{}, nil

images/virtualization-artifact/pkg/controller/dvcr-garbage-collection/types/interfaces.go

@@ -21,6 +21,8 @@ import (
 
 	corev1 "k8s.io/api/core/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
+
+	dvcrdeploymentcondition "github.com/deckhouse/virtualization/api/core/v1alpha2/dvcr-deployment-condition"
 )
 
 type DVCRService interface {
@@ -31,6 +33,9 @@ type DVCRService interface {
 
 	IsGarbageCollectionStarted(secret *corev1.Secret) bool
 	IsGarbageCollectionDone(secret *corev1.Secret) bool
+
+	GetGarbageCollectionResult(secret *corev1.Secret) string
+	ParseGarbageCollectionResult(secret *corev1.Secret) (reason dvcrdeploymentcondition.GarbageCollectionReason, message string, err error)
 }
 
 type ProvisioningLister interface {

images/virtualization-artifact/pkg/controller/service/dvcr_service.go

@@ -18,6 +18,7 @@ package service
 
 import (
 	"context"
+	"encoding/json"
 	"fmt"
 
 	corev1 "k8s.io/api/core/v1"
@@ -27,6 +28,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	"github.com/deckhouse/virtualization-controller/pkg/common/annotations"
+	dvcrdeploymentcondition "github.com/deckhouse/virtualization/api/core/v1alpha2/dvcr-deployment-condition"
 )
 
 type DVCRService struct {
@@ -148,3 +150,32 @@ func (d *DVCRService) DeleteGarbageCollectionSecret(ctx context.Context) error {
 	err := d.client.Delete(ctx, secret)
 	return client.IgnoreNotFound(err)
 }
+
+func (d *DVCRService) GetGarbageCollectionResult(secret *corev1.Secret) string {
+	if secret == nil {
+		return ""
+	}
+	return string(secret.Data["result"])
+}
+
+func (d *DVCRService) ParseGarbageCollectionResult(secret *corev1.Secret) (reason dvcrdeploymentcondition.GarbageCollectionReason, message string, err error) {
+	var gcResult struct {
+		result  string
+		error   string
+		message string
+	}
+	err = json.Unmarshal(secret.Data["result"], &gcResult)
+	if err != nil {
+		return "", "", fmt.Errorf("parse garbage collection result '%s': %w", string(secret.Data["result"]), err)
+	}
+
+	switch gcResult.result {
+	case "success":
+		return dvcrdeploymentcondition.Done, gcResult.message, nil
+	case "fail":
+		return dvcrdeploymentcondition.Error, gcResult.error, nil
+	}
+
+	// Unexpected format. It should not happen, but we need to show something if it happens.
+	return dvcrdeploymentcondition.Done, string(secret.Data["result"]), nil
+}