Bug 1912944: Set proxy env in vsphere-problem-detector, manila and oVirt deployment containers

assets/csidriveroperators/manila/07_deployment.yaml

@@ -3,6 +3,8 @@ kind: Deployment
 metadata:
   name: manila-csi-driver-operator
   namespace: openshift-cluster-csi-drivers
+  annotations:
+    config.openshift.io/inject-proxy: manila-csi-driver-operator
 spec:
   replicas: 1
   selector:

assets/csidriveroperators/ovirt/07_deployment.yaml

@@ -4,6 +4,8 @@ kind: Deployment
 metadata:
   name: ovirt-csi-driver-operator
   namespace: openshift-cluster-csi-drivers
+  annotations:
+    config.openshift.io/inject-proxy: ovirt-csi-driver-operator
 spec:
   replicas: 1
   selector:

assets/vsphere_problem_detector/04_clusterrole.yaml

@@ -63,6 +63,7 @@ rules:
   - config.openshift.io
   resources:
   - infrastructures
+  - proxies
   verbs:
   - get
   - list

assets/vsphere_problem_detector/06_deployment.yaml

@@ -3,6 +3,8 @@ kind: Deployment
 metadata:
   name: vsphere-problem-detector-operator
   namespace: openshift-cluster-storage-operator
+  annotations:
+    config.openshift.io/inject-proxy: vsphere-problem-detector-operator
 spec:
   replicas: 1
   selector:

go.mod

@@ -1,29 +1,29 @@
 module github.com/openshift/cluster-storage-operator
 
-go 1.14
+go 1.15
 
 require (
 	github.com/go-bindata/go-bindata v3.1.2+incompatible
 	github.com/google/go-cmp v0.5.2
 	github.com/google/gofuzz v1.2.0 // indirect
-	github.com/openshift/api v0.0.0-20201130121019-19e3831bc513
+	github.com/openshift/api v0.0.0-20201214114959-164a2fb63b5f
 	github.com/openshift/build-machinery-go v0.0.0-20200917070002-f171684f77ab
-	github.com/openshift/client-go v0.0.0-20200827190008-3062137373b5
-	github.com/openshift/library-go v0.0.0-20200909144351-f29d76719396
+	github.com/openshift/client-go v0.0.0-20201214125552-e615e336eb49
+	github.com/openshift/library-go v0.0.0-20210113192829-cfbb3f4c80c2
 	github.com/prometheus-operator/prometheus-operator v0.44.1
 	github.com/prometheus/client_golang v1.8.0
-	github.com/spf13/cobra v1.0.0
+	github.com/spf13/cobra v1.1.1
 	github.com/spf13/pflag v1.0.5
-	k8s.io/api v0.19.2
-	k8s.io/apiextensions-apiserver v0.19.2
-	k8s.io/apimachinery v0.19.2
+	k8s.io/api v0.20.0
+	k8s.io/apiextensions-apiserver v0.20.0
+	k8s.io/apimachinery v0.20.0
 	k8s.io/client-go v12.0.0+incompatible
-	k8s.io/code-generator v0.19.2
-	k8s.io/component-base v0.19.2
-	k8s.io/klog/v2 v2.3.0
+	k8s.io/code-generator v0.20.0
+	k8s.io/component-base v0.20.0
+	k8s.io/klog/v2 v2.4.0
 )
 
 replace (
 	google.golang.org/grpc => google.golang.org/grpc v1.27.0
-	k8s.io/client-go => k8s.io/client-go v0.19.2
+	k8s.io/client-go => k8s.io/client-go v0.20.0
 )

pkg/operator/configobservation/configobservercontroller/config_observer_controller.go

@@ -0,0 +1,49 @@
+package configobservercontroller
+
+import (
+	"k8s.io/client-go/tools/cache"
+
+	"github.com/openshift/library-go/pkg/controller/factory"
+	"github.com/openshift/library-go/pkg/operator/configobserver"
+	"github.com/openshift/library-go/pkg/operator/configobserver/proxy"
+	"github.com/openshift/library-go/pkg/operator/events"
+
+	"github.com/openshift/cluster-storage-operator/pkg/csoclients"
+	"github.com/openshift/cluster-storage-operator/pkg/operator/configobservation"
+	"github.com/openshift/cluster-storage-operator/pkg/operator/configobservation/util"
+)
+
+// ConfigObserverController watches information that's relevant to CSO and adds
+// it to CR.Spec.ObservedConfig.
+type ConfigObserverController struct {
+	factory.Controller
+}
+
+// NewConfigObserverController returns a new ConfigObserverController.
+func NewConfigObserverController(
+	clients *csoclients.Clients,
+	eventRecorder events.Recorder,
+) *ConfigObserverController {
+	informers := []factory.Informer{
+		clients.OperatorClient.Informer(),
+		clients.ConfigInformers.Config().V1().Proxies().Informer(),
+	}
+
+	c := &ConfigObserverController{
+		Controller: configobserver.NewConfigObserver(
+			clients.OperatorClient,
+			eventRecorder.WithComponentSuffix("config-observer-controller-"),
+			configobservation.Listers{
+				ProxyLister_: clients.ConfigInformers.Config().V1().Proxies().Lister(),
+				PreRunCachesSynced: append([]cache.InformerSynced{},
+					clients.OperatorClient.Informer().HasSynced,
+					clients.ConfigInformers.Config().V1().Proxies().Informer().HasSynced,
+				),
+			},
+			informers,
+			proxy.NewProxyObserveFunc(util.ProxyConfigPath()),
+		),
+	}
+
+	return c
+}

pkg/operator/configobservation/interface.go

@@ -0,0 +1,27 @@
+package configobservation
+
+import (
+	configlistersv1 "github.com/openshift/client-go/config/listers/config/v1"
+	"github.com/openshift/library-go/pkg/operator/resourcesynccontroller"
+	"k8s.io/client-go/tools/cache"
+)
+
+// Listers implement the configobserver.Listers interface.
+type Listers struct {
+	ProxyLister_ configlistersv1.ProxyLister
+
+	ResourceSync       resourcesynccontroller.ResourceSyncer
+	PreRunCachesSynced []cache.InformerSynced
+}
+
+func (l Listers) ProxyLister() configlistersv1.ProxyLister {
+	return l.ProxyLister_
+}
+
+func (l Listers) ResourceSyncer() resourcesynccontroller.ResourceSyncer {
+	return l.ResourceSync
+}
+
+func (l Listers) PreRunHasSynced() []cache.InformerSynced {
+	return l.PreRunCachesSynced
+}

pkg/operator/configobservation/util/util.go

@@ -0,0 +1,32 @@
+package util
+
+import (
+	"strings"
+
+	appsv1 "k8s.io/api/apps/v1"
+
+	operatorapi "github.com/openshift/api/operator/v1"
+	"github.com/openshift/library-go/pkg/operator/v1helpers"
+)
+
+// InjectObservedProxyInDeploymentContainers takes an observed proxy config and returns a patched Deployment with proxy env vars set.
+func InjectObservedProxyInDeploymentContainers(deployment *appsv1.Deployment, opSpec *operatorapi.OperatorSpec) (*appsv1.Deployment, error) {
+	deploymentCopy := deployment.DeepCopy()
+	containerNamesString := deploymentCopy.Annotations["config.openshift.io/inject-proxy"]
+	err := v1helpers.InjectObservedProxyIntoContainers(
+		&deploymentCopy.Spec.Template.Spec,
+		strings.Split(containerNamesString, ","),
+		opSpec.ObservedConfig.Raw,
+		ProxyConfigPath()...,
+	)
+	if err != nil {
+		return nil, err
+	}
+	return deploymentCopy, nil
+}
+
+// ProxyConfigPath returns the path for the observed proxy config. This is a
+// function to avoid exposing a slice that could potentially be appended.
+func ProxyConfigPath() []string {
+	return []string{"targetconfig", "proxy"}
+}

pkg/operator/csidriveroperator/deploymentcontroller.go

@@ -2,19 +2,23 @@ package csidriveroperator
 
 import (
 	"context"
+	"fmt"
 	"strings"
 	"time"
 
+	"k8s.io/client-go/kubernetes"
+	"k8s.io/klog/v2"
+
 	operatorapi "github.com/openshift/api/operator/v1"
-	"github.com/openshift/cluster-storage-operator/pkg/csoclients"
-	"github.com/openshift/cluster-storage-operator/pkg/operator/csidriveroperator/csioperatorclient"
-	csoutils "github.com/openshift/cluster-storage-operator/pkg/utils"
 	"github.com/openshift/library-go/pkg/controller/factory"
 	"github.com/openshift/library-go/pkg/operator/events"
 	"github.com/openshift/library-go/pkg/operator/status"
 	"github.com/openshift/library-go/pkg/operator/v1helpers"
-	"k8s.io/client-go/kubernetes"
-	"k8s.io/klog/v2"
+
+	"github.com/openshift/cluster-storage-operator/pkg/csoclients"
+	"github.com/openshift/cluster-storage-operator/pkg/operator/configobservation/util"
+	"github.com/openshift/cluster-storage-operator/pkg/operator/csidriveroperator/csioperatorclient"
+	csoutils "github.com/openshift/cluster-storage-operator/pkg/utils"
 )
 
 // This CSIDriverStarterController installs and syncs CSI driver operator Deployment.
@@ -104,8 +108,13 @@ func (c *CSIDriverOperatorDeploymentController) Sync(ctx context.Context, syncCt
 	}
 
 	required := csoutils.GetRequiredDeployment(c.csiOperatorConfig.DeploymentAsset, opSpec, replacers...)
+	requiredCopy, err := util.InjectObservedProxyInDeploymentContainers(required, opSpec)
+	if err != nil {
+		return fmt.Errorf("failed to inject proxy data into deployment: %w", err)
+	}
+
 	_, err = csoutils.CreateDeployment(csoutils.DeploymentOptions{
-		Required:       required,
+		Required:       requiredCopy,
 		ControllerName: c.Name(),
 		OpStatus:       opStatus,
 		EventRecorder:  c.eventRecorder,

pkg/operator/starter.go

@@ -8,6 +8,7 @@ import (
 	configv1 "github.com/openshift/api/config/v1"
 	operatorv1 "github.com/openshift/api/operator/v1"
 	"github.com/openshift/cluster-storage-operator/pkg/csoclients"
+	"github.com/openshift/cluster-storage-operator/pkg/operator/configobservation/configobservercontroller"
 	"github.com/openshift/cluster-storage-operator/pkg/operator/csidriveroperator"
 	"github.com/openshift/cluster-storage-operator/pkg/operator/csidriveroperator/csioperatorclient"
 	"github.com/openshift/cluster-storage-operator/pkg/operator/defaultstorageclass"
@@ -98,6 +99,9 @@ func RunOperator(ctx context.Context, controllerConfig *controllercmd.Controller
 	// This controller syncs the operator log level with the value set in the CR.Spec.OperatorLogLevel
 	logLevelController := loglevel.NewClusterOperatorLoggingController(clients.OperatorClient, controllerConfig.EventRecorder)
 
+	// This controller observes a config (proxy for now) and writes it to CR.Spec.ObservedConfig for later use by the operator
+	configObserverController := configobservercontroller.NewConfigObserverController(clients, controllerConfig.EventRecorder)
+
 	klog.Info("Starting the Informers.")
 
 	csoclients.StartInformers(clients, ctx.Done())
@@ -109,6 +113,7 @@ func RunOperator(ctx context.Context, controllerConfig *controllercmd.Controller
 		logLevelController,
 		clusterOperatorStatus,
 		managementStateController,
+		configObserverController,
 		storageClassController,
 		snapshotCRDController,
 		csiDriverController,

pkg/operator/vsphereproblemdetector/vsphere_problem_detector_deployment.go

@@ -2,12 +2,14 @@ package vsphereproblemdetector
 
 import (
 	"context"
+	"fmt"
 	"os"
 	"strings"
 	"time"
 
 	operatorapi "github.com/openshift/api/operator/v1"
 	"github.com/openshift/cluster-storage-operator/pkg/csoclients"
+	"github.com/openshift/cluster-storage-operator/pkg/operator/configobservation/util"
 	csoutils "github.com/openshift/cluster-storage-operator/pkg/utils"
 	"github.com/openshift/library-go/pkg/controller/factory"
 	"github.com/openshift/library-go/pkg/operator/events"
@@ -75,8 +77,14 @@ func (c *VSphereProblemDetectorDeploymentController) sync(ctx context.Context, s
 
 	replacer := strings.NewReplacer(pairs...)
 	required := csoutils.GetRequiredDeployment("vsphere_problem_detector/06_deployment.yaml", opSpec, replacer)
+
+	requiredCopy, err := util.InjectObservedProxyInDeploymentContainers(required, opSpec)
+	if err != nil {
+		return fmt.Errorf("failed to inject proxy data into deployment: %w", err)
+	}
+
 	_, err = csoutils.CreateDeployment(csoutils.DeploymentOptions{
-		Required:       required,
+		Required:       requiredCopy,
 		ControllerName: deploymentControllerName,
 		OpStatus:       opStatus,
 		EventRecorder:  c.eventRecorder,