api: make status substruct on operatorstatus

The spec/status split is a kuberentes standard that is respected in a generic way by
kubectl and CRDs.  Making OperatorStatus conform will make it match expectations.

Author: deads2k

cmd/start.go

@@ -232,7 +232,7 @@ func startControllers(ctx *controllerContext) error {
 		componentNamespace, componentName,
 		rootOpts.releaseImage,
 		ctx.InformerFactory.Clusterversion().V1().CVOConfigs(),
-		ctx.InformerFactory.Operatorstatus().V1().OperatorStatuses(),
+		ctx.InformerFactory.Operatorstatus().V1().ClusterOperators(),
 		ctx.APIExtInformerFactory.Apiextensions().V1beta1().CustomResourceDefinitions(),
 		ctx.KubeInformerFactory.Apps().V1().Deployments(),
 		ctx.ClientBuilder.RestConfig(),
@@ -245,7 +245,7 @@ func startControllers(ctx *controllerContext) error {
 		go autoupdate.New(
 			componentNamespace, componentName,
 			ctx.InformerFactory.Clusterversion().V1().CVOConfigs(),
-			ctx.InformerFactory.Operatorstatus().V1().OperatorStatuses(),
+			ctx.InformerFactory.Operatorstatus().V1().ClusterOperators(),
 			ctx.ClientBuilder.ClientOrDie(componentName),
 			ctx.ClientBuilder.KubeClientOrDie(componentName),
 		).Run(2, ctx.Stop)

install/0000_00_cluster-version-operator_01_cvoconfig.crd.yaml

@@ -15,6 +15,9 @@ spec:
       storage: true
   # either Namespaced or Cluster
   scope: Namespaced
+  subresources:
+    # enable spec/status
+    status: {}
   names:
     # plural name to be used in the URL: /apis/<group>/<version>/<plural>
     plural: cvoconfigs

lib/resourceapply/cv.go

@@ -15,13 +15,13 @@ import (
 	"k8s.io/utils/pointer"
 )
 
-func ApplyOperatorStatus(client osclientv1.OperatorStatusesGetter, required *osv1.OperatorStatus) (*osv1.OperatorStatus, bool, error) {
-	if required.Extension.Raw != nil && required.Extension.Object != nil {
+func ApplyOperatorStatus(client osclientv1.ClusterOperatorsGetter, required *osv1.ClusterOperator) (*osv1.ClusterOperator, bool, error) {
+	if required.Status.Extension.Raw != nil && required.Status.Extension.Object != nil {
 		return nil, false, fmt.Errorf("both extension.Raw and extension.Object should not be set")
 	}
-	existing, err := client.OperatorStatuses(required.Namespace).Get(required.Name, metav1.GetOptions{})
+	existing, err := client.ClusterOperators(required.Namespace).Get(required.Name, metav1.GetOptions{})
 	if errors.IsNotFound(err) {
-		actual, err := client.OperatorStatuses(required.Namespace).Create(required)
+		actual, err := client.ClusterOperators(required.Namespace).Create(required)
 		return actual, true, err
 	}
 	if err != nil {
@@ -34,17 +34,17 @@ func ApplyOperatorStatus(client osclientv1.OperatorStatusesGetter, required *osv
 		return existing, false, nil
 	}
 
-	actual, err := client.OperatorStatuses(required.Namespace).Update(existing)
+	actual, err := client.ClusterOperators(required.Namespace).Update(existing)
 	return actual, true, err
 }
 
-func ApplyOperatorStatusFromCache(lister oslistersv1.OperatorStatusLister, client osclientv1.OperatorStatusesGetter, required *osv1.OperatorStatus) (*osv1.OperatorStatus, bool, error) {
-	if required.Extension.Raw != nil && required.Extension.Object != nil {
+func ApplyOperatorStatusFromCache(lister oslistersv1.ClusterOperatorLister, client osclientv1.ClusterOperatorsGetter, required *osv1.ClusterOperator) (*osv1.ClusterOperator, bool, error) {
+	if required.Status.Extension.Raw != nil && required.Status.Extension.Object != nil {
 		return nil, false, fmt.Errorf("both extension.Raw and extension.Object should not be set")
 	}
-	existing, err := lister.OperatorStatuses(required.Namespace).Get(required.Name)
+	existing, err := lister.ClusterOperators(required.Namespace).Get(required.Name)
 	if errors.IsNotFound(err) {
-		actual, err := client.OperatorStatuses(required.Namespace).Create(required)
+		actual, err := client.ClusterOperators(required.Namespace).Create(required)
 		return actual, true, err
 	}
 	if err != nil {
@@ -59,7 +59,7 @@ func ApplyOperatorStatusFromCache(lister oslistersv1.OperatorStatusLister, clien
 		return existing, false, nil
 	}
 
-	actual, err := client.OperatorStatuses(required.Namespace).Update(existing)
+	actual, err := client.ClusterOperators(required.Namespace).Update(existing)
 	return actual, true, err
 }
 

lib/resourcemerge/os.go

@@ -1,24 +1,28 @@
 package resourcemerge
 
 import (
-	osv1 "github.com/openshift/cluster-version-operator/pkg/apis/operatorstatus.openshift.io/v1"
+	"time"
+
 	"k8s.io/apimachinery/pkg/api/equality"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	osv1 "github.com/openshift/cluster-version-operator/pkg/apis/operatorstatus.openshift.io/v1"
 )
 
-func EnsureOperatorStatus(modified *bool, existing *osv1.OperatorStatus, required osv1.OperatorStatus) {
+func EnsureOperatorStatus(modified *bool, existing *osv1.ClusterOperator, required osv1.ClusterOperator) {
 	EnsureObjectMeta(modified, &existing.ObjectMeta, required.ObjectMeta)
-	if !equality.Semantic.DeepEqual(existing.Condition, required.Condition) {
+	ensureOperatorStatusStatus(modified, &existing.Status, required.Status)
+}
+
+func ensureOperatorStatusStatus(modified *bool, existing *osv1.ClusterOperatorStatus, required osv1.ClusterOperatorStatus) {
+	if !equality.Semantic.DeepEqual(existing.Conditions, required.Conditions) {
 		*modified = true
-		existing.Condition = required.Condition
+		existing.Conditions = required.Conditions
 	}
 	if existing.Version != required.Version {
 		*modified = true
 		existing.Version = required.Version
 	}
-	if !existing.LastUpdate.Equal(&required.LastUpdate) {
-		*modified = true
-		existing.LastUpdate = required.LastUpdate
-	}
 	if !equality.Semantic.DeepEqual(existing.Extension.Raw, required.Extension.Raw) {
 		*modified = true
 		existing.Extension.Raw = required.Extension.Raw
@@ -28,3 +32,64 @@ func EnsureOperatorStatus(modified *bool, existing *osv1.OperatorStatus, require
 		existing.Extension.Object = required.Extension.Object
 	}
 }
+
+func SetOperatorStatusCondition(conditions *[]osv1.ClusterOperatorStatusCondition, newCondition osv1.ClusterOperatorStatusCondition) {
+	if conditions == nil {
+		conditions = &[]osv1.ClusterOperatorStatusCondition{}
+	}
+	existingCondition := FindOperatorStatusCondition(*conditions, newCondition.Type)
+	if existingCondition == nil {
+		newCondition.LastTransitionTime = metav1.NewTime(time.Now())
+		*conditions = append(*conditions, newCondition)
+		return
+	}
+
+	if existingCondition.Status != newCondition.Status {
+		existingCondition.Status = newCondition.Status
+		existingCondition.LastTransitionTime = newCondition.LastTransitionTime
+	}
+
+	existingCondition.Reason = newCondition.Reason
+	existingCondition.Message = newCondition.Message
+}
+
+func RemoveOperatorStatusCondition(conditions *[]osv1.ClusterOperatorStatusCondition, conditionType osv1.ClusterStatusConditionType) {
+	if conditions == nil {
+		conditions = &[]osv1.ClusterOperatorStatusCondition{}
+	}
+	newConditions := []osv1.ClusterOperatorStatusCondition{}
+	for _, condition := range *conditions {
+		if condition.Type != conditionType {
+			newConditions = append(newConditions, condition)
+		}
+	}
+
+	*conditions = newConditions
+}
+
+func FindOperatorStatusCondition(conditions []osv1.ClusterOperatorStatusCondition, conditionType osv1.ClusterStatusConditionType) *osv1.ClusterOperatorStatusCondition {
+	for i := range conditions {
+		if conditions[i].Type == conditionType {
+			return &conditions[i]
+		}
+	}
+
+	return nil
+}
+
+func IsOperatorStatusConditionTrue(conditions []osv1.ClusterOperatorStatusCondition, conditionType osv1.ClusterStatusConditionType) bool {
+	return IsOperatorStatusConditionPresentAndEqual(conditions, conditionType, osv1.ConditionTrue)
+}
+
+func IsOperatorStatusConditionFalse(conditions []osv1.ClusterOperatorStatusCondition, conditionType osv1.ClusterStatusConditionType) bool {
+	return IsOperatorStatusConditionPresentAndEqual(conditions, conditionType, osv1.ConditionFalse)
+}
+
+func IsOperatorStatusConditionPresentAndEqual(conditions []osv1.ClusterOperatorStatusCondition, conditionType osv1.ClusterStatusConditionType, status osv1.ConditionStatus) bool {
+	for _, condition := range conditions {
+		if condition.Type == conditionType {
+			return condition.Status == status
+		}
+	}
+	return false
+}

pkg/apis/operatorstatus.openshift.io/v1/register.go

@@ -36,8 +36,8 @@ func init() {
 // Adds the list of known types to api.Scheme.
 func addKnownTypes(scheme *runtime.Scheme) error {
 	scheme.AddKnownTypes(SchemeGroupVersion,
-		&OperatorStatus{},
-		&OperatorStatusList{},
+		&ClusterOperator{},
+		&ClusterOperatorList{},
 	)
 
 	metav1.AddToGroupVersion(scheme, SchemeGroupVersion)

pkg/apis/operatorstatus.openshift.io/v1/types.go

@@ -5,72 +5,102 @@ import (
 	"k8s.io/apimachinery/pkg/runtime"
 )
 
-// OperatorStatusList is a list of OperatorStatus resources.
+// ClusterOperatorList is a list of OperatorStatus resources.
 // +k8s:deepcopy-gen=true
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
-type OperatorStatusList struct {
+type ClusterOperatorList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata"`
 
-	Items []OperatorStatus `json:"items"`
+	Items []ClusterOperator `json:"items"`
 }
 
-// OperatorStatus is the Custom Resource object which holds the current state
+// ClusterOperator is the Custom Resource object which holds the current state
 // of an operator. This object is used by operators to convey their state to
 // the rest of the cluster.
 // +genclient
 // +k8s:deepcopy-gen=true
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
-type OperatorStatus struct {
+type ClusterOperator struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata"`
 
-	// Condition describes the state of the operator's reconciliation
-	// functionality.
-	Condition OperatorStatusCondition `json:"condition"`
+	// Spec hold the intent of how this operator should behave.
+	Spec ClusterOperatorSpec `json:"spec"`
 
-	// Version indicates which version of the operator updated the current
+	// status holds the information about the state of an operator.  It is consistent with status information across
+	// the kube ecosystem.
+	Status ClusterOperatorStatus `json:"status"`
+}
+
+// ClusterOperatorSpec is empty for now, but you could imagine holding information like "pause".
+type ClusterOperatorSpec struct {
+}
+
+// ClusterOperatorStatus provides information about the status of the operator.
+// +k8s:deepcopy-gen=true
+type ClusterOperatorStatus struct {
+	// conditions describes the state of the operator's reconciliation functionality.
+	// +patchMergeKey=type
+	// +patchStrategy=merge
+	Conditions []ClusterOperatorStatusCondition `json:"conditions"`
+
+	// version indicates which version of the operator updated the current
 	// status object.
 	Version string `json:"version"`
 
-	// LasteUpdate is the time of the last update to the current status object.
-	LastUpdate metav1.Time `json:"lastUpdate"`
-
-	// Extension contains any additional status information specific to the
+	// extension contains any additional status information specific to the
 	// operator which owns this status object.
-	Extension runtime.RawExtension `json:"extension"`
+	Extension runtime.RawExtension `json:"extension,omitempty"`
 }
 
-// OperatorStatusCondition represents the state of the operator's
+type ConditionStatus string
+
+// These are valid condition statuses. "ConditionTrue" means a resource is in the condition.
+// "ConditionFalse" means a resource is not in the condition. "ConditionUnknown" means kubernetes
+// can't decide if a resource is in the condition or not. In the future, we could add other
+// intermediate conditions, e.g. ConditionDegraded.
+const (
+	ConditionTrue    ConditionStatus = "True"
+	ConditionFalse   ConditionStatus = "False"
+	ConditionUnknown ConditionStatus = "Unknown"
+)
+
+// ClusterOperatorStatusCondition represents the state of the operator's
 // reconciliation functionality.
-type OperatorStatusCondition struct {
-	// Type specifies the state of the operator's reconciliation functionality.
-	Type OperatorStatusConditionType `json:"type"`
+// +k8s:deepcopy-gen=true
+type ClusterOperatorStatusCondition struct {
+	// type specifies the state of the operator's reconciliation functionality.
+	Type ClusterStatusConditionType `json:"type"`
+
+	// Status of the condition, one of True, False, Unknown.
+	Status ConditionStatus `json:"status"`
 
-	// Message provides any additional information about the current condition.
+	// LastTransitionTime is the time of the last update to the current status object.
+	LastTransitionTime metav1.Time `json:"lastTransitionTime"`
+
+	// reason is the reason for the condition's last transition.  Reasons are CamelCase
+	Reason string `json:"reason,omitempty"`
+
+	// message provides additional information about the current condition.
 	// This is only to be consumed by humans.
-	Message string `json:"message"`
+	Message string `json:"message,omitempty"`
 }
 
-// OperatorStatusConditionType is the state of the operator's reconciliation
-// functionality.
-type OperatorStatusConditionType string
+// ClusterStatusConditionType is the state of the operator's reconciliation functionality.
+type ClusterStatusConditionType string
 
 const (
-	// OperatorStatusConditionTypeWaiting indicates that the operator isn't
-	// running its reconciliation functionality. This may be because a
-	// dependency or other prerequisite hasn't been satisfied.
-	OperatorStatusConditionTypeWaiting OperatorStatusConditionType = "Waiting"
-
-	// OperatorStatusConditionTypeWorking indicates that the operator is
-	// actively reconciling its operands.
-	OperatorStatusConditionTypeWorking OperatorStatusConditionType = "Working"
-
-	// OperatorStatusConditionTypeDone indicates that the operator has finished
-	// reconciling its operands and is waiting for changes.
-	OperatorStatusConditionTypeDone OperatorStatusConditionType = "Done"
-
-	// OperatorStatusConditionTypeDegraded indicates that the operator has
-	// encountered an error that is preventing it from working properly.
-	OperatorStatusConditionTypeDegraded OperatorStatusConditionType = "Degraded"
+	// OperatorAvailable indicates that the binary maintained by the operator (eg: openshift-apiserver for the
+	// openshift-apiserver-operator), is functional and available in the cluster.
+	OperatorAvailable ClusterStatusConditionType = "Available"
+
+	// OperatorProgressing indicates that the operator is actively making changes to the binary maintained by the
+	// operator (eg: openshift-apiserver for the openshift-apiserver-operator).
+	OperatorProgressing ClusterStatusConditionType = "Progressing"
+
+	// OperatorFailing indicates that the operator has encountered an error that is preventing it from working properly.
+	// The binary maintained by the operator (eg: openshift-apiserver for the openshift-apiserver-operator) may still be
+	// available, but the user intent cannot be fulfilled.
+	OperatorFailing ClusterStatusConditionType = "Failing"
 )