MetalLB load balancer

MetalLB is a load balancer designed for bare metal Kubernetes clusters that uses standard routing protocols.

Prerequisites

An MKE cluster that does not already have load-balancing functionality.
A MetalLB-compatible cluster network configuration.
kube-proxy running in iptables mode.
The absence of any cloud provider configuration.

Configuration

MetalLB is configured through the addons section of the MKE 4 configuration file. The function is disabled by default, and thus to use MetalLB you must set the enabled parameter to true.

MetalLB example configuration:

spec:
  addons:
    - chart:
        name: metallb
        repo: https://metallb.github.io/metallb
        values: |
          controller:
            tolerations:
              - key: node-role.kubernetes.io/master
                operator: Exists
                effect: NoSchedule
          speaker:
            frr:
              enabled: false          
        version: 0.14.7
      dryRun: false
      enabled: true
      kind: chart
      name: metallb
      namespace: metallb-system

ℹ️

The example above presents a MetalLB configuration that is deployed by a Helm chart within the cluster. Free Range Routing (FRR) mode is disabled by default.

To configure MetalLB:

Obtain the default MKE 4 configuration file:
```
mkectl init
```
Set the enabled parameter for metallb in the addons section to true.

Apply the configuration:

mkectl apply -f <mke-configuration-file>

Verify the successful deployment of MetalLB in the cluster:

kubectl get pods,services,deployments -n metallb-system -l app.kubernetes.io/name=metallb

Example output:

NAME                                      READY   STATUS    RESTARTS   AGE
pod/metallb-controller-79d6b8bb85-c2hrm   1/1     Running   0          17m
pod/metallb-speaker-ccpdf                 1/1     Running   0          17m
pod/metallb-speaker-x2pgf                 1/1     Running   0          17m

NAME                              TYPE        CLUSTER-IP    EXTERNAL-IP   PORT(S)   AGE
service/metallb-webhook-service   ClusterIP   10.96.8.155   none          443/TCP   17m

NAME                                 READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/metallb-controller   1/1     1            1           17m

Configuration parameters

The default configuration parameters for the MetalLB add-on are detailed in the following table:

Field	Description	Default
`kind`	Type of add-on.	`chart`
`enabled`	Enablement state of add-on.	`false`
`name`	Name of the add-on.	`metallb`
`namespace`	Namespace used for deploying MetalLB.	`metallb-system`
`chart.name`	Name of the MetalLB Helm chart.	`metallb`
`chart.repo`	MetalLB Helm repository.	`https://metallb.github.io/metallb`
`chart.version`	Version of the MetalLB Helm chart.	`0.14.7`
`chart.values.controller.tolerations`	Tolerations for the MetalLB controller pod.	YAML: - key: node-role.kubernetes.io/master operator: Exists effect: NoSchedule
`chart.values.speaker.frr.enabled`	Enablement state of FRR with regard to MetalLB speaker.	`false`

An MKE version comparison for MetalLB configuration parameters is offered in the following table:

MKE-3	MKE-4
`[cluster_config.metallb_config.enabled]`	`addons.metallb.enabled`
`[[cluster_config.metallb_config.metallb_ip_addr_pool]]`	`Deprecated`

IP address pool configuration

Support for IP address pool configuration is deprecated in MKE 4, and as such the configuration must now be managed independently.

Create IP address pools in a fresh installation

For information on how to create IP address pools, refer to the official MetalLB documentation, Layer 2 configuration.

The following example configuration gives MetalLB control over IPs from 192.168.1.240 to 192.168.1.250, and configures Layer 2 mode.

---
apiVersion: metallb.io/v1beta1
kind: IPAddressPool
metadata:
  name: cheap
  namespace: metallb-system
spec:
  addresses:
  - 192.168.10.0/24
---
apiVersion: metallb.io/v1beta1
kind: L2Advertisement
metadata:
  name: empty
  namespace: metallb-system

As necessary, refer to the official MetalLB documentation, Advanced AddressPool.

Managing IP address pools during upgrade

During an upgrade from MKE 3 to MKE 4, if metalLB is enabled in the former the configured IP address pool details display in the upgrade summary.

The following example configuration presents MetalLB enabled in MKE 3:

[cluster_config.metallb_config]
  enabled = true

  [[cluster_config.metallb_config.metallb_ip_addr_pool]]
    name = "example1"
    external_ip = ["192.168.10.0/24", "192.168.1.0/24"]
  [[cluster_config.metallb_config.metallb_ip_addr_pool]]
    name = "example2"
    external_ip = ["192.155.10.0/24"]

The upgrade summary presents as follows:

MetalLB IP address pools
---------------
name: example1
ipaddress: [192.168.10.0/24 192.168.1.0/24]

name: example2
ipaddress: [192.155.10.0/24]

Please make sure that you create these pools after MKE4 installation is complete.

Refer to the upgrade summary for guidance in the creation of IP address pools. To create the pools, you can use the template that follows or consult the official MetalLB documentation Layer 2 configuration for assistance.

apiVersion: metallb.io/v1beta1
kind: IPAddressPool
metadata:
  name: example1
  namespace: metallb-system
spec:
  addresses:
  - 192.168.10.0/24
  - 192.168.1.0/24
---
apiVersion: metallb.io/v1beta1
kind: IPAddressPool
metadata:
  name: example2
  namespace: metallb-system
spec:
  addresses:
  - 192.155.10.0/24
---
apiVersion: metallb.io/v1beta1
kind: L2Advertisement
metadata:
  name: empty
  namespace: metallb-system

Uninstall MetalLB

Obtain the MKE 4 configuration file.
Set the enabled field to false to disable MetalLB.
```
mkectl <mke-configuration-file>
```

Apply the configuration:

mkectl apply -f <mke-configuration-file>