Skip to content

Commit b756161

Browse files
authored
✨ Add controller option for setting leader election (#2117)
* Add controller option for overrding the need for leader election * Update Options to be clearer Addresses PR review comment
1 parent 056869c commit b756161

File tree

3 files changed

+60
-0
lines changed

3 files changed

+60
-0
lines changed

pkg/controller/controller.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ type Options struct {
5858
// RecoverPanic indicates whether the panic caused by reconcile should be recovered.
5959
// Defaults to the Controller.RecoverPanic setting from the Manager if unset.
6060
RecoverPanic *bool
61+
62+
// NeedLeaderElection indicates whether the controller needs to use leader election.
63+
// Defaults to true, which means the controller will use leader election.
64+
NeedLeaderElection *bool
6165
}
6266

6367
// Controller implements a Kubernetes API. A Controller manages a work queue fed reconcile.Requests
@@ -156,6 +160,7 @@ func NewUnmanaged(name string, mgr manager.Manager, options Options) (Controller
156160
Name: name,
157161
LogConstructor: options.LogConstructor,
158162
RecoverPanic: options.RecoverPanic,
163+
LeaderElected: options.NeedLeaderElection,
159164
}, nil
160165
}
161166

pkg/controller/controller_test.go

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,50 @@ var _ = Describe("controller.Controller", func() {
178178
Expect(ctrl.RecoverPanic).NotTo(BeNil())
179179
Expect(*ctrl.RecoverPanic).To(BeFalse())
180180
})
181+
182+
It("should default NeedLeaderElection on the controller to true", func() {
183+
m, err := manager.New(cfg, manager.Options{})
184+
Expect(err).NotTo(HaveOccurred())
185+
186+
c, err := controller.New("new-controller", m, controller.Options{
187+
Reconciler: rec,
188+
})
189+
Expect(err).NotTo(HaveOccurred())
190+
191+
ctrl, ok := c.(*internalcontroller.Controller)
192+
Expect(ok).To(BeTrue())
193+
194+
Expect(ctrl.NeedLeaderElection()).To(BeTrue())
195+
})
196+
197+
It("should allow for setting leaderElected to false", func() {
198+
m, err := manager.New(cfg, manager.Options{})
199+
Expect(err).NotTo(HaveOccurred())
200+
201+
c, err := controller.New("new-controller", m, controller.Options{
202+
Reconciler: rec,
203+
NeedLeaderElection: pointer.Bool(false),
204+
})
205+
Expect(err).NotTo(HaveOccurred())
206+
207+
ctrl, ok := c.(*internalcontroller.Controller)
208+
Expect(ok).To(BeTrue())
209+
210+
Expect(ctrl.NeedLeaderElection()).To(BeFalse())
211+
})
212+
213+
It("should implement manager.LeaderElectionRunnable", func() {
214+
m, err := manager.New(cfg, manager.Options{})
215+
Expect(err).NotTo(HaveOccurred())
216+
217+
c, err := controller.New("new-controller", m, controller.Options{
218+
Reconciler: rec,
219+
})
220+
Expect(err).NotTo(HaveOccurred())
221+
222+
_, ok := c.(manager.LeaderElectionRunnable)
223+
Expect(ok).To(BeTrue())
224+
})
181225
})
182226
})
183227

pkg/internal/controller/controller.go

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,9 @@ type Controller struct {
9393

9494
// RecoverPanic indicates whether the panic caused by reconcile should be recovered.
9595
RecoverPanic *bool
96+
97+
// LeaderElected indicates whether the controller is leader elected or always running.
98+
LeaderElected *bool
9699
}
97100

98101
// watchDescription contains all the information necessary to start a watch.
@@ -152,6 +155,14 @@ func (c *Controller) Watch(src source.Source, evthdler handler.EventHandler, prc
152155
return src.Start(c.ctx, evthdler, c.Queue, prct...)
153156
}
154157

158+
// NeedLeaderElection implements the manager.LeaderElectionRunnable interface.
159+
func (c *Controller) NeedLeaderElection() bool {
160+
if c.LeaderElected == nil {
161+
return true
162+
}
163+
return *c.LeaderElected
164+
}
165+
155166
// Start implements controller.Controller.
156167
func (c *Controller) Start(ctx context.Context) error {
157168
// use an IIFE to get proper lock handling

0 commit comments

Comments
 (0)