Ingress-Nginx Annotation 简介
KubeSphere 基于 Nginx Ingress Controller 实现了项目的网关,作为项目对外的流量入口和项目中各个服务的反向代理。而 Ingress-Nginx 支持配置 Ingress Annotations 来实现不同场景下的灰度发布和测试,可以满足金丝雀发布
、蓝绿部署
与 A/B 测试
等业务场景。
Nginx Annotations 支持以下 5 种 Canary 规则:
nginx.ingress.kubernetes.io/canary-by-header
:基于 Request Header 的流量切分,适用于灰度发布以及 A/B 测试
。当 Request Header 设置为always
时,请求将会被一直
发送到 Canary 版本;当 Request Header 设置为never
时,请求不会
被发送到 Canary 入口;对于任何其他Header
值,将忽略Header
,并通过优先级将请求与其他金丝雀规则进行优先级的比较。nginx.ingress.kubernetes.io/canary-by-header-value
:要匹配的 Request Header 的值,用于通知Ingress
将请求路由到Canary Ingress
中指定的服务。当Request Header
设置为此值时,它将被路由到 Canary 入口。该规则允许用户自定义 Request Header 的值,必须与上一个 annotation (即:canary-by-header
) 一起使用。nginx.ingress.kubernetes.io/canary-by-header-pattern
:要匹配的 Request Header 值的 PCRE 正则表达式,作用同上面的canary-by-header-value
一样,当Request Header
设置的值满足该正则表达式时,它将被路由到 Canary 入口,必须与canary-by-header
一起使用。nginx.ingress.kubernetes.io/canary-weight
:基于服务权重的流量切分,适用于蓝绿部署,权重范围0
-100
按百分比将请求路由到Canary Ingress
中指定的服务。权重为0
意味着该金丝雀规则不会向 Canary 入口的服务发送任何请求,权重为100
意味着所有请求都将被发送到 Canary 入口。nginx.ingress.kubernetes.io/canary-by-cookie
:基于cookie
的流量切分,适用于灰度发布与 A/B 测试
。用于通知 Ingress 将请求路由到Canary Ingress
中指定的服务的cookie
。当cookie
值设置为always
时,它将被路由到 Canary 入口;当 cookie 值设置为never
时,请求不会被发送到 Canary 入口;对于任何其他值,将忽略 cookie 并将请求与其他金丝雀规则进行优先级的比较。注意:金丝雀规则按优先顺序进行如下排序:
canary-by-header
- >canary-by-cookie
- >canary-weight
使用
- 创建两个不同版本的service及ingress
- 两个ingress使用相关的域名,但是后端服务使用不同版本的
- canary版本的ingress增加
nginx.ingress.kubernetes.io/canary: "true"
启用Canary
- 其余策略参考nginx annotation