add progressing condition

Signed-off-by: everettraven <[email protected]>

Author: everettraven

api/v1alpha1/clusterextension_types.go

@@ -22,12 +22,12 @@ import (
 	"github.com/operator-framework/operator-controller/internal/conditionsets"
 )
 
-var (
-	ClusterExtensionKind = "ClusterExtension"
-)
+var ClusterExtensionKind = "ClusterExtension"
 
-type UpgradeConstraintPolicy string
-type CRDUpgradeSafetyPolicy string
+type (
+	UpgradeConstraintPolicy string
+	CRDUpgradeSafetyPolicy  string
+)
 
 const (
 	// The extension will only upgrade if the new version satisfies
@@ -412,9 +412,10 @@ type CRDUpgradeSafetyPreflightConfig struct {
 
 const (
 	// TODO(user): add more Types, here and into init()
-	TypeInstalled = "Installed"
-	TypeResolved  = "Resolved"
-	TypeHealthy   = "Healthy"
+	TypeInstalled   = "Installed"
+	TypeResolved    = "Resolved"
+	TypeHealthy     = "Healthy"
+	TypeProgressing = "Progressing"
 
 	// TypeDeprecated is a rollup condition that is present when
 	// any of the deprecated conditions are present.
@@ -427,6 +428,8 @@ const (
 	ReasonSuccess    = "Succeeded"
 	ReasonDeprecated = "Deprecated"
 	ReasonFailed     = "Failed"
+	ReasonBlocked    = "Blocked"
+	ReasonRetrying   = "Retrying"
 
 	ReasonErrorGettingClient       = "ErrorGettingClient"
 	ReasonErrorGettingReleaseState = "ErrorGettingReleaseState"
@@ -448,6 +451,7 @@ func init() {
 		TypeBundleDeprecated,
 		TypeUnpacked,
 		TypeHealthy,
+		TypeProgressing,
 	)
 	// TODO(user): add Reasons from above
 	conditionsets.ConditionReasons = append(conditionsets.ConditionReasons,
@@ -457,6 +461,8 @@ func init() {
 		ReasonErrorGettingClient,
 		ReasonErrorGettingReleaseState,
 		ReasonUnverifiable,
+		ReasonBlocked,
+		ReasonRetrying,
 	)
 }
 

internal/controllers/clusterextension_controller.go

@@ -201,6 +201,7 @@ func (r *ClusterExtensionReconciler) reconcile(ctx context.Context, ext *ocv1alp
 		setInstallStatus(ext, nil)
 		setResolutionStatus(ext, nil)
 		setResolvedStatusConditionFailed(ext, err.Error())
+		setStatusProgressing(ext, err)
 		ensureAllConditionsWithReason(ext, ocv1alpha1.ReasonFailed, err.Error())
 		return ctrl.Result{}, err
 	}
@@ -216,6 +217,7 @@ func (r *ClusterExtensionReconciler) reconcile(ctx context.Context, ext *ocv1alp
 		setInstallStatus(ext, nil)
 		// TODO: use Installed=Unknown
 		setInstalledStatusConditionFailed(ext, err.Error())
+		setStatusProgressing(ext, err)
 		return ctrl.Result{}, err
 	}
 
@@ -227,6 +229,7 @@ func (r *ClusterExtensionReconciler) reconcile(ctx context.Context, ext *ocv1alp
 		setInstallStatus(ext, nil)
 		setResolutionStatus(ext, nil)
 		setResolvedStatusConditionFailed(ext, err.Error())
+		setStatusProgressing(ext, err)
 		ensureAllConditionsWithReason(ext, ocv1alpha1.ReasonFailed, err.Error())
 		return ctrl.Result{}, err
 	}
@@ -264,20 +267,15 @@ func (r *ClusterExtensionReconciler) reconcile(ctx context.Context, ext *ocv1alp
 	unpackResult, err := r.Unpacker.Unpack(ctx, bundleSource)
 	if err != nil {
 		setStatusUnpackFailed(ext, err.Error())
+		setStatusProgressing(ext, err)
 		return ctrl.Result{}, err
 	}
 
 	switch unpackResult.State {
-	case rukpaksource.StatePending:
-		setStatusUnpackFailed(ext, unpackResult.Message)
-		ensureAllConditionsWithReason(ext, ocv1alpha1.ReasonFailed, "unpack pending")
-		return ctrl.Result{}, nil
 	case rukpaksource.StateUnpacked:
 		setStatusUnpacked(ext, unpackResult.Message)
 	default:
-		setStatusUnpackFailed(ext, "unexpected unpack status")
-		// We previously exit with a failed status if error is not nil.
-		return ctrl.Result{}, fmt.Errorf("unexpected unpack status: %v", unpackResult.Message)
+		panic(fmt.Sprintf("unexpected unpack state %q", unpackResult.State))
 	}
 
 	objLbls := map[string]string{
@@ -304,6 +302,7 @@ func (r *ClusterExtensionReconciler) reconcile(ctx context.Context, ext *ocv1alp
 	managedObjs, _, err := r.Applier.Apply(ctx, unpackResult.Bundle, ext, objLbls, storeLbls)
 	if err != nil {
 		setInstalledStatusConditionFailed(ext, err.Error())
+		setStatusProgressing(ext, err)
 		return ctrl.Result{}, err
 	}
 
@@ -325,6 +324,7 @@ func (r *ClusterExtensionReconciler) reconcile(ctx context.Context, ext *ocv1alp
 			Message:            err.Error(),
 			ObservedGeneration: ext.Generation,
 		})
+		setStatusProgressing(ext, err)
 		return ctrl.Result{}, err
 	}
 
@@ -338,13 +338,20 @@ func (r *ClusterExtensionReconciler) reconcile(ctx context.Context, ext *ocv1alp
 			Message:            err.Error(),
 			ObservedGeneration: ext.Generation,
 		})
+		setStatusProgressing(ext, err)
 		return ctrl.Result{}, err
 	}
 
 	// If we have successfully established the watches, remove the "Healthy" condition.
 	// It should be interpreted as "Unknown" when not present.
 	apimeta.RemoveStatusCondition(&ext.Status.Conditions, ocv1alpha1.TypeHealthy)
 
+	// If we made it here, we have successfully reconciled the ClusterExtension
+	// and have reached the desired state. Since the Progressing status should reflect
+	// our progress towards the desired state, we also set it when we have reached
+	// the desired state by providing a nil error value.
+	setStatusProgressing(ext, nil)
+
 	return ctrl.Result{}, nil
 }