Skip to content

Commit

Permalink
docs: fix typos (#415)
Browse files Browse the repository at this point in the history
Signed-off-by: Aolin <aolin.zhang@pingcap.com>
Co-authored-by: Yue Yang <g1enyy0ung@gmail.com>
  • Loading branch information
Oreoxmt and g1eny0ung authored Sep 11, 2024
1 parent 0d61f62 commit 08b51f2
Show file tree
Hide file tree
Showing 41 changed files with 69 additions and 69 deletions.
2 changes: 1 addition & 1 deletion docs/basic-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This document describes the basic features of Chaos Mesh, including [fault injec
Fault injection is the key of Chaos experiments. Chaos Mesh covers a full range of faults that might occur in a distributed system, and provides three comprehensive and fine-grained fault types: basic resource faults, platform faults, and application-layer faults.

- Basic resource faults:
- [PodChaos](simulate-pod-chaos-on-kubernetes.md): simulates Pod failures, such as Pod node restart, Pod's persistent unavailablility, and certain container failures in a specific Pod.
- [PodChaos](simulate-pod-chaos-on-kubernetes.md): simulates Pod failures, such as Pod node restart, Pod's persistent unavailability, and certain container failures in a specific Pod.
- [NetworkChaos](simulate-network-chaos-on-kubernetes.md): simulates network failures, such as network latency, packet loss, packet disorder, and network partitions.
- [DNSChaos](simulate-dns-chaos-on-kubernetes.md): simulates DNS failures, such as the parsing failure of DNS domain name and the wrong IP address returned.
- [HTTPChaos](simulate-http-chaos-on-kubernetes.md): simulates HTTP communication failures, such as HTTP communication latency.
Expand Down
2 changes: 1 addition & 1 deletion docs/chaosd-search-recover.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Search and Recover Experiments of Chaosd
summary: Describes how to search and recover the experiments of Chaosd, and provide related examples.
---

You can search experiments by conditions and recover the experiments corresponding to specified UIDs using Chaosd. This document describes how to search and recover experiments of Chaosd, and provides releated examples.
You can search experiments by conditions and recover the experiments corresponding to specified UIDs using Chaosd. This document describes how to search and recover experiments of Chaosd, and provides related examples.

## Search experiments of Chaosd

Expand Down
8 changes: 4 additions & 4 deletions docs/define-chaos-experiment-scope.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ When you create a Chaos experiment, Chaos Mesh supports the following ways to de

## Define the experiment scope in a YAML configuration file

This section introduces the meanings of different selector types and their the usages, and provides the configuration examples in the YAML file. When defining the experiment scope in the YAML file, you can specify one or more selectors according to your need of scope filtering.
This section introduces the meanings of different selector types and their usages, and provides the configuration examples in the YAML file. When defining the experiment scope in the YAML file, you can specify one or more selectors according to your need of scope filtering.

### Namespace selectors

Expand Down Expand Up @@ -51,7 +51,7 @@ spec:
### Expression selectors
- Specifies a set of [expressions](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#resources-that-support-set-based-requirements) that define the label's rules to specifiy the experiment's target Pod.
- Specifies a set of [expressions](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#resources-that-support-set-based-requirements) that define the label's rules to specify the experiment's target Pod.
- You can use this selector to set up the experiment's target Pod that does not meet some labels.
When creating the experiment using the YAML file, you need to configure selectors. For example:
Expand Down Expand Up @@ -179,8 +179,8 @@ spec:
selector:
physicalMachines:
default: # namespace of the target PhysicalMachines
- physcial-machine-a
- physcial-machine-b
- physical-machine-a
- physical-machine-b
```

## Define the experiment scope on Chaos Dashboard
Expand Down
2 changes: 1 addition & 1 deletion docs/inspect-chaos-experiments.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ The above output contains two parts:
- `Paused`: indicates the chaos experiment is in the "Paused" step.
- `Selected`: indicates the chaos experiment had correctly selected the target pods where to inject chaos actions.
- `AllInjected`: indicates the faults have been successfully injected to all target pods.
- `AllRecoverd`: indicates the injected faults have been succesfully restored from all target pods.
- `AllRecoverd`: indicates the injected faults have been successfully restored from all target pods.

The actual running status of current chaos experiments can be inferred from these four types of status records. For example:

Expand Down
2 changes: 1 addition & 1 deletion docs/simulate-dns-chaos-on-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This document describes how to create DNSChaos experiments in Chaos Mesh to simu

:::info

To simluate DNS faults, you need to deploy a special DNS service called Chaos DNS Server.
To simulate DNS faults, you need to deploy a special DNS service called Chaos DNS Server.

In the latest version, Chaos Mesh will deploy Chaos DNS Server by default. If you don't need to simulate DNS faults, you can set `dnsServer.create` to `false` when installing Chaos Mesh:

Expand Down
6 changes: 3 additions & 3 deletions docs/simulate-jvm-application-chaos-in-physical-nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ Global Flags:
| Configuration item | Abbreviation | Description | Value |
| :-- | :-- | :-- | :-- |
| `class` | `c` | The name of the Java class | string type, required |
| `latency` | None | The duration of increasing method latency | int type, required. The unit is milisecond. |
| `latency` | None | The duration of increasing method latency | int type, required. The unit is millisecond. |
| `method` | `m` | The name of the method | string type, required |
| `pid` | None | The Java process ID where the fault is to be injected | int type, required |
| `port` | None | The port number attached to the Java process agent. The fault is injected into the Java process through this port number. | int type. The default value is `9288`. |
Expand Down Expand Up @@ -471,7 +471,7 @@ Triggering garbage collection is a one-time operation. The experiment does not r
| :-- | :-- | :-- |
| `action` | The action of the experiment | Set to "latency" |
| `class` | The name of the Java class | string type, required |
| `latency` | The duration of increasing method latency | int type, required. The unit is milisecond. |
| `latency` | The duration of increasing method latency | int type, required. The unit is millisecond. |
| `method` | The name of the method | string type, required |
| `pid` | The Java process ID where the fault is to be injected | int type, required |
| `port` | The Java process ID where the fault is needed to be injected | int type, required |
Expand Down Expand Up @@ -517,7 +517,7 @@ The result is as follows:

### Trigger faults by setting Byteman configuration files using service mode

You can set the fault rules according to the Byteman rule configuration. Regarding to the Byteman rule configuration, refer to [byteman-rule-language](https://downloads.jboss.org/byteman/4.0.16/byteman-programmers-guide.html#the-byteman-rule-language).
You can set the fault rules according to the Byteman rule configuration. For more information about the Byteman rule configuration, refer to [byteman-rule-language](https://downloads.jboss.org/byteman/4.0.16/byteman-programmers-guide.html#the-byteman-rule-language).

#### Parameters for triggering faults by setting Byteman configuration files

Expand Down
4 changes: 2 additions & 2 deletions docs/simulate-jvm-application-chaos.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ For different `action` values, there are different configuration items that can
| --- | --- | --- | --- |
| `class` | string | The name of the Java class | Yes |
| `method` | string | The name of the method | Yes |
| `latency` | int | The duration of increasing method latency. The unit is milisecond. | Yes |
| `latency` | int | The duration of increasing method latency. The unit is millisecond. | Yes |
| `port` | int | The port ID attached to the Java process agent. The faults are injected into the Java process through this ID. | No |

### Parameters for `return`
Expand Down Expand Up @@ -221,7 +221,7 @@ For different `action` values, there are different configuration items that can

| Parameter | Type | Description | Required |
| --- | --- | --- | --- |
| `ruleData` | srting | Specifies the Byteman configuration data | Yes |
| `ruleData` | string | Specifies the Byteman configuration data | Yes |
| `port` | int | The port ID attached to the Java process agent. The faults are injected into the Java process through this ID. | No |

When you write the rule configuration file, take into account the specific Java program and the [byteman-rule-language](https://downloads.jboss.org/byteman/4.0.16/byteman-programmers-guide.html#the-byteman-rule-language). For example:
Expand Down
2 changes: 1 addition & 1 deletion docs/simulate-kernel-chaos-on-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The simulation of Linux kernel faults is disabled by default. Do not use this fe
## Prerequisites

- Linux kernel version >= 4.18.
- The Linux kernel configuration [CONFOG_BPF_KPROBE_OVERRIDE](https://cateee.net/lkddb/web-lkddb/BPF_KPROBE_OVERRIDE.html) is enabled.
- The Linux kernel configuration [CONFIG_BPF_KPROBE_OVERRIDE](https://cateee.net/lkddb/web-lkddb/BPF_KPROBE_OVERRIDE.html) is enabled.
- The `bpfki.create` configuration value in [values.yaml](https://github.com/chaos-mesh/chaos-mesh/blob/master/helm/chaos-mesh/values.yaml) is `true`.

## Configuration file
Expand Down
2 changes: 1 addition & 1 deletion docs/simulate-network-chaos-on-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ Before creating NetworkChaos experiments, ensure the following:
| --- | --- | --- | --- | --- | --- |
| action | string | Indicates the specific fault type. Available types include: `netem`, `delay` (network delay), `loss` (packet loss), `duplicate` (packet duplicating), `corrupt` (packet corrupt), `partition` (network partition), and `bandwidth` (network bandwidth limit). After you specify `action` field, refer to [Description for `action`-related fields](#description-for-action-related-fields) for other necessary field configuration. | None | Yes | Partition |
| target | Selector | Used in combination with direction, making Chaos only effective for some packets. | None | No | |
| direction | enum | Indicates the direction of `target` packets. Available vaules include `from` (the packets from `target`), `to` (the packets to `target`), and `both` ( the packets from or to `target`). This parameter makes Chaos only take effect for a specific direction of packets. | to | No | both |
| direction | enum | Indicates the direction of `target` packets. Available values include `from` (the packets from `target`), `to` (the packets to `target`), and `both` ( the packets from or to `target`). This parameter makes Chaos only take effect for a specific direction of packets. | to | No | both |
| mode | string | Specifies the mode of the experiment. The mode options include `one` (selecting a random Pod), `all` (selecting all eligible Pods), `fixed` (selecting a specified number of eligible Pods), `fixed-percent` (selecting a specified percentage of Pods from the eligible Pods), and `random-max-percent` (selecting the maximum percentage of Pods from the eligible Pods). | None | Yes | `one` |
| value | string | Provides a parameter for the `mode` configuration, depending on `mode`. For example, when `mode` is set to `fixed-percent`, `value` specifies the percentage of Pods. | None | No | 1 |
| selector | struct | Specifies the target Pod. For details, refer to [Define the experiment scope](./define-chaos-experiment-scope.md). | None | Yes | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,8 @@ spec:
selector:
physicalMachines:
default: # namespace of the target PhysicalMachines
- physcial-machine-a
- physcial-machine-b
- physical-machine-a
- physical-machine-b
```

## 在 Dashboard 上定义实验范围
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ kubectl -n helloworld logs -f helloworld

| 参数 | 类型 | 说明 | 是否必填 |
| ---------- | ----------- | ------------------------------------------------------------------- | -------- |
| `ruleData` | srting 类型 | 指定 Byteman 配置数据 | 是 |
| `ruleData` | string 类型 | 指定 Byteman 配置数据 | 是 |
| `port` | int 类型 | 附加到 Java 进程 agent 的端口号,通过该端口号将故障注入到 Java 进程 | 否 |

当编写规则配置文件时,你需要根据具体的 Java 程序,并参考 [byteman-rule-language](https://downloads.jboss.org/byteman/4.0.16/byteman-programmers-guide.html#the-byteman-rule-language)。例如:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,8 @@ spec:
selector:
physicalMachines:
default: # namespace of the target PhysicalMachines
- physcial-machine-a
- physcial-machine-b
- physical-machine-a
- physical-machine-b
```

## 在 Dashboard 上定义实验范围
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ kubectl -n helloworld logs -f helloworld

| 参数 | 类型 | 说明 | 是否必填 |
| ---------- | ----------- | ------------------------------------------------------------------- | -------- |
| `ruleData` | srting 类型 | 指定 Byteman 配置数据 | 是 |
| `ruleData` | string 类型 | 指定 Byteman 配置数据 | 是 |
| `port` | int 类型 | 附加到 Java 进程 agent 的端口号,通过该端口号将故障注入到 Java 进程 | 否 |

当编写规则配置文件时,你需要根据具体的 Java 程序,并参考 [byteman-rule-language](https://downloads.jboss.org/byteman/4.0.16/byteman-programmers-guide.html#the-byteman-rule-language)。例如:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,8 @@ spec:
selector:
physicalMachines:
default: # namespace of the target PhysicalMachines
- physcial-machine-a
- physcial-machine-b
- physical-machine-a
- physical-machine-b
```

## 在 Dashboard 上定义实验范围
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ kubectl -n helloworld logs -f helloworld

| 参数 | 类型 | 说明 | 是否必填 |
| ---------- | ----------- | ------------------------------------------------------------------- | -------- |
| `ruleData` | srting 类型 | 指定 Byteman 配置数据 | 是 |
| `ruleData` | string 类型 | 指定 Byteman 配置数据 | 是 |
| `port` | int 类型 | 附加到 Java 进程 agent 的端口号,通过该端口号将故障注入到 Java 进程 | 否 |

当编写规则配置文件时,你需要根据具体的 Java 程序,并参考 [byteman-rule-language](https://downloads.jboss.org/byteman/4.0.16/byteman-programmers-guide.html#the-byteman-rule-language)。例如:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,8 @@ spec:
selector:
physicalMachines:
default: # namespace of the target PhysicalMachines
- physcial-machine-a
- physcial-machine-b
- physical-machine-a
- physical-machine-b
```

## 在 Dashboard 上定义实验范围
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ kubectl -n helloworld logs -f helloworld

| 参数 | 类型 | 说明 | 是否必填 |
| ---------- | ----------- | ------------------------------------------------------------------- | -------- |
| `ruleData` | srting 类型 | 指定 Byteman 配置数据 | 是 |
| `ruleData` | string 类型 | 指定 Byteman 配置数据 | 是 |
| `port` | int 类型 | 附加到 Java 进程 agent 的端口号,通过该端口号将故障注入到 Java 进程 | 否 |

当编写规则配置文件时,你需要根据具体的 Java 程序,并参考 [byteman-rule-language](https://downloads.jboss.org/byteman/4.0.16/byteman-programmers-guide.html#the-byteman-rule-language)。例如:
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-2.4.3/basic-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This document describes the basic features of Chaos Mesh, including [fault injec
Fault injection is the key of Chaos experiments. Chaos Mesh covers a full range of faults that might occur in a distributed system, and provides three comprehensive and fine-grained fault types: basic resource faults, platform faults, and application-layer faults.

- Basic resource faults:
- [PodChaos](simulate-pod-chaos-on-kubernetes.md): simulates Pod failures, such as Pod node restart, Pod's persistent unavailablility, and certain container failures in a specific Pod.
- [PodChaos](simulate-pod-chaos-on-kubernetes.md): simulates Pod failures, such as Pod node restart, Pod's persistent unavailability, and certain container failures in a specific Pod.
- [NetworkChaos](simulate-network-chaos-on-kubernetes.md): simulates network failures, such as network latency, packet loss, packet disorder, and network partitions.
- [DNSChaos](simulate-dns-chaos-on-kubernetes.md): simulates DNS failures, such as the parsing failure of DNS domain name and the wrong IP address returned.
- [HTTPChaos](simulate-http-chaos-on-kubernetes.md): simulates HTTP communication failures, such as HTTP communication latency.
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-2.4.3/chaosd-search-recover.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Search and Recover Experiments of Chaosd
summary: Describes how to search and recover the experiments of Chaosd, and provide related examples.
---

You can search experiments by conditions and recover the experiments corresponding to specified UIDs using Chaosd. This document describes how to search and recover experiments of Chaosd, and provides releated examples.
You can search experiments by conditions and recover the experiments corresponding to specified UIDs using Chaosd. This document describes how to search and recover experiments of Chaosd, and provides related examples.

## Search experiments of Chaosd

Expand Down
8 changes: 4 additions & 4 deletions versioned_docs/version-2.4.3/define-chaos-experiment-scope.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ When you create a Chaos experiment, Chaos Mesh supports the following ways to de

## Define the experiment scope in a YAML configuration file

This section introduces the meanings of different selector types and their the usages, and provides the configuration examples in the YAML file. When defining the experiment scope in the YAML file, you can specify one or more selectors according to your need of scope filtering.
This section introduces the meanings of different selector types and their usages, and provides the configuration examples in the YAML file. When defining the experiment scope in the YAML file, you can specify one or more selectors according to your need of scope filtering.

### Namespace selectors

Expand Down Expand Up @@ -51,7 +51,7 @@ spec:
### Expression selectors
- Specifies a set of [expressions](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#resources-that-support-set-based-requirements) that define the label's rules to specifiy the experiment's target Pod.
- Specifies a set of [expressions](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#resources-that-support-set-based-requirements) that define the label's rules to specify the experiment's target Pod.
- You can use this selector to set up the experiment's target Pod that does not meet some labels.
When creating the experiment using the YAML file, you need to configure selectors. For example:
Expand Down Expand Up @@ -179,8 +179,8 @@ spec:
selector:
physicalMachines:
default: # namespace of the target PhysicalMachines
- physcial-machine-a
- physcial-machine-b
- physical-machine-a
- physical-machine-b
```

## Define the experiment scope on Chaos Dashboard
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-2.4.3/inspect-chaos-experiments.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ The above output contains two parts:
- `Paused`: indicates the chaos experiment is in the "Paused" step.
- `Selected`: indicates the chaos experiment had correctly selected the target pods where to inject chaos actions.
- `AllInjected`: indicates the faults have been successfully injected to all target pods.
- `AllRecoverd`: indicates the injected faults have been succesfully restored from all target pods.
- `AllRecoverd`: indicates the injected faults have been successfully restored from all target pods.

The actual running status of current chaos experiments can be inferred from these four types of status records. For example:

Expand Down
Loading

0 comments on commit 08b51f2

Please sign in to comment.