golint fixes to plugin/pkg/scheduler/scheduler.go

plugin/pkg/scheduler/scheduler.go

@@ -41,6 +41,8 @@ type Binder interface {
 	Bind(binding *v1.Binding) error
 }
 
+// PodConditionUpdater updates the condition of a pod based on the passed
+// PodCondition
 type PodConditionUpdater interface {
 	Update(pod *v1.Pod, podCondition *v1.PodCondition) error
 }
@@ -51,12 +53,15 @@ type Scheduler struct {
 	config *Config
 }
 
+// StopEverything closes the scheduler config's StopEverything channel, to shut
+// down the Scheduler.
 func (sched *Scheduler) StopEverything() {
 	close(sched.config.StopEverything)
 }
 
-// These are the functions which need to be provided in order to build a Scheduler configuration.
+// Configurator defines I/O, caching, and other functionality needed to
-// An implementation of this can be seen in factory.go.
+// construct a new scheduler. An implementation of this can be seen in
+// factory.go.
 type Configurator interface {
 	GetPriorityFunctionConfigs(priorityKeys sets.String) ([]algorithm.PriorityConfig, error)
 	GetPriorityMetadataProducer() (algorithm.MetadataProducer, error)
@@ -81,6 +86,7 @@ type Configurator interface {
 	CreateFromKeys(predicateKeys, priorityKeys sets.String, extenders []algorithm.SchedulerExtender) (*Config, error)
 }
 
+// Config is an implementation of the Scheduler's configured input data.
 // TODO over time we should make this struct a hidden implementation detail of the scheduler.
 type Config struct {
 	// It is expected that changes made via SchedulerCache will be observed
@@ -141,26 +147,26 @@ func NewFromConfigurator(c Configurator, modifiers ...func(c *Config)) (*Schedul
 }
 
 // Run begins watching and scheduling. It starts a goroutine and returns immediately.
-func (s *Scheduler) Run() {
+func (sched *Scheduler) Run() {
-	go wait.Until(s.scheduleOne, 0, s.config.StopEverything)
+	go wait.Until(sched.scheduleOne, 0, sched.config.StopEverything)
 }
 
-func (s *Scheduler) scheduleOne() {
+func (sched *Scheduler) scheduleOne() {
-	pod := s.config.NextPod()
+	pod := sched.config.NextPod()
 	if pod.DeletionTimestamp != nil {
-		s.config.Recorder.Eventf(pod, v1.EventTypeWarning, "FailedScheduling", "skip schedule deleting pod: %v/%v", pod.Namespace, pod.Name)
+		sched.config.Recorder.Eventf(pod, v1.EventTypeWarning, "FailedScheduling", "skip schedule deleting pod: %v/%v", pod.Namespace, pod.Name)
 		glog.V(3).Infof("Skip schedule deleting pod: %v/%v", pod.Namespace, pod.Name)
 		return
 	}
 
 	glog.V(3).Infof("Attempting to schedule pod: %v/%v", pod.Namespace, pod.Name)
 	start := time.Now()
-	dest, err := s.config.Algorithm.Schedule(pod, s.config.NodeLister)
+	dest, err := sched.config.Algorithm.Schedule(pod, sched.config.NodeLister)
 	if err != nil {
 		glog.V(1).Infof("Failed to schedule pod: %v/%v", pod.Namespace, pod.Name)
-		s.config.Error(pod, err)
+		sched.config.Error(pod, err)
-		s.config.Recorder.Eventf(pod, v1.EventTypeWarning, "FailedScheduling", "%v", err)
+		sched.config.Recorder.Eventf(pod, v1.EventTypeWarning, "FailedScheduling", "%v", err)
-		s.config.PodConditionUpdater.Update(pod, &v1.PodCondition{
+		sched.config.PodConditionUpdater.Update(pod, &v1.PodCondition{
 			Type:    v1.PodScheduled,
 			Status:  v1.ConditionFalse,
 			Reason:  v1.PodReasonUnschedulable,
@@ -176,7 +182,7 @@ func (s *Scheduler) scheduleOne() {
 	// immediately.
 	assumed := *pod
 	assumed.Spec.NodeName = dest
-	if err := s.config.SchedulerCache.AssumePod(&assumed); err != nil {
+	if err := sched.config.SchedulerCache.AssumePod(&assumed); err != nil {
 		glog.Errorf("scheduler cache AssumePod failed: %v", err)
 		// TODO: This means that a given pod is already in cache (which means it
 		// is either assumed or already added). This is most probably result of a
@@ -201,18 +207,18 @@ func (s *Scheduler) scheduleOne() {
 		bindingStart := time.Now()
 		// If binding succeeded then PodScheduled condition will be updated in apiserver so that
 		// it's atomic with setting host.
-		err := s.config.Binder.Bind(b)
+		err := sched.config.Binder.Bind(b)
-		if err := s.config.SchedulerCache.FinishBinding(&assumed); err != nil {
+		if err := sched.config.SchedulerCache.FinishBinding(&assumed); err != nil {
 			glog.Errorf("scheduler cache FinishBinding failed: %v", err)
 		}
 		if err != nil {
 			glog.V(1).Infof("Failed to bind pod: %v/%v", pod.Namespace, pod.Name)
-			if err := s.config.SchedulerCache.ForgetPod(&assumed); err != nil {
+			if err := sched.config.SchedulerCache.ForgetPod(&assumed); err != nil {
 				glog.Errorf("scheduler cache ForgetPod failed: %v", err)
 			}
-			s.config.Error(pod, err)
+			sched.config.Error(pod, err)
-			s.config.Recorder.Eventf(pod, v1.EventTypeNormal, "FailedScheduling", "Binding rejected: %v", err)
+			sched.config.Recorder.Eventf(pod, v1.EventTypeNormal, "FailedScheduling", "Binding rejected: %v", err)
-			s.config.PodConditionUpdater.Update(pod, &v1.PodCondition{
+			sched.config.PodConditionUpdater.Update(pod, &v1.PodCondition{
 				Type:   v1.PodScheduled,
 				Status: v1.ConditionFalse,
 				Reason: "BindingRejected",
@@ -220,6 +226,6 @@ func (s *Scheduler) scheduleOne() {
 			return
 		}
 		metrics.BindingLatency.Observe(metrics.SinceInMicroseconds(bindingStart))
-		s.config.Recorder.Eventf(pod, v1.EventTypeNormal, "Scheduled", "Successfully assigned %v to %v", pod.Name, dest)
+		sched.config.Recorder.Eventf(pod, v1.EventTypeNormal, "Scheduled", "Successfully assigned %v to %v", pod.Name, dest)
 	}()
 }