带你读《云原生应用开发 Operator原理与实践》第三章 Kubebuilder 原理3.3 Controller-runtime 模块分析(四)

2. 创建

pkg/manager/internal.go中的 controllerManager对象实现了 Manager接口,可以通过manager.New()方法新建(见代码清单3-26

...

mgr,err:=manager.New(cfg,manager.Options{})iferr!=nil{

log.Error(err,"unabletosetupmanager")os.Exit(1)

}

...

 

其中,方法的第一个参数为 rest.Config对象,定义了如何访问Kube-APIServer ;第二个参数为 manager.Options对象,用于配置 Manager,主要包括以下内容。


 

(3)  Scheme结构。一般先通过k8s.io/apimachinery/pkg/runtime中的 NewScheme()方法获取Kubernetes的Scheme,然后再将CRD注册到Scheme中(见代码清单3-27)。

...

varscheme=runtime.NewScheme()

 

funcinit(){crd1.AddToScheme(scheme)crd2.AddToScheme(scheme)

...

}


...

 

(2)  MapperProvider是一个函数对象,其定义为 func(c*rest.Config)(meta.REST- Mapper,error),用于定义 Manager如何获取RESTMapper。默认通过 k8s.io/client-go中的 DiscoveryClient请求获取Kube-APIServer。

(3)  Logger用于定义 Manager的日志输出对象,默认使用 pkg/internal/log包下的全局参数 RuntimeLog。

(4)  SyncPeriod参数用于指定 Informer 重新同步并处理资源的时间间隔,默认为10小时。此参数也决定了Controller重新同步的时间间隔,每个 Controller的时间间隔以此参数为基准有10% 的抖动,以避免多个 Controller同时进行重新同步。

(5)   LeaderElection、LeaderElectionResourceLock、LeaderElectionNamespace、LeaderElectionID等用于开启和配置 Manager的选举。其中,LeaderElectionResource-Lock配置选举锁的类型可以为 Leases、Configmapsleases、Endpointsleases等, 默认为Configmapslease。LeaderElectionNamespace、LeaderElectionID用于配置锁资源的Namespace和Name(见代码清单3-28)。


LeaderElectionboolLeaderElectionResourceLockstringLeaderElectionNamespacestringLeaderElectionIDstring

//访问选举锁所在的APIServer的配置

LeaderElectionConfig*rest.Config



//当设置为True时,Manager结束前会主动释放选举锁,否则需要等到选举任期结束

//才能进⾏新的选举。此选项可以加快重新选举的速度

LeaderElectionReleaseOnCancelbool

 

//候选⼈强制获取 Leader的时间,相当于⼀个选举任期,默认为 15sLeaseDuration*time.Duration

//当选 Leader后,刷新选举信息的间隔,其需要⼩于 LeaseDuration,默认为 10sRenewDeadline*time.Duration

//候选⼈尝试竞选的时间间隔默认为 2sRetryPeriod*time.Duration

 

(6)  Namespace参数用于限制 Manager.Cache只监听指定 Namespace的资源,默认情况下无限制。

(7)  NewCache参数的类型为 cache.NewCacheFunc,Manager会调用此参数创建Cache,因此,可以用于自定义 Manager使用的 Cache。在默认情况下,Manager使用InformersMap对象实现 Cache接口,InformersMap接口的实现在 pkg/cache/internal/deleg_map.go中(见代码清单3-29)。

typeNewCacheFuncfunc(config*rest.Config,optsOptions)(Cache,error)

 

(8)  ClusterBuilder参数的类型为 ClientBuilder接口,Manager会调用此接口创建 Client,即 Manager.GetClient()返回的 Client。在默认情况下,Manager使用pkg/cluster下的 newClientBuilder对象创建 Client。

(9)  ClientDisableCacheFor参数用于配置 Client,指定某些资源对象的操作不使用缓存,而是直接操作 Kube-APIServer。

(10)   EventBroadcaster参数用于提供 Manager,以获取 EventRecorder,当前已不推荐使用,因为当Manager或Controller的生命周期短于EventBroadcaster的生命周期时,可能会导致 goroutine泄露。

2. 实现ControllerManager对象是 Manager的实现,其结构成员中部分成员是直接通过manager.Options传入的,或是通过 manager.Options传入的方法创建的,另外一些主要的成员如下。

(1)cluster.Cluster接口类型成员Cluster:提供 Manager接口中的匿名成员 cluster.

Cluster 的实现。

(2)[]Runnable类型成员 leaderElectionRunnables与 nonLeaderElectionRunnables:两者存储了所有注册到Manager中的 Controller、WebHookServer 以及自定义对象,按照是否需要遵循选举机制 []Runnable 类型成员分为两类,nonLeaderElectionRunnables中的 Runnable,在调用 Manager.Start()方法后会立即启动。

(3)   metricsListener和 healthProbeListener:类型都为 net.Listener,前者是Prometheus监控服务的监听对象,后者是健康检查服务的监听对象。

(4)   WebHookServer:WebHook的服务对象, 在Manager.GetWebhookServer()方法被调用时,进行创建并返回。

(5)   startCache:是函数对象,类型为 func(ctxcontext.Context)error,用于启动缓存的同步。 在启动 leaderElectionRunnables和 nonLeaderElectionRunnables之前,Manager会先调用此方法启动缓存同步,并等待同步完成,启动 Runnable。在实现上,startCache实际上是 cluster.Cluster.Start()方法。

上一篇:jquery 联级菜单


下一篇:带你读《云原生应用开发 Operator原理与实践》第三章 Kubebuilder 原理3.3 Controller-runtime 模块分析(四)