chore: make leader election ID configurable (#1797)

kubernetes-sigs · Nov 6, 2024 · fea57a1 · fea57a1
1 parent ab33542
commit fea57a1
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 1 deletion.
diff --git a/pkg/operator/operator.go b/pkg/operator/operator.go
@@ -130,7 +130,7 @@ func NewOperator() (context.Context, *Operator) {
 	mgrOpts := ctrl.Options{
 		Logger:                        logging.IgnoreDebugEvents(logger),
 		LeaderElection:                !options.FromContext(ctx).DisableLeaderElection,
-		LeaderElectionID:              "karpenter-leader-election",
+		LeaderElectionID:              options.FromContext(ctx).LeaderElectionName,
 		LeaderElectionNamespace:       options.FromContext(ctx).LeaderElectionNamespace,
 		LeaderElectionResourceLock:    resourcelock.LeasesResourceLock,
 		LeaderElectionReleaseOnCancel: true,

diff --git a/pkg/operator/options/options.go b/pkg/operator/options/options.go
@@ -53,6 +53,7 @@ type Options struct {
 	KubeClientBurst         int
 	EnableProfiling         bool
 	DisableLeaderElection   bool
+	LeaderElectionName      string
 	LeaderElectionNamespace string
 	MemoryLimit             int64
 	LogLevel                string
@@ -88,6 +89,7 @@ func (o *Options) AddFlags(fs *FlagSet) {
 	fs.IntVar(&o.KubeClientBurst, "kube-client-burst", env.WithDefaultInt("KUBE_CLIENT_BURST", 300), "The maximum allowed burst of queries to the kube-apiserver")
 	fs.BoolVarWithEnv(&o.EnableProfiling, "enable-profiling", "ENABLE_PROFILING", false, "Enable the profiling on the metric endpoint")
 	fs.BoolVarWithEnv(&o.DisableLeaderElection, "disable-leader-election", "DISABLE_LEADER_ELECTION", false, "Disable the leader election client before executing the main loop. Disable when running replicated components for high availability is not desired.")
+	fs.StringVar(&o.LeaderElectionName, "leader-election-name", env.WithDefaultString("LEADER_ELECTION_NAME", "karpenter-leader-election"), "Leader election name to create and monitor the lease if running outside the cluster")
 	fs.StringVar(&o.LeaderElectionNamespace, "leader-election-namespace", env.WithDefaultString("LEADER_ELECTION_NAMESPACE", ""), "Leader election namespace to create and monitor the lease if running outside the cluster")
 	fs.Int64Var(&o.MemoryLimit, "memory-limit", env.WithDefaultInt64("MEMORY_LIMIT", -1), "Memory limit on the container running the controller. The GC soft memory limit is set to 90% of this value.")
 	fs.StringVar(&o.LogLevel, "log-level", env.WithDefaultString("LOG_LEVEL", "info"), "Log verbosity level. Can be one of 'debug', 'info', or 'error'")

diff --git a/pkg/operator/options/suite_test.go b/pkg/operator/options/suite_test.go
@@ -102,6 +102,7 @@ var _ = Describe("Options", func() {
 				KubeClientBurst:         lo.ToPtr(300),
 				EnableProfiling:         lo.ToPtr(false),
 				DisableLeaderElection:   lo.ToPtr(false),
+				LeaderElectionName:      lo.ToPtr("karpenter-leader-election"),
 				LeaderElectionNamespace: lo.ToPtr(""),
 				MemoryLimit:             lo.ToPtr[int64](-1),
 				LogLevel:                lo.ToPtr("info"),
@@ -127,6 +128,7 @@ var _ = Describe("Options", func() {
 				"--kube-client-burst", "0",
 				"--enable-profiling",
 				"--disable-leader-election=true",
+				"--leader-election-name=karpenter-controller",
 				"--leader-election-namespace=karpenter",
 				"--memory-limit", "0",
 				"--log-level", "debug",
@@ -145,6 +147,7 @@ var _ = Describe("Options", func() {
 				KubeClientBurst:         lo.ToPtr(0),
 				EnableProfiling:         lo.ToPtr(true),
 				DisableLeaderElection:   lo.ToPtr(true),
+				LeaderElectionName:      lo.ToPtr("karpenter-controller"),
 				LeaderElectionNamespace: lo.ToPtr("karpenter"),
 				MemoryLimit:             lo.ToPtr[int64](0),
 				LogLevel:                lo.ToPtr("debug"),
@@ -166,6 +169,7 @@ var _ = Describe("Options", func() {
 			os.Setenv("KUBE_CLIENT_BURST", "0")
 			os.Setenv("ENABLE_PROFILING", "true")
 			os.Setenv("DISABLE_LEADER_ELECTION", "true")
+			os.Setenv("LEADER_ELECTION_NAME", "karpenter-controller")
 			os.Setenv("LEADER_ELECTION_NAMESPACE", "karpenter")
 			os.Setenv("MEMORY_LIMIT", "0")
 			os.Setenv("LOG_LEVEL", "debug")
@@ -188,6 +192,7 @@ var _ = Describe("Options", func() {
 				KubeClientBurst:         lo.ToPtr(0),
 				EnableProfiling:         lo.ToPtr(true),
 				DisableLeaderElection:   lo.ToPtr(true),
+				LeaderElectionName:      lo.ToPtr("karpenter-controller"),
 				LeaderElectionNamespace: lo.ToPtr("karpenter"),
 				MemoryLimit:             lo.ToPtr[int64](0),
 				LogLevel:                lo.ToPtr("debug"),
@@ -232,6 +237,7 @@ var _ = Describe("Options", func() {
 				KubeClientBurst:         lo.ToPtr(0),
 				EnableProfiling:         lo.ToPtr(true),
 				DisableLeaderElection:   lo.ToPtr(true),
+				LeaderElectionName:      lo.ToPtr("karpenter-leader-election"),
 				LeaderElectionNamespace: lo.ToPtr(""),
 				MemoryLimit:             lo.ToPtr[int64](0),
 				LogLevel:                lo.ToPtr("debug"),

diff --git a/pkg/test/options.go b/pkg/test/options.go
@@ -35,6 +35,7 @@ type OptionsFields struct {
 	KubeClientBurst         *int
 	EnableProfiling         *bool
 	DisableLeaderElection   *bool
+	LeaderElectionName      *string
 	LeaderElectionNamespace *string
 	MemoryLimit             *int64
 	LogLevel                *string