进阶 docs.flagger.app 2026-11-21 03:00:57 · 1 阅读

第5章 Flagger 工作原理

工作原理

可以通过配置 Flagger,利用名为 Canary 的自定义资源来自动化 Kubernetes 工作负载的发布流程。

Canary 资源

Canary 自定义资源定义了运行在 Kubernetes 上的应用的发布流程,并可在集群、服务网格和 Ingress 提供商之间移植。

对于一个名为 podinfo 的 Deployment,可以定义一个具有渐进式流量转移的 Canary 发布:

apiVersion: flagger.app/v1beta1 kind: Canary metadata: name: podinfo spec: targetRef: apiVersion: apps/v1 kind: Deployment name: podinfo service: port: 9898 analysis: interval: 1m threshold: 10 maxWeight: 50 stepWeight: 5 metrics: - name: request-success-rate thresholdRange: min: 99 interval: 1m - name: request-duration thresholdRange: max: 500 interval: 1m webhooks: - name: load-test url: http://flagger-loadtester.test/ metadata: cmd: "hey -z 1m -q 10 -c 2 http://podinfo-canary.test:9898/"

当你部署应用程序的新版本时,Flagger 会逐步将流量转移到 Canary,同时测量请求成功率及平均响应时间。你可以通过自定义指标、验收测试和负载测试来扩展 Canary 分析,从而强化应用发布流程的验证过程。

如果在同一集群中运行多个服务网格或 Ingress 控制器,你可以使用 spec.provider 覆盖特定 Canary 的全局提供商。

Canary 目标

Canary 资源可以指定 Kubernetes Deployment 或 DaemonSet 作为目标。

Kubernetes Deployment 示例:

基于上述配置,Flagger 将生成以下 Kubernetes 对象: deployment/-primary hpa/-primary

主 Deployment(primary)被视为应用的稳定版本。默认情况下,所有流量都路由到该版本,且目标 Deployment 的副本数缩放为零。Flagger 会检测目标 Deployment 的变更(包括 Secrets 和 ConfigMaps),并在将新版本提升为主版本之前执行 Canary 分析。

使用 .spec.autoscalerRef.primaryScalerReplicas 可以覆盖生成的主 HorizontalPodAutoscaler 的副本缩放配置。这在需要为主工作负载设置不同的缩放配置(而不是使用原始工作负载 HorizontalPodAutoscaler 中相同的值)时非常有用。

请注意,目标 Deployment 必须具有格式为 app: 的单个标签选择器:

除了 app 之外,Flagger 还支持 name 和 app.kubernetes.io/name 选择器。如果你使用不同的约定,可以在 Flagger 部署清单中 containers args 下通过 -selector-labels=my-app-label 命令标志指定标签,或者在安装 Flagger 时通过 Helm 设置 --set selectorLabels=my-app-label。

如果目标 Deployment 使用了 Secrets 和/或 ConfigMaps,Flagger 将创建每个对象的副本并使用 -primary 后缀,并在主 Deployment 中引用这些对象。如果你通过添加 flagger.app/config-tracking: disabled 注解来标记 ConfigMap 或 Secret,Flagger 将为主 Deployment 使用相同的对象,而不是创建主副本。你可以通过在 Flagger 部署清单中 containers args 下使用 -enable-config-tracking=false 命令标志,或在通过 Helm 安装 Flagger 时设置 --set configTracking.enabled=false 来全局禁用 Secrets/ConfigMaps 跟踪,但对于某些用例,使用每个 Secret/ConfigMap 注解来禁用 config-tracking 可能更合适。

自动缩引用是可选的。当指定时,Flagger 将在目标或主 Deployment 扩容或缩容期间暂停流量增加。HPA 有助于减少 Canary 分析期间的资源使用。当指定了自动缩引用时,对自动缩的任何更改仅在主自动缩中生效,条件是 Deployment 的滚动更新开始并成功完成。可选地,你可以创建两个 HPA,一个用于 Canary,一个用于主,以便在不进行新的滚动更新的情况下更新 HPA。由于 Canary Deployment 将缩放为 0,Canary 上的 HPA 将处于非活动状态。

请注意,Flagger 需要 autoscaling/v2 API 版本用于 HPAs。

进度截止时间表示 Canary Deployment 在回滚之前做出进展的最大秒数,默认为 10 分钟。

Canary 服务

Canary 资源规定了目标工作负载在集群内部如何暴露。Canary 目标应暴露一个 TCP 端口,Flagger 将使用它来创建 ClusterIP 服务。

目标工作负载的容器端口应与 service.port 或 service.targetPort 匹配。service.name 是可选的,默认为 spec.targetRef.name。service.targetPort 可以是容器端口号或名称。service.portName 是可选的(默认为 http),如果你的工作负载使用 gRPC,请将端口名称设置为 grpc。service.appProtocol 是可选的,更多详情见此处。service.trafficDistribution 是可选的,更多详情见此处。

如果启用了端口发现,Flagger 将扫描目标工作负载,并提取除 Canary 服务和服务网格 sidecar 端口指定的端口之外的容器端口。这些端口将在生成 ClusterIP 服务时使用。

基于 Canary 规范的 service,Flagger 创建以下 Kubernetes ClusterIP 服务: ..svc.cluster.local 选择器 app=-primary -primary..svc.cluster.local 选择器 app=-primary -canary..svc.cluster.local 选择器 app=

这确保了发往 podinfo.test:9898 的流量将路由到你应用的最新稳定版本。podinfo-canary.test:9898 地址仅在 Canary 分析期间可用,可用于一致性测试或负载测试。

你可以配置 Flagger 为生成的服务设置注解和标签:

请注意,apex 注解会被添加到生成的 Kubernetes 服务和生成的服务网格/Ingress 对象中。这使得可以使用 Istio VirtualServices 和 TraefikServices 与 external-dns 配合使用。请注意此处可能存在配置冲突。

请注意,如果添加了任何未在此处指定的注解或标签,Flagger 将在协调期间移除它们。要指定 Flagger 应忽略的元数据,请配置 unmanagedMetadata。

如果你希望生成的 Kubernetes ClusterIP 服务是无头(headless)的,请将 service.headless 设置为 true。

除了端口映射和元数据外,服务规范还可以包含 URI 匹配和重写规则、超时和重试策略:

当使用 Istio 作为网格提供商时,你还可以指定 HTTP 头操作、CORS 和流量策略、Istio 网关和主机。Istio 路由配置见此处。

Canary 状态

你可以使用 kubectl 获取集群范围内 Canary 部署的当前状态:

状态条件反映了 Canary 分析的最后已知状态:

成功的滚动状态:

Promoted 状态条件可能具有以下原因之一:Initialized, Waiting, Progressing, WaitingPromotion, Promoting, Finalising, Succeeded 或 Failed。失败的 Canary 将把 promoted 状态设置为 false,原因设为 failed,且最后应用的 spec 将与最后提升的 spec 不同。

等待成功滚动:

CI 示例:

Canary 终结器

Flagger 在删除 Canary 时的默认行为是保持不由控制器拥有的资源处于当前状态。这简化了删除操作,并避免了资源终结期间可能的死锁。如果 Canary 引入时已存在某些资源(例如 service、virtual service 等),这些资源将在初始化阶段被修改,不再反映其初始状态。如果期望的删除功能是恢复资源到初始状态,可以启用 revertOnDeletion 属性。

当删除操作提交到集群时,Flagger 将尝试恢复以下资源: Canary 目标副本将更新为主副本数量 Canary 服务选择器将被恢复 Mesh/Ingress 流量将路由到目标

推荐的禁用 Canary 分析的方法是使用 skipAnalysis 属性,这限制了资源协调的需求。当你不再计划依赖 Flagger 进行部署管理时,应启用 revertOnDeletion 属性。

注意:启用此功能时,预计删除操作会因协调而产生延迟。

Canary 分析

Canary 分析定义了: 部署策略类型 用于验证 Canary 版本的指标 用于一致性测试、负载测试和手动门控的 Webhooks 警报设置

规范:

Canary 分析周期性地运行,直到达到最大流量权重或迭代次数。在每次运行中,Flagger 调用 Webhooks,检查指标,如果达到失败检查阈值,则停止分析并回滚 Canary。如果配置了警报,Flagger 将使用警报提供商发布分析结果。

Canary 暂停

suspend 字段可以设置为 true 以暂停 Canary。如果 Canary 被暂停,其协调将完全停止。这意味着对目标工作负载、跟踪的 ConfigMaps 和 Secrets 的更改不会触发 Canary 运行,且对 Flagger 生成的资源的更改不会被纠正。如果 Canary 在活动的 Canary 运行期间被暂停,则该运行将被暂停,而不会干扰工作负载或流量权重。

上一篇 使用 Flux 安装 Flagger 下一篇 部署策略 最后更新:4 个月前

评论 (0)