Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 837b849

Browse files
authored
Chore(docs): Udpate pre-requisite content (#499)
Signed-off-by: udit <[email protected]>
1 parent 9cc9290 commit 837b849

File tree

4 files changed

+6
-8
lines changed

4 files changed

+6
-8
lines changed

docs/disk-fill.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ sidebar_label: Disk Fill
2626
- Ensure that the Litmus Chaos Operator is running by executing `kubectl get pods` in operator namespace (typically, `litmus`). If not, install from [here](https://v1-docs.litmuschaos.io/docs/getstarted/#install-litmus)
2727
- Ensure that the `disk-fill` experiment resource is available in the cluster by executing `kubectl get chaosexperiments` in the desired namespace If not, install from [here](https://hub.litmuschaos.io/api/chaos/master?file=charts/generic/disk-fill/experiment.yaml)
2828
- Cluster must run docker container runtime
29-
- Appropriate Ephemeral Storage Requests and Limits should be set for the application before running the experiment.
29+
- Either an appropriate Ephemeral Storage Requests and Limits should be set for the application or `EPHEMERAL_STORAGE_MEBIBYTES` ENV should be defined in the ChaosEngine before running the experiment.
3030
An example specification is shown below:
3131

3232
```

docs/getstarted.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_label: Introduction
77

88
## Pre-requisites
99

10-
Kubernetes 1.15 or later.
10+
Kubernetes 1.16 or later.
1111

1212
## Getting Started
1313

@@ -19,8 +19,6 @@ Running chaos on your application involves the following steps:
1919

2020
[Setup Service Account](#setup-service-account)
2121

22-
[Annotate your application](#annotate-your-application)
23-
2422
[Prepare ChaosEngine](#prepare-chaosengine)
2523

2624
[Run Chaos](#run-chaos)

docs/pod-dns-error.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,11 +165,11 @@ subjects:
165165
<td> CONTAINER_RUNTIME </td>
166166
<td> container runtime interface for the cluster</td>
167167
<td> Optional </td>
168-
<td> Defaults to docker, supported values: docker, containerd and crio </td>
168+
<td> Defaults to docker, supported values: docker </td>
169169
</tr>
170170
<tr>
171171
<td> SOCKET_PATH </td>
172-
<td> Path of the containerd/crio/docker socket file </td>
172+
<td> Path of the docker socket file </td>
173173
<td> Optional </td>
174174
<td> Defaults to `/var/run/docker.sock` </td>
175175
</tr>

docs/pod-dns-spoof.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,11 +159,11 @@ subjects:
159159
<td> CONTAINER_RUNTIME </td>
160160
<td> container runtime interface for the cluster</td>
161161
<td> Optional </td>
162-
<td> Defaults to docker, supported values: docker, containerd and crio </td>
162+
<td> Defaults to docker, supported values: docker </td>
163163
</tr>
164164
<tr>
165165
<td> SOCKET_PATH </td>
166-
<td> Path of the containerd/crio/docker socket file </td>
166+
<td> Path of the docker socket file </td>
167167
<td> Optional </td>
168168
<td> Defaults to `/var/run/docker.sock` </td>
169169
</tr>

0 commit comments

Comments
 (0)