Merge pull request kubernetes-csi#76 from dfajmon/rebase-4.6.1

STOR-1593: Rebase external-attacher to v4.6.1 for OCP 4.17
rhrmo · Jul 22, 2024 · c3fe8e2 · c3fe8e2
2 parents aad6c31 + db9da3c
commit c3fe8e2
Show file tree

Hide file tree

Showing 781 changed files with 87,347 additions and 26,453 deletions.
diff --git a/CHANGELOG/CHANGELOG-4.5.md b/CHANGELOG/CHANGELOG-4.5.md
@@ -1,21 +1,3 @@
-# Release notes for v4.5.1
-
-[Documentation](https://kubernetes-csi.github.io)
-
-
-
-## Dependencies
-
-### Added
-_Nothing has changed._
-
-### Changed
-- github.com/golang/protobuf: [v1.5.3 → v1.5.4](https://github.com/golang/protobuf/compare/v1.5.3...v1.5.4)
-- google.golang.org/protobuf: v1.31.0 → v1.33.0
-
-### Removed
-_Nothing has changed._
-
 # Release notes for v4.5.0
 
 [Documentation](https://kubernetes-csi.github.io)

diff --git a/CHANGELOG/CHANGELOG-4.6.md b/CHANGELOG/CHANGELOG-4.6.md
@@ -0,0 +1,121 @@
+# Release notes for v4.6.1
+
+[Documentation](https://kubernetes-csi.github.io)
+
+## Changes by Kind
+
+### Bug or Regression
+
+- Update csi-lib-utils to v0.18.1 ([#564](https://github.com/kubernetes-csi/external-attacher/pull/564), [@rhrmo](https://github.com/rhrmo))
+
+## Dependencies
+
+### Added
+_Nothing has changed._
+
+### Changed
+- github.com/kubernetes-csi/csi-lib-utils: [v0.18.0 → v0.18.1](https://github.com/kubernetes-csi/csi-lib-utils/compare/v0.18.0...v0.18.1)
+
+### Removed
+_Nothing has changed._
+
+# Release notes for v4.6.0
+
+[Documentation](https://kubernetes-csi.github.io)
+
+# Changelog since v4.5.0
+
+## Changes by Kind
+
+### Feature
+
+- Added support for contextual logging. ([#549](https://github.com/kubernetes-csi/external-attacher/pull/549), [@bells17](https://github.com/bells17))
+- Updated Kubernetes deps to v1.30 ([#555](https://github.com/kubernetes-csi/external-attacher/pull/555), [@jsafrane](https://github.com/jsafrane))
+
+## Dependencies
+
+### Added
+- github.com/cpuguy83/go-md2man/v2: [v2.0.3](https://github.com/cpuguy83/go-md2man/v2/tree/v2.0.3)
+- github.com/fxamacker/cbor/v2: [v2.6.0](https://github.com/fxamacker/cbor/v2/tree/v2.6.0)
+- github.com/russross/blackfriday/v2: [v2.1.0](https://github.com/russross/blackfriday/v2/tree/v2.1.0)
+- github.com/x448/float16: [v0.8.4](https://github.com/x448/float16/tree/v0.8.4)
+- go.uber.org/goleak: v1.3.0
+- k8s.io/gengo/v2: 51d4e06
+
+### Changed
+- cloud.google.com/go/compute/metadata: v0.2.3 → v0.3.0
+- cloud.google.com/go/compute: v1.23.0 → v1.24.0
+- github.com/alecthomas/kingpin/v2: [v2.3.2 → v2.4.0](https://github.com/alecthomas/kingpin/v2/compare/v2.3.2...v2.4.0)
+- github.com/cespare/xxhash/v2: [v2.2.0 → v2.3.0](https://github.com/cespare/xxhash/v2/compare/v2.2.0...v2.3.0)
+- github.com/cncf/xds/go: [e9ce688 → 0fa0005](https://github.com/cncf/xds/go/compare/e9ce688...0fa0005)
+- github.com/emicklei/go-restful/v3: [v3.11.0 → v3.12.0](https://github.com/emicklei/go-restful/v3/compare/v3.11.0...v3.12.0)
+- github.com/envoyproxy/go-control-plane: [v0.11.1 → v0.12.0](https://github.com/envoyproxy/go-control-plane/compare/v0.11.1...v0.12.0)
+- github.com/envoyproxy/protoc-gen-validate: [v1.0.2 → v1.0.4](https://github.com/envoyproxy/protoc-gen-validate/compare/v1.0.2...v1.0.4)
+- github.com/evanphx/json-patch: [v5.7.0+incompatible → v5.9.0+incompatible](https://github.com/evanphx/json-patch/compare/v5.7.0...v5.9.0)
+- github.com/go-logr/logr: [v1.3.0 → v1.4.1](https://github.com/go-logr/logr/compare/v1.3.0...v1.4.1)
+- github.com/go-logr/zapr: [v1.2.3 → v1.3.0](https://github.com/go-logr/zapr/compare/v1.2.3...v1.3.0)
+- github.com/go-openapi/jsonpointer: [v0.19.6 → v0.21.0](https://github.com/go-openapi/jsonpointer/compare/v0.19.6...v0.21.0)
+- github.com/go-openapi/jsonreference: [v0.20.2 → v0.21.0](https://github.com/go-openapi/jsonreference/compare/v0.20.2...v0.21.0)
+- github.com/go-openapi/swag: [v0.22.3 → v0.23.0](https://github.com/go-openapi/swag/compare/v0.22.3...v0.23.0)
+- github.com/golang/glog: [v1.1.2 → v1.2.0](https://github.com/golang/glog/compare/v1.1.2...v1.2.0)
+- github.com/golang/protobuf: [v1.5.3 → v1.5.4](https://github.com/golang/protobuf/compare/v1.5.3...v1.5.4)
+- github.com/google/uuid: [v1.4.0 → v1.6.0](https://github.com/google/uuid/compare/v1.4.0...v1.6.0)
+- github.com/kubernetes-csi/csi-lib-utils: [v0.17.0 → v0.18.0](https://github.com/kubernetes-csi/csi-lib-utils/compare/v0.17.0...v0.18.0)
+- github.com/onsi/ginkgo/v2: [v2.13.1 → v2.15.0](https://github.com/onsi/ginkgo/v2/compare/v2.13.1...v2.15.0)
+- github.com/onsi/gomega: [v1.30.0 → v1.31.0](https://github.com/onsi/gomega/compare/v1.30.0...v1.31.0)
+- github.com/prometheus/client_golang: [v1.16.0 → v1.19.1](https://github.com/prometheus/client_golang/compare/v1.16.0...v1.19.1)
+- github.com/prometheus/client_model: [v0.4.0 → v0.6.1](https://github.com/prometheus/client_model/compare/v0.4.0...v0.6.1)
+- github.com/prometheus/common: [v0.44.0 → v0.53.0](https://github.com/prometheus/common/compare/v0.44.0...v0.53.0)
+- github.com/prometheus/procfs: [v0.10.1 → v0.14.0](https://github.com/prometheus/procfs/compare/v0.10.1...v0.14.0)
+- github.com/rogpeppe/go-internal: [v1.10.0 → v1.11.0](https://github.com/rogpeppe/go-internal/compare/v1.10.0...v1.11.0)
+- github.com/spf13/cobra: [v1.7.0 → v1.8.0](https://github.com/spf13/cobra/compare/v1.7.0...v1.8.0)
+- github.com/stretchr/objx: [v0.5.0 → v0.1.0](https://github.com/stretchr/objx/compare/v0.5.0...v0.1.0)
+- github.com/stretchr/testify: [v1.8.4 → v1.9.0](https://github.com/stretchr/testify/compare/v1.8.4...v1.9.0)
+- github.com/yuin/goldmark: [v1.4.13 → v1.3.5](https://github.com/yuin/goldmark/compare/v1.4.13...v1.3.5)
+- go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc: v0.44.0 → v0.51.0
+- go.opentelemetry.io/otel/metric: v1.19.0 → v1.26.0
+- go.opentelemetry.io/otel/trace: v1.19.0 → v1.26.0
+- go.opentelemetry.io/otel: v1.19.0 → v1.26.0
+- go.uber.org/zap: v1.19.0 → v1.27.0
+- golang.org/x/crypto: v0.15.0 → v0.23.0
+- golang.org/x/mod: v0.8.0 → v0.15.0
+- golang.org/x/net: v0.18.0 → v0.25.0
+- golang.org/x/oauth2: v0.13.0 → v0.20.0
+- golang.org/x/sync: v0.4.0 → v0.7.0
+- golang.org/x/sys: v0.14.0 → v0.20.0
+- golang.org/x/term: v0.14.0 → v0.20.0
+- golang.org/x/text: v0.14.0 → v0.15.0
+- golang.org/x/time: v0.3.0 → v0.5.0
+- golang.org/x/tools: v0.14.0 → v0.18.0
+- google.golang.org/genproto/googleapis/api: d307bd8 → 6ceb2ff
+- google.golang.org/genproto/googleapis/rpc: bbf56f3 → 6ceb2ff
+- google.golang.org/genproto: d783a09 → 6ceb2ff
+- google.golang.org/grpc: v1.60.1 → v1.63.2
+- google.golang.org/protobuf: v1.31.0 → v1.34.1
+- k8s.io/api: v0.29.0 → v0.30.0
+- k8s.io/apimachinery: v0.29.0 → v0.30.0
+- k8s.io/client-go: v0.29.0 → v0.30.0
+- k8s.io/component-base: v0.29.0 → v0.30.0
+- k8s.io/csi-translation-lib: v0.29.0 → v0.30.0
+- k8s.io/klog/v2: v2.110.1 → v2.120.1
+- k8s.io/kube-openapi: 2dd684a → 70dd376
+- sigs.k8s.io/yaml: v1.3.0 → v1.4.0
+
+### Removed
+- github.com/cncf/udpa/go: [c52dc94](https://github.com/cncf/udpa/go/tree/c52dc94)
+- github.com/creack/pty: [v1.1.9](https://github.com/creack/pty/tree/v1.1.9)
+- github.com/kr/pty: [v1.1.1](https://github.com/kr/pty/tree/v1.1.1)
+- go.uber.org/atomic: v1.10.0
+- k8s.io/gengo: 9cce18d
+com/ianlancetaylor/demangle: [28f6c0f](https://github.com/ianlancetaylor/demangle/tree/28f6c0f)
+- github.com/kubernetes-csi/csi-test/v4: [v4.4.0](https://github.com/kubernetes-csi/csi-test/v4/tree/v4.4.0)
+- github.com/nxadm/tail: [v1.4.8](https://github.com/nxadm/tail/tree/v1.4.8)
+- github.com/onsi/ginkgo: [v1.16.5](https://github.com/onsi/ginkgo/tree/v1.16.5)
+- github.com/rogpeppe/fastuuid: [v1.2.0](https://github.com/rogpeppe/fastuuid/tree/v1.2.0)
+- go.opentelemetry.io/otel/exporters/otlp/internal/retry: v1.10.0
+- go.uber.org/goleak: v1.2.1
+- golang.org/x/exp: 509febe
+- golang.org/x/lint: d0100b6
+- gopkg.in/fsnotify.v1: v1.4.7
+- gopkg.in/tomb.v1: dd63297
+- honnef.co/go/tools: ea95bdf
diff --git a/Dockerfile.openshift b/Dockerfile.openshift
diff --git a/Makefile b/Makefile
@@ -17,3 +17,5 @@ all: build
 
 include release-tools/build.make
 
+# Check contextual logging.
+test: test-logcheck
diff --git a/cmd/csi-attacher/main.go b/cmd/csi-attacher/main.go
@@ -29,6 +29,10 @@ import (
 	"k8s.io/client-go/rest"
 	"k8s.io/client-go/tools/clientcmd"
 	"k8s.io/client-go/util/workqueue"
+	"k8s.io/component-base/featuregate"
+	"k8s.io/component-base/logs"
+	logsapi "k8s.io/component-base/logs/api/v1"
+	_ "k8s.io/component-base/logs/json/register"
 	csitrans "k8s.io/csi-translation-lib"
 	"k8s.io/klog/v2"
 
@@ -86,19 +90,27 @@ var (
 )
 
 func main() {
-	klog.InitFlags(nil)
-	flag.Set("logtostderr", "true")
+	fg := featuregate.NewFeatureGate()
+	logsapi.AddFeatureGates(fg)
+	c := logsapi.NewLoggingConfiguration()
+	logsapi.AddGoFlags(c, flag.CommandLine)
+	logs.InitLogs()
 	flag.Parse()
+	logger := klog.Background()
+	if err := logsapi.ValidateAndApply(c, fg); err != nil {
+		logger.Error(err, "LoggingConfiguration is invalid")
+		klog.FlushAndExit(klog.ExitFlushTimeout, 1)
+	}
 
 	if *showVersion {
 		fmt.Println(os.Args[0], version)
 		return
 	}
-	klog.Infof("Version: %s", version)
+	logger.Info("Version", "version", version)
 
 	if *metricsAddress != "" && *httpEndpoint != "" {
-		klog.Error("only one of `--metrics-address` and `--http-endpoint` can be set.")
-		os.Exit(1)
+		logger.Error(nil, "Only one of `--metrics-address` and `--http-endpoint` can be set")
+		klog.FlushAndExit(klog.ExitFlushTimeout, 1)
 	}
 	addr := *metricsAddress
 	if addr == "" {
@@ -108,21 +120,21 @@ func main() {
 	// Create the client config. Use kubeconfig if given, otherwise assume in-cluster.
 	config, err := buildConfig(*kubeconfig)
 	if err != nil {
-		klog.Error(err.Error())
-		os.Exit(1)
+		logger.Error(err, "Failed to build a Kubernetes config")
+		klog.FlushAndExit(klog.ExitFlushTimeout, 1)
 	}
 	config.QPS = (float32)(*kubeAPIQPS)
 	config.Burst = *kubeAPIBurst
 
 	if *workerThreads == 0 {
-		klog.Error("option -worker-threads must be greater than zero")
-		os.Exit(1)
+		logger.Error(nil, "Option -worker-threads must be greater than zero")
+		klog.FlushAndExit(klog.ExitFlushTimeout, 1)
 	}
 
 	clientset, err := kubernetes.NewForConfig(config)
 	if err != nil {
-		klog.Error(err.Error())
-		os.Exit(1)
+		logger.Error(err, "Failed to create a Clientset")
+		klog.FlushAndExit(klog.ExitFlushTimeout, 1)
 	}
 
 	factory := informers.NewSharedInformerFactory(clientset, *resync)
@@ -131,43 +143,47 @@ func main() {
 
 	// Connect to CSI.
 	connection.SetMaxGRPCLogLength(*maxGRPCLogLength)
-	csiConn, err := connection.Connect(*csiAddress, metricsManager, connection.OnConnectionLoss(connection.ExitOnConnectionLoss()))
+	ctx := context.Background()
+	csiConn, err := connection.Connect(ctx, *csiAddress, metricsManager, connection.OnConnectionLoss(connection.ExitOnConnectionLoss()))
 	if err != nil {
-		klog.Error(err.Error())
-		os.Exit(1)
+		logger.Error(err, "Failed to connect to the CSI driver", "csiAddress", *csiAddress)
+		klog.FlushAndExit(klog.ExitFlushTimeout, 1)
 	}
 
-	err = rpc.ProbeForever(csiConn, *timeout)
+	err = rpc.ProbeForever(ctx, csiConn, *timeout)
 	if err != nil {
-		klog.Error(err.Error())
-		os.Exit(1)
+		logger.Error(err, "Failed to probe the CSI driver")
+		klog.FlushAndExit(klog.ExitFlushTimeout, 1)
 	}
 
 	// Find driver name.
-	ctx, cancel := context.WithTimeout(context.Background(), csiTimeout)
+	cancelationCtx, cancel := context.WithTimeout(ctx, csiTimeout)
+	cancelationCtx = klog.NewContext(cancelationCtx, logger)
 	defer cancel()
-	csiAttacher, err := rpc.GetDriverName(ctx, csiConn)
+	csiAttacher, err := rpc.GetDriverName(cancelationCtx, csiConn)
 	if err != nil {
-		klog.Error(err.Error())
-		os.Exit(1)
+		logger.Error(err, "Failed to get the CSI driver name")
+		klog.FlushAndExit(klog.ExitFlushTimeout, 1)
 	}
-	klog.V(2).Infof("CSI driver name: %q", csiAttacher)
+	logger = klog.LoggerWithValues(logger, "driver", csiAttacher)
+	logger.V(2).Info("CSI driver name")
+	cancelationCtx = klog.NewContext(cancelationCtx, logger)
 
 	translator := csitrans.New()
 	if translator.IsMigratedCSIDriverByName(csiAttacher) {
 		metricsManager = metrics.NewCSIMetricsManagerWithOptions(csiAttacher, metrics.WithMigration())
-		migratedCsiClient, err := connection.Connect(*csiAddress, metricsManager, connection.OnConnectionLoss(connection.ExitOnConnectionLoss()))
+		migratedCsiClient, err := connection.Connect(ctx, *csiAddress, metricsManager, connection.OnConnectionLoss(connection.ExitOnConnectionLoss()))
 		if err != nil {
-			klog.Error(err.Error())
-			os.Exit(1)
+			logger.Error(err, "Failed to connect to the CSI driver", "csiAddress", *csiAddress, "migrated", true)
+			klog.FlushAndExit(klog.ExitFlushTimeout, 1)
 		}
 		csiConn.Close()
 		csiConn = migratedCsiClient
 
-		err = rpc.ProbeForever(csiConn, *timeout)
+		err = rpc.ProbeForever(ctx, csiConn, *timeout)
 		if err != nil {
-			klog.Error(err.Error())
-			os.Exit(1)
+			logger.Error(err, "Failed to probe the CSI driver", "migrated", true)
+			klog.FlushAndExit(klog.ExitFlushTimeout, 1)
 		}
 	}
 
@@ -177,18 +193,19 @@ func main() {
 		metricsManager.RegisterToServer(mux, *metricsPath)
 		metricsManager.SetDriverName(csiAttacher)
 		go func() {
-			klog.Infof("ServeMux listening at %q", addr)
+			logger.Info("ServeMux listening", "address", addr, "metricsPath", *metricsPath)
 			err := http.ListenAndServe(addr, mux)
 			if err != nil {
-				klog.Fatalf("Failed to start HTTP server at specified address (%q) and metrics path (%q): %s", addr, *metricsPath, err)
+				logger.Error(err, "Failed to start HTTP server at specified address and metrics path", "address", addr, "metricsPath", *metricsPath)
+				klog.FlushAndExit(klog.ExitFlushTimeout, 1)
 			}
 		}()
 	}
 
-	supportsService, err := supportsPluginControllerService(ctx, csiConn)
+	supportsService, err := supportsPluginControllerService(cancelationCtx, csiConn)
 	if err != nil {
-		klog.Error(err.Error())
-		os.Exit(1)
+		logger.Error(err, "Failed to check if the CSI Driver supports the CONTROLLER_SERVICE")
+		klog.FlushAndExit(klog.ExitFlushTimeout, 1)
 	}
 
 	var (
@@ -199,12 +216,12 @@ func main() {
 	)
 	if !supportsService {
 		handler = controller.NewTrivialHandler(clientset)
-		klog.V(2).Infof("CSI driver does not support Plugin Controller Service, using trivial handler")
+		logger.V(2).Info("CSI driver does not support Plugin Controller Service, using trivial handler")
 	} else {
-		supportsAttach, supportsReadOnly, supportsListVolumesPublishedNodes, supportsSingleNodeMultiWriter, err = supportsControllerCapabilities(ctx, csiConn)
+		supportsAttach, supportsReadOnly, supportsListVolumesPublishedNodes, supportsSingleNodeMultiWriter, err = supportsControllerCapabilities(cancelationCtx, csiConn)
 		if err != nil {
-			klog.Error(err.Error())
-			os.Exit(1)
+			logger.Error(err, "Failed to controller capability check")
+			klog.FlushAndExit(klog.ExitFlushTimeout, 1)
 		}
 
 		if supportsAttach {
@@ -227,18 +244,19 @@ func main() {
 				csitrans.New(),
 				*defaultFSType,
 			)
-			klog.V(2).Infof("CSI driver supports ControllerPublishUnpublish, using real CSI handler")
+			logger.V(2).Info("CSI driver supports ControllerPublishUnpublish, using real CSI handler")
 		} else {
 			handler = controller.NewTrivialHandler(clientset)
-			klog.V(2).Infof("CSI driver does not support ControllerPublishUnpublish, using trivial handler")
+			logger.V(2).Info("CSI driver does not support ControllerPublishUnpublish, using trivial handler")
 		}
 	}
 
 	if supportsListVolumesPublishedNodes {
-		klog.V(2).Infof("CSI driver supports list volumes published nodes. Using capability to reconcile volume attachment objects with actual backend state")
+		logger.V(2).Info("CSI driver supports list volumes published nodes. Using capability to reconcile volume attachment objects with actual backend state")
 	}
 
 	ctrl := controller.NewCSIAttachController(
+		logger,
 		clientset,
 		csiAttacher,
 		handler,
@@ -253,18 +271,19 @@ func main() {
 	run := func(ctx context.Context) {
 		stopCh := ctx.Done()
 		factory.Start(stopCh)
-		ctrl.Run(int(*workerThreads), stopCh)
+		ctrl.Run(ctx, int(*workerThreads))
 	}
 
 	if !*enableLeaderElection {
-		run(context.TODO())
+		run(klog.NewContext(context.Background(), logger))
 	} else {
 		// Create a new clientset for leader election. When the attacher
 		// gets busy and its client gets throttled, the leader election
 		// can proceed without issues.
 		leClientset, err := kubernetes.NewForConfig(config)
 		if err != nil {
-			klog.Fatalf("Failed to create leaderelection client: %v", err)
+			logger.Error(err, "Failed to create leaderelection client")
+			klog.FlushAndExit(klog.ExitFlushTimeout, 1)
 		}
 
 		// Name of config map with leader election lock
@@ -283,7 +302,8 @@ func main() {
 		le.WithRetryPeriod(*leaderElectionRetryPeriod)
 
 		if err := le.Run(); err != nil {
-			klog.Fatalf("failed to initialize leader election: %v", err)
+			logger.Error(err, "Failed to initialize leader election")
+			klog.FlushAndExit(klog.ExitFlushTimeout, 1)
 		}
 	}
 }
Original file line number	Diff line number	Diff line change
Expand Up		@@ -17,3 +17,5 @@ all: build

		include release-tools/build.make

		# Check contextual logging.
		test: test-logcheck