k8s controller源码阅读

源文件：

pkg\internal\controller\controller.go

 

// Start implements controller.Controller
func (c *Controller) Start(stop <-chan struct{}) error {
    // use an IIFE to get proper lock handling
    // but lock outside to get proper handling of the queue shutdown
    c.mu.Lock()

    c.Queue = c.MakeQueue()
    defer c.Queue.ShutDown() // needs to be outside the iife so that we shutdown after the stop channel is closed

    err := func() error {
        defer c.mu.Unlock()

        // TODO(pwittrock): Reconsider HandleCrash
        defer utilruntime.HandleCrash()

        // NB(directxman12): launch the sources *before* trying to wait for the
        // caches to sync so that they have a chance to register their intendeded
        // caches.
        for _, watch := range c.watches {
            log.Info("Starting EventSource", "controller", c.Name, "source", watch.src)
            if err := watch.src.Start(watch.handler, c.Queue, watch.predicates...); err != nil {
                return err
            }
        }

        // Start the SharedIndexInformer factories to begin populating the SharedIndexInformer caches
        log.Info("Starting Controller", "controller", c.Name)

        // Wait for the caches to be synced before starting workers
        if c.WaitForCacheSync == nil {
            c.WaitForCacheSync = c.Cache.WaitForCacheSync
        }
        if ok := c.WaitForCacheSync(stop); !ok {
            // This code is unreachable right now since WaitForCacheSync will never return an error
            // Leaving it here because that could happen in the future
            err := fmt.Errorf("failed to wait for %s caches to sync", c.Name)
            log.Error(err, "Could not wait for Cache to sync", "controller", c.Name)
            return err
        }

        if c.JitterPeriod == 0 {
            c.JitterPeriod = 1 * time.Second
        }

        // Launch workers to process resources
        log.Info("Starting workers", "controller", c.Name, "worker count", c.MaxConcurrentReconciles)
        for i := 0; i < c.MaxConcurrentReconciles; i++ {
            // Process work items
            go wait.Until(c.worker, c.JitterPeriod, stop)
        }

        c.Started = true
        return nil
    }()
    if err != nil {
        return err
    }

    <-stop
    log.Info("Stopping workers", "controller", c.Name)
    return nil
}

// worker runs a worker thread that just dequeues items, processes them, and marks them done.
// It enforces that the reconcileHandler is never invoked concurrently with the same object.
func (c *Controller) worker() {
    for c.processNextWorkItem() {
    }
}

// processNextWorkItem will read a single work item off the workqueue and
// attempt to process it, by calling the reconcileHandler.
func (c *Controller) processNextWorkItem() bool {
    obj, shutdown := c.Queue.Get()
    if shutdown {
        // Stop working
        return false
    }

    // We call Done here so the workqueue knows we have finished
    // processing this item. We also must remember to call Forget if we
    // do not want this work item being re-queued. For example, we do
    // not call Forget if a transient error occurs, instead the item is
    // put back on the workqueue and attempted again after a back-off
    // period.
    defer c.Queue.Done(obj)

    return c.reconcileHandler(obj)
}

func (c *Controller) reconcileHandler(obj interface{}) bool {
    // Update metrics after processing each item
    reconcileStartTS := time.Now()
    defer func() {
        c.updateMetrics(time.Since(reconcileStartTS))
    }()

    var req reconcile.Request
    var ok bool
    if req, ok = obj.(reconcile.Request); !ok {
        // As the item in the workqueue is actually invalid, we call
        // Forget here else we'd go into a loop of attempting to
        // process a work item that is invalid.
        c.Queue.Forget(obj)
        log.Error(nil, "Queue item was not a Request",
            "controller", c.Name, "type", fmt.Sprintf("%T", obj), "value", obj)
        // Return true, don't take a break
        return true
    }
    // RunInformersAndControllers the syncHandler, passing it the namespace/Name string of the
    // resource to be synced.
    if result, err := c.Do.Reconcile(req); err != nil {
        c.Queue.AddRateLimited(req)
        log.Error(err, "Reconciler error", "controller", c.Name, "request", req)
        ctrlmetrics.ReconcileErrors.WithLabelValues(c.Name).Inc()
        ctrlmetrics.ReconcileTotal.WithLabelValues(c.Name, "error").Inc()
        return false
    } else if result.RequeueAfter > 0 {
        // The result.RequeueAfter request will be lost, if it is returned
        // along with a non-nil error. But this is intended as
        // We need to drive to stable reconcile loops before queuing due
        // to result.RequestAfter
        c.Queue.Forget(obj)
        c.Queue.AddAfter(req, result.RequeueAfter)
        ctrlmetrics.ReconcileTotal.WithLabelValues(c.Name, "requeue_after").Inc()
        return true
    } else if result.Requeue {
        c.Queue.AddRateLimited(req)
        ctrlmetrics.ReconcileTotal.WithLabelValues(c.Name, "requeue").Inc()
        return true
    }

    // Finally, if no error occurs we Forget this item so it does not
    // get queued again until another change happens.
    c.Queue.Forget(obj)

    // TODO(directxman12): What does 1 mean?  Do we want level constants?  Do we want levels at all?
    log.V(1).Info("Successfully Reconciled", "controller", c.Name, "request", req)

    ctrlmetrics.ReconcileTotal.WithLabelValues(c.Name, "success").Inc()
    // Return true, don't take a break
    return true
}