Higress自定义CRD开发指引
2023年8月10日 · 阅读需 20 分钟
功能划分
这里我们先大概梳理一下Higress工程各目录的职责划分
目录 | 功能说明 |
---|
api | Higress所涉及操作的kubernetes api |
client | Higress集成kubernetes的client进行资源监听与下发 |
cmd | 命令行参数解析等处理代码 |
docker | 构建Higress docker image的描述文件 |
docs | 文档内容 |
envoy | envoy源码内容 |
helm | 使用helm安装Higress等配置 |
istio | istio源码内容 |
pkg/ingress | Ingress 资源转换为 Istio 资源等相关代码 |
pkg/bootstrap | 包括启动 gRPC/xDS/HTTP server 等的代码 |
plugins | Higress 插件 sdk,以及官方内置插件代码 |
registry | 实现对接多种注册中心进行服务发现的代码 |
samples | 一些常见Pod、Service的yaml示例 |
test | 单元测试及e2e测试用例 |
tools | 编译、构建、image分发以及本地测试环境搭建等脚本 |
研发指引
CRD模型定义
进入api目录
higress/api
根据所要新建CRD的api类型,选择相对于的子目录,比如
networking/v1
编写CRD模型
比如我这里想定义一个http_2_rpc的CRD资源
http_2_rpc.proto
2、代码生成
这里依赖kubernetes code generators
生成相关kubetype、client、informer、lister等代码。 在higress根目录执行以下命令,
GENERATE_API=1 make gen-client
执行上述命令后会生成,如下代码
kubernetes customresuource定义
通过将这个定义注册给kubernetes集群,然后就能创建对应的CRD资源实例。
CRD对应资源对象Go语言的定义及操作方法
Hingress(IngressConfig)初始化及运行阶段会使用这里的api模型。
kubernetes client apis
Hingress集成kubernetes client与kube-apiserver交互时会使用这里的模型对象。
kubernetes client apis operate
3、集成 Controller
这里主要是在ingress_config,添加自定义CRD Resource的引用对象,并且通过informer机制监听CRD实例的变化,然后实现相关业务逻辑,比如生成istio EnvoyFilter等
higress/pkg/ingress/config/ingress_config.go
定义相关属性
在higress启动阶段初始化上述变量
这里就会引用自动化生成的一些代码,进行Controller的创建及事件绑定。
实现CRD变更事件处理逻辑
扩展阅读
Kubernetes Controller 机制详解(一)
Kubernetes Informer机制