English | 简体中文

What is NEW!
Latest Release: January 11th, 2022. OpenYurt v0.6.0. Please check the CHANGELOG for details.
First Release: May 29th, 2020. OpenYurt v0.1.0-beta.1

OpenYurt is built based on upstream Kubernetes and now hosted by the Cloud Native Computing Foundation(CNCF) as a Sandbox Level Project.

OpenYurt has been designed to meet various DevOps requirements against typical edge infrastructures. It provides the same user experience for managing the edge applications as if they were running in the cloud infrastructure. It addresses specific challenges for cloud-edge orchestration in Kubernetes such as unreliable or disconnected cloud-edge networking, edge node autonomy, edge device management, region-aware deployment and so on. OpenYurt preserves intact Kubernetes API compatibility, is vendor agnostic, and more importantly, is SIMPLE to use.

OpenYurt follows a classic cloud-edge architecture design. It uses a centralized Kubernetes control plane residing in the cloud site to manage multiple edge nodes residing in the edge sites. Each edge node has moderate compute resources available in order to run edge applications plus the required OpenYurt components. The edge nodes in a cluster can span multiple physical regions, which are referred to as Pools in OpenYurt.

The above figure demonstrates the core OpenYurt architecture. The major components consist of:

• YurtHub: A node daemon that serves as a proxy for the outbound traffic from typical Kubernetes node daemons such as Kubelet, Kubeproxy, CNI plugins and so on. It caches the states of all the API resources that they might access in the edge node's local storage. In case the edge node is disconnected to the cloud, YurtHub can recover the states when the node restarts.
• Yurt controller manager: It supplements the upstream node controller to support edge computing requirements. For example, Pods in the nodes that are in the autonomy mode will not be evicted from APIServer even if the node heartbeats are missing.
• Yurt app manager: It manages four CRD resources introduced in OpenYurt: NodePool, YurtAppSet, YurtAppDaemon and YurtIngress. NodePool provides a convenient management for a pool of nodes within the same region or site. YurtAppSet defines a new edge application management methodology of using per NodePool workload. YurtAppDaemon enables to deploy workload for every matching NodePool. YurtIngress ocherstrates the deployment of multiple ingress controllers to the respective NodePools.
• Yurt tunnel (server/agent): TunnelServer connects with the TunnelAgent daemon running in each edge node via a reverse proxy to establish a secure network access between the cloud site control plane and the edge nodes that are connected to the intranet.

In addition, OpenYurt also includes auxiliary controllers for integration and customization purposes.

• Node resource manager: It manages additional edge node resources such as LVM, QuotaPath and Persistent Memory. Please refer to node-resource-manager repo for more details.
• Integrating EdgeX Foundry platform and uses Kubernetes CRD to manage edge devices!

OpenYurt introduces Yurt-edgex-manager to manage the lifecycle of the EdgeX Foundry software suite, and Yurt-device-controller to manage edge devices hosted by EdgeX Foundry via Kubernetes custom resources. Please refer to the short demo and the respective repos for more details.

Please check the resource and system requirements before installing OpenYurt.

OpenYurt supports Kubernetes versions up to 1.21. Using higher Kubernetes versions may cause compatibility issues. OpenYurt can be installed using any of the following methods:

To experience the power of OpenYurt, please try the detailed tutorials.

• 2021 roadmap

If you are willing to be a contributor for the OpenYurt project, please refer to our CONTRIBUTING document for details. We have also prepared a developer guide to help the code contributors.

If you have any questions or want to contribute, you are welcome to communicate most things via GitHub issues or pull requests. Other active communication channels:

• Mailing List: https://groups.google.com/g/openyurt/
• Slack: channel
• Dingtalk Group (钉钉讨论群)

OpenYurt is under the Apache 2.0 license. See the LICENSE file for details. Certain implementations in OpenYurt rely on the existing code from Kubernetes and the credits go to the original Kubernetes authors.