docs: upgrade from 2.1 to 2.2 (#303)

* docs: upgrade from 2.1 to 2.2

Signed-off-by: STRRL <im@strrl.dev>

* chore: cleanup untraslated eng

Signed-off-by: STRRL <im@strrl.dev>

* Apply suggestions from code review

Co-authored-by: Aolin <aolinz@outlook.com>
Signed-off-by: STRRL <im@strrl.dev>

* Apply suggestions from code review

Co-authored-by: Aolin <aolinz@outlook.com>
Signed-off-by: STRRL <im@strrl.dev>

* Apply suggestions from code review

Co-authored-by: Aolin <aolinz@outlook.com>
Signed-off-by: STRRL <im@strrl.dev>

Co-authored-by: Aolin <aolinz@outlook.com>
This commit is contained in:
Zhou Zhiqiang 2022-05-27 14:18:47 +08:00 committed by GitHub
parent 8b2f667abb
commit 66ac60beee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 139 additions and 0 deletions

View File

@ -0,0 +1,69 @@
---
title: Upgrade from 2.1 to 2.2
---
There are several changes in Helm Charts 2.2.0 release. This documentation introduces how to migrate from 2.1.x to 2.2.0.
## Upgrade with Helm
### Step 1: Add/Update Chaos Mesh Helm repository
Add the Chaos Mesh repository to the Helm repository and update it:
```bash
helm repo add chaos-mesh https://charts.chaos-mesh.org
helm repo update
```
### Step 2: Migrate the `values.yaml` file
If you installed Chaos Mesh with a certain `values.yaml`, it is recommended to apply your customized configuration to the `values.yaml` of Chaos Mesh 2.2.0.
You can fetch the default `values.yaml` by the following command:
```bash
helm show values chaos-mesh/chaos-mesh --version 2.2.0 > values.yaml
```
If you do not recognize the changed configurations, you might not rely on that specific feature, it is usually safe to ignore them.
Here is a list of Helm Chart changes:
- new configuration: `chaosDaemon.mtls.enabled` represents using mtls bwteen chaos-controller-manager and chaos-daemon.
- new configuration: `webhook.caBundlePEM` represents the CA bundle used to serve the webhook server.
- value changed: `dashboard.serviceAccount` changed from `chaos-controller-manager` to `chaos-dashboard`
- value changed: `webhook.FailurePolicy` changed from `Ignore` to `Fail`
:::note
For more information about the detailed description, see [README](https://github.com/chaos-mesh/chaos-mesh/blob/v2.2.0/helm/chaos-mesh/README.md).
:::
### Step 3: Update the CRD
For Kubernetes version >= 1.16, you can apply the latest CRD by executing the following command:
```bash
kubectl replace -f https://mirrors.chaos-mesh.org/v2.2.0/crd.yaml
```
For Kubernetes version <= 1.15, you can apply the latest CRD by executing the following command:
```bash
kubectl replace -f https://mirrors.chaos-mesh.org/v2.2.0/crd-v1beta1.yaml
```
:::note
Chaos Mesh 2.2.x would be the last series of releases that support Kubernetes < 1.19.
:::
### Step 4: Upgrade Chaos Mesh by `helm upgrade`
Then you can execute the following command to upgrade Chaos Mesh to the 2.2.0:
```bash
helm upgrade <release-name> chaos-mesh/chaos-mesh --namespace=<namespace> --version=2.2.0 <--other-required-flags>
```
## Ask the Community
If you have any questions about upgrading Chaos Mesh, feel free to contact us at [Slack Channel](https://cloud-native.slack.com/archives/C0193VAV272), GitHub [Issues](https://github.com/chaos-mesh/chaos-mesh/issues/new?assignees=&labels=&template=question.md) and [Discussions](https://github.com/chaos-mesh/chaos-mesh/discussions/new).

View File

@ -0,0 +1,69 @@
---
title: 从 2.1 升级到 2.2
---
在 2.2.0 版本中Helm Charts 做了一些改变。这个文档将帮助你从 2.1.x 升级到 2.2.0。
## 使用 Helm 升级
### 第 1 步:添加/更新 Chaos Mesh Helm 仓库
添加 Chaos Mesh 到 Helm 仓库并更新:
```bash
helm repo add chaos-mesh https://charts.chaos-mesh.org
helm repo update
```
### 第 2 步:迁移 `values.yaml` 文件
如果你在安装 Chaos Mesh 的时候使用了一个特定的 `values.yaml`,我们建议你应用你的自定义配置到 Chaos Mesh 2.2.0 的 `values.yaml`
你可以通过这个命令获取默认的 `values.yaml`
```bash
helm show values chaos-mesh/chaos-mesh --version 2.2.0 > values.yaml
```
如果你不熟悉这些改变过的配置,你可能不会依赖这些特定的功能,忽略他们通常是安全的。
这里是 Helm Chart 改变的列表:
- 新配置:`chaosDaemon.mtls.enabled` 表示在 `chaos-controller-manager``chaos-daemon` 之间使用 mtls。
- 新配置:`webhook.caBundlePEM` 表示用于 webhook 服务的 CA bundle。
- 改变的值:`dashboard.serviceAccount` 从 `chaos-controller-manager` 改为 `chaos-dashboard`
- 改变的值:`webhook.FailurePolicy` 从 `Ignore` 改为 `Fail`
:::note 注意
你可以在 [README](https://github.com/chaos-mesh/chaos-mesh/blob/v2.2.0/helm/chaos-mesh/README.md) 查看 Helm Chart 配置的详细描述。
:::
### 第 3 步:更新 CRD
如果你的 Kubernetes 版本 >= 1.16,你可以使用以下命令更新 Chaos Mesh CRD
```bash
kubectl replace -f https://mirrors.chaos-mesh.org/v2.2.0/crd.yaml
```
如果你的 Kubernetes 版本 <= 1.15,你可以使用以下命令更新 Chaos Mesh CRD
```bash
kubectl replace -f https://mirrors.chaos-mesh.org/v2.2.0/crd-v1beta1.yaml
```
:::note 注意
Chaos Mesh 2.2.x 将会是支持 Kubernetes < 1.19 的最后一系列版本
:::
### 第 4 步:使用 `helm upgrade` 升级 Chaos Mesh
你可以使用以下命令来升级 Chaos Mesh 到 2.2.0
```bash
helm upgrade <release-name> chaos-mesh/chaos-mesh --namespace=<namespace> --version=2.2.0 <--other-required-flags>
```
## 询问社区
如果你对升级 Chaos Mesh 有任何问题,请在 [Slack Channel](https://cloud-native.slack.com/archives/C0193VAV272)GitHub [Issues](https://github.com/chaos-mesh/chaos-mesh/issues/new?assignees=&labels=&template=question.md) 和 [Discussions](https://github.com/chaos-mesh/chaos-mesh/discussions/new) 联系我们。

View File

@ -147,6 +147,7 @@ module.exports = {
'faqs',
// 'troubleshooting-guide',
'upgrade-to-2.0',
'upgrade-from-2.1-to-2.2',
],
},
// {