Skip to content

One-Click Installation

Kube-OVN provides a one-click installation script and charts repo to help you quickly install a highly available, production-ready Kube-OVN container network with Overlay networking by default.

If you need Underlay/Vlan networking as the default container network，please read Underlay Installation

Before installation please read Prerequisites first to make sure the environment is ready. If you want to completely remove Kube-OVN, please refer to Uninstallation.

Script Installation

Download the installation script

We recommend using the stable release version for production environments, please use the following command to download:

wget https://raw.githubusercontent.com/kubeovn/kube-ovn/refs/tags/v1.15.0/dist/images/install.sh

If you are interested in the latest features of the master branch, please use the following command to download:

wget https://raw.githubusercontent.com/kubeovn/kube-ovn/master/dist/images/install.sh

Modify Configuration Options

Open the script using the editor and change the following variables to the expected:

REGISTRY="kubeovn"                     # Image Repo 
VERSION="v1.15.0"                      # Image Tag
POD_CIDR="10.16.0.0/16"                # Default subnet CIDR don't overlay with SVC/NODE/JOIN CIDR
SVC_CIDR="10.96.0.0/12"                # Be consistent with apiserver's service-cluster-ip-range
JOIN_CIDR="100.64.0.0/16"              # Pod/Host communication Subnet CIDR, don't overlay with SVC/NODE/POD CIDR
LABEL="node-role.kubernetes.io/master" # The node label to deploy OVN DB
IFACE=""                               # The name of the host NIC used by the container network, or if empty use the NIC that host Node IP in Kubernetes
TUNNEL_TYPE="geneve"                   # Tunnel protocol，available options: geneve, vxlan or stt. stt requires compilation of ovs kernel module

You can also use regular expression to math NIC names，such as IFACE=enp6s0f0,eth.*.

Run the Script

The script needs to be executed with root permission

bash install.sh

Wait Kube-OVN ready.

Upgrade

When using this script to upgrade Kube-OVN, please pay attention to the following points:

  1. The script's [Step 4/6] restarts all container network Pods. During an upgrade, this step should be skipped or commented out from the script to avoid unintended restarts.
  2. Important: If any parameters were adjusted during Kube-OVN operation, these changes must be updated in the script before upgrading. Otherwise, previous parameter adjustments will be reverted.

Helm Chart Installation

Since the installation of Kube-OVN requires setting some parameters, to install Kube-OVN using Helm, you need to follow the steps below.

View the node IP address

# kubectl get node -o wide
NAME                     STATUS     ROLES           AGE   VERSION   INTERNAL-IP   EXTERNAL-IP   OS-IMAGE             KERNEL-VERSION      CONTAINER-RUNTIME
kube-ovn-control-plane   NotReady   control-plane   20h   v1.26.0   172.18.0.3    <none>        Ubuntu 22.04.1 LTS   5.10.104-linuxkit   containerd://1.6.9
kube-ovn-worker          NotReady   <none>          20h   v1.26.0   172.18.0.2    <none>        Ubuntu 22.04.1 LTS   5.10.104-linuxkit   containerd://1.6.9

Add label to node

# kubectl label node -lbeta.kubernetes.io/os=linux kubernetes.io/os=linux --overwrite
node/kube-ovn-control-plane not labeled
node/kube-ovn-worker not labeled

# kubectl label node -lnode-role.kubernetes.io/control-plane kube-ovn/role=master --overwrite
node/kube-ovn-control-plane labeled

# The following labels are used for the installation of dpdk images and can be ignored in non-dpdk cases
# kubectl label node -lovn.kubernetes.io/ovs_dp_type!=userspace ovn.kubernetes.io/ovs_dp_type=kernel --overwrite
node/kube-ovn-control-plane labeled
node/kube-ovn-worker labeled

Add Helm Repo information

# helm repo add kubeovn https://kubeovn.github.io/kube-ovn/
"kubeovn" has been added to your repositories

$ helm repo list
NAME            URL
kubeovn         https://kubeovn.github.io/kube-ovn/

# helm repo update kubeovn
Hang tight while we grab the latest from your chart repositories...
...Successfully got an update from the "kubeovn" chart repository
Update Complete. ⎈Happy Helming!⎈

# helm search repo kubeovn
NAME                    CHART VERSION   APP VERSION     DESCRIPTION
kubeovn/kube-ovn        v1.15.0        v1.15.0         Helm chart for Kube-OVN

Install Kube-OVN with Helm

You can refer to the variable definitions in the values.yaml file for available parameters.

# helm install kube-ovn kubeovn/kube-ovn --wait -n kube-system --version v1.15.0
NAME: kube-ovn
LAST DEPLOYED: Thu Apr 24 08:30:13 2025
NAMESPACE: kube-system
STATUS: deployed
REVISION: 1
TEST SUITE: None

Upgrade

Important: Similar to script-based upgrades, ensure all parameter adjustments are updated in the values.yaml file before upgrading with Helm. Otherwise, previous parameter adjustments will be reverted.

helm upgrade -f values.yaml kube-ovn kubeovn/kube-ovn --wait -n kube-system --version v1.15.0

微信群 Slack Support

Comments