Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
mongodb
eventtracker
eventtrackerpolicies
portalScope
LitmusCRDs
graphql
accomodate
accomodated
Expand Down
193 changes: 0 additions & 193 deletions website/docs/admin-mode.md

This file was deleted.

32 changes: 16 additions & 16 deletions website/docs/agent-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,22 +27,6 @@ The litmusctl CLI requires the following things:

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

- Download the stable litmusctl(v0.1.0) binary from:

| Platforms | Download Link |
| ------------------------------ | ------------------------------------------------------------------------------------------------------- |
| litmusctl-darwin-386 (MacOS) | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-darwin-386-v0.1.0.tar.gz) |
| litmusctl-darwin-amd64 (MacOS) | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-darwin-amd64-v0.1.0.tar.gz) |
| litmusctl-linux-386 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-386-v0.1.0.tar.gz) |
| litmusctl-linux-amd64 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-amd64-v0.1.0.tar.gz) |
| litmusctl-linux-arm | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-arm-v0.1.0.tar.gz) |
| litmusctl-linux-arm64 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-arm64-v0.1.0.tar.gz) |
| litmusctl-windows-386 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-windows-386-v0.1.0.tar.gz) |
| litmusctl-windows-amd64 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-windows-amd64-v0.1.0.tar.gz) |
| litmusctl-windows-arm | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-windows-arm-v0.1.0.tar.gz) |

<br />

- Download the latest litmusctl(master) binary from:

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

<br />

- Download the litmusctl(v0.2.0) binary from:

| Platforms | Download Link |
| ------------------------------ | ------------------------------------------------------------------------------------------------------- |
| litmusctl-darwin-386 (MacOS) | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-darwin-386-v0.2.0.tar.gz) |
| litmusctl-darwin-amd64 (MacOS) | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-darwin-amd64-v0.2.0.tar.gz) |
| litmusctl-linux-386 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-386-v0.2.0.tar.gz) |
| litmusctl-linux-amd64 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-amd64-v0.2.0.tar.gz) |
| litmusctl-linux-arm | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-arm-v0.2.0.tar.gz) |
| litmusctl-linux-arm64 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-linux-arm64-v0.2.0.tar.gz) |
| litmusctl-windows-386 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-windows-386-v0.2.0.tar.gz) |
| litmusctl-windows-amd64 | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-windows-amd64-v0.2.0.tar.gz) |
| litmusctl-windows-arm | [Click here](https://litmusctl-bucket.s3-eu-west-1.amazonaws.com/litmusctl-windows-arm-v0.2.0.tar.gz) |

<br />

- Extract the binary

```shell
Expand Down
5 changes: 2 additions & 3 deletions website/docs/getstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,15 @@ sidebar_label: Pre-requisites

- Persistent volume of 20GB

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
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

- Helm3 or Kubectl


## Getting Started

Running chaos on your application involves the following steps:

[Install Litmus](litmus-install)
[Install Litmus](litmus-install-cluster-mode)

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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: litmus-install
title: Litmus Chaos Control Plane
sidebar_label: Control Plane
id: litmus-install-cluster-mode
title: Litmus Chaos Control Plane (Cluster Mode)
sidebar_label: Control Plane (Cluster Mode)
---

---
Expand All @@ -12,17 +12,16 @@ sidebar_label: Control Plane

- Kubernetes 1.15 or later.
- Persistent volume of 20GB
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
- 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.

- Helm3 or Kubectl

## Installation
## Installation

Installation of Litmus can be done using either of the below methods
- [Helm3](#helm_install) chart or
- [Kubectl](#kubectl_install) yaml spec file

- [Helm3](#helm_install) chart or
- [Kubectl](#kubectl_install) yaml spec file

### Installation Steps

Expand Down Expand Up @@ -58,19 +57,13 @@ namespace/litmus created

```bash
root@demo:~# helm install chaos litmuschaos/litmus-2-0-0-beta --namespace=litmus --devel
NAME: chaos
LAST DEPLOYED: Fri Sep 29 06:19:50 2020
NAMESPACE: litmus
STATUS: deployed
REVISION: 1
TEST SUITE: None
```

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

```
NAME: chaos
LAST DEPLOYED: Mon Mar 15 18:27:42 2021
LAST DEPLOYED: Tue Jun 15 19:20:09 2021
NAMESPACE: litmus
STATUS: deployed
REVISION: 1
Expand All @@ -81,27 +74,30 @@ Thank you for installing litmus-2-0-0-beta 😀
Your release is named chaos and its installed to namespace: litmus.

Visit https://docs.litmuschaos.io/docs/getstarted/ to find more info.

```

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

### <a name="kubectl_install"> </a>**Install Litmus using kubectl **

#### **Create a Litmus namespace in Kubernetes**
#### **Create a Litmus namespace in Kubernetes**

```bash
kubectl create ns litmus
```

#### **Install Litmus**

Applying the manifest file will install all the required service account configuration and chaos control plane.

```bash
kubectl apply -f https://litmuschaos.github.io/litmus/2.0.0-Beta/litmus-2.0.0-Beta.yaml
```

## **Verify your installation**

**Verify if the frontend, backend, and database Pods are running**
**Verify if the frontend, server, and database pod are running**

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

<br />

## **Setup the Portal**

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