kubernetes1.9源码阅读 List-Watch及Reflector机制

List-Watch是kubernetes的核心机制。组件kubelet、kube-controller-manager、kube-scheduler需要监控各种资源(pod、service等)的变化,当这些对象发生变化时(add、delete、update),kube-apiserver会主动通知这些组件。这个过程类似一个发布-订阅系统。本文章将从代码角度探究一下list-watch的实现方式。

源码分析是kubernetes tag v1.9.0

第一部分:kube-apiserver对etcd的List-watch机制

构建PodStorage

pkg/registry/core/pod/storage.go
NewStorage方法

1. kube-apiserver针对每一类资源(pod、service、endpoint、replication controller、depolyments)都会构建Storage对象,如:PodStorage;
2. PodStorage.Pod.Store封装了对etcd的操作;
3. store.CompleteWithOptions会调用etcdOptions.GetRESTOptions,此方法将
调用generic.UndecoratedStorage创建无cache的Store;
或者调用genericregistry.StorageWithCacher创建带Cache的Store;

StorageWithCacher

staging/src/k8s.io/apiserver/pkg/registry/generic/registry/storage_factory.go 
StorageWithCacher方法

1. 调用NewRawStorage,它将构建etcdHelper,etcdHelper实现Storage.Interface接口,封装了对etcd的操作;
2. 调用NewCacherFromConfig,将创建Cacher对象;

创建Cacher

staging/src/k8s.io/apiserver/pkg/storage/cacher.go
NewCacherFromConfig方法

1. 首先,创建watchCache对象和cacheListerWatcher对象,cacheListWatcher对象是ListerWatcher接口实现,实现了List()和Watch()方法;
2. 构建Cacher对象,主要的数据成员:watchCache、reflector、watchers及incoming channel;
(1) watchCache是一个cache,用来存储apiserver从etcd那里watch到的对象;
(2) watchers是一个map,map的值类型为cacheWatcher,当kubelet、kube-scheduler需要watch某类资源时,他们会向kube-apiserver发起watch请求,kube-apiserver就会生成一个cacheWatcher,cacheWatcher负责将watch的资源通过http从apiserver传递到kubelet、kube-scheduler;
(3) Reflector对象,主要数据成员:ListerWatcher,ListerWatcher是接口对象,包括方法List()和Watch();listerWatcher包装了Storage,主要是将watch到的对象存到watchCache中;
(4) incoming channel接收watchCacheEvent;
3. 协程调用cacher.dispatchEvents,watchCache将incoming channel接收watchCacheEvent添加到watchers的inputChan中;
4. 协程调用cacher.startCaching;

StartCaching

staging/src/k8s.io/client-go/tools/cache/reflector.go
ListAndWatch方法

1 执行cacheListerWatcher的List方法和Watch方法;
2 调用reflector的watchHandler方法;

cacheListWatcher.List/cacheListWatcher.Watch

staging/src/k8s.io/apiserver/pkg/storage/cacher.go
List方法和Watch方法

1 List方法将调用storage.List方法,这里是etcdHelper.List方法;
2 Watch方法将调用storage.watch方法,这里是etcdHelper.WatchList方法;

etcdHelper.List/etcdHelper.Watch

staging/src/k8s.io/apiserver/pkg/storage/etcd/etcd_helper.go
List方法/WatchList方法

1. etcdHelper对象是Storage接口对象的实现;
2. etcdHelper的List方法:
(1) 获取etcd的对象(包括resourceVersion信息);
3. etcdHelper的WatchList方法:
(1) 创建etcdWatcher;
(2) etcdWatcher对象,实现了Watch接口;
(3) etcdWatcher对象,主要的数据成员是etcdIncoming channel和outgoing channel;
(4) 协程执行etcdWatcher.translate;
(5) 最后,协程运行etcdWatcher.etcdWatch;

etcdWatcher.etcdWatch

staging/src/k8s.io/apiserver/pkg/storage/etcd/etcd_watcher.go
etcdWatch方法

1. 如果resourceVersion==0, 运行etcdGetInitialWatchState(),获取所有的pods,并将结果输入到etcdIncoming channel;
2. 之后,不停的调用watcher.Next(),并将结果输入到etcdIncoming channel;

etcdWatcher.translate

staging/src/k8s.io/apiserver/pkg/storage/etcd/etcd_watcher.go
translate方法

1. 读取etcdIncoming channel信息;
2. 调用etcdWatcher.sendResult进行转化;
3. 发送到outgoing channel;

reflector.watchHandler

staging/src/k8s.io/client-go/tools/cache/reflector.go
watchHandler方法

1. 读取outgoing channel信息,操作watchCache;

操作watchCache

staging/src/k8s.io/apiserver/pkg/storage/watch_cache.go
Add方法
Delete方法
Get方法
Update方法

处理事件watchCache.processEvent

staging/src/k8s.io/apiserver/pkg/storage/watch_cache.go
processEvent方法

1. 创建watchCacheEvent
2. 调用watchCache.updateCache,更新watchCache;

到此分析完kube-apiserver对etcd的watch机制,除此之外,kube-apiserver会向其他组件提供watch接口,下面将分析kube-apiserver的watch API。

第二部分:kube-apiserver的watch restful API

kube-apiserver提供watch restful API给其他组件(kubelet、kube-controller-manager、kube-scheduler、kube-proxy)。watch restful API的处理流程和PUT、DELETE、GET等REST API处理流程类似。

registerResourceHandlers

staging/src/k8s.io/apiserver/pkg/endpoints/installer.go
registerResourceHandlers方法

ListResource

staging/src/k8s.io/apiserver/pkg/endpoints/handlers/get.go
ListResource方法

1.调用rw.watch方法,这里将会调用Store.watch;
2.调用serveWatch方法;

Store.watch

staging/src/k8s.io/apiserver/pkg/registry/generic/registry/store.go
watch方法和watchPredicate方法

1. 调用Storage.Watch方法和Storage.WatchList方法,这里将调用Cacher.watch方法和Cacher.WatchList方法

Cacher.watch

staging/src/k8s.io/apiserver/pkg/storage/cacher.go
watch方法和watchList方法

1. watch方法中将调用newCacheWatcher;
2. newCacheWatcher方法:
(1) 生成一个watcher,并将watcher插入到cacher.watchers中;
(2) 协程调用cacheWatcher.process方法,此方法将会操作input channel的消息;

操作input channel

staging/src/k8s.io/apiserver/pkg/storage/cacher.go
cacheWatcher.process方法

1. 读取input channel的信息,并调用sendWatchCacheEvent方法;

sendWatchCacheEvent

staging/src/k8s.io/apiserver/pkg/storage/cacher.go
cacheWatcher.sendWatchCacheEvent方法

1. kube-apiserver的watch会带过滤功能;
2. 对watchCacheEvent进行Filter,发送到cacher.result channel中;

serveWatch

apiserver/pkg/endpoints/handlers/rest.go
serveWatch方法

1. 对result Channel信息进行序列化,并发送给调用者;

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,793评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,567评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,342评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,825评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,814评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,680评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,033评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,687评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,175评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,668评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,775评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,419评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,020评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,206评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,092评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,510评论 2 343

推荐阅读更多精彩内容

  • 很长时间没有写文章,一直在啃kubernetes文档,本来立志一定要读完所有的文档。还有它的最佳实践openshi...
    范彬2017阅读 639评论 0 1
  • from http://www.infoq.com/cn/articles/etcd-interpretation...
    小树苗苗阅读 13,939评论 3 38
  • docker实现了更便捷的单机容器虚拟化的管理, docker的位置处于操作系统层与应用层之间; 相对传统虚拟化(...
    Harvey_L阅读 19,888评论 3 44
  • 我家换了新的练字方法 用毛笔练字,墨水变白开水了。 一下白开水干了,练的字也没有了。看看吧
    基__250303阅读 213评论 0 0
  • 前几天,微信群收到朋友发来的一张图片——新郎被其他人用透明胶捆在公路的电线杆上,我当时第一个表态,要是我遇到这种情...
    越过坎阅读 1,283评论 1 0