Install KubeLB Manager and setup Management Cluster

Requirements

  • 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.

Installation for KubeLB manager

In case if Gateway API needs to be enabled for the cluster. Please set kubelb.enableGatewayAPI to true in the values.yaml. This is required otherwise due to missing CRDs, kubelb will not be able to start.

Prerequisites

  • Create a namespace kubelb for the CCM to be deployed in.
  • Create imagePullSecrets for the chart to pull the image from the registry in kubelb namespace.

At this point a minimal values.yaml should look like this:

imagePullSecrets:
  - name: <imagePullSecretName>

Install the helm chart

helm pull oci://quay.io/kubermatic/helm-charts/kubelb-manager-ee --version=v1.1.1 --untardir "." --untar
## 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

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""
image.pullPolicystring"IfNotPresent"
image.repositorystring"quay.io/kubermatic/kubelb-manager-ee"
image.tagstring"v1.1.1"
imagePullSecrets[0].namestring"kubermatic-quay.io"
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.enableTenantMigrationbooltrue
kubelb.envoyProxy.affinityobject{}
kubelb.envoyProxy.nodeSelectorobject{}
kubelb.envoyProxy.replicasint3The 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.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.
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[]

Install the helm chart

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

KubeLB Manager CE Values

KeyTypeDefaultDescription
affinityobject{}
autoscaling.enabledboolfalse
autoscaling.maxReplicasint10
autoscaling.minReplicasint1
autoscaling.targetCPUUtilizationPercentageint80
autoscaling.targetMemoryUtilizationPercentageint80
fullnameOverridestring""
image.pullPolicystring"IfNotPresent"
image.repositorystring"quay.io/kubermatic/kubelb-manager"
image.tagstring"v1.1.1"
imagePullSecretslist[]
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.enableTenantMigrationbooltrue
kubelb.envoyProxy.affinityobject{}
kubelb.envoyProxy.nodeSelectorobject{}
kubelb.envoyProxy.replicasint3The 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.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.
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[]

Setup 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.

Management cluster is the place where all the components required for Layer 4 and Layer 7 load balancing are installed. The management cluster is responsible for managing the tenant clusters and their load balancing requests/configurations.

Layer 4 Load Balancing

Refer to Layer 4 Load Balancing Setup for more details.

Layer 7 Load Balancing

For Layer 7 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. The features specific to Gateway API that will be built and consumed in KubeLB will be based on Envoy Gateway. Although this is not a strict binding and our consumers are free to use 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.

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.