You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/versioned_docs/version-3.10.0/getting-started/installation.md
+58-66Lines changed: 58 additions & 66 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,33 +9,41 @@ sidebar_label: Installation
9
9
## Prerequisites
10
10
11
11
- 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)
14
-
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.
17
-
:::
18
12
19
-
## Installation
13
+
- A Persistent volume of 20GB
20
14
21
-
If you are a first time Litmus user, you can install Litmus in two ways:
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
17
+
:::
22
18
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.
19
+
-[Helm3](https://v3.helm.sh/) or [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
24
20
25
-
**OR**
21
+
## Installation
26
22
27
-
- Install Litmus in your Kubernetes cluster. Go to [self-hosted service] to know more.
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.
28
24
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.
25
+
Users choosing the self-hosted option can refer to our Install and Configure docs for installing alternate versions and more detailed instructions.
30
26
31
-
## Self-hosted service
27
+
import Tabs from '@theme/Tabs';
28
+
import TabItem from '@theme/TabItem';
32
29
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).
Refer to the below details for Self-Hosted Litmus installation.
37
+
</TabItem>
38
+
<TabItemvalue="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>
36
44
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.
45
+
:::note
46
+
With 3.9.0 release, Cluster scope installation is deprecated. Now Namespaced mode is the only supported and standard installation mode.
39
47
:::
40
48
41
49
### Install Litmus using Helm
@@ -44,37 +52,30 @@ The helm chart will install all the required service account configuration and C
44
52
45
53
The following steps will help you install Litmus ChaosCenter via helm.
- 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
-
:::
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`.
76
77
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.
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.
@@ -101,24 +102,22 @@ Your release is named chaos and its installed to namespace: litmus.
101
102
Visit https://docs.litmuschaos.io to find more info.
102
103
```
103
104
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
-
:::
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.
107
106
108
-
### Install Litmus using kubectl
107
+
##**Install Litmus using kubectl**
109
108
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).
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).
### Advanced installation (HTTPS-based and CORS rules apply)
161
-
162
-
For advanced installation visit [advanced installation](../user-guides/chaoscenter-advanced-installation.md)
159
+
### Advanced installation (HTTPS based and CORS rules apply)
163
160
164
-
## Hosted (beta) service
161
+
For advanced installation visit [here](../user-guides/chaoscenter-advanced-installation.md)
165
162
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.
163
+
---
169
164
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.
165
+
## **Verify your installation**
171
166
172
-
##Verify your installation
167
+
#### **Verify if the frontend, server, and database pods are running**
173
168
174
-
- Verify if the frontend, server, and database pods are running
175
169
- Check the pods in the namespace where you installed Litmus:
176
170
177
171
```bash
@@ -211,9 +205,11 @@ To get started with Harness Chaos Engineering SaaS, go to [Harness developer hub
In this case, the PORT for `litmusportal-frontend-service` is `31846`. Your port will be a different one.
235
-
:::
229
+
> **Note**: In this case, the PORT for `litmusportal-frontend-service` is `31846`. Yours will be different.
236
230
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.
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.
238
232
239
233
For example:
240
234
241
235
```yaml
242
236
http://172.17.0.3:31846/
243
237
```
244
238
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)
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)
246
240
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
-
:::
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.
250
242
251
-
You will see the login page of Litmus ChaosCenter. The **default credentials** are:
243
+
You should be able to see the Login Page of Litmus ChaosCenter. The **default credentials** are
Copy file name to clipboardExpand all lines: website/versioned_docs/version-3.10.0/getting-started/resources.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,11 +7,11 @@ sidebar_label: Resources
7
7
---
8
8
9
9
## ChaosCenter
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.
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.
11
11
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.
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.
13
13
14
-
ChaosCenter gives you a plethora of features, that include:
14
+
ChaosCenter gives you access to a plethora of features, the major ones include:
15
15
16
16
-**Chaos experiment creation**
17
17
- From templates, custom experiments from scratch (using ChaosHubs), from pre-created YAMLs
@@ -27,13 +27,13 @@ ChaosCenter gives you a plethora of features, that include:
27
27
- Allowing image addition from custom image server (both public and private)
28
28
- Measure and analyze the Resilience Score of each chaos scenario
29
29
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.
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.
32
32
33
-
## Types of Chaos Infrastructure
33
+
## Types of Chaos Infrastructures
34
34
35
-
In Litmus, you can classify chaos infrastructure into two types:
35
+
In Litmus, chaos infrastructures can be classified into two types:
36
36
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.
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.
38
38
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.
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.
0 commit comments