tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Kubernetes Engine
    Documentation
    Download PDF

    Service Annotation

    Last updated: 2023-04-07 20:04:01
    Download PDF
      You can use the following annotations to configure Services to enrich CLB capabilities.

      Annotation Usage

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

      Annotation Collection

      service.kubernetes.io/loadbalance-id

      Note: This is a read-only annotation that provides the LoadBalanceId imported by the current Service. You can go to Tencent Cloud CLB console to view the IDs of the CLB instances in the same VPC with the cluster.
      

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

      Note: This annotation is used to specify the creation of a private network CLB instance. Its value is the subnet ID.
      Use case:
      service.kubernetes.io/qcloud-loadbalancer-internal-subnetid: subnet-xxxxxxxx

      service.kubernetes.io/tke-existed-lbid

      Note: When you use an existing CLB instance, you should note that different usages have different impacts on Tencent Cloud tags.
      Use case: For the detailed usage, see Using Existing CLBs.

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

      Note: In Service Local mode, only nodes with Pods are bound.
      Use case: For the detailed usage, see Service Local Mode.
      

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

      Note:
      It is used with the annotation service.kubernetes.io/local-svc-only-bind-node-with-pod.
      The weight of the CLB backend is determined by the number of workloads on the nodes.
      Use case: For the detailed usage, see Service Local Mode.
      

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

      Note: This annotation is used to specify a tag for setting the nodes to be bound to the CLB backend.
      Use case: For the detailed usage, see Specifying the Access-Layer Backend.
      

      service.cloud.tencent.com/direct-access

      Note: This annotation is used to connect a CLB instance directly to a Pod.
      Use case: For the detailed usage, see Using Services with CLB-to-Pod Direct Access Mode.
      

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

      Note: This annotation is used to configure CLB through tke-service-config.
      Use case: For the detailed usage, see Service CLB Configuration.
      

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

      Note: This annotation is used to automatically create a TkeServiceConfig.
      Use case: For the detailed usage, see Associated Actions Between Service and TkeServiceConfig.
      

      service.kubernetes.io/loadbalance-nat-ipv6

      Note: This is a read-only annotation. When you create an NAT64 IPv6 CLB instance, its IPv6 address will be displayed in the annotation.
      Use case:
      service.kubernetes.io/loadbalance-nat-ipv6: "2402:4e00:1402:7200:0:9223:5842:2a44"
      

      service.kubernetes.io/loadbalance-type (it will be disused soon)

      Note:
      This annotation is used to control the type of the automatically created CLB instance: classic CLB or CLB.
      Valid values: yunapi_clb (classic), classic (classic), yunapiv3_forward_clb (CLB)
      Default value: yunapiv3_forward_clb (CLB)
      Note
      Without special needs, we don't recommend you use classic CLB, which has ceased to be iterated and lacks many features.
      

      service.cloud.tencent.com/specify-protocol

      Note: This annotation is used to configure TCP, UDP, TCP SSL, HTTP, or HTTPS for the specified listening port.
      Use case: For the detailed usage, see Service Extension Protocol.
      

      service.kubernetes.io/service.extensiveParameters

      Note: This annotation uses the parameters configured when the CLB was created. It can only be configured at the time of creation and cannot be modified after the creation. Refer to Creating a CLB Instance to add custom parameters for the created CLB instance.
      Use case:
      Creating a NAT64 IPv6 instance: service.kubernetes.io/service.extensiveParameters: '{"AddressIPVersion":"IPV6"}'
      Purchasing a CTCC CLB: service.kubernetes.io/service.extensiveParameters: '{"VipIsp":"CTCC"}'
      Creating a CLB with a custom name: service.kubernetes.io/service.extensiveParameters: '{"LoadBalancerName":"my_cutom_lb_name"}'
      

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

      Note: This annotation is used to shut down CLB instances gracefully in direct access mode. If a deleted Pod contains DeletionTimestamp and is in Terminating status, the weight of the Pod on the CLB backend is adjusted to 0.
      Use case: It is only supported in direct access mode and needs to be used together with service.cloud.tencent.com/direct-access. For more information on how to use it, please see Graceful Service Shutdown.
      

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

      Note: This annotation is used to shut down CLB instances gracefully in direct access mode. If the endpoints in the Endpoint object are not-ready, the weights on the CLB backend are adjusted to 0.
      Use case: It is only supported in direct access mode and needs to be used together with service.cloud.tencent.com/direct-access. For more information on how to use it, see Graceful Service Shutdown.
      

      service.kubernetes.io/qcloud-loadbalancer-internet-charge-type

      Note: The billing type of CLB can only be configured at the time of creation, and cannot be modified after the creation. This annotation is used to specify the CLB payment mode when a CLB is created. Please use it with service.kubernetes.io/qcloud-loadbalancer-internet-max-bandwidth-out annotation.
      Valid values:
      BANDWIDTH_POSTPAID_BY_HOUR: Postpaid by bandwidth on an hourly basis
      TRAFFIC_POSTPAID_BY_HOUR: Postpaid by traffic on an hourly basis
      Use case:
      service.kubernetes.io/qcloud-loadbalancer-internet-charge-type: "TRAFFIC_POSTPAID_BY_HOUR"
      

      service.kubernetes.io/qcloud-loadbalancer-internet-max-bandwidth-out

      Note: CLB bandwidth can only be configured at the time of creation, and cannot be modified after the creation. This annotation is used to specify the maximum outbound bandwidth of the CLB when a CLB is created, which applies only to public network CLB instances. Please use it with service.kubernetes.io/qcloud-loadbalancer-internet-charge-type annotation.
      Valid values: Value range: 1-2,048 Mbps
      Use case:
      service.kubernetes.io/qcloud-loadbalancer-internet-max-bandwidth-out: "2048"
      

      service.cloud.tencent.com/security-groups

      Note: This annotation is used to bind security groups to CLB-type Services. Up to five security groups can be bound to a CLB.
      Note:
      For more information, see Use Limits of CLB security groups.
      Usually, the "Allow Traffic by Default" feature must be enabled, with which the traffic forwarding between CLB and CVM is allowed by default. Traffic coming from the CLB only needs to be verified by the security group bound to the CLB. The annotation is service.cloud.tencent.com/pass-to-target.
      When Using Existing CLBs, logic conflicts may occur if different security groups are configured for multiple Services.
      Use case:
      service.cloud.tencent.com/security-groups: "sg-xxxxxx,sg-xxxxxx"
      

      service.cloud.tencent.com/pass-to-target

      Note: This annotation is used to configure the "Allow Traffic by Default" feature for the CLB-type Services. The traffic forwarding between CLB and CVM is allowed by default. Traffic coming from the CLB only needs to be verified by the security group bound to the CLB.
      Note:
      For more information, see Use Limits of CLB security groups.
      Usually, the feature of binding a security group is required. The annotation is service.cloud.tencent.com/security-groups.
      When Using Existing CLBs, logic conflicts may occur if different “Allow Traffic” configurations are configured for multiple Services.
      Use case:
      service.cloud.tencent.com/pass-to-target: "true"
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy