Install OpenELB on K3s

This document describes how to use kubectl and Helm to install and delete OpenELB in a K3s Kubernetes cluster.

NOTE

In a Kubernetes cluster, you only need to install OpenELB once. After the installation is complete, an openelb-controller Deployment containing an openelb-controller Pod and an openelb-speaker DaemonSet containing openelb-speaker Pods will be installed in the cluster. The openelb-controller Pod is used to implement the IPAM for service load balancer IPs, while the openelb-speaker Pods are used to announce the service load balancer IPs.
After the installation is complete, you can set node selectors to ensure that the load traffic runs on specific nodes. For details, see Configure Multiple OpenELB Replicas.

Prerequisites

You need to prepare a K3s Kubernetes cluster, and ensure that the Kubernetes version is 1.15 or later. OpenELB requires CustomResourceDefinition (CRD) v1, which is only supported by Kubernetes 1.15 or later. OpenELB is designed to be used in bare-metal Kubernetes environments. However, you can also use a cloud-based K3s Kubernetes cluster for learning and testing.
If you use Helm to install OpenELB, ensure that the Helm version is Helm 3.

Install OpenELB Using kubectl

Log in to the master node of the K3s Kubernetes cluster over SSH and run the following command:

We recommend using the stable release version in a production environment. Please use the following command to download the installation script for the stable version:
```
wget https://raw.githubusercontent.com/openelb/openelb/release-0.6/deploy/openelb.yaml
kubectl apply -f openelb.yaml
```
If you are interested in the latest features of the master branch and want to use the development version, use the following command to download the deployment script:
```
wget https://raw.githubusercontent.com/openelb/openelb/master/deploy/openelb.yaml
kubectl apply -f openelb.yaml
```

Run the following command to check whether the status of openelb-controller and openelb-speaker is READY: 1/1 and STATUS: Running. If yes, OpenELB has been installed successfully.

kubectl get po -n openelb-system

It should return something like the following.

NAME                                  READY   STATUS      RESTARTS   AGE
openelb-admission-create-fv8jb        0/1     Completed   0          41s
openelb-admission-patch-887qh         0/1     Completed   0          41s
openelb-controller-6d59c894c9-jgfks   1/1     Running     0          41s
openelb-speaker-dnkcr                 1/1     Running     0          41s
openelb-speaker-fmkxb                 1/1     Running     0          41s
openelb-speaker-trh6p                 1/1     Running     0          41s

Delete OpenELB Using kubectl

To delete OpenELB, log in to the master node of the K3s Kubernetes cluster and run the following command:
```
kubectl delete -f openelb.yaml
```
NOTE

Before deleting OpenELB, you should first delete all Services that use OpenELB.
Run the following command to check the result. If the openelb-system namespace does not exist, OpenELB has been deleted successfully.
```
kubectl get ns
```

Install OpenELB Using Helm

Log in to the master node of the K3s Kubernetes cluster over SSH and run the following command to configure the environment variable:
```
export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
```
NOTE

You need to configure this environment variable so that Helm can reach the K3s Kubernetes cluster. For details, see the official K3s document.

Run the following commands to install OpenELB:

helm repo add openelb https://openelb.github.io/openelb
helm repo update
helm install openelb openelb/openelb -n openelb-system --create-namespace

Run the following command to check whether the status of openelb-controller and openelb-speaker is READY: 1/1 and STATUS: Running. If yes, OpenELB has been installed successfully.

kubectl get po -A

It should return something like the following.

NAMESPACE            NAME                                  READY   STATUS      RESTARTS   AGE
openelb-system       openelb-admission-create-fv8jb        0/1     Completed   0          41s
openelb-system       openelb-admission-patch-887qh         0/1     Completed   0          41s
openelb-system       openelb-controller-6d59c894c9-jgfks   1/1     Running     0          41s
openelb-system       openelb-speaker-dnkcr                 1/1     Running     0          41s
openelb-system       openelb-speaker-fmkxb                 1/1     Running     0          41s
openelb-system       openelb-speaker-trh6p                 1/1     Running     0          41s
... ...

Delete OpenELB Using Helm

To delete OpenELB, run the following command:
```
helm delete openelb -n openelb-system
```
NOTE

Before deleting OpenELB, you should first delete all Services that use OpenELB.
Run the following command to check the result. If the OpenELB application does not exist, OpenELB has been deleted successfully.
```
helm ls -n openelb-system
```

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

Last modified June 14, 2024: update install openelb by helm (63c2abd)