Skip to content

Commit 5a13db4

Browse files
committed
Document !NeedLeaderElection+NeedWarmup behavior
1 parent c201bfa commit 5a13db4

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

pkg/config/controller.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,10 @@ type Controller struct {
6666
// improves leadership failover time, as the caches will be prepopulated before the controller
6767
// transitions to be leader.
6868
//
69-
// When set to true, the controller will start its sources without waiting to become leader.
69+
// Setting NeedWarmup to true and NeedLeaderElection to true means the controller will start its
70+
// sources without waiting to become leader.
71+
// Setting NeedWarmup to true and NeedLeaderElection is false is a no-op as controllers without
72+
// leader election do not wait on leader election to start their sources.
7073
// Defaults to false.
7174
NeedWarmup *bool
7275

0 commit comments

Comments
 (0)