當前位置：首頁 > 运维知识 > windows >内容正文

windows

Kubernetes: client-go 源码剖析（一）

發布時間：2023/12/24 windows 34 coder

生活随笔收集整理的這篇文章主要介紹了 Kubernetes: client-go 源码剖析（一）小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

0. 前言

在看 kube-scheduler 組件的過程中遇到了 kube-scheduler 對于 client-go 的調用，泛泛的理解調用過程總有種隔靴搔癢的感覺，于是調轉頭先把 client-go 理清楚在回來看 kube-scheduler。

為什么要看 client-go，并且要深入到原理，源碼層面去看。很簡單，因為它很重要。重要在兩方面：

kubernetes 組件通過 client-go 和 kube-apiserver 交互。
client-go 簡單，易用，大部分基于 Kubernetes 做二次開發的應用，在和 kube-apiserver 交互時會使用 client-go。

當然，不僅在于使用，理解層面，對于我們學習代碼開發，架構等也有幫助。

1. client-go 客戶端對象

client-go 支持四種客戶端對象，分別是 RESTClient，ClientSet，DynamicClient 和 DiscoveryClient：

組件或者二次開發的應用可以通過這四種客戶端對象和 kube-apiserver 交互。其中，RESTClient 是最基礎的客戶端對象，它封裝了 HTTP Request，實現了 RESTful 風格的 API。ClientSet 基于 RESTClient，封裝了對于 Resource 和 Version 的請求方法。DynamicClient 相比于 ClientSet 提供了全資源，包括自定義資源的請求方法。DiscoveryClient 用于發現 kube-apiserver 支持的資源組，資源版本和資源信息。

每種客戶端適用的場景不同，主要是對 HTTP Request 做了層層封裝，具體的代碼實現可參考 client-go 客戶端對象。

2. informer 機制

僅僅封裝 HTTP Request 是不夠的，組件通過 client-go 和 kube-apiserver 交互，必然對實時性，可靠性等有很高要求。試想，如果 ETCD 中存儲的數據和組件通過 client-go 從 ETCD 獲取的數據不匹配的話，那將會是一個非常嚴重的問題。

如何實現 client-go 的實時性，可靠性？client-go 給出的答案是：informer 機制。

? ? ? ? ? ? ? ? client-go informer 流程圖

informer 機制的核心組件包括：

Reflector: 主要負責兩類任務：
1. 通過 client-go 客戶端對象 list kube-apiserver 資源，并且 watch kube-apiserver 資源變更。
2. 作為生產者，將獲取的資源放入 Delta FIFO 隊列。
Informer: 主要負責三類任務：
1. 作為消費者，將 Reflector 放入隊列的資源拿出來。
2. 將資源交給 indexer 組件。
3. 交給 indexer 組件之后觸發回調函數，處理回調事件。
Indexer: indexer 組件負責將資源信息存入到本地內存數據庫（實際是 map 對象），該數據庫作為緩存存在，其資源信息和 ETCD 中的資源信息完全一致（得益于 watch 機制）。因此，client-go 可以從本地 indexer 中讀取相應的資源，而不用每次都從 kube-apiserver 中獲取資源信息。這也實現了 client-go 對于實時性的要求。

接下來從源碼角度看各個組件的處理流程，力圖做到知其然，知其所以然。

2 informer 源碼分析

直接閱讀 informer 源碼是非常晦澀難懂的，這里通過 informer 的代碼示例開始學習：

package main

import (
	"log"
	"time"

	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/client-go/informers"
	"k8s.io/client-go/kubernetes"
	"k8s.io/client-go/tools/cache"
	"k8s.io/client-go/tools/clientcmd"
)

func main() {
    // 解析 kubeconfig
	config, err := clientcmd.BuildConfigFromFlags("", "/root/.kube/config")
	if err != nil {
		panic(err)
	}

    // 創建 ClientSet 客戶端對象
	clientset, err := kubernetes.NewForConfig(config)
	if err != nil {
		panic(err)
	}

	stopCh := make(chan struct{})
	defer close(stopCh)

    // 創建 sharedInformers
	sharedInformers := informers.NewSharedInformerFactory(clientset, time.Minute)
    // 創建 informer
	informer := sharedInformers.Core().V1().Pods().Informer()

    // 創建 Event 回調 handler
	informer.AddEventHandler(cache.ResourceEventHandlerFuncs{
		AddFunc: func(obj interface{}) {
			mObj := obj.(v1.Object)
			log.Printf("New Pod Added to Store: %s", mObj.GetName())
		},
		UpdateFunc: func(oldObj, newObj interface{}) {
			oObj := oldObj.(v1.Object)
			nObj := newObj.(v1.Object)
			log.Printf("%s Pod Updated to %s", oObj.GetName(), nObj.GetName())
		},
		DeleteFunc: func(obj interface{}) {
			mObj := obj.(v1.Object)
			log.Printf("Pod Deleted from Store: %s", mObj.GetName())
		},
	})

    // 運行 informer
	informer.Run(stopCh)
}

執行結果如下：

# go run informer.go 
2023/12/14 12:00:26 New Pod Added to Store: prometheus-alertmanager-0
2023/12/14 12:01:26 prometheus-alertmanager-0 Pod Updated to prometheus-alertmanager-0

上述代碼示例分為三部分：創建 informer，創建 informer 的 EventHandler，運行 informer。下面，通過這三部分流程介紹 client-go 的核心組件。

2.1 創建 `informer`

創建 informer 分為兩步。

1）創建工廠 sharedInformerFactory

// sharedInformers factory 
sharedInformers := informers.NewSharedInformerFactory(clientset, time.Minute)

// client-go/informers/factory.go
func NewSharedInformerFactory(client kubernetes.Interface, defaultResync time.Duration) SharedInformerFactory {
	return NewSharedInformerFactoryWithOptions(client, defaultResync)
}

func NewSharedInformerFactoryWithOptions(client kubernetes.Interface, defaultResync time.Duration, options ...SharedInformerOption) SharedInformerFactory {
	factory := &sharedInformerFactory{
		client:           client,
		namespace:        v1.NamespaceAll,
		defaultResync:    defaultResync,
		informers:        make(map[reflect.Type]cache.SharedIndexInformer),
		startedInformers: make(map[reflect.Type]bool),
		customResync:     make(map[reflect.Type]time.Duration),
	}

	// Apply all options
	for _, opt := range options {
		factory = opt(factory)
	}

	return factory
}

sharedInformerFactory 實現了 SharedInformerFactory 接口，該工廠負責創建 informer。

2）創建 informer

// 創建 informer
informer := sharedInformers.Core().V1().Pods().Informer()

// 調用 Core 方法
func (f *sharedInformerFactory) Core() core.Interface {
	return core.New(f, f.namespace, f.tweakListOptions)
}

func New(f internalinterfaces.SharedInformerFactory, namespace string, tweakListOptions internalinterfaces.TweakListOptionsFunc) Interface {
	return &group{factory: f, namespace: namespace, tweakListOptions: tweakListOptions}
}

// 調用 V1 方法
func (g *group) V1() v1.Interface {
	return v1.New(g.factory, g.namespace, g.tweakListOptions)
}

func New(f internalinterfaces.SharedInformerFactory, namespace string, tweakListOptions internalinterfaces.TweakListOptionsFunc) Interface {
	return &version{factory: f, namespace: namespace, tweakListOptions: tweakListOptions}
}

// 調用 Pods 方法
func (v *version) Pods() PodInformer {
	return &podInformer{factory: v.factory, namespace: v.namespace, tweakListOptions: v.tweakListOptions}
}

經過層層構建創建 podInformer 對象，該對象實現了 PodInformer 接口，調用接口的 Informer 方法創建 informer 對象：

func (f *podInformer) Informer() cache.SharedIndexInformer {
	return f.factory.InformerFor(&corev1.Pod{}, f.defaultInformer)
}

podInformer.Informer 實際調用的是 sharedInformerFactory.InformerFor：

func (f *sharedInformerFactory) InformerFor(obj runtime.Object, newFunc internalinterfaces.NewInformerFunc) cache.SharedIndexInformer {
	f.lock.Lock()
	defer f.lock.Unlock()

    // 反射出資源對象 obj 的 type 
	informerType := reflect.TypeOf(obj)

    // 讀取并判斷資源對象的 informer
	informer, exists := f.informers[informerType]
	if exists {
		return informer
	}

	...

    // 調用 newFunc 創建 informer
	informer = newFunc(f.client, resyncPeriod)

    // 將 type:informer 加入到 factory 的 informers 中
	f.informers[informerType] = informer

	return informer
}

從 InformerFor 方法可以看出，sharedInformerFactory 的 share 體現在同一個資源類型共享 informer。

這么設計在于，每個 informer 包括一個 Reflector，Reflector 通過訪問 kube-apiserver 實現 ListAndWatch 操作。共享 informer 實際是共享 Reflector，這種共享機制將減少 Reflector 對于 kube-apiserver 的訪問，降低 kube-apiserver 的負載，節約資源。

繼續看，創建 informer 的 newFunc 函數做了什么：

informer = newFunc(f.client, resyncPeriod)

// client-go/informers/core/v1/pod.go
func (f *podInformer) defaultInformer(client kubernetes.Interface, resyncPeriod time.Duration) cache.SharedIndexInformer {
	return NewFilteredPodInformer(client, f.namespace, resyncPeriod, cache.Indexers{cache.NamespaceIndex: cache.MetaNamespaceIndexFunc}, f.tweakListOptions)
}

func NewFilteredPodInformer(client kubernetes.Interface, namespace string, resyncPeriod time.Duration, indexers cache.Indexers, tweakListOptions internalinterfaces.TweakListOptionsFunc) cache.SharedIndexInformer {
	return cache.NewSharedIndexInformer(
		&cache.ListWatch{
			ListFunc: func(options metav1.ListOptions) (runtime.Object, error) {
				if tweakListOptions != nil {
					tweakListOptions(&options)
				}
				return client.CoreV1().Pods(namespace).List(context.TODO(), options)
			},
			WatchFunc: func(options metav1.ListOptions) (watch.Interface, error) {
				if tweakListOptions != nil {
					tweakListOptions(&options)
				}
				return client.CoreV1().Pods(namespace).Watch(context.TODO(), options)
			},
		},
		&corev1.Pod{},
		resyncPeriod,
		indexers,
	)
}

newFunc 實際調用的是 NewFilteredPodInformer 函數，在函數內創建 cache.ListAndWatch 對象，對象中包括 ListFunc 和 WatchFunc 回調函數，回調函數內調用 ClientSet 實現 list 和 watch 資源對象。

繼續看 cache.NewSharedIndexInformer：

// client-go/tools/cache/shared_informer.go
func NewSharedIndexInformer(lw ListerWatcher, exampleObject runtime.Object, defaultEventHandlerResyncPeriod time.Duration, indexers Indexers) SharedIndexInformer {
	return NewSharedIndexInformerWithOptions(
		lw,
		exampleObject,
		SharedIndexInformerOptions{
			ResyncPeriod: defaultEventHandlerResyncPeriod,
			Indexers:     indexers,
		},
	)
}

func NewSharedIndexInformerWithOptions(lw ListerWatcher, exampleObject runtime.Object, options SharedIndexInformerOptions) SharedIndexInformer {
	realClock := &clock.RealClock{}

	return &sharedIndexInformer{
		indexer:                         NewIndexer(DeletionHandlingMetaNamespaceKeyFunc, options.Indexers),
		processor:                       &sharedProcessor{clock: realClock},
		listerWatcher:                   lw,
		objectType:                      exampleObject,
		objectDescription:               options.ObjectDescription,
		resyncCheckPeriod:               options.ResyncPeriod,
		defaultEventHandlerResyncPeriod: options.ResyncPeriod,
		clock:                           realClock,
		cacheMutationDetector:           NewCacheMutationDetector(fmt.Sprintf("%T", exampleObject)),
	}
}

在 NewSharedIndexInformerWithOptions 函數內創建 informer sharedIndexInformer。可以看到，sharedIndexInformer 內包括了 indexer 核心組件。

informer 創建完成。接下來為 informer 添加回調函數 EventHandler。

2.2 創建 `EventHandler`

代碼實現如下：

informer.AddEventHandler(cache.ResourceEventHandlerFuncs{
    AddFunc: func(obj interface{}) {
        mObj := obj.(v1.Object)
        log.Printf("New Pod Added to Store: %s", mObj.GetName())
    },
    UpdateFunc: func(oldObj, newObj interface{}) {
        oObj := oldObj.(v1.Object)
        nObj := newObj.(v1.Object)
        log.Printf("%s Pod Updated to %s", oObj.GetName(), nObj.GetName())
    },
    DeleteFunc: func(obj interface{}) {
        mObj := obj.(v1.Object)
        log.Printf("Pod Deleted from Store: %s", mObj.GetName())
    },
})

創建 EventHandler 的 handler 中包括三種回調函數：AddFunc，UpdateFunc 和 DeleteFunc，三種回調函數分別在資源有增加，變更，刪除時觸發。

在 sharedIndexInformer.AddEventHandler 內，將 handler 傳遞給 sharedIndexInformer.AddEventHandlerWithResyncPeriod 方法，該方法主要創建 listener 對象：

// client-go/tools/cache/shared_informer.go
func (s *sharedIndexInformer) AddEventHandler(handler ResourceEventHandler) (ResourceEventHandlerRegistration, error) {
	return s.AddEventHandlerWithResyncPeriod(handler, s.defaultEventHandlerResyncPeriod)
}

func (s *sharedIndexInformer) AddEventHandlerWithResyncPeriod(handler ResourceEventHandler, resyncPeriod time.Duration) (ResourceEventHandlerRegistration, error) {
    ...
	listener := newProcessListener(handler, resyncPeriod, determineResyncPeriod(resyncPeriod, s.resyncCheckPeriod), s.clock.Now(), initialBufferSize, s.HasSynced)

    if !s.started {
		return s.processor.addListener(listener), nil
	}
    ...
}

// client-go/tools/cache/shared_informer.go
func newProcessListener(handler ResourceEventHandler, requestedResyncPeriod, resyncPeriod time.Duration, now time.Time, bufferSize int, hasSynced func() bool) *processorListener {
	ret := &processorListener{
		nextCh:                make(chan interface{}),
		addCh:                 make(chan interface{}),
		handler:               handler,
		syncTracker:           &synctrack.SingleFileTracker{UpstreamHasSynced: hasSynced},
		pendingNotifications:  *buffer.NewRingGrowing(bufferSize),
		requestedResyncPeriod: requestedResyncPeriod,
		resyncPeriod:          resyncPeriod,
	}

	ret.determineNextResync(now)

	return ret
}

func (p *sharedProcessor) addListener(listener *processorListener) ResourceEventHandlerRegistration {
    ...

	p.listeners[listener] = true
    ...

	return listener
}

listener 對象包含通道 addCh 和 nextCh，以及 handler 等對象。最后將 listener 存入 sharedIndexInformer.sharedProcessor 中。

創建完 informer 的 EventHandler，接下來該運行 informer 了。

總結

以上是生活随笔為你收集整理的Kubernetes: client-go 源码剖析（一）的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。