Rename manager.Leading to manager.Elected

It's more intuitive to close the channel when a process (i.e. election) has
completed, rather than when a state (i.e. leading) has been entered.

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

Author: negz

pkg/controller/example_test.go

@@ -152,7 +152,7 @@ func ExampleNewUnmanaged() {
 		// Block until our controller manager is elected leader. We presume our
 		// entire process will terminate if we lose leadership, so we don't need
 		// to handle that.
-		<-mgr.Leading()
+		<-mgr.Elected()
 
 		// Start our controller. This will block until the stop channel is
 		// closed, or the controller returns an error.

pkg/manager/internal.go

@@ -130,10 +130,10 @@ type controllerManager struct {
 	// It and `internalStop` should point to the same channel.
 	internalStopper chan<- struct{}
 
-	// leading is closed when this manager becomes the leader of a group of
+	// elected 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{}
+	elected chan struct{}
 
 	startCache func(stop <-chan struct{}) error
 
@@ -429,7 +429,7 @@ func (cm *controllerManager) Start(stop <-chan struct{}) error {
 		}
 	} else {
 		// Treat not having leader election enabled the same as being elected.
-		close(cm.leading)
+		close(cm.elected)
 		go cm.startLeaderElectionRunnables()
 	}
 
@@ -518,7 +518,7 @@ func (cm *controllerManager) startLeaderElection() (err error) {
 		RetryPeriod:   cm.retryPeriod,
 		Callbacks: leaderelection.LeaderCallbacks{
 			OnStartedLeading: func(_ context.Context) {
-				close(cm.leading)
+				close(cm.elected)
 				cm.startLeaderElectionRunnables()
 			},
 			OnStoppedLeading: func() {
@@ -547,6 +547,6 @@ func (cm *controllerManager) startLeaderElection() (err error) {
 	return nil
 }
 
-func (cm *controllerManager) Leading() <-chan struct{} {
-	return cm.leading
+func (cm *controllerManager) Elected() <-chan struct{} {
+	return cm.elected
 }

pkg/manager/manager.go

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