This version is under construction, please use an official release version

Install KubeLB Manager and set up the management cluster

Prerequisites

  • Service type LoadBalancer implementation. This can be a cloud solution or a self-managed implementation like MetalLB.
  • Network access to the tenant cluster nodes with node port range (default: 30000-32767). This is required for the envoy proxy to be able to connect to the tenant cluster nodes. With the mTLS backend transport mode (Enterprise Edition), the proxies instead connect to the tenant proxy on its NodePort, or on the fixed port 15443 when it is exposed through a LoadBalancer service.

See Requirements for the full port and resource sizing reference.

Install KubeLB Manager

If you enable Gateway API support, install its CRDs first and set kubelb.enableGatewayAPI to true in values.yaml. Without the CRDs, KubeLB Manager cannot start.

Prerequisites

  • Create a kubelb namespace for KubeLB Manager.
  • Create the required imagePullSecrets in that namespace so the chart can pull Enterprise Edition images.

A minimal values.yaml looks like this:

imagePullSecrets:
  - name: <imagePullSecretName>

Install the Helm chart

helm pull oci://quay.io/kubermatic/helm-charts/kubelb-manager-ee --version=v1.4.3 --untardir "." --untar
## Apply CRDs
kubectl apply -f kubelb-manager-ee/crds/
## Create and update values.yaml with the required values.
helm upgrade --install kubelb-manager kubelb-manager-ee --namespace kubelb -f kubelb-manager-ee/values.yaml --create-namespace

Helm applies a chart’s crds/ directory only on helm install and silently skips it on helm upgrade. This applies to the addon subcharts too, so the Gateway API, Envoy Gateway and External DNS CRDs are never updated by Helm. Re-apply the CRDs on every upgrade — see Upgrading KubeLB.

KubeLB Manager EE Values

KeyTypeDefaultDescription
affinityobject{}
autoscaling.enabledboolfalse
autoscaling.maxReplicasint10
autoscaling.minReplicasint1
autoscaling.targetCPUUtilizationPercentageint80
autoscaling.targetMemoryUtilizationPercentageint80
cert-manager.enabledboolfalseEnable cert-manager.
external-dns.enabledboolfalseEnable External-DNS.
fullnameOverridestring""
grafana.dashboards.annotationsobject{}Additional annotations for dashboard ConfigMaps
grafana.dashboards.enabledboolfalseRequires grafana to be deployed with sidecar.dashboards.enabled=true. For more info: https://github.com/grafana/helm-charts/tree/grafana-10.5.13/charts/grafana#:~:text=%5B%5D-,sidecar.dashboards.enabled,-Enables%20the%20cluster
image.pullPolicystring"IfNotPresent"
image.repositorystring"quay.io/kubermatic/kubelb-manager-ee"
image.tagstring"v1.3.9"
imagePullSecrets[0].namestring"kubermatic-quay.io"
kkpintegration.rbacboolfalseCreate RBAC for KKP integration.
kubeRbacProxy.image.pullPolicystring"IfNotPresent"
kubeRbacProxy.image.repositorystring"quay.io/brancz/kube-rbac-proxy"
kubeRbacProxy.image.tagstring"v0.20.1"
kubelb.debugbooltrue
kubelb.disableEnvoyGatewayFeaturesboolfalsedisableEnvoyGatewayFeatures disables Envoy Gateway support for BackendTrafficPolicy and ClientTrafficPolicy. Use this if you’re using a Gateway API implementation other than Envoy Gateway.
kubelb.enableGatewayAPIboolfalseenableGatewayAPI specifies whether to enable the Gateway API and Gateway Controllers. By default Gateway API is disabled since without Gateway APIs installed the controller cannot start.
kubelb.enableLeaderElectionbooltrue
kubelb.enableWAFboolfalse[Beta feature] Enables Web Application Firewall policy validation and reconciliation. WAF is disabled by default.
kubelb.envoyProxy.affinityobject{}
kubelb.envoyProxy.gracefulShutdown.disabledboolfalseDisable graceful shutdown (default: false)
kubelb.envoyProxy.nodeSelectorobject{}
kubelb.envoyProxy.replicasint2The number of replicas for the Envoy Proxy deployment.
kubelb.envoyProxy.resourcesobject{}
kubelb.envoyProxy.singlePodPerNodebooltrueDeploy single pod per node.
kubelb.envoyProxy.tolerationslist[]
kubelb.envoyProxy.topologystring"shared"Topology defines the deployment topology for Envoy Proxy. Valid values are: shared and global.
kubelb.envoyProxy.useDaemonsetboolfalseUse DaemonSet for Envoy Proxy deployment instead of Deployment.
kubelb.logLevelstring"info"To configure the verbosity of logging. Can be one of ‘debug’, ‘info’, ’error’, ‘panic’ or any integer value > 0 which corresponds to custom debug levels of increasing verbosity.
kubelb.propagateAllAnnotationsboolfalsePropagate all annotations from the LB resource to the LB service.
kubelb.propagatedAnnotationsobject{}Allowed annotations that will be propagated from the LB resource to the LB service.
kubelb.skipConfigGenerationboolfalseSet to true to skip the generation of the Config CR. Useful when the config CR needs to be managed manually.
kubelb.tunnel.connectionManager.affinityobject{}
kubelb.tunnel.connectionManager.healthCheck.enabledbooltrue
kubelb.tunnel.connectionManager.healthCheck.livenessInitialDelayint30
kubelb.tunnel.connectionManager.healthCheck.readinessInitialDelayint10
kubelb.tunnel.connectionManager.httpAddrstring":8080"Server addresses
kubelb.tunnel.connectionManager.httpRoute.annotationsobject{"cert-manager.io/cluster-issuer":"letsencrypt-prod","external-dns.alpha.kubernetes.io/hostname":"connection-manager.${DOMAIN}"}Annotations for HTTPRoute
kubelb.tunnel.connectionManager.httpRoute.domainstring"connection-manager.${DOMAIN}"Domain for the HTTPRoute NOTE: Replace ${DOMAIN} with your domain name.
kubelb.tunnel.connectionManager.httpRoute.enabledboolfalse
kubelb.tunnel.connectionManager.httpRoute.gatewayNamestring"gateway"Gateway name to attach to
kubelb.tunnel.connectionManager.httpRoute.gatewayNamespacestring""Gateway namespace
kubelb.tunnel.connectionManager.imageobject{"pullPolicy":"IfNotPresent","repository":"quay.io/kubermatic/kubelb-connection-manager-ee","tag":""}Connection manager image configuration
kubelb.tunnel.connectionManager.ingressobject{"annotations":{"cert-manager.io/cluster-issuer":"letsencrypt-prod","external-dns.alpha.kubernetes.io/hostname":"connection-manager.${DOMAIN}","nginx.ingress.kubernetes.io/backend-protocol":"HTTP","nginx.ingress.kubernetes.io/proxy-read-timeout":"3600","nginx.ingress.kubernetes.io/proxy-send-timeout":"3600"},"className":"nginx","enabled":false,"hosts":[{"host":"connection-manager.${DOMAIN}","paths":[{"path":"/tunnel","pathType":"Prefix"},{"path":"/health","pathType":"Prefix"}]}],"tls":[{"hosts":["connection-manager.${DOMAIN}"],"secretName":"connection-manager-tls"}]}Ingress configuration for external HTTP/2 access
kubelb.tunnel.connectionManager.nodeSelectorobject{}
kubelb.tunnel.connectionManager.podAnnotationsobject{}Pod configuration
kubelb.tunnel.connectionManager.podLabelsobject{}
kubelb.tunnel.connectionManager.podSecurityContext.fsGroupint65534
kubelb.tunnel.connectionManager.podSecurityContext.runAsNonRootbooltrue
kubelb.tunnel.connectionManager.podSecurityContext.runAsUserint65534
kubelb.tunnel.connectionManager.replicaCountint1Number of connection manager replicas
kubelb.tunnel.connectionManager.requestTimeoutstring"30s"
kubelb.tunnel.connectionManager.resourcesobject{"limits":{"cpu":"500m","memory":"256Mi"},"requests":{"cpu":"250m","memory":"128Mi"}}Resource limits
kubelb.tunnel.connectionManager.securityContextobject{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true,"runAsNonRoot":true,"runAsUser":65534}Security context
kubelb.tunnel.connectionManager.serviceobject{"httpPort":8080,"type":"ClusterIP"}Service configuration
kubelb.tunnel.connectionManager.tolerationslist[]
kubelb.tunnel.enabledboolfalseEnable tunnel functionality
metrics.portint9443Port where the manager exposes metrics (includes both manager and envoycp metrics)
nameOverridestring""
nodeSelectorobject{}
podAnnotationsobject{}
podLabelsobject{}
podSecurityContext.runAsNonRootbooltrue
podSecurityContext.seccompProfile.typestring"RuntimeDefault"
priorityClassNamestring""PriorityClassName for the manager pod (e.g., “system-cluster-critical”)
rbac.allowLeaderElectionRolebooltrue
rbac.allowMetricsReaderRolebooltrue
rbac.allowProxyRolebooltrue
rbac.enabledbooltrue
replicaCountint1
resources.limits.cpustring"500m"
resources.limits.memorystring"512Mi"
resources.requests.cpustring"100m"
resources.requests.memorystring"128Mi"
securityContext.allowPrivilegeEscalationboolfalse
securityContext.capabilities.drop[0]string"ALL"
securityContext.runAsUserint65532
service.portint8001
service.protocolstring"TCP"
service.typestring"ClusterIP"
serviceAccount.annotationsobject{}
serviceAccount.createbooltrue
serviceAccount.namestring""
serviceMonitor.enabledboolfalse
tolerationslist[]

Install the Helm chart

helm pull oci://quay.io/kubermatic/helm-charts/kubelb-manager --version=v1.4.3 --untardir "." --untar
## Apply CRDs
kubectl apply -f kubelb-manager/crds/
## Create and update values.yaml with the required values.
helm upgrade --install kubelb-manager kubelb-manager --namespace kubelb -f kubelb-manager/values.yaml --create-namespace

Helm applies a chart’s crds/ directory only on helm install and silently skips it on helm upgrade. This applies to the addon subcharts too, so the Gateway API, Envoy Gateway and External DNS CRDs are never updated by Helm. Re-apply the CRDs on every upgrade — see Upgrading KubeLB.

KubeLB Manager CE Values

KeyTypeDefaultDescription
affinityobject{}
autoscaling.enabledboolfalse
autoscaling.maxReplicasint10
autoscaling.minReplicasint1
autoscaling.targetCPUUtilizationPercentageint80
autoscaling.targetMemoryUtilizationPercentageint80
fullnameOverridestring""
grafana.dashboards.annotationsobject{}Additional annotations for dashboard ConfigMaps
grafana.dashboards.enabledboolfalseRequires grafana to be deployed with sidecar.dashboards.enabled=true. For more info: https://github.com/grafana/helm-charts/tree/grafana-10.5.13/charts/grafana#:~:text=%5B%5D-,sidecar.dashboards.enabled,-Enables%20the%20cluster
image.pullPolicystring"IfNotPresent"
image.repositorystring"quay.io/kubermatic/kubelb-manager"
image.tagstring"v1.3.9"
imagePullSecretslist[]
kkpintegration.rbacboolfalseCreate RBAC for KKP integration.
kubeRbacProxy.image.pullPolicystring"IfNotPresent"
kubeRbacProxy.image.repositorystring"quay.io/brancz/kube-rbac-proxy"
kubeRbacProxy.image.tagstring"v0.20.1"
kubelb.debugbooltrue
kubelb.enableGatewayAPIboolfalseenableGatewayAPI specifies whether to enable the Gateway API and Gateway Controllers. By default Gateway API is disabled since without Gateway APIs installed the controller cannot start.
kubelb.enableLeaderElectionbooltrue
kubelb.envoyProxy.affinityobject{}
kubelb.envoyProxy.gracefulShutdown.disabledboolfalseDisable graceful shutdown (default: false)
kubelb.envoyProxy.nodeSelectorobject{}
kubelb.envoyProxy.replicasint2The number of replicas for the Envoy Proxy deployment.
kubelb.envoyProxy.resourcesobject{}
kubelb.envoyProxy.singlePodPerNodebooltrueDeploy single pod per node.
kubelb.envoyProxy.tolerationslist[]
kubelb.envoyProxy.topologystring"shared"Topology defines the deployment topology for Envoy Proxy. Valid values are: shared and global.
kubelb.envoyProxy.useDaemonsetboolfalseUse DaemonSet for Envoy Proxy deployment instead of Deployment.
kubelb.logLevelstring"info"To configure the verbosity of logging. Can be one of ‘debug’, ‘info’, ’error’, ‘panic’ or any integer value > 0 which corresponds to custom debug levels of increasing verbosity.
kubelb.propagateAllAnnotationsboolfalsePropagate all annotations from the LB resource to the LB service.
kubelb.propagatedAnnotationsobject{}Allowed annotations that will be propagated from the LB resource to the LB service.
kubelb.skipConfigGenerationboolfalseSet to true to skip the generation of the Config CR. Useful when the config CR needs to be managed manually.
metrics.portint9443Port where the manager exposes metrics (includes both manager and envoycp metrics)
nameOverridestring""
nodeSelectorobject{}
podAnnotationsobject{}
podLabelsobject{}
podSecurityContext.runAsNonRootbooltrue
podSecurityContext.seccompProfile.typestring"RuntimeDefault"
rbac.allowLeaderElectionRolebooltrue
rbac.allowMetricsReaderRolebooltrue
rbac.allowProxyRolebooltrue
rbac.enabledbooltrue
replicaCountint1
resources.limits.cpustring"500m"
resources.limits.memorystring"512Mi"
resources.requests.cpustring"100m"
resources.requests.memorystring"128Mi"
securityContext.allowPrivilegeEscalationboolfalse
securityContext.capabilities.drop[0]string"ALL"
securityContext.runAsUserint65532
service.portint8001
service.protocolstring"TCP"
service.typestring"ClusterIP"
serviceAccount.annotationsobject{}
serviceAccount.createbooltrue
serviceAccount.namestring""
serviceMonitor.enabledboolfalse
tolerationslist[]

Verify the installation

Check that the manager is running:

kubectl get pods -n kubelb
NAME                              READY   STATUS    RESTARTS   AGE
kubelb-manager-6d95d7f45d-xz2lp   2/2     Running   0          1m

The kubelb-manager pod must be in Running state. Envoy proxy pods appear in the tenant namespaces later, once tenants are registered and load balancers are created.

Set up the management cluster

The examples and tools shared below are for demonstration purposes, you can use any other tools or configurations as per your requirements.

The management cluster acts as the data plane and central control plane for all your load balancing configurations. All the components required for Layer 4 and Layer 7 load balancing, AI Gateways, MCP Gateways, Agent2Agent Gateways, API Gateways etc. are deployed here. The management cluster is multi-tenant and can serve a whole fleet of clusters.

KubeLB has introduced an addons chart to simplify the installation of the required components for the management cluster. The chart is already part of the KubeLB manager chart and can be installed by setting the kubelb-addons.enabled to true in the values.yaml.

kubelb:
  enableGatewayAPI: true
  debug: true

## Addon configuration
kubelb-addons:
  enabled: true

  gatewayClass:
    create: true

  # Ingress Nginx
  ingress-nginx:
    enabled: false
    controller:
      service:
        externalTrafficPolicy: Local

  # Envoy Gateway
  envoy-gateway:
    enabled: true

  # Cert Manager
  cert-manager:
    enabled: true
    crds:
      enabled: true
    config:
      apiVersion: controller.config.cert-manager.io/v1alpha1
      kind: ControllerConfiguration
      enableGatewayAPI: true

  # External DNS
  external-dns:
    domainFilters:
      - example.com
    extraVolumes:
      - name: credentials
        secret:
          secretName: route53-credentials
    extraVolumeMounts:
      - name: credentials
        mountPath: /.aws
        readOnly: true
    env:
      - name: AWS_SHARED_CREDENTIALS_FILE
        value: /.aws/credentials
    txtOwnerId: kubelb-example-aws
    registry: txt
    provider: aws
    policy: sync
    sources:
      - service
      - ingress
      - gateway-httproute
      - gateway-grpcroute
      - gateway-tlsroute
      - gateway-tcproute
      - gateway-udproute

  ## AI, MCP and Agent2Agent Gateways Integration
  agentgateway-crds:
    enabled: true

  agentgateway:
    enabled: true

Custom Image Registry

The kubelb-addons chart honors global.imageRegistry and global.imagePullSecrets and propagates both to every addon subchart (ingress-nginx, envoy-gateway, cert-manager, external-dns, metallb, agentgateway). Set them on the top-level install to route all addon images through a private mirror and attach a pull secret, without editing each subchart’s own values. See the Air-Gap Installation guide for the full end-to-end mirroring workflow; the same flags apply to non-airgap setups pulling from a company registry.

Client Header Size Limits

Envoy rejects requests whose combined client headers exceed 60 KiB with a 431 Request Header Fields Too Large response. Workloads that carry large Authorization/JWT tokens, long cookies, or many tracing headers can hit this limit.

An L7 request passes through two Envoy hops: the Envoy Gateway edge proxy, and then KubeLB’s own managed Envoy. Both must allow the larger headers, otherwise the request is rejected at whichever hop still enforces the 60 KiB default.

KubeLB’s managed Envoy limits are set on the Config resource under spec.envoyProxy.headerLimits:

apiVersion: kubelb.k8c.io/v1alpha1
kind: Config
metadata:
  name: default
  namespace: kubelb
spec:
  envoyProxy:
    headerLimits:
      # Max request header block size in KiB. Range (0, 8192]. Defaults to 8192.
      maxRequestHeadersKb: 8192
      # Max number of request headers. Defaults to 4096.
      maxRequestHeadersCount: 4096
      # Max upstream response header block size in KiB. Range (0, 8192]. Defaults to 8192.
      maxResponseHeadersKb: 8192

All three fields default to Envoy’s maximum, so out of the box KubeLB’s managed Envoy never rejects headers the edge already accepted. Lower them if you want the managed Envoy to enforce a smaller cap.

On the Gateway API path the effective ceiling is therefore Envoy Gateway’s stock limits of 100 request headers / 60 KiB, not KubeLB’s: oversized requests are rejected with 431 at the Envoy Gateway hop before KubeLB’s configured limits apply, unless a ClientTrafficPolicy raising them is attached to the Gateway.

The Envoy Gateway edge is not managed by KubeLB. Raise its limit yourself on the EnvoyProxy resource that your GatewayClass references, for example with a bootstrap runtime layer:

apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
  name: kubelb-proxy-config
  namespace: kubelb
spec:
  bootstrap:
    type: Merge
    value: |
      layered_runtime:
        layers:
        - name: header-limits
          static_layer:
            envoy.reloadable_features.max_request_headers_size_kb: 96

TCP/UDP Load Balancing (Layer 4)

Refer to Layer 4 Load Balancing Setup for more details.

Application Layer Load Balancing (Layer 7)

For Application layer load balancing, kubeLB supports both Ingress and Gateway API resources.

Our default recommendation is to use Gateway API and use Envoy Gateway as the Gateway API implementation. Most of the upcoming and current features that KubeLB will focus on will prioritize Gateway API instead of Ingress. With Envoy Gateway being the product that we’ll actively support, test, and base our features on.

While KubeLB supports integration with any Ingress or Gateway API implementation, the only limitation is that we only support native Kubernetes APIs i.e. Ingress and Gateway APIs. Provider specific APIs are not supported by KubeLB and will be completely ignored. Also, we are only testing KubeLB with Envoy Gateway and Nginx Ingress, we can’t guarantee the compatibility with other Gateway API or Ingress implementations.

Ingress

Refer to Ingress Setup for more details.

Gateway API

Refer to Gateway API Setup for more details.

Certificate Management(Enterprise Edition)

Refer to Certificate Management Setup for more details.

DNS Management(Enterprise Edition)

Refer to DNS Management Setup for more details.