Skip to content

Commit 754786c

Browse files
authored
Refactoring installation mode in the docs (#40)
* Refactoring installation mode in the docs Signed-off-by: Raj Das <mail.rajdas@gmail.com>
1 parent 6dbda90 commit 754786c

File tree

9 files changed

+293
-466
lines changed

9 files changed

+293
-466
lines changed

.wordlist.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
mongodb
2+
eventtracker
3+
eventtrackerpolicies
4+
portalScope
5+
LitmusCRDs
26
graphql
37
accomodate
48
accomodated

website/docs/admin-mode.md

Lines changed: 0 additions & 193 deletions
This file was deleted.

website/docs/agent-installation.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,22 +27,6 @@ The litmusctl CLI requires the following things:
2727

2828
To install the latest version of litmusctl follow the below steps:
2929

30-
- Download the stable litmusctl(v0.1.0) binary from:
31-
32-
| Platforms | Download Link |
33-
| ------------------------------ | ------------------------------------------------------------------------------------------------------- |
34-
| litmusctl-darwin-386 (MacOS) | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-darwin-386-v0.1.0.tar.gz) |
35-
| litmusctl-darwin-amd64 (MacOS) | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-darwin-amd64-v0.1.0.tar.gz) |
36-
| litmusctl-linux-386 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-386-v0.1.0.tar.gz) |
37-
| litmusctl-linux-amd64 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-amd64-v0.1.0.tar.gz) |
38-
| litmusctl-linux-arm | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-arm-v0.1.0.tar.gz) |
39-
| litmusctl-linux-arm64 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-arm64-v0.1.0.tar.gz) |
40-
| litmusctl-windows-386 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-windows-386-v0.1.0.tar.gz) |
41-
| litmusctl-windows-amd64 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-windows-amd64-v0.1.0.tar.gz) |
42-
| litmusctl-windows-arm | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-windows-arm-v0.1.0.tar.gz) |
43-
44-
<br />
45-
4630
- Download the latest litmusctl(master) binary from:
4731

4832
| Platforms | Download Link |
@@ -59,6 +43,22 @@ To install the latest version of litmusctl follow the below steps:
5943

6044
<br />
6145

46+
- Download the litmusctl(v0.2.0) binary from:
47+
48+
| Platforms | Download Link |
49+
| ------------------------------ | ------------------------------------------------------------------------------------------------------- |
50+
| litmusctl-darwin-386 (MacOS) | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-darwin-386-v0.2.0.tar.gz) |
51+
| litmusctl-darwin-amd64 (MacOS) | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-darwin-amd64-v0.2.0.tar.gz) |
52+
| litmusctl-linux-386 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-386-v0.2.0.tar.gz) |
53+
| litmusctl-linux-amd64 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-amd64-v0.2.0.tar.gz) |
54+
| litmusctl-linux-arm | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-arm-v0.2.0.tar.gz) |
55+
| litmusctl-linux-arm64 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-arm64-v0.2.0.tar.gz) |
56+
| litmusctl-windows-386 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-windows-386-v0.2.0.tar.gz) |
57+
| litmusctl-windows-amd64 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-windows-amd64-v0.2.0.tar.gz) |
58+
| litmusctl-windows-arm | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-windows-arm-v0.2.0.tar.gz) |
59+
60+
<br />
61+
6262
- Extract the binary
6363

6464
```shell

website/docs/getstarted.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,15 @@ sidebar_label: Pre-requisites
1212

1313
- Persistent volume of 20GB
1414

15-
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 install would use the default storage class to allocate the PV. Provide this value
15+
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 install would use the default storage class to allocate the PV. Provide this value
1616

1717
- Helm3 or Kubectl
1818

19-
2019
## Getting Started
2120

2221
Running chaos on your application involves the following steps:
2322

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

2625
[How to Create and Run a Workflow](create-workflow)
2726

website/docs/litmus-installation.md renamed to website/docs/litmus-installation-cluster.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
id: litmus-install
3-
title: Litmus Chaos Control Plane
4-
sidebar_label: Control Plane
2+
id: litmus-install-cluster-mode
3+
title: Litmus Chaos Control Plane (Cluster Mode)
4+
sidebar_label: Control Plane (Cluster Mode)
55
---
66

77
---
@@ -12,17 +12,16 @@ sidebar_label: Control Plane
1212

1313
- Kubernetes 1.15 or later.
1414
15-
- Persistent volume of 20GB
16-
17-
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 install would use the default storage class to allocate the PV. Provide this value
15+
- 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.
1816

1917
- Helm3 or Kubectl
2018

21-
## Installation
19+
## Installation
2220

2321
Installation of Litmus can be done using either of the below methods
24-
- [Helm3](#helm_install) chart or
25-
- [Kubectl](#kubectl_install) yaml spec file
22+
23+
- [Helm3](#helm_install) chart or
24+
- [Kubectl](#kubectl_install) yaml spec file
2625

2726
### Installation Steps
2827

@@ -58,19 +57,13 @@ namespace/litmus created
5857

5958
```bash
6059
root@demo:~# helm install chaos litmuschaos/litmus-2-0-0-beta --namespace=litmus --devel
61-
NAME: chaos
62-
LAST DEPLOYED: Fri Sep 29 06:19:50 2020
63-
NAMESPACE: litmus
64-
STATUS: deployed
65-
REVISION: 1
66-
TEST SUITE: None
6760
```
6861

6962
<span style={{color: 'green'}}><b>Expected Output</b></span>
7063

7164
```
7265
NAME: chaos
73-
LAST DEPLOYED: Mon Mar 15 18:27:42 2021
66+
LAST DEPLOYED: Tue Jun 15 19:20:09 2021
7467
NAMESPACE: litmus
7568
STATUS: deployed
7669
REVISION: 1
@@ -81,27 +74,30 @@ Thank you for installing litmus-2-0-0-beta 😀
8174
Your release is named chaos and its installed to namespace: litmus.
8275
8376
Visit https://docs.litmuschaos.io/docs/getstarted/ to find more info.
77+
8478
```
8579

8680
> **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.
8781
8882
### <a name="kubectl_install"> </a>**Install Litmus using kubectl **
8983

90-
#### **Create a Litmus namespace in Kubernetes**
84+
#### **Create a Litmus namespace in Kubernetes**
9185

9286
```bash
9387
kubectl create ns litmus
9488
```
89+
9590
#### **Install Litmus**
9691

9792
Applying the manifest file will install all the required service account configuration and chaos control plane.
93+
9894
```bash
9995
kubectl apply -f https://litmuschaos.github.io/litmus/2.0.0-Beta/litmus-2.0.0-Beta.yaml
10096
```
10197

10298
## **Verify your installation**
10399

104-
**Verify if the frontend, backend, and database Pods are running**
100+
**Verify if the frontend, server, and database pod are running**
105101

106102
```bash
107103
kubectl get pods -n litmus
@@ -115,8 +111,6 @@ chaos-litmus-portal-mongo-6764cfdd59-c9r56 1/1 Running 0 2m6s
115111
chaos-litmus-portal-server-5ffbccbfff-dknv8 2/2 Running 0 2m6s
116112
```
117113

118-
<br />
119-
120114
## **Setup the Portal**
121115

122116
To setup and login to Litmus Portal expand the available services just created and copy the `PORT` of the `litmusportal-frontend-service` service

0 commit comments

Comments
 (0)