feat(olm): write operator status by default

`writeStatusName` may be passed as an argument set to the name in which to write
the status. The default is `openshift-operator-lifecycle-manager` with an empty
string disabling the behavior.

If the proper openshift API group isn't found, the status update will be
skipped.

Author: Jeff Peeler

Documentation/install/local-values.yaml

@@ -1,6 +1,7 @@
 rbacApiVersion: rbac.authorization.k8s.io
 namespace: local
 watchedNamespaces: local
+writeStatusName: '""'
 catalog_namespace: local
 operator_namespace: local-operators
 debug: true

cmd/olm/main.go

@@ -11,18 +11,26 @@ import (
 	"github.com/prometheus/client_golang/prometheus"
 	log "github.com/sirupsen/logrus"
 	v1 "k8s.io/api/core/v1"
+	k8serrors "k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/api/meta"
 
+	configv1 "github.com/openshift/api/config/v1"
+	configv1client "github.com/openshift/client-go/config/clientset/versioned/typed/config/v1"
+	v1helpers "github.com/openshift/library-go/pkg/config/clusteroperator/v1helpers"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/install"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/olm"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/operatorclient"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/signals"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/metrics"
 	olmversion "github.com/operator-framework/operator-lifecycle-manager/pkg/version"
+	"k8s.io/client-go/tools/clientcmd"
 )
 
 const (
-	defaultWakeupInterval = 5 * time.Minute
+	defaultWakeupInterval      = 5 * time.Minute
+	defaultOperatorName        = "openshift-operator-lifecycle-manager"
 )
 
 // config flags defined globally so that they appear on the test binary as well
@@ -38,6 +46,9 @@ var (
 			"If not set, or set to the empty string (e.g. `-watchedNamespaces=\"\"`), "+
 			"olm operator will watch all namespaces in the cluster.")
 
+	writeStatusName = flag.String(
+		"writeStatusName", defaultOperatorName, "ClusterOperator name in which to write status, set to \"\" to disable.")
+
 	debug = flag.Bool(
 		"debug", false, "use debug log level")
 
@@ -89,6 +100,16 @@ func main() {
 
 	opClient := operatorclient.NewClientFromConfig(*kubeConfigPath, logger)
 
+	// create a config client for operator status
+	config, err := clientcmd.BuildConfigFromFlags("", *kubeConfigPath)
+	if err != nil {
+		log.Fatalf("error configuring client: %s", err.Error())
+	}
+	configClient, err := configv1client.NewForConfig(config)
+	if err != nil {
+		log.Fatalf("error configuring client: %s", err.Error())
+	}
+
 	// Create a new instance of the operator.
 	operator, err := olm.NewOperator(logger, crClient, opClient, &install.StrategyResolver{}, *wakeupInterval, namespaces)
 
@@ -106,6 +127,60 @@ func main() {
 	http.Handle("/metrics", prometheus.Handler())
 	go http.ListenAndServe(":8080", nil)
 
-	_, done := operator.Run(stopCh)
+	ready, done := operator.Run(stopCh)
+	<-ready
+
+	if *writeStatusName != "" {
+			existing, err := configClient.ClusterOperators().Get(*writeStatusName, metav1.GetOptions{})
+			if meta.IsNoMatchError(err) {
+				log.Infof("ClusterOperator api not present, skipping update")
+			} else if k8serrors.IsNotFound(err) {
+				log.Info("Existing cluster operator not found, creating")
+				created, err := configClient.ClusterOperators().Create(&configv1.ClusterOperator{
+					ObjectMeta: metav1.ObjectMeta{
+						Name: *writeStatusName,
+					},
+				})
+				if err != nil {
+					log.Fatalf("ClusterOperator create failed: %v\n", err)
+				}
+
+				created.Status = configv1.ClusterOperatorStatus{
+					Conditions: []configv1.ClusterOperatorStatusCondition{
+						configv1.ClusterOperatorStatusCondition{
+							Type:               configv1.OperatorAvailable,
+							Status:             configv1.ConditionTrue,
+							Message:            fmt.Sprintf("Done deploying %s.", olmversion.OLMVersion),
+							LastTransitionTime: metav1.Now(),
+						},
+					},
+					Version: olmversion.Full(),
+				}
+				_, err = configClient.ClusterOperators().UpdateStatus(created)
+				if err != nil {
+					log.Fatalf("ClusterOperator update status failed: %v", err)
+				}
+			} else if err != nil {
+				log.Fatalf("ClusterOperators get failed: %v", err)
+			} else {
+				v1helpers.SetStatusCondition(&existing.Status.Conditions, configv1.ClusterOperatorStatusCondition{
+					Type:               configv1.OperatorAvailable,
+					Status:             configv1.ConditionTrue,
+					Message:            fmt.Sprintf("Done deploying %s.", olmversion.OLMVersion),
+					LastTransitionTime: metav1.Now(),
+				})
+				if existing.Status.Version != olmversion.Full() {
+					// if a cluster wide upgrade has occurred, hopefully any existing operator statuses have been deleted
+					log.Infof("Updating version from %v to %v\n", existing.Status.Version, olmversion.Full())
+				}
+				existing.Status.Version = olmversion.Full()
+				_, err = configClient.ClusterOperators().UpdateStatus(existing)
+				if err != nil {
+					log.Fatalf("ClusterOperator update status failed: %v", err)
+				}
+			}
+	}
+
 	<-done
 }
+

deploy/chart/templates/0000_30_10-olm-operator.deployment.yaml

@@ -33,6 +33,10 @@ spec:
           {{- if .Values.debug }}
           - -debug
           {{- end }}
+          {{- if .Values.writeStatusName }}
+          - -writeStatusName
+          - {{ .Values.writeStatusName }}
+          {{- end }}
           image: {{ .Values.olm.image.ref }}
           imagePullPolicy: {{ .Values.olm.image.pullPolicy }}
           ports:

deploy/chart/values.yaml

@@ -2,6 +2,7 @@ rbacApiVersion: rbac.authorization.k8s.io
 namespace: operator-lifecycle-manager
 catalog_namespace: operator-lifecycle-manager
 operator_namespace: operators
+writeStatusName: '""'
 imagestream: false
 debug: false
 olm:

deploy/upstream/values.yaml

@@ -3,6 +3,7 @@ namespace: olm
 catalog_namespace: olm
 operator_namespace: operators
 imagestream: false
+writeStatusName: '""'
 olm:
   replicaCount: 1
   image:

manifests/0000_30_20-operatorstatus.yaml

@@ -0,0 +1,5 @@
+apiVersion: config.openshift.io/v1
+kind: ClusterOperator
+metadata:
+  namespace: openshift-operator-lifecycle-manager
+  name: openshift-operator-lifecycle-manager

pkg/version/version.go

@@ -12,3 +12,8 @@ var GitCommit string
 func String() string {
 	return fmt.Sprintf("OLM version: %s\ngit commit: %s\n", OLMVersion, GitCommit)
 }
+
+// Full returns a hypenated concatenation of just OLMVersion and GitCommit
+func Full() string {
+	return fmt.Sprintf("%s-%s", OLMVersion, GitCommit)
+}

test/e2e/e2e-bare-values.yaml

@@ -1,6 +1,7 @@
 rbacApiVersion: rbac.authorization.k8s.io
 namespace: operator-lifecycle-manager
 catalog_namespace: operator-lifecycle-manager
+writeStatusName: '""'
 olm:
   replicaCount: 1
   image:

test/e2e/e2e-values.yaml

@@ -1,4 +1,5 @@
 rbacApiVersion: rbac.authorization.k8s.io
+writeStatusName: '""'
 
 olm:
   replicaCount: 1