Update docs for chaos-mesh#4079 (#390)
* Update docs for chaos-mesh#4079 Signed-off-by: Yue Yang <g1enyy0ung@gmail.com> * chore: use Tabs Signed-off-by: Yue Yang <g1enyy0ung@gmail.com> * fix: netlify build Signed-off-by: Yue Yang <g1enyy0ung@gmail.com> * chore: update Signed-off-by: Yue Yang <g1enyy0ung@gmail.com> * chore: update Signed-off-by: Yue Yang <g1enyy0ung@gmail.com> --------- Signed-off-by: Yue Yang <g1enyy0ung@gmail.com>
This commit is contained in:
Yue Yang
GitHub
parent
f060e5c07a
commit
5435d67338
|
|
@ -2,6 +2,10 @@
|
|||
title: Install Chaos Mesh using Helm
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs'
|
||||
|
||||
import TabItem from '@theme/TabItem'
|
||||
|
||||
import PickVersion from '@site/src/components/PickVersion'
|
||||
|
||||
import PickHelmVersion from '@site/src/components/PickHelmVersion'
|
||||
|
|
@ -82,36 +86,48 @@ When installing Chaos Mesh on Kubernetes v1.15(or an earlier version), you need
|
|||
|
||||
:::
|
||||
|
||||
Because socket paths are listened to by the daemons of different running containers, you need to set different values for socket paths during installation. You can execute the following installation commands according to different environments.
|
||||
|
||||
#### Docker
|
||||
As the daemons of different container runtimes listen on different socket paths, you need to set the appropriate values during installation. You can run the following installation commands according to different environments.
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
<PickHelmVersion className="language-bash">{`\# Default to /var/run/docker.sock
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --version latest`}
|
||||
</PickHelmVersion>
|
||||
<Tabs defaultValue="docker" values={[
|
||||
{label: 'Docker', value: 'docker'},
|
||||
{label: 'Containerd', value: 'containerd'},
|
||||
{label: 'K3s', value: 'k3s'},
|
||||
{label: 'CRI-O', value: 'cri-o'}
|
||||
]}>
|
||||
<TabItem value="docker">
|
||||
<PickHelmVersion>
|
||||
{`\# Default to /var/run/docker.sock\nhelm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --version latest`}
|
||||
</PickHelmVersion>
|
||||
</TabItem>
|
||||
<TabItem value="containerd">
|
||||
<PickHelmVersion>
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=containerd --set chaosDaemon.socketPath=/run/containerd/containerd.sock --version latest
|
||||
</PickHelmVersion>
|
||||
</TabItem>
|
||||
<TabItem value="k3s">
|
||||
<PickHelmVersion>
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=containerd --set chaosDaemon.socketPath=/run/k3s/containerd/containerd.sock --version latest
|
||||
</PickHelmVersion>
|
||||
</TabItem>
|
||||
<TabItem value="cri-o">
|
||||
<PickHelmVersion>
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=crio --set chaosDaemon.socketPath=/var/run/crio/crio.sock --version latest
|
||||
</PickHelmVersion>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
#### Containerd
|
||||
:::info
|
||||
|
||||
<PickHelmVersion className="language-bash">{`helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=containerd --set chaosDaemon.socketPath=/run/containerd/containerd.sock --version latest`}</PickHelmVersion>
|
||||
|
||||
#### K3s
|
||||
|
||||
<PickHelmVersion className="language-bash">{`helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=containerd --set chaosDaemon.socketPath=/run/k3s/containerd/containerd.sock --version latest`}</PickHelmVersion>
|
||||
|
||||
#### CRI-O
|
||||
|
||||
<PickHelmVersion className="language-bash">{`helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=crio --set chaosDaemon.socketPath=/var/run/crio/crio.sock --version latest`}</PickHelmVersion>
|
||||
|
||||
:::note
|
||||
|
||||
To install Chaos Mesh of a specific version, add the `--version xxx` parameter after `helm upgrade`, for example, `--version 2.0.0`.
|
||||
To install Chaos Mesh of a specific version, add the `--version x.y.z` parameter after `helm install/upgrade`, for example, `helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --version 2.1.0`.
|
||||
|
||||
:::
|
||||
|
||||
:::note
|
||||
:::tip
|
||||
|
||||
To ensure high availability, Chaos Mesh turns on `leader-election` feature by default. If you do not need to use this feature, you can manually turn it off through `--set controllerManager.leaderElection.enabled=false --set controllerManager.replicaCount=1`.
|
||||
To ensure high availability, Chaos Mesh turns on `leader-election` feature by default. If you do not need to use this feature, you can disable it manually with `--set controllerManager.leaderElection.enabled=false`.
|
||||
|
||||
> If version `<2.6.1`, you still need to set `--set controllerManager.replicaCount=1` to reduce the controller manager to one replica.
|
||||
|
||||
:::
|
||||
|
||||
|
|
|
|||
|
|
@ -2,6 +2,10 @@
|
|||
title: 使用 Helm 安装 Chaos Mesh
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs'
|
||||
|
||||
import TabItem from '@theme/TabItem'
|
||||
|
||||
import PickVersion from '@site/src/components/PickVersion'
|
||||
|
||||
import PickHelmVersion from '@site/src/components/PickHelmVersion'
|
||||
|
|
@ -82,40 +86,48 @@ kubectl create ns chaos-mesh
|
|||
|
||||
:::
|
||||
|
||||
由于不同容器运行时的守护进程所监听的 socket path 不同，在安装时需要设置不同的值，可以根据不同的环境来运行如下的安装命令。
|
||||
由于不同容器运行时的守护进程所监听的 socket path 不同，你需要在安装时设置适当的值。你可以根据不同的环境来运行以下的安装命令。
|
||||
|
||||
#### Docker
|
||||
<!-- prettier-ignore -->
|
||||
<Tabs defaultValue="docker" values={[
|
||||
{label: 'Docker', value: 'docker'},
|
||||
{label: 'Containerd', value: 'containerd'},
|
||||
{label: 'K3s', value: 'k3s'},
|
||||
{label: 'CRI-O', value: 'cri-o'}
|
||||
]}>
|
||||
<TabItem value="docker">
|
||||
<PickHelmVersion>
|
||||
{`\# Default to /var/run/docker.sock\nhelm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --version latest`}
|
||||
</PickHelmVersion>
|
||||
</TabItem>
|
||||
<TabItem value="containerd">
|
||||
<PickHelmVersion>
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=containerd --set chaosDaemon.socketPath=/run/containerd/containerd.sock --version latest
|
||||
</PickHelmVersion>
|
||||
</TabItem>
|
||||
<TabItem value="k3s">
|
||||
<PickHelmVersion>
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=containerd --set chaosDaemon.socketPath=/run/k3s/containerd/containerd.sock --version latest
|
||||
</PickHelmVersion>
|
||||
</TabItem>
|
||||
<TabItem value="cri-o">
|
||||
<PickHelmVersion>
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=crio --set chaosDaemon.socketPath=/var/run/crio/crio.sock --version latest
|
||||
</PickHelmVersion>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```bash
|
||||
# 默认为 /var/run/docker.sock
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh
|
||||
```
|
||||
:::info 提示
|
||||
|
||||
#### containerd
|
||||
|
||||
```bash
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=containerd --set chaosDaemon.socketPath=/run/containerd/containerd.sock
|
||||
```
|
||||
|
||||
#### K3s
|
||||
|
||||
```bash
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=containerd --set chaosDaemon.socketPath=/run/k3s/containerd/containerd.sock
|
||||
```
|
||||
|
||||
#### CRI-O
|
||||
|
||||
<PickHelmVersion className="language-bash">{`helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=crio --set chaosDaemon.socketPath=/var/run/crio/crio.sock --version latest`}</PickHelmVersion>
|
||||
|
||||
:::note 注意
|
||||
|
||||
如要安装特定版本的 Chaos Mesh，请在 `helm install` 后添加 `--version xxx` 参数，如 `--version v2.0.0`。
|
||||
如需安装特定版本的 Chaos Mesh，请在 `helm install/upgrade` 后添加 `--version x.y.z` 参数，如 `helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --version 2.1.0`。
|
||||
|
||||
:::
|
||||
|
||||
:::note 注意
|
||||
:::tip 小贴士
|
||||
|
||||
为了保证高可用性，Chaos Mesh 默认开启了 `leader-election` 特性。如果不需要这个特性，请通过 `--set controllerManager.leaderElection.enabled=false --set controllerManager.replicaCount=1` 手动关闭该特性。
|
||||
为了保证高可用性，Chaos Mesh 默认开启了 `leader-election` 特性。如果不需要这个特性，请通过 `--set controllerManager.leaderElection.enabled=false` 手动关闭该特性。
|
||||
|
||||
> 如果版本 `<2.6.1`，你仍然需要设置 `--set controllerManager.replicaCount=1` 来将控制器管理器减少到一个副本。
|
||||
|
||||
:::
|
||||
|
||||
|
|
|
|||
|
|
@ -2,6 +2,10 @@
|
|||
title: 使用 Helm 安装 Chaos Mesh
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs'
|
||||
|
||||
import TabItem from '@theme/TabItem'
|
||||
|
||||
import PickVersion from '@site/src/components/PickVersion'
|
||||
|
||||
import PickHelmVersion from '@site/src/components/PickHelmVersion'
|
||||
|
|
@ -82,40 +86,48 @@ kubectl create ns chaos-mesh
|
|||
|
||||
:::
|
||||
|
||||
由于不同容器运行时的守护进程所监听的 socket path 不同，在安装时需要设置不同的值，可以根据不同的环境来运行如下的安装命令。
|
||||
由于不同容器运行时的守护进程所监听的 socket path 不同，你需要在安装时设置适当的值。你可以根据不同的环境来运行以下的安装命令。
|
||||
|
||||
#### Docker
|
||||
<!-- prettier-ignore -->
|
||||
<Tabs defaultValue="docker" values={[
|
||||
{label: 'Docker', value: 'docker'},
|
||||
{label: 'Containerd', value: 'containerd'},
|
||||
{label: 'K3s', value: 'k3s'},
|
||||
{label: 'CRI-O', value: 'cri-o'}
|
||||
]}>
|
||||
<TabItem value="docker">
|
||||
<PickHelmVersion>
|
||||
{`\# Default to /var/run/docker.sock\nhelm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --version latest`}
|
||||
</PickHelmVersion>
|
||||
</TabItem>
|
||||
<TabItem value="containerd">
|
||||
<PickHelmVersion>
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=containerd --set chaosDaemon.socketPath=/run/containerd/containerd.sock --version latest
|
||||
</PickHelmVersion>
|
||||
</TabItem>
|
||||
<TabItem value="k3s">
|
||||
<PickHelmVersion>
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=containerd --set chaosDaemon.socketPath=/run/k3s/containerd/containerd.sock --version latest
|
||||
</PickHelmVersion>
|
||||
</TabItem>
|
||||
<TabItem value="cri-o">
|
||||
<PickHelmVersion>
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=crio --set chaosDaemon.socketPath=/var/run/crio/crio.sock --version latest
|
||||
</PickHelmVersion>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
```bash
|
||||
# 默认为 /var/run/docker.sock
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh
|
||||
```
|
||||
:::info 提示
|
||||
|
||||
#### containerd
|
||||
|
||||
```bash
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=containerd --set chaosDaemon.socketPath=/run/containerd/containerd.sock
|
||||
```
|
||||
|
||||
#### K3s
|
||||
|
||||
```bash
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=containerd --set chaosDaemon.socketPath=/run/k3s/containerd/containerd.sock
|
||||
```
|
||||
|
||||
#### CRI-O
|
||||
|
||||
<PickHelmVersion className="language-bash">{`helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=crio --set chaosDaemon.socketPath=/var/run/crio/crio.sock --version latest`}</PickHelmVersion>
|
||||
|
||||
:::note 注意
|
||||
|
||||
如要安装特定版本的 Chaos Mesh，请在 `helm install` 后添加 `--version xxx` 参数，如 `--version v2.0.0`。
|
||||
如需安装特定版本的 Chaos Mesh，请在 `helm install/upgrade` 后添加 `--version x.y.z` 参数，如 `helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --version 2.1.0`。
|
||||
|
||||
:::
|
||||
|
||||
:::note 注意
|
||||
:::tip 小贴士
|
||||
|
||||
为了保证高可用性，Chaos Mesh 默认开启了 `leader-election` 特性。如果不需要这个特性，请通过 `--set controllerManager.leaderElection.enabled=false --set controllerManager.replicaCount=1` 手动关闭该特性。
|
||||
为了保证高可用性，Chaos Mesh 默认开启了 `leader-election` 特性。如果不需要这个特性，请通过 `--set controllerManager.leaderElection.enabled=false` 手动关闭该特性。
|
||||
|
||||
> 如果版本 `<2.6.1`，你仍然需要设置 `--set controllerManager.replicaCount=1` 来将控制器管理器减少到一个副本。
|
||||
|
||||
:::
|
||||
|
||||
|
|
|
|||
|
|
@ -39,5 +39,6 @@
|
|||
},
|
||||
"lint-staged": {
|
||||
"*.(js|md)": "prettier --write"
|
||||
}
|
||||
},
|
||||
"packageManager": "pnpm@8.6.2"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -2,6 +2,10 @@
|
|||
title: Install Chaos Mesh using Helm
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs'
|
||||
|
||||
import TabItem from '@theme/TabItem'
|
||||
|
||||
import PickVersion from '@site/src/components/PickVersion'
|
||||
|
||||
import PickHelmVersion from '@site/src/components/PickHelmVersion'
|
||||
|
|
@ -82,36 +86,48 @@ When installing Chaos Mesh on Kubernetes v1.15(or an earlier version), you need
|
|||
|
||||
:::
|
||||
|
||||
Because socket paths are listened to by the daemons of different running containers, you need to set different values for socket paths during installation. You can execute the following installation commands according to different environments.
|
||||
|
||||
#### Docker
|
||||
As the daemons of different container runtimes listen on different socket paths, you need to set the appropriate values during installation. You can run the following installation commands according to different environments.
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
<PickHelmVersion className="language-bash">{`\# Default to /var/run/docker.sock
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --version latest`}
|
||||
</PickHelmVersion>
|
||||
<Tabs defaultValue="docker" values={[
|
||||
{label: 'Docker', value: 'docker'},
|
||||
{label: 'Containerd', value: 'containerd'},
|
||||
{label: 'K3s', value: 'k3s'},
|
||||
{label: 'CRI-O', value: 'cri-o'}
|
||||
]}>
|
||||
<TabItem value="docker">
|
||||
<PickHelmVersion>
|
||||
{`\# Default to /var/run/docker.sock\nhelm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --version latest`}
|
||||
</PickHelmVersion>
|
||||
</TabItem>
|
||||
<TabItem value="containerd">
|
||||
<PickHelmVersion>
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=containerd --set chaosDaemon.socketPath=/run/containerd/containerd.sock --version latest
|
||||
</PickHelmVersion>
|
||||
</TabItem>
|
||||
<TabItem value="k3s">
|
||||
<PickHelmVersion>
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=containerd --set chaosDaemon.socketPath=/run/k3s/containerd/containerd.sock --version latest
|
||||
</PickHelmVersion>
|
||||
</TabItem>
|
||||
<TabItem value="cri-o">
|
||||
<PickHelmVersion>
|
||||
helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=crio --set chaosDaemon.socketPath=/var/run/crio/crio.sock --version latest
|
||||
</PickHelmVersion>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
#### Containerd
|
||||
:::info
|
||||
|
||||
<PickHelmVersion className="language-bash">{`helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=containerd --set chaosDaemon.socketPath=/run/containerd/containerd.sock --version latest`}</PickHelmVersion>
|
||||
|
||||
#### K3s
|
||||
|
||||
<PickHelmVersion className="language-bash">{`helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=containerd --set chaosDaemon.socketPath=/run/k3s/containerd/containerd.sock --version latest`}</PickHelmVersion>
|
||||
|
||||
#### CRI-O
|
||||
|
||||
<PickHelmVersion className="language-bash">{`helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=crio --set chaosDaemon.socketPath=/var/run/crio/crio.sock --version latest`}</PickHelmVersion>
|
||||
|
||||
:::note
|
||||
|
||||
To install Chaos Mesh of a specific version, add the `--version xxx` parameter after `helm upgrade`, for example, `--version 2.0.0`.
|
||||
To install Chaos Mesh of a specific version, add the `--version x.y.z` parameter after `helm install/upgrade`, for example, `helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --version 2.1.0`.
|
||||
|
||||
:::
|
||||
|
||||
:::note
|
||||
:::tip
|
||||
|
||||
To ensure high availability, Chaos Mesh turns on `leader-election` feature by default. If you do not need to use this feature, you can manually turn it off through `--set controllerManager.leaderElection.enabled=false --set controllerManager.replicaCount=1`.
|
||||
To ensure high availability, Chaos Mesh turns on `leader-election` feature by default. If you do not need to use this feature, you can disable it manually with `--set controllerManager.leaderElection.enabled=false`.
|
||||
|
||||
> If version `<2.6.1`, you still need to set `--set controllerManager.replicaCount=1` to reduce the controller manager to one replica.
|
||||
|
||||
:::
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue