Skip to content

Commit

Permalink
revise readme and 2021 roadmap (#217)
Browse files Browse the repository at this point in the history
  • Loading branch information
rambohe-ch authored Feb 5, 2021
1 parent 0ac07d6 commit dc16378
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 11 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,16 @@ English | [简体中文](./README.zh.md)
|August 30th, 2020. OpenYurt v0.2.0 is **RELEASED**! Please check the [CHANGELOG](CHANGELOG.md) for details.|
|May 29th, 2020. OpenYurt v0.1.0-beta.1 is **RELEASED**! Please check the [CHANGELOG](CHANGELOG.md) for details.|

OpenYurt is built based on native Kubernetes and targets to extend it to support edge computing seamlessly.
OpenYurt(official website: https://openyurt.io) is now hosted by the Cloud Native Computing Foundation(CNCF) as a [Sandbox Level Project](https://www.cncf.io/sandbox-projects/). It is built based on native Kubernetes and targets to extend it to support edge computing seamlessly.
In a nutshell, OpenYurt enables users to manage applications that run in the edge infrastructure as if they were running
in the cloud infrastructure. Our official website is [https://openyurt.io](https://openyurt.io).
in the cloud infrastructure.

OpenYurt is suitable for common edge computing use cases whose requirements include:
- Minimizing the network traffic over long distances between the devices and the workloads.
- Overcoming the network bandwidth or reliability limitations.
- Processing data remotely to reduce latency.
- Providing a better security model to handle sensitive data.
- Manage edge resources and edge applications in a single cluster.

OpenYurt has the following advantages in terms of compatibility and usability.
- **Kubernetes native**. It provides full Kubernetes API compatibility. All Kubernetes workloads, services,
Expand Down Expand Up @@ -101,7 +102,7 @@ We provider detailed [**tutorials**](./docs/tutorial/README.md) to demonstrate h

## Roadmap

- [2020 Q3 roadmap](docs/roadmap.md)
- [2021 roadmap](docs/roadmap.md)

## Community

Expand Down
7 changes: 4 additions & 3 deletions README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,14 @@
| 2020-08-30 OpenYurt v0.2.0 **正式发布**! 请查看 [CHANGELOG](CHANGELOG.md) 来获得更多更新细节.|
| 2020-05-29 OpenYurt v0.1.0-beta.1 **正式发布**! 请查看 [CHANGELOG](CHANGELOG.md) 来获得更多更新细节.|

OpenYurt 是基于原生 Kubernetes 构建的,目标是扩展 Kubernetes 以无缝支持边缘计算场景。简而言之,OpenYurt 使客户可以像在公共云基础设施上运行应用一样管理在边缘基础设施之上运行的应用。
OpenYurt (官网: https://openyurt.io) 是托管在 Cloud Native Computing Foundation (CNCF) 下的 [沙箱项目](https://www.cncf.io/sandbox-projects/). 它是基于原生 Kubernetes 构建的,目标是扩展 Kubernetes 以无缝支持边缘计算场景。简而言之,OpenYurt 使客户可以像在公共云基础设施上运行应用一样管理在边缘基础设施之上运行的应用。

OpenYurt 适合如下这些常见的边缘计算用户场景:
- 使设备和负载之间的长途通信网络通讯流量最小化;
- 克服网络带宽限制及可靠性限制;
- 在边缘节点处理数据以减少延迟;
- 为敏感数据的处理提供了一个更好的安全模型;
- 在单个集群中管理分散在不同地域的边缘资源和边缘应用;


就兼容性和可用性而言,OpenYurt 具有以下优点:
Expand Down Expand Up @@ -78,8 +79,8 @@ $ _output/bin/yurtctl revert
## 使用方法
我们提供详细的[教程](./docs/tutorial/README.md)来演示如何使用 OpenYurt 管理部署在边缘节点上的应用。

## 线路图
[2020 Q3 roadmap](docs/roadmap.md)
## 发展规划
[2021年 发展规划](docs/roadmap.md)


## 社区
Expand Down
16 changes: 11 additions & 5 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,18 @@

This document outlines the development roadmap for the OpenYurt project.

## 2020 Q3 Roadmap
## v0.4.0 Roadmap(Release Plan: 2021.5)

- Add Yurt tunnel server/agent to enable cloud-to-edge network communication across intranet/firewall.
- Add Cloud Native IOT Device Management API definition.
- Support IOT Device Management that comply with cloud native IOT API
- Support autonomy feature in node pool level.
- Support manage configmap in node pool with unique setting.
- Upgrade openyurt components to support Kubernetes 1.18.
- Introduce `YurtCluster` crd to help manage autonomous edge nodes and implement the crd controller.
- Add `YurtUnit` feature and enable `YurtUnit` autonomy.
- Add basic Pod network recovery mechanism to handle edge node restarts.
- Improve `YurtCtl` user experience.
- Add more e2e test cases and improve overall code coverage.
- Add minimal hardware requirement and system requirement info of OpenYurt.


## v0.5.0 Roadmap

It will be added after v0.4.0 released.

0 comments on commit dc16378

Please sign in to comment.