Docs

Volcengine Kubernetes Engine

CLB Ingress

Creating CLB Ingresses through kubectl

By configuring specific annotations in the Ingress YAML files, you can achieve more comprehensive Layer 7 LoadBalancer capabilities and more diverse service routing rules.

warning

Read CLB Ingress considerations carefully before getting started.

ALB Ingresses offer richer features and greater reliability. To ensure the security and stability of your business, we recommend ALB Ingresses for business deployments in clusters. For details, see ALB Ingress.

The annotations in YAML files are case-sensitive.

Prerequisites

The clusters have been created. For details, see Creating clusters.

The kubectl tool is installed on your computer. For details, please see Installation and settings of kubectl.

The target cluster has been connected through kubectl. For details, please see Connect to a cluster.

A service has been created. For details, see Creating services.

Creating CLB Ingresses

Binding to existing CLB instances

The LoadBalancer (CLB) instances mentioned below refer to those manually created on the console. For detailed instructions, see Creating LoadBalancer instances.

danger

Do not bind to CLB instances already used by API servers (either API servers of the current cluster or from another cluster). Otherwise, cluster failures may occur.

Here are the descriptions for the annotations included in the YAML file.

Parameter	Type	Required	Description	Default value	Changeable
ingress.vke.volcengine.com/loadbalancer-id	String	Yes	Specify an existing CLB instance ID.	No	No

Creating CLB instances

Use the following YAML configuration to create an Ingress and create a new CLB instance.

Here are the descriptions for the annotations included in the YAML file.

Parameter	Type	Required	Description	Default value	Changeable
ingress.vke.volcengine.com/loadbalancer-name	String	No	The name of the newly created LoadBalancer instance. If not specified, the system will generate one automatically.	No	No
ingress.vke.volcengine.com/loadbalancer-spec	String	Yes	Specification of the LoadBalancer instance. Available values: small_1, small_2, medium_1, medium_2, large_1, and large_2. For details, see Product types and specifications.	No	No
ingress.vke.volcengine.com/loadbalancer-subnet-id	String	Yes	Specify the subnet to which the created LoadBalancer instance belongs.	No	No
ingress.vke.volcengine.com/loadbalancer-address-type	String	No	Specify the type of LoadBalancer instance. Available values: public: A LoadBalancer instance accessible from the Internet. private: A LoadBalancer instance accessible only within private networks.	public	No
ingress.vke.volcengine.com/loadbalancer-isp-type	String	No	ISP type for EIP of an Internet-accessible LoadBalancer instance. The available types include BGP, SingleLine_BGP, Static_BGP, Fusion_BGP, ChinaMobile, ChinaTelecom, ChinaUnicom, ChinaMobile_Value, ChinaUnicom_Value, and ChinaTelecom_Value. For details, see EIP product documentation. warning Except for BGP, all the ISP types are beta features of EIP products. To apply for these features, contact your account manager.	BGP	No
ingress.vke.volcengine.com/loadbalancer-bandwidth	Integer	No	The maximum bandwidth of the EIP of an Internet-accessible LoadBalancer instance. Value: 1–500 Unit: Mbps	10	No
ingress.vke.volcengine.com/loadbalancer-ip-version	String	No	The IP version of the LoadBalancer instance. Value: ipv4.	IPv4	No
ingress.vke.volcengine.com/loadbalancer-scheduler	String	No	Scheduling algorithms used by LoadBalancer. Available values: wrr: Backend servers with higher weight values are polled more frequently (with higher probability). wlc: Forward requests to the backend server that has the lowest ratio of current connections to weight. sh: A hash-based algorithm that forwards requests from the same IP to a single backend server.	wrr	No
ingress.vke.volcengine.com/loadbalancer-protocol	String	No	The listening protocol of the LoadBalancer instance. Available values: http: The listening protocol for the LoadBalancer instance is HTTP. https: The listening protocol of the LoadBalancer instance is HTTPS.	http	No
ingress.vke.volcengine.com/loadbalancer-port	Integer	No	The listening port of LoadBalancer ranges from 1 to 65535.	HTTPS protocol: 443 HTTP protocol: 80	No
ingress.vke.volcengine.com/loadbalancer-eip-BandwidthPackageId	String	No	Specify the shared bandwidth package for the EIP. tip A shared bandwidth package is a reusable cloud resource for bandwidth sharing. It aggregates multiple public IPs and IPv6 public bandwidths from the same region into a shared bandwidth pool, reducing public bandwidth costs through bandwidth sharing. For details, see What is a shared bandwidth package.	No	Yes

Result validation

Execute the following command to view the newly created Ingress.

The information below is expected to be printed on the screen.

tip

ADDRESS is the Elastic IP Address (EIP) of the CLB for this Ingress. You can use this IP to find the corresponding CLB instance on the LoadBalancer console.

Execute the following command to view the detailed information of the specified Ingress.

The information below is expected to be printed on the screen. The annotations below show the information about the CLB, including CLB ID, listener, and health check. For details, see Using annotations to configure CLB Ingresses.

Last updated: 2026.07.24 14:51:36