Skip to content

Commit 46a701c

Browse files
committed
Modified Litnmus Installation steps(Cluster and Namespace modes)
Signed-off-by: Gbadebo Bello <gbahdeybohbello@gmail.com>
1 parent be0b02a commit 46a701c

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed

website/docs/getstarted.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ sidebar_label: Pre-requisites
2020

2121
Running chaos on your application involves the following steps:
2222

23-
[Install Litmus](litmus-install-cluster-mode)
23+
- [Install Litmus](litmus-install-cluster-mode)
2424

25-
[How to Create and Run a Workflow](create-workflow)
25+
- [How to Create and Run a Workflow](create-workflow)
2626

27-
[Observe ChaosResults](observe-workflow)
27+
- [Observe ChaosResults](observe-workflow)
2828

2929
<hr/>
3030

website/docs/litmus-installation-cluster.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Installing Litmus in cluster mode gives Litmus access to cluster wide resources.
2222

2323
## Installation
2424

25-
Installation of Litmus can be done using either of the below methods
25+
Installation of Litmus can be done using either of the below methods;
2626

2727
- [Helm3](#helm_install) chart or
2828
- [Kubectl](#kubectl_install) yaml spec file
@@ -48,7 +48,7 @@ litmuschaos https://litmuschaos.github.io/litmus-helm/
4848

4949
#### Step-2: Create the litmus namespace
5050

51-
- The litmus infra components will be placed in this namespace.
51+
The litmus infra components will be placed in this namespace.
5252

5353
**Note**: The chaos control plane can be placed in any namespace, though it is typically placed in "litmus".
5454

website/docs/litmus-installation-namespace.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Installing Litmus in namespace mode limits Litmus access to a particluar namespa
1616

1717
- Kubernetes 1.15 or later.
1818
19-
- Recommend to have a Persistent volume(PV) of 20GB, You can start with 1GB for test purposes as well. This PV is used as persistent storage to store the chaos config and chaos-metrics in the Portal. By default, litmus would use the default storage class to allocate the PV.
19+
- It is Recommended to have a Persistent volume(PV) of 20GB, You can start with 1GB for test purposes as well. This PV is used as persistent storage to store the chaos config and chaos-metrics in the Portal. By default, litmus would use the default storage class to allocate the PV.
2020

2121
- Helm3 or Kubectl
2222

@@ -48,7 +48,7 @@ litmuschaos https://litmuschaos.github.io/litmus-helm/
4848

4949
#### Step-2: Create the litmus namespace
5050

51-
- The litmus infra components will be placed in this namespace.
51+
The litmus infra components will be placed in this namespace.
5252

5353
**Note**: The chaos control plane can be placed in any namespace, though it is typically placed in "litmus".
5454

@@ -83,7 +83,7 @@ Visit https://docs.litmuschaos.io/docs/getstarted/ to find more info.
8383

8484
> **Note:** Litmus uses Kubernetes CRDs to define chaos intent. Helm3 handles CRDs better than Helm2. Before you start running a chaos experiment, verify if Litmus is installed correctly.
8585
86-
- The cluster-admin or an equivalent user with the right permissions are required to install them CRDs upfront. To apply LitmusCRDs:
86+
The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. To apply LitmusCRDs, run the command below.
8787

8888
```bash
8989
kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/litmus-portal-crds.yml
@@ -106,7 +106,7 @@ customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker.
106106

107107
#### **Install Litmus**
108108

109-
- Set the namespace on which you want to install litmus.
109+
Set the namespace on which you want to install litmus.
110110

111111
```bash
112112
export LITMUS_PORTAL_NAMESPACE="<namespace>"
@@ -116,7 +116,7 @@ kubectl get ns ${LITMUS_PORTAL_NAMESPACE}
116116
kubectl create ns ${LITMUS_PORTAL_NAMESPACE}
117117
```
118118

119-
- The cluster-admin or an equivalent user with the right permissions are required to install them CRDs upfront. To apply LitmusCRDs:
119+
The cluster-admin or an equivalent user with the right permissions are required to install them CRDs upfront. To apply LitmusCRDs, run:
120120

121121
```bash
122122
kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/litmus-portal-crds.yml
@@ -135,7 +135,7 @@ customresourcedefinition.apiextensions.k8s.io/chaosresults.litmuschaos.io create
135135
customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker.litmuschaos.io created
136136
```
137137

138-
- Replace namespace with the target namespace.
138+
Replace namespace with the target namespace.
139139

140140
```bash
141141
export LITMUS_PORTAL_NAMESPACE="<namespace>"
@@ -164,7 +164,7 @@ service/mongo-service created
164164

165165
**Verify if the frontend, server, and database pods are running**
166166

167-
- Check the litmus CRDs:
167+
Check the litmus CRDs:
168168

169169
```bash
170170
$ kubectl get crds | grep litmus
@@ -175,7 +175,7 @@ service/mongo-service created
175175

176176
```
177177

178-
- Check the pods in litmus namespace:
178+
Check the pods in litmus namespace:
179179

180180
```bash
181181
$ kubectl get pods -n litmus
@@ -186,7 +186,7 @@ service/mongo-service created
186186
mongo-0 1/1 Running 0 6m16s
187187
```
188188

189-
- Check the services running in litmus namespace:
189+
Check the services running in litmus namespace:
190190

191191
```bash
192192
$ kubectl get svc -n litmus

0 commit comments

Comments
 (0)