Add OLM resource to relatedObjects

Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>

Author: Per Goncalves da Silva

cmd/cluster-olm-operator/main.go

@@ -4,6 +4,8 @@ import (
 	"context"
 	goflag "flag"
 	"fmt"
+	configv1 "github.com/openshift/api/config/v1"
+	operatorv1alpha1 "github.com/openshift/api/operator/v1alpha1"
 	"os"
 	"time"
 
@@ -30,6 +32,11 @@ import (
 	catalogdv1alpha1 "github.com/operator-framework/catalogd/api/core/v1alpha1"
 )
 
+const (
+	olmResourceName             = "cluster"
+	clusterOLMOperatorNamespace = "openshift-cluster-olm-operator"
+)
+
 func main() {
 	pflag.CommandLine.SetNormalizeFunc(utilflag.WordSepNormalizeFunc)
 	pflag.CommandLine.AddGoFlagSet(goflag.CommandLine)
@@ -149,6 +156,14 @@ func runOperator(ctx context.Context, cc *controllercmd.ControllerContext) error
 	versionGetter := status.NewVersionGetter()
 	versionGetter.SetVersion("operator", status.VersionForOperatorFromEnv())
 
+	// Add OLM resource and openshift-cluster-olm-operator namespace to relatedObjects
+	// to ensure that must-gather picks them up.
+	// Note: These two resources are also hard-coded in the ClusterOperator manifest. This way,
+	// must-gather will pick them up in case of catastrophic failure before we cluster-olm-operator
+	// gets a chance to dynamically update the relatedObjects. Thus, making the pod logs accessible
+	// for troubleshooting in the must-gather.
+	relatedObjects = append(relatedObjects, newOLMObjectReference(), newNamespaceObjectReference())
+
 	clusterOperatorController := status.NewClusterOperatorStatusController(
 		"olm",
 		relatedObjects,
@@ -189,3 +204,23 @@ func runOperator(ctx context.Context, cc *controllercmd.ControllerContext) error
 	<-ctx.Done()
 	return nil
 }
+
+// newOLMObjectReference creates a configv1.ObjectReference for
+// the cluster scoped OLM resources
+func newOLMObjectReference() configv1.ObjectReference {
+	return configv1.ObjectReference{
+		Group:    operatorv1alpha1.GroupName,
+		Resource: "OLM",
+		Name:     "cluster",
+	}
+}
+
+// newNamespaceObjectReferences creates a configv1.ObjectReference for
+// the OCP namespaces where this operator is installed: openshift-cluster-olm-operator
+func newNamespaceObjectReference() configv1.ObjectReference {
+	return configv1.ObjectReference{
+		Group:    "",
+		Resource: "namespaces",
+		Name:     "openshift-cluster-olm-operator",
+	}
+}

manifests/0000_51_olm_07_cluster_operator.yaml

@@ -10,3 +10,10 @@ status:
   versions:
   - name: operator
     version: "0.0.1-snapshot"
+  relatedObjects:
+  - group: ""
+    name: openshift-cluster-olm-operator
+    resource: namespaces
+  - group: operator.openshift.io
+    name: cluster
+    resource: OLM