用户指南

最佳实践

API 文档

Service Annotation 说明

最近更新时间:2021-11-30 14:39:56

您可以通过以下 Annotation 注解配置 Service,以实现更丰富的负载均衡的能力。

注解使用方式

apiVersion: v1
kind: Service
metadata:
    annotations:  
      service.kubernetes.io/tke-existed-lbid: lb-6swtxxxx
    name: test
........

Annotation 集合

service.kubernetes.io/loadbalance-id

展开&收起

说明:
只读注解,提供当前 Service 引用的负载均衡 LoadBalanceId。您可以在腾讯云 CLB 控制台查看与集群在同一 VPC 下的 CLB 实例 ID。

service.kubernetes.io/qcloud-loadbalancer-internal-subnetid

展开&收起

说明:
通过该 Annotation 指定创建内网类型 CLB,取值为子网 ID。
使用示例:
service.kubernetes.io/qcloud-loadbalancer-internal-subnetid: subnet-xxxxxxxx

service.kubernetes.io/tke-existed-lbid

展开&收起

说明:
使用已存在的 CLB,需注意不同使用方式对腾讯云标签的影响。
使用示例:
使用方式详情见 Service 使用已有 CLB

service.kubernetes.io/local-svc-only-bind-node-with-pod

展开&收起

说明:
Service Local 模式下仅绑定有 Pod 存在的节点。
使用示例:
使用方式详情见 Service Local 模式

service.cloud.tencent.com/local-svc-weighted-balance

展开&收起

说明:

  • 与 Annotation service.kubernetes.io/local-svc-only-bind-node-with-pod 搭配使用。
  • CLB 后端的权重将会由节点上工作负载的数量决定。

使用示例:
使用方式详情见 Service Local 模式

service.kubernetes.io/qcloud-loadbalancer-backends-label

展开&收起

说明:
指定标签设置负载均衡后端绑定的节点。
使用示例:
使用方式详情见 指定接入层后端

service.cloud.tencent.com/direct-access

展开&收起

说明:
使用负载均衡直连 Pod。
使用示例:
使用方式详情见 使用 LoadBalancer 直连 Pod 模式 Service

service.cloud.tencent.com/tke-service-config

展开&收起

说明:
通过 tke-service-config 配置负载均衡 CLB。
使用示例:
使用方式详情见 Service 负载均衡配置

service.cloud.tencent.com/tke-service-config-auto

展开&收起

说明:
通过该注解可自动创建 TkeServiceConfig。
使用示例:
使用方式详情见 Service 与 TkeServiceConfig 关联行为

service.kubernetes.io/loadbalance-nat-ipv6

展开&收起

说明:
只读注解,创建 NAT64 IPv6 负载均衡时,负载均衡的 IPv6 地址将会展示到注解中。
使用示例:
service.kubernetes.io/loadbalance-nat-ipv6: "2402:4e00:1402:7200:0:9223:5842:2a44"

service.kubernetes.io/loadbalance-type(即将废弃)

展开&收起

说明:

  • 控制自动创建的负载均衡类型,传统型负载均衡、应用型负载均衡。
  • 可选值:yunapi_clb(传统型)、classic(传统型)、yunapiv3_forward_clb(应用型)
  • 默认值:yunapiv3_forward_clb(应用型)
    注意:

    除非有特殊原因,否则不推荐使用传统型负载均衡,传统型负载均衡已经停止迭代准备下线,并且缺失大量特性。

service.cloud.tencent.com/specify-protocol

展开&收起

说明:
支持通过注解为指定的监听端口配置 TCP、UDP、TCP SSL、HTTP、HTTPS。
使用示例:
使用方式详情见 Service 扩展协议

service.kubernetes.io/service.extensiveParameters

展开&收起

说明:
参考 创建负载均衡实例 为创建负载均衡追加自定义参数。
使用示例:

  • 创建 NAT64 IPv6 实例:
    service.kubernetes.io/service.extensiveParameters: '{"AddressIPVersion":"IPV6"}'
  • 购买电信负载均衡:
    service.kubernetes.io/service.extensiveParameters: '{"VipIsp":"CTCC"}'

service.cloud.tencent.com/enable-grace-shutdown

展开&收起

说明:
支持 CLB 直连模式的优雅停机。
使用示例:
仅在直连模式下支持,需要配合使用 service.cloud.tencent.com/direct-access,使用方式详情见 Service 优雅停机

kubernetes.io/service.internetChargeType

展开&收起

说明:
指定创建负载均衡时,负载均衡的付费类型。请配合 kubernetes.io/service.internetMaxBandwidthOut 注解一起使用。
可选值:

TRAFFIC_POSTPAID_BY_HOUR 按流量按小时后计费。
BANDWIDTH_POSTPAID_BY_HOUR 按带宽按小时后计费。
使用示例:
kubernetes.io/service.internetChargeType: "TRAFFIC_POSTPAID_BY_HOUR"

kubernetes.io/service.internetMaxBandwidthOut

展开&收起

说明:
指定创建负载均衡时,负载均衡的最大出带宽,仅对公网属性的 LB 生效。需配合 kubernetes.io/service.internetChargeType 注解一起使用。

可选值:
范围支持1到2048,单位 Mbps。

使用示例:
kubernetes.io/service.internetMaxBandwidthOut: "2048"

目录