Skip to content

Commit f58406d

Browse files
committed
Fix the abbreviation for manager
The former abbreviation (`mrg`) is a well known typo. This fixes instances of `mrg` so they say `mgr` (ManaGeR).
1 parent ecee73e commit f58406d

File tree

4 files changed

+30
-30
lines changed

4 files changed

+30
-30
lines changed

example/main.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,15 @@ func main() {
4747
entryLog := log.WithName("entrypoint")
4848

4949
// Setup a Manager
50-
mrg, err := manager.New(config.GetConfigOrDie(), manager.Options{})
50+
mgr, err := manager.New(config.GetConfigOrDie(), manager.Options{})
5151
if err != nil {
5252
entryLog.Error(err, "unable to set up overall controller manager")
5353
os.Exit(1)
5454
}
5555

5656
// Setup a new controller to Reconciler ReplicaSets
57-
c, err := controller.New("foo-controller", mrg, controller.Options{
58-
Reconciler: &reconcileReplicaSet{client: mrg.GetClient(), log: log.WithName("reconciler")},
57+
c, err := controller.New("foo-controller", mgr, controller.Options{
58+
Reconciler: &reconcileReplicaSet{client: mgr.GetClient(), log: log.WithName("reconciler")},
5959
})
6060
if err != nil {
6161
entryLog.Error(err, "unable to set up individual controller")
@@ -75,7 +75,7 @@ func main() {
7575
os.Exit(1)
7676
}
7777

78-
if err := mrg.Start(signals.SetupSignalHandler()); err != nil {
78+
if err := mgr.Start(signals.SetupSignalHandler()); err != nil {
7979
entryLog.Error(err, "unable to run manager")
8080
os.Exit(1)
8181
}

pkg/controller/example_test.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ import (
2828
"sigs.k8s.io/controller-runtime/pkg/source"
2929
)
3030

31-
var mrg manager.Manager
31+
var mgr manager.Manager
3232

3333
// This example creates a new Controller named "pod-controller" with a no-op reconcile function. The
3434
// manager.Manager will be used to Start the Controller, and will provide it a shared Cache and Client.
3535
func ExampleNew() {
36-
_, err := controller.New("pod-controller", mrg, controller.Options{
36+
_, err := controller.New("pod-controller", mgr, controller.Options{
3737
Reconciler: reconcile.Func(func(o reconcile.Request) (reconcile.Result, error) {
3838
// Your business logic to implement the API by creating, updating, deleting objects goes here.
3939
return reconcile.Result{}, nil
@@ -46,11 +46,11 @@ func ExampleNew() {
4646

4747
// This example starts a new Controller named "pod-controller" to Watch Pods and call a no-op Reconciler.
4848
func ExampleController() {
49-
// mrg is a manager.Manager
49+
// mgr is a manager.Manager
5050

5151
// Create a new Controller that will call the provided Reconciler function in response
5252
// to events.
53-
c, err := controller.New("pod-controller", mrg, controller.Options{
53+
c, err := controller.New("pod-controller", mgr, controller.Options{
5454
Reconciler: reconcile.Func(func(o reconcile.Request) (reconcile.Result, error) {
5555
// Your business logic to implement the API by creating, updating, deleting objects goes here.
5656
return reconcile.Result{}, nil
@@ -70,5 +70,5 @@ func ExampleController() {
7070
}
7171

7272
// Start the Controller through the manager.
73-
mrg.Start(signals.SetupSignalHandler())
73+
mgr.Start(signals.SetupSignalHandler())
7474
}

pkg/manager/example_test.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import (
2424
"sigs.k8s.io/controller-runtime/pkg/runtime/signals"
2525
)
2626

27-
var mrg manager.Manager
27+
var mgr manager.Manager
2828

2929
// This example creates a new Manager that can be used with controller.New to create Controllers.
3030
func ExampleNew() {
@@ -33,16 +33,16 @@ func ExampleNew() {
3333
log.Fatal(err)
3434
}
3535

36-
mrg, err := manager.New(cfg, manager.Options{})
36+
mgr, err := manager.New(cfg, manager.Options{})
3737
if err != nil {
3838
log.Fatal(err)
3939
}
40-
log.Print(mrg)
40+
log.Print(mgr)
4141
}
4242

4343
// This example adds a Runnable for the Manager to Start.
4444
func ExampleManager_Add() {
45-
err := mrg.Add(manager.RunnableFunc(func(<-chan struct{}) error {
45+
err := mgr.Add(manager.RunnableFunc(func(<-chan struct{}) error {
4646
// Do something
4747
return nil
4848
}))
@@ -53,7 +53,7 @@ func ExampleManager_Add() {
5353

5454
// This example starts a Manager that has had Runnables added.
5555
func ExampleManager_Start() {
56-
err := mrg.Start(signals.SetupSignalHandler())
56+
err := mgr.Start(signals.SetupSignalHandler())
5757
if err != nil {
5858
log.Fatal(err)
5959
}

pkg/manager/manager_test.go

+16-16
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,9 @@ var _ = Describe("manger.Manager", func() {
138138
It("should return an error if it can't start the cache", func(done Done) {
139139
m, err := New(cfg, Options{})
140140
Expect(err).NotTo(HaveOccurred())
141-
mrg, ok := m.(*controllerManager)
141+
mgr, ok := m.(*controllerManager)
142142
Expect(ok).To(BeTrue())
143-
mrg.startCache = func(stop <-chan struct{}) error {
143+
mgr.startCache = func(stop <-chan struct{}) error {
144144
return fmt.Errorf("expected error")
145145
}
146146
Expect(m.Start(stop).Error()).To(ContainSubstring("expected error"))
@@ -188,7 +188,7 @@ var _ = Describe("manger.Manager", func() {
188188
func(done Done) {
189189
m, err := New(cfg, Options{})
190190
Expect(err).NotTo(HaveOccurred())
191-
mrg, ok := m.(*controllerManager)
191+
mgr, ok := m.(*controllerManager)
192192
Expect(ok).To(BeTrue())
193193

194194
// Add one component before starting
@@ -205,7 +205,7 @@ var _ = Describe("manger.Manager", func() {
205205
}()
206206

207207
// Wait for the Manager to start
208-
Eventually(func() bool { return mrg.started }).Should(BeTrue())
208+
Eventually(func() bool { return mgr.started }).Should(BeTrue())
209209

210210
// Add another component after starting
211211
c2 := make(chan struct{})
@@ -223,7 +223,7 @@ var _ = Describe("manger.Manager", func() {
223223
It("should immediately start the Component if the Manager has already Started", func(done Done) {
224224
m, err := New(cfg, Options{})
225225
Expect(err).NotTo(HaveOccurred())
226-
mrg, ok := m.(*controllerManager)
226+
mgr, ok := m.(*controllerManager)
227227
Expect(ok).To(BeTrue())
228228

229229
go func() {
@@ -232,7 +232,7 @@ var _ = Describe("manger.Manager", func() {
232232
}()
233233

234234
// Wait for the Manager to start
235-
Eventually(func() bool { return mrg.started }).Should(BeTrue())
235+
Eventually(func() bool { return mgr.started }).Should(BeTrue())
236236

237237
c1 := make(chan struct{})
238238
m.Add(RunnableFunc(func(s <-chan struct{}) error {
@@ -255,10 +255,10 @@ var _ = Describe("manger.Manager", func() {
255255
It("should inject field values", func(done Done) {
256256
m, err := New(cfg, Options{})
257257
Expect(err).NotTo(HaveOccurred())
258-
mrg, ok := m.(*controllerManager)
258+
mgr, ok := m.(*controllerManager)
259259
Expect(ok).To(BeTrue())
260260

261-
mrg.cache = &informertest.FakeInformers{}
261+
mgr.cache = &informertest.FakeInformers{}
262262

263263
By("Injecting the dependencies")
264264
err = m.SetFields(&injectable{
@@ -346,33 +346,33 @@ var _ = Describe("manger.Manager", func() {
346346
It("should provide a function to get the Config", func() {
347347
m, err := New(cfg, Options{})
348348
Expect(err).NotTo(HaveOccurred())
349-
mrg, ok := m.(*controllerManager)
349+
mgr, ok := m.(*controllerManager)
350350
Expect(ok).To(BeTrue())
351-
Expect(m.GetConfig()).To(Equal(mrg.config))
351+
Expect(m.GetConfig()).To(Equal(mgr.config))
352352
})
353353

354354
It("should provide a function to get the Client", func() {
355355
m, err := New(cfg, Options{})
356356
Expect(err).NotTo(HaveOccurred())
357-
mrg, ok := m.(*controllerManager)
357+
mgr, ok := m.(*controllerManager)
358358
Expect(ok).To(BeTrue())
359-
Expect(m.GetClient()).To(Equal(mrg.client))
359+
Expect(m.GetClient()).To(Equal(mgr.client))
360360
})
361361

362362
It("should provide a function to get the Scheme", func() {
363363
m, err := New(cfg, Options{})
364364
Expect(err).NotTo(HaveOccurred())
365-
mrg, ok := m.(*controllerManager)
365+
mgr, ok := m.(*controllerManager)
366366
Expect(ok).To(BeTrue())
367-
Expect(m.GetScheme()).To(Equal(mrg.scheme))
367+
Expect(m.GetScheme()).To(Equal(mgr.scheme))
368368
})
369369

370370
It("should provide a function to get the FieldIndexer", func() {
371371
m, err := New(cfg, Options{})
372372
Expect(err).NotTo(HaveOccurred())
373-
mrg, ok := m.(*controllerManager)
373+
mgr, ok := m.(*controllerManager)
374374
Expect(ok).To(BeTrue())
375-
Expect(m.GetFieldIndexer()).To(Equal(mrg.fieldIndexes))
375+
Expect(m.GetFieldIndexer()).To(Equal(mgr.fieldIndexes))
376376
})
377377

378378
It("should provide a function to get the EventRecorder", func() {

0 commit comments

Comments
 (0)