Skip to main content
Version: Next

Manually Setup

This tutorial shows how to setup OpenYurt control plane components manually. We assume you already have a Kubernetes control plane setup properly.

1. Precondition

Make sure you already have a Kubernetes control plane with at least one node. We recommend to create your Kubernetes cluster with kubeadm tool.

$ kubectl get nodes
NAME                      STATUS   ROLES                  AGE     VERSION
izwz9dohcv74iegqecp4axz   Ready    control-plane,master   6d1h    v1.22.11

2. Prerequisites for installing the OpenYurt control plane

  • The IP addresses of all nodes in the cluster must be different if Raven enables node forwarding
  • You must make the following adjustments if using docker as container runtime, which is mainly to avoid docker modifying the iptables forward chain and damaged the node forward.
    iptables -w -P FORWARD ACCEPT
    sed -i 's#^ firewalld.service$ firewalld.service containerd.service#g' \
  • Domain Name resolution from pods on edge nodes will be handled by CoreDNS instance on master node or cloud node through VPN tunnel that provided by Raven, so some resolution latency or timeout will be caused by network. we recommend you to adjust CoreDNS Deployment according to CoreDNS Adjustment tutorial if you care about latency or timeout.
  • To adapt to the complex network scenarios at the edge, we need to disable the original node lifecycle management controller of the k8s. For details, see Kube-Controller-Manager Installation Configuration Adjustments.
  • We recommend installing OpenYurt components via Helm, please make sure helm CLI is installed properly before proceeding.

3. Install OpenYurt control plane components

All the helm charts used in this tutorial can be found in openyurt-helm repo. please add the repo as follows:

helm repo add openyurt

You can then run helm search repo openyurt to see the charts.

3.1 Install yurt-manager

yurt-manager should be started before joining the node via the yurtadm command, because the yurthub component on the node depends on yurt-manager to approve csr. So please ensure that the yurt-manager component is running on the master node or any other node that does not have a yurthub component.

helm upgrade --install yurt-manager -n kube-system openyurt/yurt-manager

Ensure that the pod and service configurations of the yurt-manager component have been created successfully:

kubectl get pod -n kube-system | grep yurt-manager
kubectl get svc -n kube-system | grep yurt-manager

3.2 Install yurthub artifacts

The yurthub artifacts include the yurtstaticset template, as well as the yurthub-related configmap. When installing the yurthub artifacts, we need to set the kubernetesServerAddr field to the Kubernetes server address(use kubectl config view to find). Take the Kubernetes server address of as an example.

helm upgrade --install yurt-hub -n kube-system --set kubernetesServerAddr= openyurt/yurthub

Ensure yurthub yurtstaticset and yurthub cloud yurtstaticset have been created successfully:

kubectl get yss -n kube-system

3.3 Install raven component

Raven provides network communication capabilities when the cloud and the edge are in different network areas, which include two components raven-controller-manager and raven-agent.

helm upgrade --install raven-agent -n kube-system openyurt/raven-agent

Ensure that the pod of the raven agent component have been created successfully:

You need to configure the cluster by referring to if you need to enable raven l7 proxy

kubectl get pod -n kube-system | grep raven-agent

4. Attention

The above operation is only for the Master node, if there are other nodes in the cluster, additional adjustment is needed, the operation method can be referred to Install OpenYurt Node on Existing K8s Nodes.