Skip to content

Commit

Permalink
Update README and add CHANGELOG for v1.0.0-alpha.1 (#784)
Browse files Browse the repository at this point in the history
Signed-off-by: FillZpp <[email protected]>
  • Loading branch information
FillZpp authored Oct 27, 2021
1 parent cd4800b commit 9a0879c
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 41 deletions.
51 changes: 51 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,56 @@
# Change Log

## v1.0.0-alpha.1

> Change log since v0.10.0
### Project

- Bump CustomResourceDefinition(CRD) from v1beta1 to v1
- Bump ValidatingWebhookConfiguration/MutatingWebhookConfiguration from v1beta1 to v1
- Bump dependencies: k8s v1.18 -> v1.20, controller-runtime v0.6.5 -> v0.8.3

**So that Kruise can install into Kubernetes 1.22 and no longer support Kubernetes < 1.16.**

### New feature: in-place update with env from metadata

When update `spec.template.metadata.labels/annotations` in CloneSet or Advanced StatefulSet and there exists container env from the changed labels/annotations,
Kruise will in-place update them to renew the env value in containers.

[doc](https://openkruise.io/docs/next/core-concepts/inplace-update#understand-inplaceifpossible)

### New feature: ContainerLaunchPriority

Container Launch Priority provides a way to help users control the sequence of containers start in a Pod.

It works for Pod, no matter what kind of owner it belongs to, which means Deployment, CloneSet or any other Workloads are all supported.

[doc](https://openkruise.io/docs/next/user-manuals/containerlaunchpriority)

### WorkloadSpread

- Manage the pods that were created before WorkloadSpread.
- Optimize webhook update and retry during injection.

### PodUnavailableBudget

- Add pod no pub-protection annotation.
- PUB controller watch workload replicas changed.

### Advanced DaemonSet

- Support in-place update daemon pod.

### SidecarSet

- Fix SidecarSet filter active pods.

### Other

- Kruise-daemon watch pods using protobuf.
- Export resync seconds args.
- Fix http checker reload ca.cert.

## v0.10.0

### New feature: PodUnavailableBudget
Expand Down
22 changes: 4 additions & 18 deletions README-zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,6 @@

[English](./README.md) | 简体中文

|![notification](docs/img/bell-outline-badge.svg) 最新进展:|
|------------------|
|Sep 6th, 2021. Kruise v0.10.0 发布! 新增 WorkloadSpread、PodUnavailableBudget 控制器以及一系列新功能, please check the [CHANGELOG](CHANGELOG.md) for details.|
|May 20th, 2021. Kruise v0.9.0 发布! 新增了多种重大功能如 容器重建/重启、删除安全防护等,详情参见 [CHANGELOG](CHANGELOG.md).|
|Mar 4th, 2021. Kruise v0.8.0 发布! 提供了重构版本的 SidecarSet、UnitedDeployment 支持管理 Deployment,以及一个新的 kruise-daemon 组件目前支持镜像预热,详情参见 [CHANGELOG](CHANGELOG.md).|

## 介绍

OpenKruise (官网: [https://openkruise.io](https://openkruise.io)) 是托管在 [Cloud Native Computing Foundation](https://cncf.io/) (CNCF) 下的 Sandbox 项目。
Expand Down Expand Up @@ -68,20 +62,11 @@ OpenKruise (官网: [https://openkruise.io](https://openkruise.io)) 是托管在

## 快速开始

我们强烈建议在 **Kubernetes >= 1.16** 以上版本的集群中使用 Kruise,使用 helm v3.1.0+ 执行安装即可:

```bash
helm install kruise https://github.com/openkruise/kruise/releases/download/v0.10.0/kruise-chart.tgz
```

> 注意直接安装 chart 会使用默认的 template values,你也可以根据你的集群情况指定一些特殊配置,比如修改 resources 限制或者配置 feature-gates。
更多的安装/升级细节、或者更老版本的 Kubernetes 集群,可以查看 [这个文档](https://openkruise.io/docs/installation)

## 文档

你可以在 [OpenKruise website](https://openkruise.io/zh/docs/) 查看到完整的文档集。

- 安装/升级 Kruise [稳定版本](https://openkruise.io/docs/installation)
- 安装/升级 Kruise [最新版本(包括 alpha/beta/rc)](https://openkruise.io/docs/next/installation)

## 用户

登记: [如果贵司正在使用 Kruise 请留言](https://github.com/openkruise/kruise/issues/289)
Expand All @@ -92,6 +77,7 @@ helm install kruise https://github.com/openkruise/kruise/releases/download/v0.10
- 小红书, 比心, 永辉科技中心, 跟谁学, 哈啰出行
- Spectro Cloud, 艾佳生活, Arkane Systems, 滴普科技, 火花思维
- OPPO, 苏宁, 欢聚时代, 汇量科技, 深圳凤凰木网络有限公司
- 小米, 网易

## 贡献

Expand Down
26 changes: 5 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,6 @@

English | [简体中文](./README-zh_CN.md)

|![notification](docs/img/bell-outline-badge.svg) What is NEW!|
|------------------|
|Sep 6th, 2021. Kruise v0.10.0 is **RELEASED**! It provides new controllers like WorkloadSpread and PodUnavailableBudget, please check the [CHANGELOG](CHANGELOG.md) for details.|
|May 20th, 2021. Kruise v0.9.0 is **RELEASED**! It provides great features such as ContainerRecreate and DeletionProtection, please check the [CHANGELOG](CHANGELOG.md) for details.|
|Mar 4th, 2021. Kruise v0.8.0 is **RELEASED**! It provides refactoring SidecarSet, Deployment hosted by UnitedDeployment, and a new kruise-daemon component which supports image pre-download, please check the [CHANGELOG](CHANGELOG.md) for details.|

## Introduction

OpenKruise (official site: [https://openkruise.io](https://openkruise.io)) is now hosted by the [Cloud Native Computing Foundation](https://cncf.io/) (CNCF) as a Sandbox Level Project.
Expand Down Expand Up @@ -69,22 +63,11 @@ It consists of several controllers which extend and complement the [Kubernetes c

## Quick Start

We strongly recommend you to use Kruise with **Kubernetes version >= 1.16**.
For these clusters, you can simply install Kruise with helm v3.1.0+:

```bash
helm install kruise https://github.com/openkruise/kruise/releases/download/v0.10.0/kruise-chart.tgz
```

> Note that installing this chart directly means it will use the default template values for the kruise-manager.
You may have to set your specific configurations when it is deployed into a production cluster or you want to configure feature-gates.

For more install/upgrade details or older Kubernetes versions, please read [this doc](https://openkruise.io/docs/installation).

## Documentation

You can view the full documentation from the [OpenKruise website](https://openkruise.io/docs/).

- Install or upgrade Kruise with [the stable version](https://openkruise.io/docs/installation).
- Install or upgrade Kruise with [the latest version including alpha/beta/rc](https://openkruise.io/docs/next/installation).

## Users

Registration: [Who is using Kruise](https://github.com/openkruise/kruise/issues/289)
Expand All @@ -94,7 +77,8 @@ Registration: [Who is using Kruise](https://github.com/openkruise/kruise/issues/
- Lyft, Ctrip, 享住智慧, VIPKID, zhangmen
- xiaohongshu, bixin, 永辉科技中心, 跟谁学, 哈啰出行
- Spectro Cloud, ihomefnt, Arkane Systems, Deepexi, 火花思维
- OPPO, Suning.cn, joyy, Mobvista
- OPPO, Suning.cn, joyy, Mobvista, 深圳凤凰木网络有限公司
- xiaomi, Netease

## Contributing

Expand Down
4 changes: 2 additions & 2 deletions config/crd/patches/webhook_in_statefulsets.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ spec:
webhook:
clientConfig:
service:
namespace: system
name: webhook-service
namespace: kruise-system
name: kruise-webhook-service
path: /convert
conversionReviewVersions:
- v1
Expand Down

0 comments on commit 9a0879c

Please sign in to comment.