client-go源码分析(3):Indexer, cache, threadSafeMap

前言

本文聚焦client-go v11.0.0 controller框架Indexer对象,分析源码indexer的实现。关于client-go的介绍已有优秀文章,可参考第一篇参考文档,本文不再赘述。

1 cache - indexer对象关系

golang的struct和interface之间是弱耦合关系,即struct只需要实现了某个interface的所有方法,就认为该struct实现了该interface。cache和Store对象关系如下:

cache UML组件图

从类的实现、组合关系上可见,cache实现了Store interface和Index interface的所有方法,因此cache可以赋值给Store和Index接口。理解threadSafeMap的实现能帮助我们理解cache。

2 理解threadSafeMap的实现

几个内部索引对象及其关系

type IndexFunc func(obj interface) ([]string, error)

type Indexers map[string]indexFunc

type Index map[string]sets.String

type indices map[string]Index

从上述几个对象的命名和关系看,很难理解几个对象的依赖关系。我们首先梳理几个对象之间的关系,其次分析一个pod对象的增、删、改时,几个索引对象的状态迁移如何发生。

2.1 threadSafeMap内部对象关系

threadSafeMap内部对象关系示意图

Items:

Items类型map[string] interface{},用来存储runtime.object,map的key(对象键)用函数MetaNamespaceKeyFunc生成,value是runtime.object本身。

Indexers:

indexers类型是map[string]indexFunc,用来存储indexFunc(索引键计算函数),map的key是indexFuncName,value是indexFunc。注意两个要点:1. 区别对象键和索引键;2. {indexName: indexFunc}是外部调用者传入,调用关系参考k8s源码: kubernetes-master\pkg\client\informers\informers_generated\internalversion\extensions\internalversion\deployment.go:

cache.MetaNamespaceIndexFunc函数调用

cache.MetaNamespaceIndexFunc函数注释:

// MetaNamespaceIndexFunc is a default index function that indexes based on an object's namespace.

Indices:

Indices类型map[string]Index。indices是对象快速索引表,map的key是indexName,value是Index对象,即map[string]sets.String。

Index:

Index类型map[string]sets.String。Index map的key是indexFunc计算的值,如MetaNamespaceIndexFunc返回的是namespace,如果使用indexByPodNodeName(源码:kubernetes-master\pkg\controller\daemon\daemon_controller.go)那么返回nodename。

indexSet:

IndexSet是笔者自己取的名字。IndexSet是set.String类型,值是对象键objkey。

到此为止,相信细心的读者可能会发现,threadSafeMap做了两件事:

1)存储:保存k8s runtime.object到items map。

2)索引:为items map的每个对象建立三层索引:第一层是indices map的类别索引,如按'namespace', 'nodeName'索引;第二层是index map的详细类别索引,如'namespace1','namespace2'… 或者'nodeName1','nodeName2'……;第三层是indexSet的对象键。第三层索引才真正索引到runtime.object。

2.2 threadSafeMap关键实现分析

以两个典型的方法func (c *threadSafeMap) updateIndices(oldObj interface{}, newObj interface{}, key string)和func (c *threadSafeMap) deleteFromIndices(obj interface{}, key string)为例分析threadSafeMap内部对象的状态迁移过程。

deleteFromIndices实现

deleteFromIndices被Delete,updateIndices等函数调用,它的功能是删除indices的某个索引。deleteFromIndices函数执行步骤如下:

1)遍历indexFunc map c.indexers获取第一层索引indices的类别name,并计算第二层索引index的详细索引类别indexValue;

2)遍历第二层索引表index,依次删除第三层索引表indexSet的对象键。

updateIndices实现

updateIndices函数被Add,Update,Replace等函数调用。updateIndices执行步骤如下:

1)updateIndices函数首先删除oldObj的索引键;

2)遍历indexFunc map c.indexers,获取第一层索引indices的索引类别name,并计算第二层索引Index的详细索引类别indexValues(数组);

3)遍历第二层索引Index,依次执行:若第三层索引IndexSet为空则添加一个空set;若非空则添加对象键到第三层索引IndexSet。

3 结语

到此为止threadSafeMap的机制基本分析清楚,cache无非threadSafeMap的封装和扩展,核心机制是一样的,就不再细说 。

4 参考文档

https://www.jianshu.com/p/d17f70369c35

https://blog.csdn.net/weixin_42663840/article/details/81530606

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