Rename unmanaged controller concepts

Signed-off-by: Nic Cope <[email protected]>

Author: negz

pkg/controller/controller.go

@@ -67,7 +67,7 @@ type Controller interface {
 // New returns a new Controller registered with the Manager.  The Manager will ensure that shared Caches have
 // been synced before the Controller is Started.
 func New(name string, mgr manager.Manager, options Options) (Controller, error) {
-	c, err := Configure(name, mgr, options)
+	c, err := NewUnmanaged(name, mgr, options)
 	if err != nil {
 		return nil, err
 	}
@@ -76,8 +76,9 @@ func New(name string, mgr manager.Manager, options Options) (Controller, error)
 	return c, mgr.Add(c)
 }
 
-// Configure a new controller without starting it or adding it to the manager.
-func Configure(name string, mgr manager.Manager, options Options) (Controller, error) {
+// NewUnmanaged returns a new controller without adding it to the manager. The
+// caller is responsible for starting the returned controller.
+func NewUnmanaged(name string, mgr manager.Manager, options Options) (Controller, error) {
 	if options.Reconciler == nil {
 		return nil, fmt.Errorf("must specify Reconciler")
 	}

pkg/manager/internal.go

@@ -130,7 +130,10 @@ type controllerManager struct {
 	// It and `internalStop` should point to the same channel.
 	internalStopper chan<- struct{}
 
-	elected chan struct{}
+	// leading is closed when this manager becomes the leader of a group of
+	// managers, either because it won a leader election or because no leader
+	// election was configured.
+	leading chan struct{}
 
 	startCache func(stop <-chan struct{}) error
 
@@ -425,8 +428,8 @@ func (cm *controllerManager) Start(stop <-chan struct{}) error {
 			return err
 		}
 	} else {
-		// Treat not having an election the same as being elected.
-		close(cm.elected)
+		// Treat not having leader election enabled the same as being elected.
+		close(cm.leading)
 		go cm.startLeaderElectionRunnables()
 	}
 
@@ -515,7 +518,7 @@ func (cm *controllerManager) startLeaderElection() (err error) {
 		RetryPeriod:   cm.retryPeriod,
 		Callbacks: leaderelection.LeaderCallbacks{
 			OnStartedLeading: func(_ context.Context) {
-				close(cm.elected)
+				close(cm.leading)
 				cm.startLeaderElectionRunnables()
 			},
 			OnStoppedLeading: func() {
@@ -544,6 +547,6 @@ func (cm *controllerManager) startLeaderElection() (err error) {
 	return nil
 }
 
-func (cm *controllerManager) Elected() <-chan struct{} {
-	return cm.elected
+func (cm *controllerManager) Leading() <-chan struct{} {
+	return cm.leading
 }

pkg/manager/manager.go

@@ -50,9 +50,10 @@ type Manager interface {
 	// non-leaderelection mode (always running) or leader election mode (managed by leader election if enabled).
 	Add(Runnable) error
 
-	// Elected is closed when this manager is elected the leader, or when no
-	// election is configured.
-	Elected() <-chan struct{}
+	// Leading is closed when this manager becomes the leader of a group of
+	// managers, either because it won a leader election or because no leader
+	// election was configured.
+	Leading() <-chan struct{}
 
 	// SetFields will set any dependencies on an object for which the object has implemented the inject
 	// interface - e.g. inject.Client.
@@ -317,7 +318,7 @@ func New(config *rest.Config, options Options) (Manager, error) {
 		metricsListener:       metricsListener,
 		internalStop:          stop,
 		internalStopper:       stop,
-		elected:               make(chan struct{}),
+		leading:               make(chan struct{}),
 		port:                  options.Port,
 		host:                  options.Host,
 		certDir:               options.CertDir,