Skip to content

Commit b3ef078

Browse files
authored
update content on all versions (#325)
* update content on all versions Signed-off-by: SmritiSatya <[email protected]> * update Signed-off-by: Smriti Satya <[email protected]> Signed-off-by: SmritiSatya <[email protected]> --------- Signed-off-by: SmritiSatya <[email protected]> Signed-off-by: Smriti Satya <[email protected]>
1 parent 4a3ea64 commit b3ef078

File tree

11 files changed

+1703
-1518
lines changed

11 files changed

+1703
-1518
lines changed

website/versioned_docs/version-3.10.0/getting-started/installation.md

+66-58
Original file line numberDiff line numberDiff line change
@@ -9,41 +9,33 @@ sidebar_label: Installation
99
## Prerequisites
1010

1111
- Kubernetes 1.17 or later
12+
- A persistent volume of 20GB
13+
- [Helm3](https://v3.helm.sh/) or [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
1214

13-
- A Persistent volume of 20GB
14-
15-
:::note
16-
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+
:::tip
16+
Litmus recommends you have a persistent volume (PV) of 20GB. You can start with 1GB for test purposes. This PV is used as persistent storage to store the chaos configuration and other chaos metrics in the portal. By default, the `litmus install` command uses the default storage class to allocate the PV.
1717
:::
1818

19-
- [Helm3](https://v3.helm.sh/) or [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
20-
2119
## Installation
2220

23-
Users looking to use Litmus for the first time have two options available to them today. One way is to use a hosted Litmus service like [Harness Chaos Engineering SaaS](https://app.harness.io/auth/#/signin). Alternatively, users looking for some more flexibility can install Litmus into their own Kubernetes cluster.
21+
If you are a first time Litmus user, you can install Litmus in two ways:
2422

25-
Users choosing the self-hosted option can refer to our Install and Configure docs for installing alternate versions and more detailed instructions.
23+
- Use a hosted Litmus service like [Harness Chaos Engineering SaaS](https://app.harness.io/auth/#/signin). Go to [install hosted service] to know more.
2624

27-
import Tabs from '@theme/Tabs';
28-
import TabItem from '@theme/TabItem';
25+
**OR**
2926

30-
<Tabs>
31-
<TabItem value="self-hosted" label="Self-Hosted" default>
32-
Installation of Self-Hosted Litmus can be done using either of the below methods:
33-
<li><a href="#install-litmus-using-helm">Helm3</a> chart</li>
34-
<li><a href="#install-litmus-using-kubectl">Kubectl</a> yaml spec file</li>
35-
<br/>
36-
Refer to the below details for Self-Hosted Litmus installation.
37-
</TabItem>
38-
<TabItem value="hosted" label="Hosted (Beta)">
39-
<a href="https://harness.io/">Harness</a> offers a free service for community members which makes getting started with Litmus easy. Create an account to get started. Once logged in, create a new hosted control plane and connect to it via the up CLI. Litmus can be used as a hosted cloud service using <a href="https://app.harness.io/auth/#/signin">Harness Chaos Engineering SaaS</a>. Harness Chaos Engineering SaaS executes your Chaos Experiments in the cloud by managing all your Chaos Control Plane components, while the Chaos Execution Plane components exist on your Kubernetes cluster as part of an external chaos infrastructure.
40-
<br/><br/>
41-
To get started with Harness Chaos Engineering SaaS, visit <a href="https://developer.harness.io/docs/chaos-engineering/get-started/learn-more-free-plan">Harness Chaos Engineering SaaS</a> and register for free. You can skip the below installation steps.
42-
</TabItem>
43-
</Tabs>
27+
- Install Litmus in your Kubernetes cluster. Go to [self-hosted service] to know more.
4428

45-
:::note
46-
With 3.9.0 release, Cluster scope installation is deprecated. Now Namespaced mode is the only supported and standard installation mode.
29+
If you wish to install Litmus in your Kubernetes cluster (that is, self-hosted), Install and Configure docs for installing alternate versions and more detailed instructions.
30+
31+
## Self-hosted service
32+
33+
You can install self-hosted Litmus in two ways:
34+
- Using [Helm](#install-litmus-using-helm).
35+
- Using [kubectl YAML spec file](#install-litmus-using-kubectl).
36+
37+
:::tip
38+
With the 3.9.0 release, cluster scope installation has been deprecated. Only namespaced scope is supported and is the standard installation mode.
4739
:::
4840

4941
### Install Litmus using Helm
@@ -52,30 +44,37 @@ The helm chart will install all the required service account configuration and C
5244

5345
The following steps will help you install Litmus ChaosCenter via helm.
5446

55-
#### Step-1: Add the litmus helm repository
47+
#### 1. Add the Litmus Helm repository
48+
49+
Execute the below commands on your terminal.
5650

5751
```bash
5852
helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/
5953
helm repo list
6054
```
6155

62-
#### Step-2: Create the namespace on which you want to install Litmus ChaosCenter
56+
#### 2. Create the namespace where you want to install Litmus ChaosCenter
6357

64-
- The ChaosCenter can be placed in any namespace, but for this scenario we are choose `litmus` as the namespace.
58+
You can place ChaosCenter in any namespace, but for this case, choose `litmus` as the namespace.
6559

6660
```bash
6761
kubectl create ns litmus
6862
```
6963

70-
#### Step-3: Install Litmus ChaosCenter
64+
#### 3. Install Litmus ChaosCenter
65+
66+
Execute the below command on your terminal.
7167

7268
```bash
7369
helm install chaos litmuschaos/litmus --namespace=litmus --set portal.frontend.service.type=NodePort
7470
```
7571

76-
> **Note:** If your Kubernetes cluster isn't local, you may want not to expose Litmus via `NodePort`. If so, remove `--set portal.frontend.service.type=NodePort` option. To connect to Litmus UI from your laptop, you can use `port-forward svc/chaos-litmus-frontend-service 9091:9091`. Then you can use your browser and open `127.0.0.1:9091`.
72+
:::info note
73+
- your Kubernetes cluster isn't local, you may want not to expose Litmus via `NodePort`. In that case, remove `--set portal.frontend.service.type=NodePort` option.
74+
- To connect to Litmus UI from your laptop, you can use `port-forward svc/chaos-litmus-frontend-service 9091:9091`. And open `127.0.0.1:9091` on your browser.
75+
:::
7776

78-
- Litmus helm chart depends on `bitnami/mongodb` [helm chart](https://github.com/bitnami/charts/tree/main/bitnami/mongodb), which uses a mongodb image not supported on ARM. If you want to install Litmus on an ARM-based server, please replace the default one with your custom mongodb arm image as shown below.
77+
Litmus helm chart depends on `bitnami/mongodb` [Helm chart](https://github.com/bitnami/charts/tree/main/bitnami/mongodb), which uses a MongoDB image that is not supported on ARM. If you want to install Litmus on an ARM-based server, replace the default with your custom MongoDB ARM image as shown below.
7978

8079
```bash
8180
helm install chaos litmuschaos/litmus --namespace=litmus \
@@ -102,22 +101,24 @@ Your release is named chaos and its installed to namespace: litmus.
102101
Visit https://docs.litmuschaos.io to find more info.
103102
```
104103

105-
> **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.
104+
:::tip
105+
Litmus uses Kubernetes CRDs to define the chaos intent. Helm3 handles CRDs better than Helm2. Before you run a chaos experiment, verify if Litmus is installed correctly.
106+
:::
106107

107-
## **Install Litmus using kubectl**
108+
### Install Litmus using kubectl
108109

109-
In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9).
110+
You need to install Mongo via helm and apply the installation manifest. Go to [installation instructions for Litmus Beta](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9).
110111

111-
### **Install mongo**
112+
#### Install Mongo
112113

113114
```bash
114115
helm repo add bitnami https://charts.bitnami.com/bitnami
115116
```
116117

117-
Mongo Values
118+
Mongo values
118119

119120
```bash
120-
auth:
121+
auth:
121122
enabled: true
122123
rootPassword: "1234"
123124
# -- existingSecret Existing secret with MongoDB(&reg;) credentials (keys: `mongodb-passwords`, `mongodb-root-password`, `mongodb-metrics-password`, ` mongodb-replica-set-key`)
@@ -146,26 +147,31 @@ metrics:
146147
helm install my-release bitnami/mongodb --values mongo-values.yml -n <NAMESPACE> --create-namespace
147148
```
148149

149-
Litmus supports for HTTP and HTTPS mode of installation.
150+
Litmus supports HTTP and HTTPS mode of installation.
150151

151-
### Basic installation (HTTP based and allows all origins)
152+
### Basic installation (HTTP-based and allows all origins)
152153

153-
Applying the manifest file will install all the required service account configuration and ChaosCenter in namespaced scope.
154+
Applying the manifest file installs all the required service account configuration and ChaosCenter in the namespaced scope.
154155

155156
```bash
156-
kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.10.0/litmus-getting-started.yaml -n <NAMESPACE>
157+
kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.9.1/litmus-getting-started.yaml -n <NAMESPACE>
157158
```
158159

159-
### Advanced installation (HTTPS based and CORS rules apply)
160+
### Advanced installation (HTTPS-based and CORS rules apply)
160161

161-
For advanced installation visit [here](../user-guides/chaoscenter-advanced-installation.md)
162+
For advanced installation visit [advanced installation](../user-guides/chaoscenter-advanced-installation.md)
162163

163-
---
164+
## Hosted (beta) service
165+
166+
[Harness](https://harness.io/) offers a free service for community members which makes getting started with Litmus easy. Create an account to get started. Once you log in, create a new hosted control plane and connect to it via the CLI.
167+
168+
You can use Litmus as a hosted cloud service using [Harness Chaos Engineering SaaS](https://app.harness.io/auth/#/signin). Harness Chaos Engineering SaaS executes your chaos experiments in the cloud by managing all your chaos control plane components. The chaos execution plane components exist on your Kubernetes cluster as part of an external chaos infrastructure.
164169

165-
## **Verify your installation**
170+
To get started with Harness Chaos Engineering SaaS, go to [Harness developer hub](https://developer.harness.io/docs/chaos-engineering/get-started/learn-more-free-plan) and register for free.
166171

167-
#### **Verify if the frontend, server, and database pods are running**
172+
## Verify your installation
168173

174+
- Verify if the frontend, server, and database pods are running
169175
- Check the pods in the namespace where you installed Litmus:
170176

171177
```bash
@@ -205,11 +211,9 @@ For advanced installation visit [here](../user-guides/chaoscenter-advanced-insta
205211
workflow-controller-metrics ClusterIP 10.68.33.65 <none> 9090/TCP 23h
206212
```
207213

208-
---
209-
210-
## **Accessing the ChaosCenter**
214+
## Access the ChaosCenter
211215

212-
To setup and login to ChaosCenter expand the available services just created and copy the `PORT` of the `litmusportal-frontend-service` service
216+
To setup and login to ChaosCenter, expand the available services you created and copy the `PORT` of the `litmusportal-frontend-service` service.
213217

214218
```bash
215219
kubectl get svc -n litmus
@@ -226,21 +230,25 @@ mongo-service ClusterIP 10.43.227.10 <none> 2701
226230
mongo-headless-service ClusterIP None <none> 27017/TCP 101s
227231
```
228232

229-
> **Note**: In this case, the PORT for `litmusportal-frontend-service` is `31846`. Yours will be different.
233+
:::note
234+
In this case, the PORT for `litmusportal-frontend-service` is `31846`. Your port will be a different one.
235+
:::
230236

231-
Once you have the PORT copied in your clipboard, simply use your IP and PORT in this manner `<NODEIP>:<PORT>` to access the Litmus ChaosCenter.
237+
Once you copy the PORT to your clipboard, use your IP and PORT in the following manner: `<NODEIP>:<PORT>` to access the Litmus ChaosCenter.
232238

233239
For example:
234240

235241
```yaml
236242
http://172.17.0.3:31846/
237243
```
238244

239-
> Where `172.17.0.3` is my NodeIP and `31846` is the frontend service PORT. If using a LoadBalancer, the only change would be to provide a `<LoadBalancerIP>:<PORT>`. [Learn more about how to access ChaosCenter with LoadBalancer](../user-guides/setup-without-ingress.md#with-loadbalancer)
245+
> Where `172.17.0.3` is your NodeIP and `31846` is the frontend service PORT. If you are using a LoadBalancer, provide a `<LoadBalancerIP>:<PORT>`. [Learn more about how to access ChaosCenter with LoadBalancer](../user-guides/setup-without-ingress.md#with-loadbalancer)
240246
241-
**NOTE:** With advanced installation CORS rules are applied, once manifest is applied frontend loadbalancer IP needs to be added in the `ALLOWED_ORIGINS` environment in both auth and graphql server deployment.
247+
:::info note
248+
With advanced installation, CORS rules are applied. Once the manifest is applied, the frontend LoadBalancer IP needs to be added to the `ALLOWED_ORIGINS` environment in both `auth` and `graphql` server deployment.
249+
:::
242250

243-
You should be able to see the Login Page of Litmus ChaosCenter. The **default credentials** are
251+
You will see the login page of Litmus ChaosCenter. The **default credentials** are:
244252

245253
```yaml
246254
Username: admin
@@ -249,7 +257,7 @@ Password: litmus
249257
250258
<img src={require('../assets/login.png').default} width="800" />
251259
252-
By default you are assigned with a default project with Owner permissions.
260+
By default, you are assigned to a default project with **owner** permissions.
253261
254262
<img src={require('../assets/landing-page.png').default} width="800" />
255263
@@ -258,4 +266,4 @@ By default you are assigned with a default project with Owner permissions.
258266
- [Install ChaosCenter with HTTPS](../user-guides/chaoscenter-advanced-installation.md)
259267
- [Connect External Chaos Infrastructures to ChaosCenter](../user-guides/chaos-infrastructure-installation.md)
260268
- [Setup Endpoints and Access ChaosCenter without Ingress](../user-guides/setup-without-ingress.md)
261-
- [Setup Endpoints and Access ChaosCenter with Ingress](../user-guides/setup-with-ingress.md)
269+
- [Setup Endpoints and Access ChaosCenter with Ingress](../user-guides/setup-with-ingress.md)

website/versioned_docs/version-3.10.0/getting-started/resources.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ sidebar_label: Resources
77
---
88

99
## ChaosCenter
10-
ChaosCenter is a unified pane that controls all the functions provided by Litmus. It can be used for managing the entire lifecycle of the chaos experiments, including all the components within.
10+
ChaosCenter is a unified pane that controls all the functions Litmus provides. You can use ChaosCenter to manage the entire lifecycle of the chaos experiments, including the components within.
1111

12-
ChaosCenter comes pre-packaged as a part of LitmusChaos installation and can be easily accessed via [Ingress](../user-guides/setup-with-ingress.md), [NodePort](../user-guides/setup-without-ingress.md#with-nodeport) or [LoadBalancer](../user-guides/setup-without-ingress.md#with-loadbalancer). Since Litmus has Cross-Cloud support, you get seamless access to the ChaosCenter irrespectively of where you deploy it.
12+
ChaosCenter comes pre-packaged as a part of LitmusChaos installation and you can easily access it via [ingress](../user-guides/setup-with-ingress.md), [NodePort](../user-guides/setup-without-ingress.md#with-nodeport) or [LoadBalancer](../user-guides/setup-without-ingress.md#with-loadbalancer). Since Litmus has cross-cloud support, you get seamless access to the ChaosCenter regardless of where you deploy it.
1313

14-
ChaosCenter gives you access to a plethora of features, the major ones include:
14+
ChaosCenter gives you a plethora of features, that include:
1515

1616
- **Chaos experiment creation**
1717
- From templates, custom experiments from scratch (using ChaosHubs), from pre-created YAMLs
@@ -27,13 +27,13 @@ ChaosCenter gives you access to a plethora of features, the major ones include:
2727
- Allowing image addition from custom image server (both public and private)
2828
- Measure and analyze the Resilience Score of each chaos scenario
2929

30-
## Chaos Infrastructures
31-
Chaos infrastructure is a service that runs in your target environment and aids Litmus in accessing and injecting chaos to your target environment. There should always be at least one or more than one chaos infrastructure connected to the ChaosCenter to execute an experiment.
30+
## Chaos Infrastructure
31+
Chaos infrastructure is a service that runs in your target environment and aids Litmus in accessing and injecting chaos into your target environment. To execute an experiment, you need at least one chaos infrastructure connected to the ChaosCenter.
3232

33-
## Types of Chaos Infrastructures
33+
## Types of Chaos Infrastructure
3434

35-
In Litmus, chaos infrastructures can be classified into two types:
35+
In Litmus, you can classify chaos infrastructure into two types:
3636

37-
- **Self Chaos Infrastructures:** A Chaos Infrastructure that is connected to the same cluster and namespace where the ChaosCenter is deployed. It can be used to target the workloads executing on that cluster only.
37+
- **Self chaos infrastructure:** A chaos infrastructure that is connected to the same cluster and namespace where the ChaosCenter is deployed. You can use this to target the workloads executing on that cluster only.
3838

39-
- **External Chaos Infrastructures:** A Chaos Infrastructure that is connected to a remote Kubernetes cluster. ChaosCenter can be operated in a cross-cloud manner, which allows connecting multiple External Chaos Infrastructure to the same ChaosCenter with the help of the [litmusctl](../litmusctl/installation.md) CLI. Once connected you can manage, monitor, observe and induce chaos from the ChaosCenter to the respective External Chaos Infrastructures.
39+
- **External chaos infrastructure:** A chaos infrastructure connected to a remote Kubernetes cluster. You can operate ChaosCenter in a cross-cloud manner, connecting multiple external chaos infrastructures to the same ChaosCenter with the help of the [litmusctl](../litmusctl/installation.md) CLI. Once connected you can manage, monitor, observe, and induce chaos from the ChaosCenter to the respective external chaos infrastructures.

0 commit comments

Comments
 (0)