feat(olm): add message to requirement statuses

Author: Jeff Peeler

pkg/api/apis/operators/v1alpha1/clusterserviceversion_types.go

@@ -274,6 +274,7 @@ type RequirementStatus struct {
 	Kind       string            `json:"kind"`
 	Name       string            `json:"name"`
 	Status     StatusReason      `json:"status"`
+	Message    string            `json:"message"`
 	UUID       string            `json:"uuid,omitempty"`
 	Dependents []DependentStatus `json:"dependents,omitempty"`
 }
@@ -445,3 +446,4 @@ func (csv ClusterServiceVersion) GetOwnedAPIServiceDescriptions() []APIServiceDe
 
 	return descs
 }
+

pkg/controller/operators/olm/operator_test.go

@@ -2143,6 +2143,7 @@ func TestSyncOperatorGroups(t *testing.T) {
 			Kind:    "CustomResourceDefinition",
 			Name:    crd.GetName(),
 			Status:  v1alpha1.RequirementStatusReasonPresent,
+			Message: "CRD is present and Established condition is true",
 		},
 		{
 			Group:   "",

pkg/controller/operators/olm/requirements.go

@@ -31,20 +31,18 @@ func (a *Operator) requirementStatus(strategyDetailsDeployment *install.Strategy
 		crd, err := a.lister.APIExtensionsV1beta1().CustomResourceDefinitionLister().Get(r.Name)
 		if err != nil {
 			status.Status = v1alpha1.RequirementStatusReasonNotPresent
+			status.Message = "CRD is not present"
 			a.Log.Debugf("Setting 'met' to false, %v with status %v, with err: %v", r.Name, status, err)
 			met = false
 			statuses = append(statuses, status)
 			continue
 		}
 
-		if crd.Spec.Version == r.Version {
-			status.Status = v1alpha1.RequirementStatusReasonPresent
-		} else {
+		if crd.Spec.Version != r.Version {
 			served := false
 			for _, version := range crd.Spec.Versions {
 				if version.Name == r.Version {
 					if version.Served {
-						status.Status = v1alpha1.RequirementStatusReasonPresent
 						served = true
 					}
 					break
@@ -53,6 +51,7 @@ func (a *Operator) requirementStatus(strategyDetailsDeployment *install.Strategy
 
 			if !served {
 				status.Status = v1alpha1.RequirementStatusReasonNotPresent
+				status.Message = "CRD version not served"
 				a.Log.Debugf("Setting 'met' to false, %v with status %v, CRD version %v not found", r.Name, status, r.Version)
 				met = false
 				statuses = append(statuses, status)
@@ -77,10 +76,13 @@ func (a *Operator) requirementStatus(strategyDetailsDeployment *install.Strategy
 		}
 
 		if established && namesAccepted {
+			status.Status = v1alpha1.RequirementStatusReasonPresent
+			status.Message = "CRD is present and Established condition is true"
 			status.UUID = string(crd.GetUID())
 			statuses = append(statuses, status)
 		} else {
 			status.Status = v1alpha1.RequirementStatusReasonNotAvailable
+			status.Message = "CRD is present but the Established condition is False (not available)"
 			met = false
 			a.Log.Debugf("Setting 'met' to false, %v with status %v, established=%v, namesAccepted=%v", r.Name, status, established, namesAccepted)
 			statuses = append(statuses, status)
@@ -163,11 +165,13 @@ func (a *Operator) requirementStatus(strategyDetailsDeployment *install.Strategy
 
 		if err := a.isGVKRegistered(r.Group, r.Version, r.Kind); err != nil {
 			status.Status = v1alpha1.RequirementStatusReasonNotPresent
+			status.Message = "Native API does not exist"
 			met = false
 			statuses = append(statuses, status)
 			continue
 		} else {
 			status.Status = v1alpha1.RequirementStatusReasonPresent
+			status.Message = "Native API exists"
 			statuses = append(statuses, status)
 			continue
 		}
@@ -205,6 +209,7 @@ func (a *Operator) permissionStatus(strategyDetailsDeployment *install.StrategyD
 			if err != nil {
 				met = false
 				status.Status = v1alpha1.RequirementStatusReasonNotPresent
+				status.Message = "Service account does not exist"
 				statusesSet[saName] = status
 				continue
 			}
@@ -240,6 +245,7 @@ func (a *Operator) permissionStatus(strategyDetailsDeployment *install.StrategyD
 					met = false
 					dependent.Status = v1alpha1.DependentStatusReasonNotSatisfied
 					status.Status = v1alpha1.RequirementStatusReasonPresentNotSatisfied
+					status.Message = "Policy rule not satisfied for service account"
 				} else {
 					dependent.Status = v1alpha1.DependentStatusReasonSatisfied
 				}