使用 Annotation 配置 ALB Ingress

ALB Ingress 支持通过注解（Annotation）实现更加丰富的 ALB 能力配置。本文主要介绍使用 Annotation 配置 ALB Ingress 的主要场景和配置方法。

选择监听器

ALB Ingress 支持通过 Annotation 选择监听器，示例和说明如下：

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: alb-ingress # 路由规则的名称
  namespace: default  # 路由规则所属的命名空间
  annotations:
    ingress.vke.volcengine.com/loadbalancer-port: "80" # 监听器端口号
    ingress.vke.volcengine.com/loadbalancer-protocol: "http"  # 监听器协议。取值：http、https
    ingress.vke.volcengine.com/loadbalancer-scheduler: "wrr"  # 监听器调度算法。取值：wrr(加权轮询)、wlc(加权最小连接数)、sh（源地址哈希）
    ingress.vke.volcengine.com/loadbalancer-enable-http2: "true" # 监听器是否启用 HTTP2.0 协议特性，仅对 HTTPS 监听器有效
    ingress.vke.volcengine.com/loadbalancer-enable-quic: "true" # 监听器是否启用 Quic 协议特性，仅对 HTTPS 监听器有效
spec:
  ingressClassName: alb  # ALBInstance 的资源名称
  rules:
    - host: example.com  # 需要对外提供访问的域名
      http:
        paths:
        - pathType: Prefix # 路径匹配规则，默认为 Prefix（前缀匹配）
          path: / # 请求匹配的路径
          backend:
            service:
              name: service-demo # 需要对接的服务名称
              port: 
                number: 80 # 需要对接服务的端口号

Annotation 说明如下表所示。

配置直通 Pod 模式

ALB Ingress 支持通过 Annotation 配置直通 Pod 模式，示例和说明如下：

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: alb-ingress # 路由规则的名称
  namespace: default  # 路由规则所属的命名空间
  annotations:
    ingress.vke.volcengine.com/loadbalancer-pass-through: "true" # 配置直通 Pod 模式
spec:
  ingressClassName: alb  # ALBInstance 的资源名称
  rules:
    - host: example.com  # 需要对外提供访问的域名
      http:
        paths:
        - pathType: Prefix # 路径匹配规则，默认为 Prefix（前缀匹配）
          path: / # 请求匹配的路径
          backend:
            service:
              name: service-demo # 需要对接的服务名称
              port: 
                number: 80 # 需要对接服务的端口号

Annotation 说明如下表所示。

配置健康检查

ALB Ingress 支持通过 Annotation 配置健康检查。示例和注解说明如下：

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    ingress.vke.volcengine.com/loadbalancer-healthcheck-enabled: "true" # 是否开启健康检查。取值：true、false
    ingress.vke.volcengine.com/loadbalancer-healthcheck-domain: "example.com"  # 健康检查域名
    ingress.vke.volcengine.com/loadbalancer-healthcheck-path: "/"  # 健康检查路径，默认为 "/"。
    ingress.vke.volcengine.com/loadbalancer-healthcheck-method: "GET"  # 健康检查方法。取值 GET、HEAD
    ingress.vke.volcengine.com/loadbalancer-healthcheck-httpcode: "http_2xx,http_3xx"  # 健康检查的状态码。取值：http_2xx（默认）、http_3xx（默认）、http_4xx、http_5xx。
    ingress.vke.volcengine.com/loadbalancer-healthcheck-timeout: "2"  # 等待健康检查响应的时间。取值范围：1～60 秒
    ingress.vke.volcengine.com/loadbalancer-healthcheck-interval: "2"  # 执行健康检查的时间间隔。取值范围：1～300 秒
    ingress.vke.volcengine.com/loadbalancer-healthy-threshold: "3"  # 判断后端服务器正常的健康检查次数。取值范围：1～10 次
    ingress.vke.volcengine.com/loadbalancer-unhealthy-threshold: "3"  # 判断后端服务器异常的健康检查次数。取值范围：1～10 次
  name: alb-ingress      # 自定义路由规则名称。
  namespace: default     # 路由规则所属的命名空间。
spec:
  ingressClassName: alb  # ALBInstance 的资源名称
  rules:
    - host: example.com  # 需要对外提供访问的域名
      http:
        paths:
        - pathType: Prefix # 路径匹配规则，默认为 Prefix（前缀匹配）
          path: / # 请求匹配的路径
          backend:
            service:
              name: service-demo # 需要对接的服务名称
              port: 
                number: 80 # 需要对接服务的端口号

Annotation 说明如下表所示。

配置后端服务组健康检查

ALB Ingress 支持通过 Annotation 配置指定后端服务组的健康检查，示例和注解说明如下：

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: alb-ingress
  annotations:
    ingress.vke.volcengine.com/loadbalancer-port: "80" # 监听器端口号
    ingress.vke.volcengine.com/loadbalancer-protocol: http # 监听器协议。取值：http、https
    ingress.vke.volcengine.com/loadbalancer-rules-configs: |
        [
            {
                "host": "second.example.com",
                "path": "/",
                "healthCheck":
                 {
                   "enabled": true,
                   "protocol": "http",
                   "method": "GET",
                   "httpcode": "http_2xx,http_3xx",
                   "timeout": 2,
                   "interval": 2,
                   "healthyThreshold": 3,
                   "unhealthyThreshold": 3
                }
            }
        ]
spec:
  ingressClassName: alb
  rules:
  - host: first.example.com
    http:
      paths:
      - pathType: Prefix
        path: /
        backend:
          service:
            name: service-demo-a
            port:
              number: 80
  - host: second.example.com
    http:
      paths:
      - pathType: Prefix
        path: /
        backend:
          service:
            name: service-demo-b
            port:
              number: 80

ingress.vke.volcengine.com/loadbalancer-rules-configs注解中的参数说明如下表所示。

healthCheck

配置转发流量限速

ALB Ingress 支持通过 Annotation 配置转发流量限速，示例和注解说明如下：

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    ingress.vke.volcengine.com/loadbalancer-port: "80" # 监听器端口号
    ingress.vke.volcengine.com/loadbalancer-protocol: "http"  # 监听器协议。取值：http、https
    ingress.vke.volcengine.com/loadbalancer-rules-configs: |   # 配置 ALB Ingress 转发规则的流量限速
      [
          {
              "host": "example.com", 
              "path": "/", 
              "trafficLimitQps": 2000 
          }
      ]
  name: alb-ingress      # 自定义路由规则名称
  namespace: default     # 路由规则所属的命名空间
spec:
  ingressClassName: alb  # ALBInstance 的资源名称
  rules:
    - host: example.com  # 需要对外提供访问的域名
      http:
        paths:
        - pathType: Prefix # 路径匹配规则，默认为 Prefix（前缀匹配）
          path: / # 请求匹配的路径
          backend:
            service:
              name: service-demo # 需要对接的服务名称
              port: 
                number: 80 # 需要对接服务的端口号

ingress.vke.volcengine.com/loadbalancer-rules-configs注解中的参数说明如下表所示。

配置转发重定向规则

ALB Ingress 支持通过 Annotation 配置转发重定向规则，示例和注解说明如下：

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: alb-ingress
  annotations:
    ingress.vke.volcengine.com/loadbalancer-port: "80" # 监听器端口号
    ingress.vke.volcengine.com/loadbalancer-protocol: http # 监听器协议。取值：http、https
    ingress.vke.volcengine.com/loadbalancer-rules-configs: |
      [
            {
                "host": "first.example.com",
                "path": "/",
                "ruleAction": "Redirect",
                "redirectConfig": 
                     {
                       "domain": "test.com",
                       "uri": "/docs",
                       "port": 8080,
                       "httpCode": "302",
                       "protocol": "HTTPS"
                    }
            }
      ]
spec:
  ingressClassName: alb
  rules:
  - host: first.example.com
    http:
      paths:
      - pathType: Prefix
        path: /
        backend:
          service:
            name: redirect # 固定值，表示重定向的服务
            port:
              name: use-annotation # 固定值，表示重定向的服务
  - host: second.example.com
    http:
      paths:
      - pathType: Prefix
        path: /
        backend:
          service:
            name: service
            port:
              number: 80

ingress.vke.volcengine.com/loadbalancer-rules-configs注解中的参数说明如下表所示。

redirectConfig