Skip to content

Commit 0a07d3a

Browse files
committed
Clarify state of Warmup feature
Signed-off-by: Stefan Büringer [email protected]
1 parent e922805 commit 0a07d3a

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

pkg/config/controller.go

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,16 @@ type Controller struct {
7171
// Setting EnableWarmup to true and NeedLeaderElection to false is a no-op as controllers without
7272
// leader election do not wait on leader election to start their sources.
7373
// Defaults to false.
74+
//
75+
// Note: This feature is currently in beta.
76+
// For more details, see: https://github.com/kubernetes-sigs/controller-runtime/issues/3220.
7477
EnableWarmup *bool
7578

7679
// UsePriorityQueue configures the controllers queue to use the controller-runtime provided
7780
// priority queue.
7881
//
79-
// Note: This flag is disabled by default until a future version. It's currently in beta.
82+
// Note: This flag is disabled by default until a future version. This feature is currently in beta.
83+
// For more details, see: https://github.com/kubernetes-sigs/controller-runtime/issues/2374.
8084
UsePriorityQueue *bool
8185

8286
// Logger is the logger controllers should use.

pkg/controller/controller.go

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,8 @@ type TypedOptions[request comparable] struct {
9191
// UsePriorityQueue configures the controllers queue to use the controller-runtime provided
9292
// priority queue.
9393
//
94-
// Note: This flag is disabled by default until a future version. It's currently in beta.
94+
// Note: This flag is disabled by default until a future version. This feature is currently in beta.
95+
// For more details, see: https://github.com/kubernetes-sigs/controller-runtime/issues/2374.
9596
UsePriorityQueue *bool
9697

9798
// EnableWarmup specifies whether the controller should start its sources when the manager is not
@@ -105,6 +106,9 @@ type TypedOptions[request comparable] struct {
105106
// Setting EnableWarmup to true and NeedLeaderElection to false is a no-op as controllers without
106107
// leader election do not wait on leader election to start their sources.
107108
// Defaults to false.
109+
//
110+
// Note: This feature is currently in beta.
111+
// For more details, see: https://github.com/kubernetes-sigs/controller-runtime/issues/3220.
108112
EnableWarmup *bool
109113

110114
// ReconciliationTimeout is used as the timeout passed to the context of each Reconcile call.

0 commit comments

Comments
 (0)