Volcengine Kubernetes Engine
Volcengine Kubernetes Engine
Volcengine Kubernetes Engine
Document
Volcengine Kubernetes Engine
What's New
History feature release notes
Kubernetes version release notes
Containerd runtime release notes
Add-on release notes
Monitoring add-ons
Scheduling add-ons
DNS add-ons
Security add-ons
GPU add-ons
Sandbox add-on
Security announcements
Product Announcement
Historical announcements
Overview
Getting started
User guide
Clusters
Creating clusters
Connecting to clusters
Upgrading clusters
Node pool
Creating node pools
Scaling out/in node pools
Nodes
Authorization management
Image
Namespaces
Networking
Cluster network
Container Network
Service
LoadBalancer
CLB
Ingress
APIG Ingress
ALB Ingress
Customize ALB Ingress forwarding rules
Certificate and security
CLB Ingress
Nginx Ingress
Gateway API
Workloads
Creating workloads
Configure workloads
Pods
Configuration management
Image acceleration
Storage
FSX client
EBS Volumes
TOS Volumes
NAS volumes
FSX access methods
NFS access methods
EFS volumes
vePFS volumes
FSX access methods
vePFS Client access methods
NFS access methods
CloudFS volumes
Local volumes
Autoscale
Node autoscaler
Workload autoscaler
Horizontal Pod Autoscaler (HPA)
Cron Horizontal Pod Autoscaler (CronHPA)
Intelligent Horizontal Pod Autoscaler (IHPA)
Horizontal Pod Autoscaler based on event-driven (KEDA)
Add-on management
Network add-ons
Storage add-ons
Monitoring add-ons
Scheduling add-ons
DNS add-ons
GPU add-ons
Core add-ons
Sandbox add-on
Upgrading add-ons
Heterogeneous computing
NVIDIA GPU
mGPU scheduling
RDMA high-performance computing
Scheduling management
Topology-aware scheduling
QoS-aware scheduling
Observability
Log management
Basic observation
Setup & Configuration
Cluster observation
Storage observation
Other observation
Using metrics
Full stack observation
Alert management
Diagnosis and inspection
Node check and self-healing
Application center
Backup center
Stability
Large-scale cluster management
Best practices
Authorization
Clusters
Nodes and node pools
Networking
Storage
Scheduling
Observability
Solution
Security and compliance
API reference
Cluster management
NodePool management
Node management
Virtual nodes management
Add-on management
Tag management
Access policy management
Instance images management
Cloud native observability
Inspection and diagnosis
Task management
Volcengine Container Instance
Appendix
SDK reference
Development guide
Terraform
FAQs
General FAQs
Cluster FAQ
cluster management
cluster network
cluster upgrade
Node and Node pool FAQs
Authorization FAQs
Workload FAQs
Service and Ingress FAQs
Storage FAQs
Heterogeneous computing FAQs
Observability FAQs
Quota FAQs
Add-on FAQs
Cloud-native AI
ServingKit
LLM applications
ComfyUI application
Deploying the Al inference application through Helm
Deepseek practices
Qwen practices
Kimi practice
Seed practices
Best practices
DeepSeek model deployment
GLM model deployment
MiniMax model deployment
Qwen model deployment
Kimi model deployment
Volcengine Container Instance
What's new
Historical feature release notes
Product Announcement
Overview
Billing
User guide
Integrating with VCI
Virtual node
VKE cluster uses virtual nodes
Self-managed/third-party cluster uses virtual node
Creating an instance
General purpose instance
GPU-accelerated computing instance
VCI Agent Sandbox
Startup acceleration
E2B-based management
Upgrade guide
Networking
Monitoring
Scheduling
Container configuration
VCI Image Cache
Best practices
Security and compliance
FAQs
- Documentation
Volcengine Kubernetes EngineVolcengine Kubernetes EngineUser guideNetworkingIngressCLB IngressConfiguring CLB Ingress through annotations
Copy page
Download PDFCLB Ingress
Configuring CLB Ingress through annotations
Copy pageDownload PDFConfiguring CLB Ingress through annotations
CLB Ingress can provide richer features through annotations. This topic introduces the typical scenarios of configuring CLB Ingress through annotations.
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.
Configuring listeners
tip
A listener can be created based on an existing CLB instance or a new CLB instance. The following examples will use an existing CLB instance. The listeners of CLB Ingress can be configured through annotations. The following is an example YAML with comments for annotations.
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations:
ingress.vke.volcengine.com/loadbalancer-id: "clb-rrxpqzg37eo0v0x58******"
ingress.vke.volcengine.com/loadbalancer-scheduler: "wrr"
ingress.vke.volcengine.com/loadbalancer-protocol: "http"
ingress.vke.volcengine.com/loadbalancer-port: "80"
name: clb-ingress
namespace: default
spec:
ingressClassName: clb
rules:
- host: example.com
http:
paths:
- backend:
service:
name: service-demo-a
port:
number: 80
path: /foo
pathType: Prefix
- backend:
service:
name: service-demo
port:
number: 80
path: /bar
pathType: Prefix
Here are the descriptions for the annotations included in the YAML file.
Key | Type | Required | Description | Default value |
Key | Type | Required | Description | Default value |
ingress.vke.volcengine.com/loadbalancer-scheduler | String | No | The scheduling algorithms used by the load balancer. Available values:
| wrr |
ingress.vke.volcengine.com/loadbalancer-protocol | String | No | The listening protocol of the LoadBalancer instance. Available values:
| http |
ingress.vke.volcengine.com/loadbalancer-port | Integer | No | The external listening port of LoadBalancer, which is registered to the LoadBalancer service address. The value can range from 1 to 65535. |
|
Configuring LB-to-pod direct access mode
tip
- The LB-to-pod direct access mode is only effective in clusters running with VPC-CNI network model.
- LB-to-pod direct access mode can be enabled when specifying an existing CLB instance or creating a new CLB instance. The following examples will use an existing CLB instance. LB-to-pod direct access mode can be configured for CLB Ingress through annotations. The following is an example YAML with comments for annotations.
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations:
ingress.vke.volcengine.com/loadbalancer-id: "clb-rrxpqzg37eo0v0x58******"
ingress.vke.volcengine.com/loadbalancer-pass-through: "true"
name: clb-ingress
namespace: default
spec:
ingressClassName: clb
rules:
- host: example.com
http:
paths:
- backend:
service:
name: service-demo
port:
number: 80
path: /
pathType: Prefix
Here are the descriptions for the annotations included in the YAML file.
Key | Type | Required | Description | Default value |
Key | Type | Required | Description | Default value |
ingress.vke.volcengine.com/loadbalancer-pass-through | String | Yes | Whether to enable LB-to-pod direct access mode for LoadBalancer. Available values:
| true |
Configuring health check
tip
Health checking can be configured when specifying an existing CLB instance or creating a new CLB instance. The following examples will use an existing CLB instance. Health checking in CLB Ingress can be configured through annotations. The following is an example YAML for annotations.
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations:
ingress.vke.volcengine.com/loadbalancer-id: "clb-rrxpqzg37eo0v0x58******"
ingress.vke.volcengine.com/loadbalancer-healthcheck-enabled: "true"
ingress.vke.volcengine.com/loadbalancer-healthcheck-path: "/"
ingress.vke.volcengine.com/loadbalancer-healthcheck-method: "GET"
ingress.vke.volcengine.com/loadbalancer-healthcheck-httpcode: "http_2xx,http_3xx"
ingress.vke.volcengine.com/loadbalancer-healthcheck-timeout: "2"
ingress.vke.volcengine.com/loadbalancer-healthcheck-interval: "2"
ingress.vke.volcengine.com/loadbalancer-healthy-threshold: "3"
ingress.vke.volcengine.com/loadbalancer-unhealthy-threshold: "3"
name: clb-ingress
namespace: default
spec:
ingressClassName: clb
rules:
- host: example.com
http:
paths:
- backend:
service:
name: service-demo
port:
number: 80
path: /
pathType: Prefix
Here are the descriptions for the annotations included in the YAML file.
Key | Type | Required | Description | Default value |
Key | Type | Required | Description | Default value |
ingress.vke.volcengine.com/loadbalancer-healthcheck-enabled | String | Yes | Whether to enable a health check. Available values:
| true |
ingress.vke.volcengine.com/loadbalancer-healthcheck-path | String | No | Health checking path. | / |
ingress.vke.volcengine.com/loadbalancer-healthcheck-method | String | No | Request methods for health checking. Available values: GET, HEAD. | GET |
ingress.vke.volcengine.com/loadbalancer-healthcheck-httpcode | String | No | Set status codes for health checks. Available values: http_2xx, http_3xx, http_4xx, and http_5xx | http_2xx,http_3xx |
ingress.vke.volcengine.com/loadbalancer-healthcheck-timeout | String | No | Specify a timeout for health checking.
| 2 |
ingress.vke.volcengine.com/loadbalancer-healthcheck-interval | String | No | Specify the interval between health checks.
| 2 |
ingress.vke.volcengine.com/loadbalancer-healthy-threshold | String | No | The number of consecutive health check requests required to determine that the backend server is running properly.
| 3 |
ingress.vke.volcengine.com/loadbalancer-unhealthy-threshold | String | No | The number of consecutive health check requests required to determine that the backend server is not running properly.
| 3 |
Last updated: 2026.07.24 14:51:36
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
