技术

对容器云平台的理解 Prometheus 源码分析 并发的成本 基础设施优化 hashicorp raft源码学习 docker 架构 mosn细节 与微服务框架整合 Java动态代理 编程范式 并发通信模型 《网络是怎样连接的》笔记 go细节 codereview mat使用 jvm 线程实现 go打包机制 go interface及反射 如何学习Kubernetes 《编译原理之美》笔记——后端部分 《编译原理之美》笔记——前端部分 Pilot MCP协议分析 go gc 内存管理玩法汇总 软件机制 istio流量管理 Pilot源码分析 golang io 学习Spring mosn源码浅析 MOSN简介 《datacenter as a computer》笔记 学习JVM Tomcat源码分析 Linux可观测性 MVCC 学习存储 学计算 Gotty源码分析 kubernetes operator kaggle泰坦尼克问题实践 kubernetes自动扩容缩容 神经网络模型优化 直觉上理解机器学习 knative入门 如何学习机器学习 神经网络系列笔记 TIDB源码分析 《阿里巴巴云原生实践15讲》笔记 Alibaba Java诊断工具Arthas TIDB存储——TIKV 《Apache Kafka源码分析》——简介 netty中的线程池 guava cache 源码分析 Springboot 启动过程分析 Spring 创建Bean的年代变迁 Linux内存管理 自定义CNI IPAM 扩展Kubernetes 副本一致性 spring redis 源码分析 kafka实践 spring kafka 源码分析 Linux进程调度 让kafka支持优先级队列 Codis源码分析 Redis源码分析 C语言学习 《趣谈Linux操作系统》笔记 docker和k8s安全机制 jvm crash分析 Kubernetes监控 Kubernetes 控制器模型 Prometheus 学习 容器日志采集 容器狂占cpu怎么办? Kubernetes资源调度——scheduler 时序性数据库介绍及对比 influxdb入门 maven的基本概念 《Apache Kafka源码分析》——server Kubernetes objects之编排对象 源码分析体会 《数据结构与算法之美》——算法新解 Kubernetes源码分析——controller mananger Kubernetes源码分析——apiserver Kubernetes源码分析——kubelet Kubernetes介绍 ansible学习 Kubernetes源码分析——从kubectl开始 jib源码分析之Step实现 kubernetes实践 jib源码分析之细节 线程排队 跨主机容器通信 jib源码分析及应用 为容器选择一个合适的entrypoint kubernetes yaml配置 《持续交付36讲》笔记 mybatis学习 程序猿应该知道的 无锁数据结构和算法 CNI——容器网络是如何打通的 为什么很多业务程序猿觉得数据结构和算法没用? 串一串一致性协议 当我在说PaaS时,我在说什么 《数据结构与算法之美》——数据结构笔记 PouchContainer技术分享体会 harbor学习 用groovy 来动态化你的代码 《深入剖析kubernetes》笔记 精简代码的利器——lombok 学习 编程语言的动态性 rxjava3——背压 rxjava2——线程切换 spring cloud 初识 《深入拆解java 虚拟机》笔记 《how tomcat works》笔记 hystrix 学习 rxjava1——概念 Redis 学习 TIDB 学习 分布式计算系统的那些套路 Storm 学习 AQS1——论文学习 Unsafe Spark Stream 学习 linux vfs轮廓 mysql 批量操作优化 《自己动手写docker》笔记 java8 实践 中本聪比特币白皮书 细读 区块链泛谈 比特币 大杂烩 总纲——如何学习分布式系统 hbase 泛谈 forkjoin 泛谈 看不见摸不着的cdn是啥 《jdk8 in action》笔记 程序猿视角看网络 bgp初识 calico学习 AQS2——粗略的代码分析 我们能用反射做什么 web 跨域问题 《clean code》笔记 硬件对软件设计的影响 《Elasticsearch权威指南》笔记 mockito简介及源码分析 2017软件开发小结—— 从做功能到做系统 《Apache Kafka源码分析》——clients dns隐藏的一个坑 《mysql技术内幕》笔记2 《mysql技术内幕》笔记1 log4j学习 为什么netty比较难懂? 回溯法 apollo client源码分析及看待面向对象设计 学习并发 docker 环境(主要运行java项目)常见问题 Scala的一些梗 OpenTSDB 入门 spring事务小结 事务一致性 javascript应用在哪里 《netty in action》读书笔记 netty对http2协议的解析 ssl证书是什么东西 http那些事 苹果APNs推送框架pushy apple 推送那些事儿 编写java框架的几大利器 java内存模型 java exception Linux IO学习 network channel network byte buffer 测试环境docker化实践 netty(七)netty在框架中的使用套路 Nginx简单使用 《Linux内核设计的艺术》小结 Go并发机制及语言层工具 Macvlan Linux网络源代码学习——数据包的发送与接收 《docker源码分析》小结 docker中涉及到的一些linux知识 hystrix学习 Linux网络源代码学习——整体介绍 zookeeper三重奏 数据库的一些知识 Spark 泛谈 链式处理的那些套路 netty(六)netty回顾 Thrift基本原理与实践(二) Thrift基本原理与实践(一) 回调 异步执行抽象——Executor与Future Docker0.1.0源码分析 java gc Jedis源码分析 Redis概述 机器学习泛谈 Linux网络命令操作 JTA与TCC 换个角度看待设计模式 Scala初识 向Hadoop学习NIO的使用 以新的角度看数据结构 并发控制相关的硬件与内核支持 systemd 简介 异构数据库表在线同步 quartz 源码分析 基于docker搭建测试环境(二) spring aop 实现原理简述 自己动手写spring(八) 支持AOP 自己动手写spring(七) 类结构设计调整 分析log日志 自己动手写spring(六) 支持FactoryBean 自己动手写spring(九) 总结 自己动手写spring(五) bean的生命周期管理 自己动手写spring(四) 整合xml与注解方式 自己动手写spring(三) 支持注解方式 自己动手写spring(二) 创建一个bean工厂 自己动手写spring(一) 使用digester varnish 简单使用 关于docker image的那点事儿 基于docker搭建测试环境 分布式配置系统 JVM内存与执行 git spring rmi和thrift maven/ant/gradle使用 再看tcp 缓存系统 java nio的多线程扩展 《Concurrency Models》笔记 回头看Spring IOC IntelliJ IDEA使用 Java泛型 vagrant 使用 Go常用的一些库 Python初学 Goroutine 调度模型 虚拟网络 《程序员的自我修养》小结 VPN(Virtual Private Network) Kubernetes存储 Kubernetes 其它特性 访问Kubernetes上的Service Kubernetes副本管理 Kubernetes pod 组件 使用etcd + confd + nginx做动态负载均衡 如何通过fleet unit files 来构建灵活的服务 CoreOS 安装 CoreOS 使用 Go学习 JVM类加载 硬币和扑克牌问题 LRU实现 virtualbox 使用 ThreadLocal小结 docker快速入门

标签


Kubernetes源码分析——从kubectl开始

2018年12月23日

简介

从kubectl 开始

A Tour of the Kubernetes Source Code Part One: From kubectl to API Server

kubectl create -f xx.yaml 为例,你会在pkg/kubectl/cmd/create 下找到一个create.go。类似的,所有kubectl 的命令 都可以在 pkg/kubectl/cmd 下找到。kubectl 命令行库 用的是 spf13/cobra

可以看到,阅读Kubernetes 源码需要一些go 语言基础、常用库、go上的设计模式等沉淀,否则会将技术细节与kubernetes 思想混在在一起

package结构

Go 常用的一些库 在介绍 spf13/cobra会提到 一个command line application 的推荐结构

appName/
	cmd/
    	add.go
    	your.go
    	commands.go
    	here.go
  	main.go

但我们要注意几个问题

  1. 其实大部分golang 应用 都可以以command line application 的结构来组织
  2. k8s 是由 多个command line application 组成的集合,所以其package 结构又有一点不一样。pkg/kubectl 是根据 cobra 推荐样式来的,main.go 的角色由pkg/kubectl/cmd.go 来承担(cmd.go 的方法被cmd/kubectl/kubectl.go 引用),kubectl 具体命令实现在 pkg/kubectl/cmd

Builders and Visitors

背景

  1. 而kubectl本身并不包含对其核心资源的访问与控制,而是通过http通信与api-server进行交互实现资源的管理,所以kubectl 操作的最后落脚点 是发送 http 请求
  2. kubectl 读取用户输入(包括参数、yaml 文件、yaml http地址)后,肯定要在内部用一个数据结构来表示,然后针对这个数据结构 发送http 请求。
  3. 实际实现中,数据结构有倒是有,但是

    1. k8s 笼统的称之为 resource,但没有一个实际的resource 对象存在。
    2. resource 可能有多个,因为 kubectl create -f 可以创建多个文件,便有了多个resource
    3. resource 有多个处理步骤,比如对于 kubectl create -f http://xxx 要先下载yaml 文件、校验、再发送http 请求
  4. 针对这几个问题

    • k8s 没有使用一个 类似Resources 的对象来聚合所有 resource
    • 针对一个resource 的多个处理步骤,k8s 也没有为resource 提供download、sendHttp、downloadAndSendHttp 之类的方法,而是通过对象的 聚合来 代替方法的顺序调用

所以,k8s 采用了访问者 模式,利用其 动态双分派 特性,参见函数式编程的设计模式

Visitor 接口

type VisitorFunc func(*Info, error) error
// Visitor lets clients walk a list of resources.
type Visitor interface {
	Visit(VisitorFunc) error
}

visitor 模式

这部分代码主要在 k8s.io/cli-runtime/pkg/genericclioptions/resource 包下,可以使用goland 单独打开看

pkg/kubectl/cmd/create/create.go 为demo

// 根据 请求参数 构造 resource
r := f.NewBuilder().
		Unstructured().
		Schema(schema).			// 简单赋值
		ContinueOnError().		// 简单赋值
		NamespaceParam(cmdNamespace).DefaultNamespace().	// 简单赋值
		FilenameParam(enforceNamespace, &o.FilenameOptions). // 文件可以是http 也可以 本地文件,最终都是为了给 builder.path 赋值,path 是一个Visitor 集合
		LabelSelectorParam(o.Selector).	// 简单赋值
		Flatten(). 	// 简单赋值
		Do()
...
// 发送http 请求
err = r.Visit(func(info *resource.Info, err error) error {
	...
	if !o.DryRun {
		if err := createAndRefresh(info); err != nil {
			return cmdutil.AddSourceToErr("creating", info.Source, err)
		}
	}
	...
	return o.PrintObj(info.Object)
})
  1. Builder provides convenience functions for taking arguments and parameters from the command line and converting them to a list of resources to iterate over using the Visitor interface.
  2. Result contains helper methods for dealing with the outcome of a Builder. Info contains temporary info to execute a REST call, or show the results of an already completed REST call.

Builder build 了什么东西?将输入转换为 resource,还不只一个。每个resource 都实现了 Visitor 接口,可以接受 VisitorFunc。Result 持有 Builder 的结果——多个实现visitor 接口的resource ,并提供对它们的快捷 访问操作。

在Result 层面,一个resource/visitor 一般代表一个yaml 文件(无论local 还是http),一个resource 内部 是多个visitor 的纵向聚合,比如 URLVisitor.visit

type URLVisitor struct {
	URL *url.URL
	*StreamVisitor
	HttpAttemptCount int
}

func (v *URLVisitor) Visit(fn VisitorFunc) error {
	body, err := readHttpWithRetries(httpgetImpl, time.Second, v.URL.String(), v.HttpAttemptCount)
	if err != nil {
		return err
	}
	defer body.Close()
	v.StreamVisitor.Reader = body
	return v.StreamVisitor.Visit(fn)
}

URLVisitor.visit 自己实现了 读取http yaml 文件内容,然后通过StreamVisitor.Visit 负责后续的发送http 逻辑。

visitor 函数聚合

k8s.io/cli-runtime/pkg/genericclioptions/resource/interfaces.go

这里面比较有意思的 是 DecoratedVisitor (纵向聚合,扩充一个visitor的 visit 逻辑)和 VisitorList(横向聚合,将多个平级的visitor 聚合为1个)

type DecoratedVisitor struct {
	visitor    Visitor
	decorators []VisitorFunc
}
func (v DecoratedVisitor) Visit(fn VisitorFunc) error {
	return v.visitor.Visit(func(info *Info, err error) error {
		if err != nil {
			return err
		}
		for i := range v.decorators {
			if err := v.decorators[i](info, nil); err != nil {
				return err
			}
		}
		return fn(info, nil)
	})
}

DecoratedVisitor 封装了一个visitor, DecoratedVisitor.Visit 执行时 会先让 visitor 执行DecoratedVisitor 自己的私货VisitorFunc ,然后再执行 传入的VisitorFunc,相当于对函数逻辑做了一个聚合。

type VisitorList []Visitor

// Visit implements Visitor
func (l VisitorList) Visit(fn VisitorFunc) error {
	for i := range l {
		if err := l[i].Visit(fn); err != nil {
			return err
		}
	}
	return nil
}

VisitorList 则是将多个 Visitor 聚合成一个visitor,VisitorList.visit 执行时会依次执行 其包含的visitor的Visit 逻辑

回头看

整这么复杂 k8s.io/cli-runtime/pkg/genericclioptions/resource

  1. 对上层提供两个 抽象Builder 和 Result,上层的调用模式很固定

    1. 构造Builder、result
    2. result.visit
  2. 尽可能在通用层面 实现了kubectl 的所有逻辑,上层通过配置、传入function 即可个性化整体流程

其实最初看完这个实现,笔者在质疑这样做是否有必要,因为kubectl 就是一个发送http 请求的工具(http client)。从常规的实现角度看,create/deploy 等操作各干个的,然后共用一些抽象(比如pod)、工具类(比如HttpUtils) 就可以了。

可以看到这个复用层次是比较浅的

  1. k8s 将一些公共组件单独提取出来,作为一个库,有点layer的感觉,但还不完全是。
  2. 借助visitor 模式,完全依靠 函数聚合来聚合逻辑,或许要从函数式编程模式的一些角度来找找感觉。