第27章 Flagger 开发指南
开发指南
本文档描述了如何从源代码构建、测试和运行 Flagger。
搭建开发环境
Flagger 使用 Go 语言编写,并通过 Go modules 管理依赖。请在你的开发机器上安装以下工具:
- go >= 1.26
- kubectl >= 1.30
- kustomize >= 5.0
- helm >= 3.0
此外,测试 Flagger 还需要一个 Kubernetes 集群。你可以使用 Minikube、Kind、Docker Desktop 或任何远程集群(如 AKS/EKS/GKE)。
要开始参与 Flagger 的贡献,请首先在 GitHub 上 fork 该仓库。在 GOPATH 内创建一个目录:
mkdir -p $GOPATH/src/github.com/fluxcd
克隆你 fork 的仓库:
cd $GOPATH/src/github.com/fluxcd git clone https://github.com/YOUR_USERNAME/flagger cd flagger
将 Flagger 仓库设置为上游(upstream):
定期同步你的 fork,以保持与上游的最新状态一致:
构建
下载 Go modules:
构建 Flagger 二进制文件:
构建负载测试二进制文件:
代码变更
我们要求所有提交都必须签署。通过签名,你证实你编写了该补丁,或者根据 DCO 规则拥有贡献该材料的权利。如果在 Git 配置中设置了 user.name 和 user.email,你可以使用以下命令自动签署提交:
在提交 PR 之前,请确保你的变更已被单元测试覆盖。如果你修改了 go.mod,请运行:
如果你修改了 pkg/apis,请使用以下命令重新生成 Kubernetes 客户端集合:
运行代码格式化器:
运行单元测试:
API 变更
如果你修改了 pkg/apis,请使用以下命令重新生成 Kubernetes 客户端集合:
更新 artifacts/flagger/crd.yaml 中的验证规范并运行:
请注意,对 CRDs 的任何更改都必须伴随 Open API 模式的更新。
手动测试
在你的集群上安装服务网格和/或 ingress 控制器,并使用此处列出的安装选项之一部署 Flagger。如果你修改了 CRDs,请使用以下命令应用本地副本:
关闭集群上已安装的 Flagger 实例(将命名空间替换为你的网格/ingress 命名空间):
将端口转发到 Prometheus 实例:
通过指定 kubeconfig 路径在本地运行 Flagger,以测试远程集群:
另一种手动测试变更的方法是构建并推送镜像到容器仓库:在集群上部署你的镜像并扩展 Flagger:
现在,你可以使用其中一个教程来手动测试你的变更。
集成测试
可以在本地使用 Kubernetes Kind 运行 Flagger 端到端测试。创建一个 Kind 集群:构建 Flagger 容器镜像并将其加载到集群中:运行 Istio e2e 测试:针对每个服务网格和 ingress 控制器,都有一个专门的 e2e 测试套件,请从以下列表中选择与你变更相匹配的套件:在 Flagger 仓库中打开 pull request 时,CI 将运行单元测试和集成测试。
上一篇:零停机部署
下一篇:发布指南
最后更新于 4 个月前