Skip to content

Commit

Permalink
add relase note and changeLog for OpenYurt v1.1.0 (#1046)
Browse files Browse the repository at this point in the history
  • Loading branch information
rambohe-ch authored Nov 7, 2022
1 parent 1c09ee3 commit 23f45da
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 8 deletions.
60 changes: 60 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,65 @@
# CHANGELOG

## v1.1.0

### What's New

**Support OTA/Auto upgrade model for DaemonSet workload**

Extend native DaemonSet `OnDelete` upgrade model by providing OTA and Auto two upgrade models.
- OTA: workload owner can control the upgrade of workload through the exposed REST API on edge nodes.
- Auto: Solve the DaemonSet upgrade process blocking problem which caused by node NotReady when the cloud-edge is disconnected.

**Support autonomy feature validation in e2e tests**

In order to test autonomy feature, network interface of control-plane is disconnected for simulating cloud-edge network
disconnected, and then stop components(like kube-proxy, flannel, coredns, etc.) and check the recovery of these components.

**Improve the Yurthub configuration for enabling the data filter function**

Compares to the previous three configuration items, which include the component name, resource, and
request verb. after improvement, only component name is need to configure for enabling data filter function. the original
configuration format is also supported in order to keep consistency.

### Other Notable changes

- cache agent change optimize by @huiwq1990 in https://github.com/openyurtio/openyurt/pull/1008
- Check if error via ListKeys of Storage Interface. by @fujitatomoya in https://github.com/openyurtio/openyurt/pull/1015
- Add released openyurt versions to projectInfo when building binaries by @Congrool in https://github.com/openyurtio/openyurt/pull/1016
- add auto pod upgrade controller for daemoset by @xavier-hou in https://github.com/openyurtio/openyurt/pull/970
- add ota update RESTful API by @xavier-hou in https://github.com/openyurtio/openyurt/pull/1004
- make servicetopology filter in yurthub work properly when service or nodepool change by @LinFCai in https://github.com/openyurtio/openyurt/pull/1019
- improve data filter framework by @rambohe-ch in https://github.com/openyurtio/openyurt/pull/1025
- add proposal to unify cloud edge comms solution by @zzguang in https://github.com/openyurtio/openyurt/pull/1027
- improve health checker for adapting coordinator by @rambohe-ch in https://github.com/openyurtio/openyurt/pull/1032
- Edge-autonomy-e2e-test implementation by @lorrielau in https://github.com/openyurtio/openyurt/pull/1022
- improve e2e tests for supporting mac env and coredns autonomy by @rambohe-ch in https://github.com/openyurtio/openyurt/pull/1045
- proposal of yurthub cache refactoring by @Congrool in https://github.com/openyurtio/openyurt/pull/897

### Fixes

- even no endpoints left after filter, an empty object should be returned to clients by @rambohe-ch in https://github.com/openyurtio/openyurt/pull/1028
- non resource handle miss for coredns by @rambohe-ch in https://github.com/openyurtio/openyurt/pull/1044

### Contributors

**Thank you to everyone who contributed to this release!**

- [@windydayc](https://github.com/windydayc)
- [@luc99hen](https://github.com/luc99hen)
- [@Congrool](https://github.com/Congrool)
- [@huiwq1990](https://github.com/huiwq1990)
- [@fujitatomoya](https://github.com/fujitatomoya)
- [@LinFCai](https://github.com/LinFCai)
- [@xavier-hou](https://github.com/xavier-hou)
- [@lorrielau](https://github.com/lorrielau)
- [@YTGhost](https://github.com/YTGhost)
- [@zzguang](https://github.com/zzguang)
- [@Lan-ce-lot](https://github.com/Lan-ce-lot)

And thank you very much to everyone else not listed here who contributed in other ways like filing issues,
giving feedback, helping users in community group, etc. ️

## v1.0

We're excited to announce the release of OpenYurt 1.0.0!🎉🎉🎉
Expand Down
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<img src="docs/img/OpenYurt.png" width="400" height="94"><br/>

[![Version](https://img.shields.io/badge/OpenYurt-v1.0.0-orange)](CHANGELOG.md)
[![Version](https://img.shields.io/badge/OpenYurt-v1.1.0-orange)](CHANGELOG.md)
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
[![Go Report Card](https://goreportcard.com/badge/github.com/openyurtio/openyurt)](https://goreportcard.com/report/github.com/openyurtio/openyurt)
[![codecov](https://codecov.io/gh/openyurtio/openyurt/branch/master/graph/badge.svg)](https://codecov.io/gh/openyurtio/openyurt)
Expand All @@ -14,7 +14,7 @@ English | [简体中文](./README.zh.md)

|![notification](docs/img/bell-outline-badge.svg) What is NEW!|
|------------------|
|Latest Release: Sep 9th, 2022. OpenYurt v1.0.0. Please check the [CHANGELOG](CHANGELOG.md) for details.|
|Latest Release: Nov 4th, 2022. OpenYurt v1.1.0. Please check the [CHANGELOG](CHANGELOG.md) for details.|
|First Release: May 29th, 2020. OpenYurt v0.1.0-beta.1 |

[OpenYurt](https://openyurt.io) is built based on upstream Kubernetes and now hosted by the Cloud Native Computing Foundation(CNCF) as a [Sandbox Level Project](https://www.cncf.io/sandbox-projects/).
Expand Down Expand Up @@ -43,7 +43,11 @@ 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](https://openyurt.io/docs/next/core-concepts/yurthub)**: YurtHub runs on worker nodes as static pod and serve as a node sidecar to handle requests that comes from components(like Kubelet, Kubeproxy and so on) on worker nodes to kube-apiserver.
- **[Yurt Controller Manager](https://openyurt.io/docs/next/core-concepts/yurt-controller-manager)**: It includes node controller that ships from upstream node controller to support edge computing requirements and csr controller that used to handle CSRs from OpenYurt components.
- **[Yurt Controller Manager](https://openyurt.io/docs/next/core-concepts/yurt-controller-manager)**: It includes several controllers for edge control loops.
`nodelifecycle` controller is shipped from upstream node controller to support edge computing requirements.
`yurtcsrapprover` controller is used for handling CSRs from OpenYurt components.
`daemonpodupdater` controller is used for providing OTA and Auto upgrade model for DaemonSet workload.
`servicetopologycontroller` is used for reconciling endpoints/endpointslices when service or nodepool happen to change.
- **[Yurt App Manager](https://openyurt.io/docs/next/core-concepts/yurt-app-manager)**: It manages several CRD resources introduced in OpenYurt: [NodePool](docs/enhancements/20201211-nodepool_uniteddeployment.md),
[YurtAppSet](docs/enhancements/20201211-nodepool_uniteddeployment.md), [YurtAppDaemon](docs/enhancements/20210729-yurtappdaemon.md)
and [YurtIngress](docs/proposals/20210628-nodepool-ingress-support.md).
Expand All @@ -70,7 +74,7 @@ Please check the [resource and system requirements](https://github.com/openyurti

## Getting started

OpenYurt supports Kubernetes versions up to 1.22. Using higher Kubernetes versions may cause
OpenYurt supports Kubernetes versions up to 1.23. Using higher Kubernetes versions may cause
compatibility issues. OpenYurt installation is divided into two parts:
- [Install OpenYurt Control Plane Components](https://openyurt.io/docs/installation/summary#part-1-install-control-plane-components)
- [Join Nodes](https://openyurt.io/docs/installation/summary#part-2-join-nodes)
Expand Down
12 changes: 8 additions & 4 deletions README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<img src="docs/img/OpenYurt.png" width="400" height="94"><br/>

[![Version](https://img.shields.io/badge/OpenYurt-v1.0.0-orange)](CHANGELOG.md)
[![Version](https://img.shields.io/badge/OpenYurt-v1.1.0-orange)](CHANGELOG.md)
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
[![Go Report Card](https://goreportcard.com/badge/github.com/openyurtio/openyurt)](https://goreportcard.com/report/github.com/openyurtio/openyurt)
[![codecov](https://codecov.io/gh/openyurtio/openyurt/branch/master/graph/badge.svg)](https://codecov.io/gh/openyurtio/openyurt)
Expand All @@ -14,7 +14,7 @@

|![notification](docs/img/bell-outline-badge.svg) What is NEW!|
|------------------|
| 最新发布:2022-09-09 OpenYurt v1.0.0 请查看 [CHANGELOG](CHANGELOG.md) 来获得更多更新细节.|
| 最新发布:2022-11-04 OpenYurt v1.1.0 请查看 [CHANGELOG](CHANGELOG.md) 来获得更多更新细节.|
| 第一个发布:2020-05-29 OpenYurt v0.1.0-beta.1 |

OpenYurt (官网: https://openyurt.io) 是基于Upstream Kubernetes构建的,现在是托管在云原生基金会(CNCF) 下的 [沙箱项目](https://www.cncf.io/sandbox-projects/).
Expand All @@ -40,7 +40,11 @@ OpenYurt 遵循经典的云边一体化架构。

上图展示了OpenYurt的核心架构。OpenYurt 的主要组件包括:
- **[YurtHub](https://openyurt.io/zh/docs/next/core-concepts/yurthub/)**:YurtHub以静态pod模式在工作节点上运行,它作为节点的Sidecar处理所有来自工作节点上的组件(如Kubelet, Kubeproxy等)到kube-apiserver的请求。
- **[Yurt Controller Manager](https://openyurt.io/zh/docs/next/core-concepts/yurt-controller-manager)**:目前包括节点控制器和CSR控制器。节点控制器基于原生节点控制器增强来支持边缘计算需求。CSR控制器用于处理来自OpenYurt组件的CSR请求。
- **[Yurt Controller Manager](https://openyurt.io/zh/docs/next/core-concepts/yurt-controller-manager)**:目前包括如下控制器。
`nodelifecycle` 控制器基于原生节点控制器增强来支持边缘计算需求
`yurtcsrapprover` 控制器用于处理来自OpenYurt组件的TLS证书申请
`daemonpodupdater` 控制器主要为DaemonSet工作负载提供OTA和Auto两种新型升级模型
`servicetopologycontroller` 控制器主要用于配合Yurthub中的服务拓扑流量路由功能,实时响应Service和NodePool的变化
- **[Yurt App Manager](https://openyurt.io/zh/docs/next/core-concepts/yurt-app-manager)**:它管理OpenYurt中引入的四个CRD资源:[NodePool](docs/enhancements/20201211-nodepool_uniteddeployment.md)[YurtAppSet](docs/enhancements/20201211-nodepool_uniteddeployment.md)(以前的UnitedDeployment),[YurtAppDaemon](docs/enhancements/20210729-yurtappdaemon.md)[YurtIngress](docs/proposals/20210628-nodepool-ingress-support.md)
`NodePool`为同一区域或站点内的节点资源提供了方便的管理。`YurtAppSet`定义了一个基于节点池维度的工作负载管理模型。`YurtAppDaemon`从节点池维度提供一种类似K8s DaemonSet的工作负载管理模型。`YurtIngress`负责将Ingress Controller部署到用户指定的节点池。
- **[Yurt Tunnel](https://openyurt.io/zh/docs/next/core-concepts/yurttunnel) (server/agent)**`TunnelServer`通过反向代理与在每个边缘节点中运行的 TunnelAgent 守护进程建立连接并以此在云端的控制平面与处于企业内网(Intranet)环境的边缘节点之间建立安全的网络访问。
Expand All @@ -62,7 +66,7 @@ OpenYurt 遵循经典的云边一体化架构。
安装OpenYurt前,请检查[资源和系统要求](https://github.com/openyurtio/openyurt.io/blob/master/i18n/zh/docusaurus-plugin-content-docs/current/usage-conditions/resource-and-system-requirements.md)

## 开始使用
OpenYurt 支持最高版本为1.22的 Kubernetes 。使用更高版本的 Kubernetes 可能会导致兼容性问题。
OpenYurt 支持最高版本为1.23的 Kubernetes 。使用更高版本的 Kubernetes 可能会导致兼容性问题。

OpenYurt集群安装分成2个部分,分别为安装OpenYurt管控组件和节点接入。
- [安装OpenYurt管控组件](https://openyurt.io/zh/docs/installation/summary/#part-1-%E5%AE%89%E8%A3%85openyurt%E7%AE%A1%E6%8E%A7%E7%BB%84%E4%BB%B6)
Expand Down

0 comments on commit 23f45da

Please sign in to comment.