Skip to content

Commit 228b1b8

Browse files
authored
refactoring installation doc (#43)
Signed-off-by: Raj Das <mail.rajdas@gmail.com>
1 parent 4d9b013 commit 228b1b8

File tree

3 files changed

+34
-52
lines changed

3 files changed

+34
-52
lines changed

website/docs/agent-installation.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -61,42 +61,42 @@ To install the latest version of litmusctl follow the below steps:
6161

6262
- Extract the binary
6363

64-
```shell
65-
$ tar -zxvf litmusctl-<OS>-<ARCH>-<VERSION>.tar.gz
64+
```bash
65+
tar -zxvf litmusctl-<OS>-<ARCH>-<VERSION>.tar.gz
6666
```
6767

6868
- Provide necessary permissions
6969

70-
```shell
71-
$ chmod +x litmusctl
70+
```bash
71+
chmod +x litmusctl
7272
```
7373

7474
- Move the litmusctl binary to /usr/local/bin/litmusctl
7575

76-
```shell
77-
$ sudo mv litmusctl /usr/local/bin/litmusctl
76+
```bash
77+
sudo mv litmusctl /usr/local/bin/litmusctl
7878
```
7979

8080
## Basic Commands
8181

8282
litmusctl CLI command has the following structure:
8383

84-
```shell
85-
$ litmusctl <command> <subcommand> <subcommand> [options and parameters]
84+
```bash
85+
litmusctl <command> <subcommand> <subcommand> [options and parameters]
8686
```
8787

8888
To get the version of the litmusctl CLI:
8989

90-
```shell
91-
$ litmusctl version
90+
```bash
91+
litmusctl version
9292
```
9393

9494
### Connecting an agent
9595

9696
To connect Litmus Chaos agent:
9797

98-
```shell
99-
$ litmusctl agent connect
98+
```bash
99+
litmusctl agent connect
100100
```
101101

102102
Next, you need to enter LitmusPortal details to login into your LitmusPortal account. Fields to be filled in:
@@ -107,7 +107,7 @@ Example, http://172.17.0.2:31696/
107107
**Username:** Enter your LitmusPortal username.
108108
**Password:** Enter your LitmusPortal password.
109109

110-
```shell
110+
```bash
111111
🔥 Connecting LitmusChaos agent
112112

113113
📶 Please enter LitmusChaos details --
@@ -119,7 +119,7 @@ Example, http://172.17.0.2:31696/
119119

120120
Upon successful login, there will be a list of exiting projects displayed on the terminal. Select the desired project by entering the sequence number indicated against it.
121121

122-
```shell
122+
```bash
123123
✨ Projects List:
124124
1. abc
125125

website/docs/litmus-installation-cluster.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,8 @@ The following steps will help you install litmus via helm.
3232
#### Step-1: Add the litmus helm repository
3333

3434
```bash
35-
root@demo:~# helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/
36-
"litmuschaos" has been added to your repositories
37-
```
38-
39-
```bash
40-
root@demo:~# helm repo list
41-
NAME URL
42-
litmuschaos https://litmuschaos.github.io/litmus-helm/
35+
helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/
36+
helm repo list
4337
```
4438

4539
#### Step-2: Create the litmus namespace
@@ -49,14 +43,13 @@ litmuschaos https://litmuschaos.github.io/litmus-helm/
4943
**Note**: The chaos control plane can be placed in any namespace, though it is typically placed in "litmus".
5044

5145
```bash
52-
root@demo:~# kubectl create ns litmus
53-
namespace/litmus created
46+
kubectl create ns litmus
5447
```
5548

5649
#### Step-3: Install the litmus chaos control plane
5750

5851
```bash
59-
root@demo:~# helm install chaos litmuschaos/litmus-2-0-0-beta --namespace=litmus --devel
52+
helm install chaos litmuschaos/litmus-2-0-0-beta --namespace=litmus --devel
6053
```
6154

6255
<span style={{color: 'green'}}><b>Expected Output</b></span>
@@ -74,7 +67,6 @@ Thank you for installing litmus-2-0-0-beta 😀
7467
Your release is named chaos and its installed to namespace: litmus.
7568
7669
Visit https://docs.litmuschaos.io/docs/getstarted/ to find more info.
77-
7870
```
7971

8072
> **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.

website/docs/litmus-installation-namespace.md

Lines changed: 16 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,8 @@ The following steps will help you install litmus via helm.
3232
#### Step-1: Add the litmus helm repository
3333

3434
```bash
35-
root@demo:~# helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/
36-
"litmuschaos" has been added to your repositories
37-
```
38-
39-
```bash
40-
root@demo:~# helm repo list
41-
NAME URL
42-
litmuschaos https://litmuschaos.github.io/litmus-helm/
35+
helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/
36+
helm repo list
4337
```
4438

4539
#### Step-2: Create the litmus namespace
@@ -49,14 +43,13 @@ litmuschaos https://litmuschaos.github.io/litmus-helm/
4943
**Note**: The chaos control plane can be placed in any namespace, though it is typically placed in "litmus".
5044

5145
```bash
52-
root@demo:~# kubectl create ns litmus
53-
namespace/litmus created
46+
kubectl create ns litmus
5447
```
5548

5649
#### Step-3: Install the litmus chaos control plane
5750

5851
```bash
59-
root@demo:~# helm install chaos litmuschaos/litmus-2-0-0-beta --namespace=litmus --devel --set portalScope=namespace
52+
helm install chaos litmuschaos/litmus-2-0-0-beta --namespace=litmus --devel --set portalScope=namespace
6053
```
6154

6255
<span style={{color: 'green'}}><b>Expected Output</b></span>
@@ -85,7 +78,7 @@ Visit https://docs.litmuschaos.io/docs/getstarted/ to find more info.
8578
kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/litmus-portal-crds.yml
8679
```
8780

88-
Output:
81+
<span style={{color: 'green'}}><b>Expected Output</b></span>
8982

9083
```bash
9184
customresourcedefinition.apiextensions.k8s.io/clusterworkflowtemplates.argoproj.io created
@@ -118,7 +111,7 @@ kubectl create ns ${LITMUS_PORTAL_NAMESPACE}
118111
kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/litmus-portal-crds.yml
119112
```
120113

121-
Output:
114+
<span style={{color: 'green'}}><b>Expected Output</b></span>
122115

123116
```bash
124117
customresourcedefinition.apiextensions.k8s.io/clusterworkflowtemplates.argoproj.io created
@@ -141,7 +134,7 @@ ${LITMUS_PORTAL_NAMESPACE}-ns-scoped-litmus-portal-manifest.yml
141134
kubectl apply -f ${LITMUS_PORTAL_NAMESPACE}-ns-scoped-litmus-portal-manifest.yml -n ${LITMUS_PORTAL_NAMESPACE}
142135
```
143136

144-
Output:
137+
<span style={{color: 'green'}}><b>Expected Output</b></span>
145138

146139
```bash
147140
configmap/litmus-portal-admin-config created
@@ -160,22 +153,15 @@ service/mongo-service created
160153

161154
**Verify if the frontend, server, and database pods are running**
162155

163-
- Check the litmus CRDs:
156+
- Check the pods in litmus namespace:
164157

165158
```bash
166-
$ kubectl get crds | grep litmus
167-
chaosengines.litmuschaos.io 2021-03-24T06:52:54Z
168-
chaosexperiments.litmuschaos.io 2021-03-24T06:52:54Z
169-
chaosresults.litmuschaos.io 2021-03-24T06:52:55Z
170-
eventtrackerpolicies.eventtracker.litmuschaos.io 2021-03-24T06:52:55Z
171-
159+
kubectl get pods -n litmus
172160
```
173161

174-
- Check the pods in litmus namespace:
175-
162+
<span style={{color: 'green'}}><b>Expected Output</b></span>
163+
176164
```bash
177-
$ kubectl get pods -n litmus
178-
179165
NAME READY STATUS RESTARTS AGE
180166
litmusportal-frontend-97c8bf86b-mx89w 1/1 Running 2 6m24s
181167
litmusportal-server-5cfbfc88cc-m6c5j 2/2 Running 2 6m19s
@@ -185,8 +171,12 @@ service/mongo-service created
185171
- Check the services running in litmus namespace:
186172

187173
```bash
188-
$ kubectl get svc -n litmus
174+
kubectl get svc -n litmus
175+
```
176+
177+
<span style={{color: 'green'}}><b>Expected Output</b></span>
189178

179+
```bash
190180
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
191181
litmusportal-frontend-service NodePort 10.100.105.154 <none> 9091:30229/TCP 7m14s
192182
litmusportal-server-service NodePort 10.100.150.175 <none> 9002:30479/TCP,9003:31949/TCP 7m8s

0 commit comments

Comments
 (0)