K8S的client-go与informer机制

saltbo
client-go
informer

# 一、介绍

client-go 是一个包含 KubernetesAPI 的 SDK，它在整个 k8s 源码中发挥着不可或缺的作用。

# 二、KubernetesAPIs

# 2.1 规范

2.1.1 RESTful REST，即 Representational State Transfer 的缩写。这个词组可以翻译为"表现层状态转化"。

  1. 每一个 URI 代表一种资源；
  2. 客户端和服务器之间，传递这种资源的某种表现层；
  3. 客户端通过五个 HTTP 动词，对服务器端资源进行操作，实现"表现层状态转化"。 提问：注册登录场景的相关 API 如何用 RESTful 的方式设计？ 2.1.2 GVK(R)
apiVersion: apps/v1
kind: Deployment
metadata:
  name: httpbin
  namespace: default
spec:
  replicas: 1
....
  • apiVersion ≈ apiGroupVersion = Group/Version
  • GVK = Group Version Kind
  • GVR = Group Version Resources 提问：Resource 和 Kind 有什么区别？

    答：Resource 是一个对象，Kind 是一个对象的类型名称

提问：一个标准的 K8S 资源的 API 长什么样？

# 2.2 实战调用

2.2.1 跳过鉴权 因为本次分享的 API 只是个引子，我们就不讲鉴权了。kubectl 有个 proxy 的子命令可以实现在本地搭建一个具备 kubectl 同等权限的代理。这里我们通过这种方式跳过鉴权。 kubectl proxy --port=6443 2.2.2 几个例子

  • 获取当前版本信息
    • http://localhost:6443/version
  • 获取 APIServer 支持的所有 APIGroup
    • http://localhost:6443/apis
  • 获取全部命名空间的 Deployment 列表
    • http://localhost:6443/apis/apps/v1/deployments
  • 获取命名空间 default 下的 Deployment 列表
    • http://localhost:6443/apis/apps/v1/namespaces/default/deployments
  • 获取命名空间 default 下的一个 Deployment 对象
    • http://localhost:6443/apis/apps/v1/namespaces/default/deployments/httpbin
  • 获取 Pod 列表 - http://localhost:6443/api/v1/namespaces/default/pods 提问：获取 rollout 列表的接口是什么样 http://localhost:6443/apis/argoproj.io/v1alpha1/rollouts

# 三、client-go 源码

# 3.1 实战调用

https://github.com/kubernetes/client-go/tree/master/examples

# clientset
clientset.AppsV1().Deployments(apiv1.NamespaceDefault).Create(context.TODO(), deployment, metav1.CreateOptions{})

# dynamic
deploymentRes := schema.GroupVersionResource{*Group*: "apps", *Version*: "v1", *Resource*: "deployments"}
dynamicClient.Resource(deploymentRes).Namespace(namespace).Create(context.TODO(), deployment, metav1.CreateOptions{})

# restclient
c.client.Post().
   Namespace(c.ns).
   Resource("deployments").
   VersionedParams(&opts, scheme.*ParameterCodec*).
   Body(deployment).
   Do(ctx).
   Into(result)

# 3.2 Package 介绍

client-go 源码目录结构

  • discovery：用于发现 APIs 的相关资源
  • kubernetes(clientset)：基于 rest 封装的包含所有 k8s 内置资源的 client 集合
  • informers：基于 clientset 实现了一个资源缓存池，封装了所有资源的 list 和 get 操作
  • dynamic：基于 rest 实现了一个动态的 client，支持所有类型的资源进行操作
  • dynamic/dynamicinformer：为 dynamic 实现的 informer
  • tools/cache：informer 的底层实现
  • tools/watch：informer 的 watch 实现，使用它可以 watch 到 informer 的资源变化
  • transport：用作初始化一个 http 连接，AA 也是在这里完成的

# 3.3 核心 Package 走读

3.3.1 kubernetes(clientset) 3.3.2 dynamic 3.3.3 transport

# 3.4 Informer

informer 实际上是为 controller 服务的，所以这里我们先了解下 k8s 的 controller 的设计理念。 3.4.1 控制循环 控制论图解 Kubernetes 中的控制循环

通常，控制环路如下所示：

  1. 阅读资源的状态
  2. 更改群集或群集外部世界中对象的状态
  3. 通过 etcd 中的 API 服务器更新步骤 1 中的资源状态
  4. 重复循环；返回步骤 1。

提问：在控制循环中要求近乎实时的获取资源状态，如何实现？ 边沿触发与电平触发

提问：事件驱动如何保证不丢数据？ 这张图里展示了三种策略:

  1. edge-driven-only，错过了第二状态改变
  2. edge-triggered，不依赖事件的数据而是自行获取数据
  3. edge-triggered with resync，在上一个策略的基础上增加 resync

3.4.2 ListWatch list-watch，顾名思义由 list 和 watch 组成。list 调用资源的 list API 获取所有资源，watch 调用资源的 watch API 监听资源变更事件。 提问：如何实现 watch？

  • 方案 1：短轮训
  • 方案 2：长轮训
  • 方案 3：chunked 普通 HTTP 响应体
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 25
Mozilla Developer Network         ——> body 数据内容，大小为25字节

chunked 的 HTTP 响应体

HTTP/1.1 206 OK
Content-Type: text/plain
Transfer-Encoding: chunked
7                            ——> 第一个chunk块，大小为7字节
Mozilla                      ——> 第一个chunk块内容
9                            ——> 第二个chunk块，大小为9字节
Developer                    ——> 第二个chunk块内容
7                            ——> 第三个chunk块，大小为7字节
Network                      ——> 第三个chunk块内容
0                            ——> 标记性终止块，大小为0字节

普通 HTTP 请求响应处理 chunked 的 HTTP 请求处理 informer 中的 chunk 抓包观察 watch 机制 3.4.3 核心代码走读 Informer 组件：

  • Controller
  • Reflector：通过 Kubernetes Watch API 监听 resource 下的所有事件
  • Lister：用来被调用 List/Get 方法
  • Processor：记录并触发回调函数
  • DeltaFIFO
  • LocalStore

# 四、实现一个简单的 Controller

# 参考文档

  • 原文出处：
  • 原文作者： https://github.com/saltbo
  • 原文链接：
  • 版权声明：本文欢迎任何形式转载，转载时完整保留本声明信息（包含原文链接、原文出处、原文作者、版权声明）即可。本文后续所有修改都会第一时间在原始地址更新。

Table of Contents

2.1 规范
2.2 实战调用
3.1 实战调用
3.2 Package 介绍
3.3 核心 Package 走读
3.4 Informer

saltbo's repos on GitHub

订阅本站

Telegram订阅
RSS订阅