tencent cloud

All product documents
Tencent Kubernetes Engine
DocumentationTencent Kubernetes EngineTKE General Cluster Guide Service ManagementService Extension Protocol
Service Extension Protocol
Download PDF
Last updated: 2024-12-23 11:41:09
Service Extension Protocol
Last updated: 2024-12-23 11:41:09
Download PDF

Protocols Supported by Services by Default

A Service is a mechanism and abstraction through which Kubernetes exposes applications outside the cluster. You can access the applications in a cluster through a Service.
Notes
For access in direct access mode, there are no restrictions on the use of extension protocols, and TCP and UDP protocols can be used together.
In non-direct access scenarios, ClusterIP and NodePort modes can be used together. However, the community has restrictions on Services of the LoadBalancer type, and only protocols of the same type can be used currently.
When LoadBalancer is declared as TCP, the port can use the capabilities of extension protocols to change the protocol of CLB to TCP_SSL, HTTP, or HTTPS.
When LoadBalancer is declared as UDP, the port can use the capabilities of extension protocols to change the protocol of CLB to UDP.

TKE Extension of Service Forwarding Protocols

In addition to the rules of the protocols supported by a native Service, a Service needs to support the hybrid use of TCP and UDP as well as the TCP SSL, HTTP, and HTTPS protocols in certain scenarios. TKE extends the support for more protocols in LoadBalancer mode.

Prerequisites

Extension protocols are only effective for Services in LoadBalancer mode.
An extension protocol describes the relationship between the protocol and the port through an annotation.
The relationship between the extension protocol and the annotation is as follows:
When the port described in Service Spec is not covered in the annotation of the extension protocol, Service Spec will be configured according to your declaration.
When the port described in the annotation of the extension protocol does not exist in Service Spec, the configuration will be ignored.
When the port described in the annotation of the extension protocol exists in Service Spec, the protocol configuration declared in Service Spec will be overwritten.

Annotation name

service.cloud.tencent.com/specify-protocol

Sample annotations of extension protocols

Sample for TCP_SSL
Sample for HTTP
Sample for HTTPS
Sample for TCP/UDP
Sample for hybrid use
QUIC
{"80":{"protocol":["TCP_SSL"],"tls":"cert-secret"}}
{"80":{"protocol":["HTTP"],"hosts":{"a.tencent.com":{},"b.tencent.com":{}}}}
 {"80":{"protocol":["HTTPS"],"hosts":{"a.tencent.com":{"tls":"cert-secret-a"},"b.tencent.com":{"tls":"cert-secret-b"}}}}
{"80":{"protocol":["TCP","UDP"]}} # Only supported in direct access mode. For more information, visit https://www.tencentcloud.com/document/product/457/36837. 
 {"80":{"protocol":["TCP_SSL","UDP"],"tls":"cert-secret"}} # Only supported in direct access mode. For more information, visit https://www.tencentcloud.com/document/product/457/36837. 
{"80":{"protocol":["QUIC"],"tls":"cert-secret"}}
Notes
The field cert-secret in TCP_SSL and HTTPS indicates that a certificate must be specified when you use the protocol. The certificate is an Opaque type Secret, the key of Secret is qcloud_cert_id, and the value is the certificate ID. For details, see Ingress Certificate Configuration.

Extension protocol use instructions

Use instructions of extension protocol `YAML`
Use instructions of extension protocols in the console
apiVersion: v1
kind: Service
metadata:
  annotations:  
    service.cloud.tencent.com/specify-protocol: '{"80":{"protocol":["TCP_SSL"],"tls":"cert-secret"}}' # To use other protocols, change the value in the key-value pair to the above content
  name: test
   ....
If you expose a Service in the form of "public network CLB" or "private network CLB" when creating it, in modes other than direct access mode, only TCP and TCP SSL can be used together in Port Mapping as shown below:

When the Service is in "ClusterIP" or "NodePort" mode, any protocols can be used together.
If you are using services with CLB-to-Pod direct access mode, hybrid use of any protocols is supported.

Cases

A native Service does not support hybrid use of protocols. Upon some special modifications, TKE supports hybrid use of protocols in CLB-to-Pod direct access mode.
Please note that the same protocol is used in YAML, but you can specify the protocol type for each port via the annotation. In the sample below, port 80 uses the TCP protocol, and port 8080 uses the UDP protocol.
apiVersion: v1
kind: Service
metadata:
  annotations:
    service.cloud.tencent.com/direct-access: "true"  # TKE Serverless clusters default to use the CLB-to-Pod direct access mode. For TKE clusters, you must enable the CLB-to-Pod direct access mode with reference to the document.
    service.cloud.tencent.com/specify-protocol: '{"80":{"protocol":["TCP"]},"8080":{"protocol":["UDP"]}}'   # It specifies that port 80 uses the TCP protocol, and port 8080 uses the UDP protocol.
  name: nginx
spec:
  externalTrafficPolicy: Cluster
  ports:
  - name: tcp-80-80
    nodePort: 32150
    port: 80
    protocol: TCP 
    targetPort: 80
  - name: udp-8080-8080
    nodePort: 31082
    port: 8080
    protocol: TCP # Note: Only the same type of protocols can be used because of the limits of Kubernetes Service Controller.
    targetPort: 8080 
  selector:
    k8s-app: nginx
    qcloud-app: nginx
  sessionAffinity: None
  type: LoadBalancer

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

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
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon