Skip to content

Commit 0ec65b1

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

File tree

3 files changed

+21
-12
lines changed

3 files changed

+21
-12
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
@@ -42,7 +42,7 @@ helm repo list
4242

4343
#### Step-2: Create the litmus namespace
4444

45-
- The litmus infra components will be placed in this namespace.
45+
The litmus infra components will be placed in this namespace.
4646

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

website/docs/litmus-installation-namespace.md

Lines changed: 16 additions & 7 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

@@ -42,7 +42,7 @@ helm repo list
4242

4343
#### Step-2: Create the litmus namespace
4444

45-
- The litmus infra components will be placed in this namespace.
45+
The litmus infra components will be placed in this namespace.
4646

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

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

7777
> **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.
7878
79-
- The cluster-admin or an equivalent user with the right permissions are required to install them CRDs upfront. To apply LitmusCRDs:
79+
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.
8080

8181
```bash
8282
kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/litmus-portal-crds.yml
@@ -99,7 +99,7 @@ customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker.
9999

100100
#### **Install Litmus**
101101

102-
- Set the namespace on which you want to install litmus.
102+
Set the namespace on which you want to install litmus.
103103

104104
```bash
105105
export LITMUS_PORTAL_NAMESPACE="<namespace>"
@@ -109,7 +109,7 @@ kubectl get ns ${LITMUS_PORTAL_NAMESPACE}
109109
kubectl create ns ${LITMUS_PORTAL_NAMESPACE}
110110
```
111111

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

114114
```bash
115115
kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/litmus-portal-crds.yml
@@ -128,7 +128,7 @@ customresourcedefinition.apiextensions.k8s.io/chaosresults.litmuschaos.io create
128128
customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker.litmuschaos.io created
129129
```
130130

131-
- Replace namespace with the target namespace.
131+
Replace namespace with the target namespace.
132132

133133
```bash
134134
export LITMUS_PORTAL_NAMESPACE="<namespace>"
@@ -157,22 +157,31 @@ service/mongo-service created
157157

158158
**Verify if the frontend, server, and database pods are running**
159159

160+
<<<<<<< HEAD
160161
- Check the pods in litmus namespace:
162+
=======
163+
Check the litmus CRDs:
164+
>>>>>>> 46a701c (Modified Litnmus Installation steps(Cluster and Namespace modes))
161165
162166
```bash
163167
kubectl get pods -n litmus
164168
```
165169

170+
<<<<<<< HEAD
166171
<span style={{color: 'green'}}><b>Expected Output</b></span>
167172

173+
=======
174+
Check the pods in litmus namespace:
175+
176+
>>>>>>> 46a701c (Modified Litnmus Installation steps(Cluster and Namespace modes))
168177
```bash
169178
NAME READY STATUS RESTARTS AGE
170179
litmusportal-frontend-97c8bf86b-mx89w 1/1 Running 2 6m24s
171180
litmusportal-server-5cfbfc88cc-m6c5j 2/2 Running 2 6m19s
172181
mongo-0 1/1 Running 0 6m16s
173182
```
174183

175-
- Check the services running in litmus namespace:
184+
Check the services running in litmus namespace:
176185

177186
```bash
178187
kubectl get svc -n litmus

0 commit comments

Comments
 (0)