Merge pull request #798 from neisw/update-event-recorder

Bug OCPBUGS-716: Add support for kube event recorder

Author: openshift-merge-robot

manifests/07-operator-ibm-cloud-managed.yaml

@@ -31,6 +31,10 @@ spec:
           valueFrom:
             fieldRef:
               fieldPath: metadata.namespace
+        - name: POD_NAME
+          valueFrom:
+            fieldRef:
+              fieldPath: metadata.name
         - name: OPERATOR_NAME
           value: cluster-image-registry-operator
         - name: IMAGE

manifests/07-operator.yaml

@@ -59,6 +59,10 @@ spec:
               valueFrom:
                 fieldRef:
                   fieldPath: metadata.namespace
+            - name: POD_NAME
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.name                   
             - name: OPERATOR_NAME
               value: "cluster-image-registry-operator"
             - name: IMAGE

pkg/operator/controller.go

@@ -28,6 +28,7 @@ import (
 	imageregistryinformers "github.com/openshift/client-go/imageregistry/informers/externalversions"
 	routeclient "github.com/openshift/client-go/route/clientset/versioned"
 	routeinformers "github.com/openshift/client-go/route/informers/externalversions"
+	"github.com/openshift/library-go/pkg/operator/events"
 
 	regopclient "github.com/openshift/cluster-image-registry-operator/pkg/client"
 	"github.com/openshift/cluster-image-registry-operator/pkg/defaults"
@@ -64,6 +65,7 @@ func (e permanentError) Error() string {
 // This controller keeps track of resources needed in order to have openshift
 // internal registry working.
 func NewController(
+	eventRecorder events.Recorder,
 	kubeconfig *restclient.Config,
 	kubeClient kubeclient.Interface,
 	configClient configclient.Interface,
@@ -81,7 +83,7 @@ func NewController(
 	clients := &regopclient.Clients{}
 	c := &Controller{
 		kubeconfig: kubeconfig,
-		generator:  resource.NewGenerator(kubeconfig, clients, listers),
+		generator:  resource.NewGenerator(eventRecorder, kubeconfig, clients, listers),
 		workqueue:  workqueue.NewNamedRateLimitingQueue(workqueue.DefaultControllerRateLimiter(), "Changes"),
 		listers:    listers,
 		clients:    clients,

pkg/operator/nodecadaemon.go

@@ -20,13 +20,15 @@ import (
 	"k8s.io/klog/v2"
 
 	operatorv1 "github.com/openshift/api/operator/v1"
+	"github.com/openshift/library-go/pkg/operator/events"
 	"github.com/openshift/library-go/pkg/operator/v1helpers"
 
 	"github.com/openshift/cluster-image-registry-operator/pkg/defaults"
 	"github.com/openshift/cluster-image-registry-operator/pkg/resource"
 )
 
 type NodeCADaemonController struct {
+	eventRecorder   events.Recorder
 	appsClient      appsv1client.AppsV1Interface
 	operatorClient  v1helpers.OperatorClient
 	daemonSetLister appsv1listers.DaemonSetNamespaceLister
@@ -37,12 +39,14 @@ type NodeCADaemonController struct {
 }
 
 func NewNodeCADaemonController(
+	eventRecorder events.Recorder,
 	appsClient appsv1client.AppsV1Interface,
 	operatorClient v1helpers.OperatorClient,
 	daemonSetInformer appsv1informers.DaemonSetInformer,
 	serviceInformer corev1informers.ServiceInformer,
 ) *NodeCADaemonController {
 	c := &NodeCADaemonController{
+		eventRecorder:   eventRecorder,
 		appsClient:      appsClient,
 		operatorClient:  operatorClient,
 		daemonSetLister: daemonSetInformer.Lister().DaemonSets(defaults.ImageRegistryOperatorNamespace),
@@ -102,7 +106,7 @@ func (c *NodeCADaemonController) processNextWorkItem() bool {
 
 func (c *NodeCADaemonController) sync() error {
 	ctx := context.TODO()
-	gen := resource.NewGeneratorNodeCADaemonSet(c.daemonSetLister, c.serviceLister, c.appsClient, c.operatorClient)
+	gen := resource.NewGeneratorNodeCADaemonSet(c.eventRecorder, c.daemonSetLister, c.serviceLister, c.appsClient, c.operatorClient)
 
 	availableCondition := operatorv1.OperatorCondition{
 		Type:   "NodeCADaemonAvailable",

pkg/operator/starter.go

@@ -6,6 +6,7 @@ import (
 	kubeinformers "k8s.io/client-go/informers"
 	kubeclient "k8s.io/client-go/kubernetes"
 	restclient "k8s.io/client-go/rest"
+	"k8s.io/klog/v2"
 
 	configv1 "github.com/openshift/api/config/v1"
 	configclient "github.com/openshift/client-go/config/clientset/versioned"
@@ -59,7 +60,16 @@ func RunOperator(ctx context.Context, kubeconfig *restclient.Config) error {
 		imageregistryInformers.Imageregistry().V1().Configs(),
 	)
 
+	// library-go just logs a warning and continues
+	// https://github.com/openshift/library-go/blob/4362aa519714a4b62b00ab8318197ba2bba51cb7/pkg/controller/controllercmd/builder.go#L230
+	controllerRef, err := events.GetControllerReferenceForCurrentPod(context.TODO(), kubeClient, defaults.ImageRegistryOperatorNamespace, nil)
+	if err != nil {
+		klog.Warningf("unable to get owner reference (falling back to namespace): %v", err)
+	}
+	eventRecorder := events.NewKubeRecorder(kubeClient.CoreV1().Events(defaults.ImageRegistryOperatorNamespace), "image-registry-operator", controllerRef)
+
 	controller := NewController(
+		eventRecorder,
 		kubeconfig,
 		kubeClient,
 		configClient,
@@ -112,6 +122,7 @@ func RunOperator(ctx context.Context, kubeconfig *restclient.Config) error {
 	)
 
 	nodeCADaemonController := NewNodeCADaemonController(
+		eventRecorder,
 		kubeClient.AppsV1(),
 		configOperatorClient,
 		kubeInformers.Apps().V1().DaemonSets(),
@@ -128,7 +139,7 @@ func RunOperator(ctx context.Context, kubeconfig *restclient.Config) error {
 
 	loggingController := loglevel.NewClusterOperatorLoggingController(
 		configOperatorClient,
-		events.NewLoggingEventRecorder("image-registry"),
+		eventRecorder,
 	)
 
 	azureStackCloudController := NewAzureStackCloudController(

pkg/resource/deployment.go

@@ -30,7 +30,7 @@ import (
 var _ Mutator = &generatorDeployment{}
 
 type generatorDeployment struct {
-	recorder        events.Recorder
+	eventRecorder   events.Recorder
 	lister          appslisters.DeploymentNamespaceLister
 	configMapLister corelisters.ConfigMapNamespaceLister
 	secretLister    corelisters.SecretNamespaceLister
@@ -41,9 +41,9 @@ type generatorDeployment struct {
 	cr              *imageregistryv1.Config
 }
 
-func newGeneratorDeployment(lister appslisters.DeploymentNamespaceLister, configMapLister corelisters.ConfigMapNamespaceLister, secretLister corelisters.SecretNamespaceLister, proxyLister configlisters.ProxyLister, coreClient coreset.CoreV1Interface, client appsset.AppsV1Interface, driver storage.Driver, cr *imageregistryv1.Config) *generatorDeployment {
+func newGeneratorDeployment(eventRecorder events.Recorder, lister appslisters.DeploymentNamespaceLister, configMapLister corelisters.ConfigMapNamespaceLister, secretLister corelisters.SecretNamespaceLister, proxyLister configlisters.ProxyLister, coreClient coreset.CoreV1Interface, client appsset.AppsV1Interface, driver storage.Driver, cr *imageregistryv1.Config) *generatorDeployment {
 	return &generatorDeployment{
-		recorder:        events.NewLoggingEventRecorder("image-registry-operator"),
+		eventRecorder:   eventRecorder,
 		lister:          lister,
 		configMapLister: configMapLister,
 		secretLister:    secretLister,
@@ -193,7 +193,7 @@ func (gd *generatorDeployment) Create() (runtime.Object, error) {
 	}
 
 	dep, _, err := resourceapply.ApplyDeployment(
-		context.TODO(), gd.client, gd.recorder, exp.(*appsapi.Deployment), -1,
+		context.TODO(), gd.client, gd.eventRecorder, exp.(*appsapi.Deployment), -1,
 	)
 	if err != nil {
 		return nil, err
@@ -210,7 +210,7 @@ func (gd *generatorDeployment) Update(o runtime.Object) (runtime.Object, bool, e
 	}
 
 	dep, updated, err := resourceapply.ApplyDeployment(
-		context.TODO(), gd.client, gd.recorder, exp.(*appsapi.Deployment), gd.LastGeneration(),
+		context.TODO(), gd.client, gd.eventRecorder, exp.(*appsapi.Deployment), gd.LastGeneration(),
 	)
 	if err != nil {
 		return o, false, err

pkg/resource/generator.go

@@ -15,6 +15,7 @@ import (
 	"k8s.io/klog/v2"
 
 	imageregistryv1 "github.com/openshift/api/imageregistry/v1"
+	"github.com/openshift/library-go/pkg/operator/events"
 
 	"github.com/openshift/cluster-image-registry-operator/pkg/client"
 	"github.com/openshift/cluster-image-registry-operator/pkg/defaults"
@@ -63,18 +64,20 @@ func ApplyMutator(gen Mutator) error {
 	})
 }
 
-func NewGenerator(kubeconfig *rest.Config, clients *client.Clients, listers *client.Listers) *Generator {
+func NewGenerator(eventRecorder events.Recorder, kubeconfig *rest.Config, clients *client.Clients, listers *client.Listers) *Generator {
 	return &Generator{
-		kubeconfig: kubeconfig,
-		listers:    listers,
-		clients:    clients,
+		eventRecorder: eventRecorder,
+		kubeconfig:    kubeconfig,
+		listers:       listers,
+		clients:       clients,
 	}
 }
 
 type Generator struct {
-	kubeconfig *rest.Config
-	listers    *client.Listers
-	clients    *client.Clients
+	eventRecorder events.Recorder
+	kubeconfig    *rest.Config
+	listers       *client.Listers
+	clients       *client.Clients
 }
 
 func (g *Generator) listRoutes(cr *imageregistryv1.Config) []Mutator {
@@ -105,7 +108,7 @@ func (g *Generator) List(cr *imageregistryv1.Config) ([]Mutator, error) {
 	mutators = append(mutators, newGeneratorPullSecret(g.clients.Core))
 	mutators = append(mutators, newGeneratorSecret(g.listers.Secrets, g.clients.Core, driver))
 	mutators = append(mutators, newGeneratorService(g.listers.Services, g.clients.Core))
-	mutators = append(mutators, newGeneratorDeployment(g.listers.Deployments, g.listers.ConfigMaps, g.listers.Secrets, g.listers.ProxyConfigs, g.clients.Core, g.clients.Apps, driver, cr))
+	mutators = append(mutators, newGeneratorDeployment(g.eventRecorder, g.listers.Deployments, g.listers.ConfigMaps, g.listers.Secrets, g.listers.ProxyConfigs, g.clients.Core, g.clients.Apps, driver, cr))
 	mutators = append(mutators, newGeneratorPodDisruptionBudget(g.listers.PodDisruptionBudgets, g.clients.Kube.PolicyV1(), cr))
 	mutators = append(mutators, g.listRoutes(cr)...)
 

pkg/resource/nodecadaemon.go

@@ -25,16 +25,16 @@ import (
 var _ Mutator = &generatorNodeCADaemonSet{}
 
 type generatorNodeCADaemonSet struct {
-	recorder        events.Recorder
+	eventRecorder   events.Recorder
 	daemonSetLister appsv1listers.DaemonSetNamespaceLister
 	serviceLister   corev1listers.ServiceNamespaceLister
 	client          appsv1client.AppsV1Interface
 	operatorClient  v1helpers.OperatorClient
 }
 
-func NewGeneratorNodeCADaemonSet(daemonSetLister appsv1listers.DaemonSetNamespaceLister, serviceLister corev1listers.ServiceNamespaceLister, client appsv1client.AppsV1Interface, operatorClient v1helpers.OperatorClient) Mutator {
+func NewGeneratorNodeCADaemonSet(eventRecorder events.Recorder, daemonSetLister appsv1listers.DaemonSetNamespaceLister, serviceLister corev1listers.ServiceNamespaceLister, client appsv1client.AppsV1Interface, operatorClient v1helpers.OperatorClient) Mutator {
 	return &generatorNodeCADaemonSet{
-		recorder:        events.NewLoggingEventRecorder("image-registry-operator"),
+		eventRecorder:   eventRecorder,
 		daemonSetLister: daemonSetLister,
 		serviceLister:   serviceLister,
 		client:          client,
@@ -79,7 +79,7 @@ func (ds *generatorNodeCADaemonSet) Update(o runtime.Object) (runtime.Object, bo
 	actualDaemonSet, updated, err := resourceapply.ApplyDaemonSet(
 		context.TODO(),
 		ds.client,
-		ds.recorder,
+		ds.eventRecorder,
 		desiredDaemonSet,
 		resourcemerge.ExpectedDaemonSetGeneration(desiredDaemonSet, opStatus.Generations),
 	)

pkg/resource/nodecadaemon_test.go

@@ -14,6 +14,7 @@ import (
 	imageregistryv1 "github.com/openshift/api/imageregistry/v1"
 	imageregistryfake "github.com/openshift/client-go/imageregistry/clientset/versioned/fake"
 	imageregistryinformers "github.com/openshift/client-go/imageregistry/informers/externalversions"
+	"github.com/openshift/library-go/pkg/operator/events"
 
 	"github.com/openshift/cluster-image-registry-operator/pkg/client"
 )
@@ -52,7 +53,7 @@ func TestNodeCADaemon(t *testing.T) {
 	imageregistryInformers.Start(ctx.Done())
 	imageregistryInformers.WaitForCacheSync(ctx.Done())
 
-	g := NewGeneratorNodeCADaemonSet(nil, nil, clientset.AppsV1(), operatorClient)
+	g := NewGeneratorNodeCADaemonSet(events.NewInMemoryRecorder("image-registry-operator"), nil, nil, clientset.AppsV1(), operatorClient)
 	obj, err := g.Create()
 	if err != nil {
 		t.Fatal(err)