Review feedback and using the new functionality in the sidecars

Author: DerekFrank

config/config.go

@@ -1,18 +1,24 @@
+/*
+Copyright 2025 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
 package config
 
 import (
-	"context"
-	"net/http"
-
-	"github.com/kubernetes-csi/csi-lib-utils/features"
-	"github.com/kubernetes-csi/csi-lib-utils/leaderelection"
-	"github.com/kubernetes-csi/csi-lib-utils/metrics"
 	"github.com/kubernetes-csi/csi-lib-utils/standardflags"
-	utilfeature "k8s.io/apiserver/pkg/util/feature"
-	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/rest"
 	"k8s.io/client-go/tools/clientcmd"
-	"k8s.io/klog/v2"
 )
 
 func BuildConfig(kubeconfig string, opts standardflags.SidecarConfiguration) (*rest.Config, error) {
@@ -25,81 +31,9 @@ func BuildConfig(kubeconfig string, opts standardflags.SidecarConfiguration) (*r
 	return config, nil
 }
 
-
 func buildConfig(kubeconfig string) (*rest.Config, error) {
 	if kubeconfig != "" {
 		return clientcmd.BuildConfigFromFlags("", kubeconfig)
 	}
 	return rest.InClusterConfig()
 }
-
-func RunWithLeaderElection(ctx context.Context, 
-	config *rest.Config, 
-	opts standardflags.SidecarConfiguration, 
-	run func(context.Context), 
-	driverName string, 
-	metricsManager metrics.CSIMetricsManager) {
-	
-	logger := klog.Background()
-	
-	// Prepare http endpoint for metrics + leader election healthz
-	mux := http.NewServeMux()
-	addr := opts.MetricsAddress
-	if addr == "" {
-		addr = opts.HttpEndpoint
-	}
-
-	if addr != "" {
-		metricsManager.RegisterToServer(mux, opts.MetricsPath)
-		metricsManager.SetDriverName(driverName)
-		go func() {
-			logger.Info("ServeMux listening", "address", addr, "metricsPath", opts.MetricsPath)
-			err := http.ListenAndServe(addr, mux)
-			if err != nil {
-				logger.Error(err, "Failed to start HTTP server at specified address and metrics path", "address", addr, "metricsPath", opts.MetricsPath)
-				klog.FlushAndExit(klog.ExitFlushTimeout, 1)
-			}
-		}()
-	}
-	
-	if !opts.LeaderElection {
-		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 {
-			logger.Error(err, "Failed to create leaderelection client")
-			klog.FlushAndExit(klog.ExitFlushTimeout, 1)
-		}
-
-		// Name of config map with leader election lock
-		le := leaderelection.NewLeaderElection(leClientset, driverName, run)
-		if opts.HttpEndpoint != "" {
-			le.PrepareHealthCheck(mux, leaderelection.DefaultHealthCheckTimeout)
-		}
-
-		if opts.LeaderElectionNamespace != "" {
-			le.WithNamespace(opts.LeaderElectionNamespace)
-		}
-
-		// TODO: uncomment once https://github.com/kubernetes-csi/csi-lib-utils/pull/200 is merged
-		//if opts.LeaderElectionLabels != nil {
-			// le.WithLabels(opts.LeaderElectionLabels)
-		//}
-
-		le.WithLeaseDuration(opts.LeaderElectionLeaseDuration)
-		le.WithRenewDeadline(opts.LeaderElectionRenewDeadline)
-		le.WithRetryPeriod(opts.LeaderElectionRetryPeriod)
-		if utilfeature.DefaultFeatureGate.Enabled(features.ReleaseLeaderElectionOnExit) {
-			le.WithReleaseOnCancel(true)
-			le.WithContext(ctx)
-		}
-
-		if err := le.Run(); err != nil {
-			logger.Error(err, "Failed to initialize leader election")
-			klog.FlushAndExit(klog.ExitFlushTimeout, 1)
-		}
-	}
-}

features/features.go

@@ -63,10 +63,6 @@ require (
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 	k8s.io/apimachinery v0.34.1 // indirect
-<<<<<<< HEAD
-	k8s.io/apiserver v0.34.1
-=======
->>>>>>> master
 	k8s.io/kube-openapi v0.0.0-20250710124328-f3f2b991d03b // indirect
 	k8s.io/utils v0.0.0-20250604170112-4c0f3b243397 // indirect
 	sigs.k8s.io/json v0.0.0-20241014173422-cfa47c3a1cc8 // indirect

go.mod

@@ -25,10 +25,12 @@ import (
 	"strings"
 	"time"
 
+	"github.com/kubernetes-csi/csi-lib-utils/standardflags"
 	v1 "k8s.io/api/core/v1"
 	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/kubernetes/scheme"
 	corev1 "k8s.io/client-go/kubernetes/typed/core/v1"
+	"k8s.io/client-go/rest"
 	"k8s.io/client-go/tools/leaderelection"
 	"k8s.io/client-go/tools/leaderelection/resourcelock"
 	"k8s.io/client-go/tools/record"
@@ -215,6 +217,58 @@ func (l *leaderElection) Run() error {
 	return nil // should never reach here
 }
 
+func RunWithLeaderElection(
+	ctx context.Context,
+	config *rest.Config,
+	opts standardflags.SidecarConfiguration,
+	run func(context.Context),
+	driverName string,
+	mux *http.ServeMux,
+	releaseOnExit bool) {
+
+	logger := klog.FromContext(ctx)
+
+	if !opts.LeaderElection {
+		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 {
+			logger.Error(err, "Failed to create leaderelection client")
+			klog.FlushAndExit(klog.ExitFlushTimeout, 1)
+		}
+
+		// Name of config map with leader election lock
+		le := NewLeaderElection(leClientset, driverName, run)
+		if opts.HttpEndpoint != "" {
+			le.PrepareHealthCheck(mux, DefaultHealthCheckTimeout)
+		}
+
+		if opts.LeaderElectionNamespace != "" {
+			le.WithNamespace(opts.LeaderElectionNamespace)
+		}
+
+		if opts.LeaderElectionLabels != nil {
+			le.WithLabels(opts.LeaderElectionLabels)
+		}
+
+		le.WithLeaseDuration(opts.LeaderElectionLeaseDuration)
+		le.WithRenewDeadline(opts.LeaderElectionRenewDeadline)
+		le.WithRetryPeriod(opts.LeaderElectionRetryPeriod)
+		if releaseOnExit {
+			le.WithReleaseOnCancel(true)
+			le.WithContext(ctx)
+		}
+
+		if err := le.Run(); err != nil {
+			logger.Error(err, "Failed to initialize leader election")
+			klog.FlushAndExit(klog.ExitFlushTimeout, 1)
+		}
+	}
+}
+
 func defaultLeaderElectionIdentity() (string, error) {
 	return os.Hostname()
 }

leaderelection/leader_election.go

@@ -5,7 +5,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-    http://www.apache.org/licenses/LICENSE-2.0
+	http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
@@ -19,46 +19,37 @@ package standardflags
 import (
 	"flag"
 	"fmt"
-	"time"
 	"strings"
+	"time"
 )
 
-
 type SidecarConfiguration struct {
 	ShowVersion bool
 
-	Master     string
 	KubeConfig string
 	CSIAddress string
-	Resync     time.Duration
-
-	RetryIntervalStart time.Duration
-	RetryIntervalMax   time.Duration
 
 	LeaderElection              bool
 	LeaderElectionNamespace     string
 	LeaderElectionLeaseDuration time.Duration
 	LeaderElectionRenewDeadline time.Duration
 	LeaderElectionRetryPeriod   time.Duration
-	LeaderElectionLabels		stringMap
+	LeaderElectionLabels        stringMap
 
 	KubeAPIQPS   float64
 	KubeAPIBurst int
 
-	HttpEndpoint string
+	HttpEndpoint   string
 	MetricsAddress string
-	MetricsPath string
+	MetricsPath    string
 }
 
 var Configuration = SidecarConfiguration{}
 
 func RegisterCommonFlags(flags *flag.FlagSet) {
 	flags.BoolVar(&Configuration.ShowVersion, "version", false, "Show version.")
-	flags.StringVar(&Configuration.Master, "master", "", "Master URL to build a client config from. Either this or kubeconfig needs to be set if the provisioner is being run out of cluster.")
 	flags.StringVar(&Configuration.KubeConfig, "kubeconfig", "", "Absolute path to the kubeconfig file. Required only when running out of cluster.")
 	flags.StringVar(&Configuration.CSIAddress, "csi-address", "/run/csi/socket", "The gRPC endpoint for Target CSI Volume.")
-	flags.DurationVar(&Configuration.RetryIntervalStart, "retry-interval-start", time.Second, "Initial retry interval of failed create volume or deletion. It doubles with each failure, up to retry-interval-max.")
-	flags.DurationVar(&Configuration.RetryIntervalMax, "retry-interval-max", 5*time.Minute, "Maximum retry interval of failed create volume or deletion.")
 	flags.BoolVar(&Configuration.LeaderElection, "leader-election", false, "Enable leader election.")
 	flags.StringVar(&Configuration.LeaderElectionNamespace, "leader-election-namespace", "", "Namespace where the leader election resource lives. Defaults to the pod namespace if not set.")
 	flags.DurationVar(&Configuration.LeaderElectionLeaseDuration, "leader-election-lease-duration", 15*time.Second, "Duration, in seconds, that non-leader candidates will wait to force acquire leadership. Defaults to 15 seconds.")
@@ -72,7 +63,6 @@ func RegisterCommonFlags(flags *flag.FlagSet) {
 	flag.StringVar(&Configuration.MetricsPath, "metrics-path", "/metrics", "The HTTP path where prometheus metrics will be exposed. Default is `/metrics`.")
 }
 
-
 type stringMap map[string]string
 
 func (sm *stringMap) String() string {
@@ -91,4 +81,3 @@ func (sm *stringMap) Set(value string) error {
 	}
 	return nil
 }
-