Kubernetes Endpoints Controller的源碼解析

本篇內容介紹了“Kubernetes Endpoints Controller的源碼解析”的有關知識，在實際案例的操作過程中，不少人都會遇到這樣的困境，接下來就讓小編帶領大家學習一下如何處理這些情況吧！希望大家仔細閱讀，能夠學有所成！

Endpoints Controller相關的配置項

• --concurrent-endpoint-syncs int32 Default: 5 The number of endpoint syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load.

• --leader-elect-resource-lock endpoints Default: "endpoints" The type of resource object that is used for locking during leader election. Supported options are endpoints (default) and configmaps.

Endpoints Controller Watch的GVK

• Core/V1/Pods

• Core/V1/Services

• Core/V1/Endpoints

Endpoints Controller Event Handler

• Add Service Event --> enqueueService

• Update Service Event --> enqueueService(new)

• Delete Service Event --> enqueueService

• Add Pod Event --> addPod

• Update Pod Event --> updatePod

• Delete Pod Event --> deletePod

• Add/Update/Delete Endpoints Event --> nil

Run Endpoints Controller

啟動兩類go協程：

• 一類協程數為--concurrent-endpoint-syncs配置值(default 5)，每個worker負責從service queue中pop service進行syncService同步，完成一次sync后等待1s再從service queue中pop一個service進行sync，如此反復。

• 另一類協程只有一個協程，負責checkLeftoverEndpoints，只有啟動時會執行一次。

// Run will not return until stopCh is closed. workers determines how many
// endpoints will be handled in parallel.
func (e *EndpointController) Run(workers int, stopCh <-chan struct{}) {
	defer utilruntime.HandleCrash()
	defer e.queue.ShutDown()

	glog.Infof("Starting endpoint controller")
	defer glog.Infof("Shutting down endpoint controller")

	if !controller.WaitForCacheSync("endpoint", stopCh, e.podsSynced, e.servicesSynced, e.endpointsSynced) {
		return
	}

	// workers = --concurrent-endpoint-syncs's value (default 5)
	for i := 0; i < workers; i++ {
		// workerLoopPeriod = 1s
		go wait.Until(e.worker, e.workerLoopPeriod, stopCh)
	}

	go func() {
		defer utilruntime.HandleCrash()
		e.checkLeftoverEndpoints()
	}()

	<-stopCh
}

checkLeftoverEndpoints

checkLeftoverEndpoints負責List所有當前集群中的endpoints并將它們對應的services添加到queue中，由workers進行syncService同步。

這是為了防止在controller-manager發生重啟時時，用戶刪除了某些Services或者某些Endpoints還沒刪除干凈，Endpoints Controller沒有處理的情況下，在Endpoints Controller再次啟動時能通過checkLeftoverEndpoints檢測到那些孤立的endpionts（沒有對應services），將虛構的Services重新加入到隊列進行syncService操作，從而完成這些孤立endpoint的清理工作。

上面提到的虛構Services其實是把Endpoints的Key(namespace/name)作為Services的Key，因此這就是為什么要求Endpiont和Service的名字要一致的原因之一。

func (e *EndpointController) checkLeftoverEndpoints() {
	list, err := e.endpointsLister.List(labels.Everything())
	if err != nil {
		utilruntime.HandleError(fmt.Errorf("Unable to list endpoints (%v); orphaned endpoints will not be cleaned up. (They're pretty harmless, but you can restart this component if you want another attempt made.)", err))
		return
	}
	for _, ep := range list {
		if _, ok := ep.Annotations[resourcelock.LeaderElectionRecordAnnotationKey]; ok {
			// when there are multiple controller-manager instances,
			// we observe that it will delete leader-election endpoints after 5min
			// and cause re-election
			// so skip the delete here
			// as leader-election only have endpoints without service
			continue
		}
		key, err := keyFunc(ep)
		if err != nil {
			utilruntime.HandleError(fmt.Errorf("Unable to get key for endpoint %#v", ep))
			continue
		}
		e.queue.Add(key)
	}
}

另外，還需要注意一點，對于kube-controller-manager多實例HA部署時，各個contorller-manager endpoints是沒有對應service的，這種情況下，我們不能把虛構的Service加入到隊列觸發這些“理應孤立”的endpoints被清理，因此我們給這些“理應孤立”的endpoints加上Annotation "control-plane.alpha.kubernetes.io/leader"以做跳過處理。

Endpoint Contoller的核心邏輯syncService

Service的Add/Update/Delete Event Handler都是將Service Key加入到Queue中，等待worker進行syncService處理：

1. 根據queue中得到的service key(namespace/name)去indexer中獲取對應的Service Object，如果沒獲取到，則調api刪除同Key（namespace/name）的Endpoints Object進行清理工作，這對應到checkLeftoverEndpoints中描述到的那些孤立endpoints清理工作。

2. 因為Service是通過LabelSelector進行Pod匹配，將匹配的Pods構建對應的Endpoints Subsets加入到Endpoints中，因此這里會先過濾掉那些沒有LabelSelector的Services。

3. 然后用Service的LabelSelector獲取同namespace下的所有Pods。

4. 檢查service.Spec.PublishNotReadyAddresses是否為true，或者Service Annotations "service.alpha.kubernetes.io/tolerate-unready-endpoints"是否為true(/t/T/True/TRUE/1)，如果為true，則表示tolerate Unready Endpoints，即Unready的Pods信息也會被加入該Service對應的Endpoints中。

   注意，Annotations "service.alpha.kubernetes.io/tolerate-unready-endpoints"在Kubernetes 1.13中將被棄用，后續只使用.Spec.PublishNotReadyAddresses Field。

5. 接下來就是遍歷前面獲取到的Pods，用各個Pod的IP、ContainerPorts、HostName及Service的Port去構建Endpoints的Subsets，注意如下特殊處理：

   4）當tolerate Unready Endpoints為true(即使Pod not Ready)或者Pod isReady時，Pod對應的EndpointAddress也會被加入到(Ready)Addresses中。

   5）tolerate Unready Endpoints為false且Pod isNotReady情況下：

    - 當pod.Spec.RestartPolicy為Never，Pod Status.Phase為非結束狀態(非Failed/Successed)時，Pod對應的EndpointAddress也會被加入到NotReadyAddresses中。
    - 當pod.Spec.RestartPolicy為OnFailure, Pod Status.Phase為非Successed時，Pod對應的EndpointAddress也會被加入到NotReadyAddresses中。
    - 其他情況下，Pod對應的EndpointAddress也會被加入到NotReadyAddresses中。

   
   

1. 跳過沒有pod.Status.PodIP為空的pod；

2. 當tolerate Unready Endpoints為false時，跳過那些被標記刪除(DeletionTimestamp != nil)的Pods;

3. 對于Headless Service，因為沒有Service Port，因此構建EndpointSubset時對應的Ports內容為空；

6. 從indexer中獲取service對應的Endpoints Object(currentEndpoints)，如果從indexer中沒有返回對應的Endpoints Object，則構建一個與該Service同名、同Labels的Endpoints對象(newEndpoints)。

7. 如果currentEndpoints的ResourceVersion不為空，則對比currentEndpoints.Subsets、Labels與前面構建的Subsets、Service.Labels是否DeepEqual，如果是則說明不需要update，流程結束。

8. 否則，就像currentEndpoints DeepCopy給newEndpoints,并用前面構建的Subsets和Services.Labels替換newEndpoints中對應內容。

9. 如果currentEndpoints的ResourceVersion為空，則調用Create API去創建上一步的newEndpoints Object。如果currentEndpoints的ResourceVersion不為空，表示已經存在對應的Endpoints，則調用Update API用newEndpoints去更新該Endpoints。

10. 流程結束。

Pod Event Hanlder

Add Pod

1. 通過Services LabeleSelector與Pod Labels進行匹配的方法，將該Pod能匹配上的所有Services都找出來，然后將它們的Key(namespace/name)都加入到queue等待sync。

// When a pod is added, figure out what services it will be a member of and
// enqueue them. obj must have *v1.Pod type.
func (e *EndpointController) addPod(obj interface{}) {
	pod := obj.(*v1.Pod)
	services, err := e.getPodServiceMemberships(pod)
	if err != nil {
		utilruntime.HandleError(fmt.Errorf("Unable to get pod %s/%s's service memberships: %v", pod.Namespace, pod.Name, err))
		return
	}
	for key := range services {
		e.queue.Add(key)
	}
}

Update Pod

• 如果newPod.ResourceVersion等于oldPod.ResourceVersion，則跳過，不進行任何update。

• 檢查新老Pod的DeletionTimestamp、Ready Condition以及由PodIP,Hostname等建構的EndpointAddress是否發生變更，只要其中之一發生變更，podChangedFlag就為true。

• 檢查新老Pod Spec的Labels、HostName、Subdomain是否發生變更，只要其中之一發生變更，labelChangedFlag就為true。

• 如果podChangedFlag和labelChangedFlag都為false，則跳過，不做任何update。

• 通過Services LabeleSelector與Pod Labels進行匹配的方法，將newPod能匹配上的所有Services都找出來(services記錄)，如果labelChangedFlag為true，則根據LabelSelector匹配找出oldPod對應的oldServices:

  互相差值進行union集合的含義：services.Difference(oldServices).Union(oldServices.Difference(services))

• 如果podChangedFlag為true,則將services和oldServices進行union集合，將集合內的所有Services Key都加入到queue中等待sync；

• 如果podChangedFlag為false，則將services和oldServices的互相差值進行union集合，將集合內的所有Services Key都加入到queue中等待sync；

Delete Pod

• 如果該pod還是個完整記錄的pod，則跟addPod邏輯一樣：通過Services LabeleSelector與Pod Labels進行匹配的方法，將該Pod能匹配上的所有Services都找出來，然后將它們的Key(namespace/name)都加入到queue等待sync。

• 如果該pod是tombstone object(final state is unrecorded)，則將其轉換成v1.pod后，再調用addPod。相比正常的Pod，就是多了一步：從tombstone到v1.pod的轉換。

// When a pod is deleted, enqueue the services the pod used to be a member of.
// obj could be an *v1.Pod, or a DeletionFinalStateUnknown marker item.
func (e *EndpointController) deletePod(obj interface{}) {
	if _, ok := obj.(*v1.Pod); ok {
		// Enqueue all the services that the pod used to be a member
		// of. This happens to be exactly the same thing we do when a
		// pod is added.
		e.addPod(obj)
		return
	}
	// If we reached here it means the pod was deleted but its final state is unrecorded.
	tombstone, ok := obj.(cache.DeletedFinalStateUnknown)
	if !ok {
		utilruntime.HandleError(fmt.Errorf("Couldn't get object from tombstone %#v", obj))
		return
	}
	pod, ok := tombstone.Obj.(*v1.Pod)
	if !ok {
		utilruntime.HandleError(fmt.Errorf("Tombstone contained object that is not a Pod: %#v", obj))
		return
	}
	glog.V(4).Infof("Enqueuing services of deleted pod %s/%s having final state unrecorded", pod.Namespace, pod.Name)
	e.addPod(pod)
}

核心Struct

里面有幾個struct，挺容易混淆的，簡單用圖表示下，方便比對：

總結

通過對Endpoints Controller的源碼分析，我們了解了其中很多細節，比如對Service和Pod事件處理邏輯、對孤立Pod的處理方法、Pod Labels變更帶來的影響等等，這對我們通過Watch Endpoints去寫自己的Ingress組件對接公司內部的路由組件時是有幫助的。

“Kubernetes Endpoints Controller的源碼解析”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識可以關注億速云網站，小編將為大家輸出更多高質量的實用文章！