litmuschaos
/
litmus-docs
mirror of https://github.com/litmuschaos/litmus-docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: Refactors user guide pages (#270) 

Signed-off-by: neelanjan00 <neelanjan.manna@harness.io>
This commit is contained in:
Neelanjan Manna 2024-09-19 21:26:31 +05:30 committed by GitHub
parent ceb8a67f93
commit d25b7fcd62
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
78 changed files with 363 additions and 380 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
website/docs/architecture/overview.md
View File

@ -14,7 +14,7 @@ A very high level overview of the entire Litmus architecture with the objective
### [Control Plane](chaos-control-plane.md) ### [Control Plane](chaos-control-plane.md)
Consists of micro-services responsible for the functioning of the ChaosCenter, the web based portal used for creating, scheduling, and monitoring chaos scenarios. Consists of micro-services responsible for the functioning of the ChaosCenter, the web based portal used for creating, scheduling, and monitoring chaos experiments.
### [Execution Plane](chaos-execution-plane.md) ### [Execution Plane](chaos-execution-plane.md)

2
website/docs/concepts/chaos-workflow.md
View File

@ -22,7 +22,7 @@ The term **Chaos Scenario/Workflow** has been changed to **Chaos Experiment**.
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- [ChaosCenter](../getting-started/resources.md#chaoscenter) - [ChaosCenter](../getting-started/resources.md#chaoscenter)
- [Chaos Infrastructure](../getting-started/resources.md#chaosagents) - [Chaos Infrastructure](../getting-started/resources.md#chaosagents)

2
website/docs/integrations/grafana.md
View File

@ -10,7 +10,7 @@ Chaos Engineering is the discipline of experimenting on a system to build confid
## Before you begin ## Before you begin
The following should be required before integrating Grafana with litmus 2.0: The following are required before integrating Grafana with litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/) - [Prometheus TSDB](https://prometheus.io/)
- [Prometheus Integration](prometheus.md) - [Prometheus Integration](prometheus.md)

2
website/docs/integrations/prometheus.md
View File

@ -10,7 +10,7 @@ LitmusChaos facilitates real-time monitoring for events and metrics using it’s
## Before you begin ## Before you begin
The following should be required before integrating Prometheus in litmus 2.0: The following are required before integrating Prometheus in litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/) - [Prometheus TSDB](https://prometheus.io/)
- [Probes](../concepts/probes.md) - [Probes](../concepts/probes.md)

2
website/docs/user-guides/accept-invite.md
View File

@ -10,6 +10,6 @@ Once the invitation is received, you can take a look at invitation project name,
<img src={require('../assets/user-guides/teaming/accept-invite/step-1.png').default} /> <img src={require('../assets/user-guides/teaming/accept-invite/step-1.png').default} />
Once accepted, you can switch to the project using the side nav as shown below: Once accepted, you can switch to the project using the side navigating as shown below:
<img src={require('../assets/user-guides/teaming/accept-invite/step-2.png').default} /> <img src={require('../assets/user-guides/teaming/accept-invite/step-2.png').default} />

20
website/docs/user-guides/account-settings.md
View File

@ -1,22 +1,24 @@
--- ---
id: account-settings id: account-settings
title: Account Settings title: Account settings
sidebar_label: Account Settings sidebar_label: Account settings
--- ---
--- ---
Under the account settings, you can change your personal details such as the email, name, and password. Under the account settings, you can change your personal details such as the email, name, and password.
> Note: The username can’t be changed as it is unique. :::note
The username can’t be changed as it is unique.
:::
To navigate to the accounts page, click on the user avatar on the bottom left of the nav-bar: To navigate to the accounts page, click on the user avatar on the bottom left of the navbar:
<figure> <figure>
<img src={require('../assets/user-guides/my-account/step-1.png').default} alt="avatar nav" /> <img src={require('../assets/user-guides/my-account/step-1.png').default} alt="avatar nav" />
</figure> </figure>
## Edit Personal Details ## Edit personal details
Click the edit icon to open the edit modal: Click the edit icon to open the edit modal:
@ -24,21 +26,21 @@ Click the edit icon to open the edit modal:
<img src={require('../assets/user-guides/my-account/step-2.png').default} alt="edit icon" /> <img src={require('../assets/user-guides/my-account/step-2.png').default} alt="edit icon" />
</figure> </figure>
Enter your name and your email address in the following text fields and click on the `Confirm` button to save the new details. Enter your name and email address in the following text fields and click on the **Confirm** button to save the new details.
<figure> <figure>
<img src={require('../assets/user-guides/my-account/step-3.png').default} alt="edit information" /> <img src={require('../assets/user-guides/my-account/step-3.png').default} alt="edit information" />
</figure> </figure>
## Change Password ## Change password
On the same page, you can change your password by clicking on the `Change Password` button. On the same page, you can change your password by clicking on the **Change Password** button.
<figure> <figure>
<img src={require('../assets/user-guides/my-account/step-4.png').default} alt="edit information" /> <img src={require('../assets/user-guides/my-account/step-4.png').default} alt="edit information" />
</figure> </figure>
To update your password enter your current password as well as the new password you wish to set and click **Confirm** To update your password enter your current password as well as the new password you wish to set and select **Confirm**.
<figure> <figure>
<img src={require('../assets/user-guides/my-account/step-5.png').default} alt="edit information" /> <img src={require('../assets/user-guides/my-account/step-5.png').default} alt="edit information" />

2
website/docs/user-guides/analyze-workflow.md
View File

@ -54,6 +54,6 @@ On clicking on a bar, more details about the chaos scenario run represented by t
## Learn more ## Learn more
- [Compare Chaos Scenarios](comparative-analysis.md) - [Compare Chaos Experiments](comparative-analysis.md)
- [Manage Application Dashboard](manage-app-dashboard.md) - [Manage Application Dashboard](manage-app-dashboard.md)
- [Configure Datasource](configure-datasource.md) - [Configure Datasource](configure-datasource.md)

14
website/docs/user-guides/change-project-name.md
View File

@ -1,22 +1,22 @@
--- ---
id: change-project-name id: change-project-name
title: Changing Project Name title: Changing project name
sidebar_label: Change Project Name sidebar_label: Change project name
--- ---
--- ---
Owners have the ability to change the name of their project if they wish to do so. Owners have the ability to change the name of their project.
## Before you begin ## Before you begin
The concept of `Projects` is discussed [here](../concepts/projects.md) and will help you build a foundational understanding of what projects mean in the ChaosCenter. The concept of **Projects** is discussed [here](../concepts/projects.md) and will help you build a foundational understanding of what projects mean in the ChaosCenter.
## Steps ## Steps
### 1. Go to `Account setting` ### 1. Go to **Account setting**
Go to the `Overview` section of settings and scroll to the `Your Projects` section: Go to the **Overview** section of settings and scroll to the **Your Projects** section:
<img src={require('../assets/user-guides/managing-projects/change-project-name/step-1.png').default} width="1000" height="500" /> <img src={require('../assets/user-guides/managing-projects/change-project-name/step-1.png').default} width="1000" height="500" />
@ -28,7 +28,7 @@ Click options icon to open the options menu and click on the edit option (demons
### 3. Replace name ### 3. Replace name
Once in the editing mode, type out the name you want to replace the current name with, and click on the `Confirm` button. Once in the editing mode, type out the name you want to replace the current name with, and click on the **Confirm** button.
<img src={require('../assets/user-guides/managing-projects/change-project-name/step-3.png').default} /> <img src={require('../assets/user-guides/managing-projects/change-project-name/step-3.png').default} />

44
website/docs/user-guides/chaoscenter-oauth-dex-installation.md
View File

@ -1,21 +1,21 @@
--- ---
id: chaoscenter-oauth-dex-installation id: chaoscenter-oauth-dex-installation
title: ChaosCenter with OAuth2 Login Support title: ChaosCenter with OAuth2 login support
sidebar_label: OAuth2 Support using Dex sidebar_label: OAuth2 support using Dex
--- ---
--- ---
# Prerequisites ## Prerequisites
Before deploying LitmusChaos, make sure the following items are there Before deploying LitmusChaos, make sure the following items are there:
- Kubernetes 1.17 or later - Kubernetes 1.17 or later
- A Persistent volume of 20GB - A Persistent volume of 20GB
:::note :::note
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 Although it is recommended 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 ChaosCenter. By default, Litmus would use the default storage class to allocate the PV.
::: :::
- [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) - [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
@ -28,9 +28,9 @@ Before deploying LitmusChaos, make sure the following items are there
## Deploy Dex OIDC provider ## Deploy Dex OIDC provider
In order to enable OAuth2 and to be able to login via Google and GitHub, litmus uses [Dex OIDC](https://dexidp.io/) In order to enable OAuth2 and to be able to login via Google and GitHub, litmus uses [Dex OIDC](https://dexidp.io/).
Make sure you have your Google and GitHub Client credentials ready, if you do not have them, you can generate one yourself Make sure you have your Google and GitHub client credentials ready. If you do not have them, you can generate one yourself:
- [Guide to generating Google Oauth Client Credentials](https://support.google.com/cloud/answer/6158849?hl=en#zippy=) - [Guide to generating Google Oauth Client Credentials](https://support.google.com/cloud/answer/6158849?hl=en#zippy=)
- [Guide to generating GitHub OAuth Client Credentials](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app) - [Guide to generating GitHub OAuth Client Credentials](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app)
@ -78,7 +78,9 @@ curl https://raw.githubusercontent.com/litmuschaos/litmus/master/litmus-portal/d
redirectURI: http://<NODE_IP>:32000/callback # Replace your NODE_IP here redirectURI: http://<NODE_IP>:32000/callback # Replace your NODE_IP here
``` ```
**Note: The Dex OIDC provider runs at `NODE_IP:32000` by default** :::info
The Dex OIDC provider runs at `NODE_IP:32000` by default
:::
After the configuration, deploy the Dex deployment using the following command: After the configuration, deploy the Dex deployment using the following command:
@ -94,7 +96,7 @@ kubectl get pods -n litmus
<span style={{color: 'green'}}><b>Expected Output</b></span> <span style={{color: 'green'}}><b>Expected Output</b></span>
```bash ```
NAME READY STATUS RESTARTS AGE NAME READY STATUS RESTARTS AGE
litmusportal-dex-server-7f7658b57-lbbxc 1/1 Running 0 107s litmusportal-dex-server-7f7658b57-lbbxc 1/1 Running 0 107s
litmusportal-frontend-74d456746f-56v9x 1/1 Running 0 5m57s litmusportal-frontend-74d456746f-56v9x 1/1 Running 0 5m57s
@ -102,33 +104,33 @@ litmusportal-server-9c4d85f57-5r6km 2/2 Running 0
mongo-0 1/1 Running 0 5m57s mongo-0 1/1 Running 0 5m57s
``` ```
### Configuring `chaos-litmus-auth-server` to enable Dex features ### Configuring authentication server to enable Dex features
To set up Dex, we would require to modify our litmusportal-server a bit in order to communicate with Dex. This will be achieved by adding some environment variables To set up Dex, the backend server needs to be modified to communicate with Dex. This can be achieved by adding some environment variables:
- `OIDC_ISSUER`: The place where the Dex OIDC is hosted, i.e `NODE_IP:32000` or `https://dex.yourdomain.com` - `OIDC_ISSUER`: The address where the Dex OIDC is hosted, i.e. `NODE_IP:32000` or `https://dex.yourdomain.com`.
- `DEX_ENABLED`: This variable enables dex features in the litmusportal-server - `DEX_ENABLED`: Toggle Dex features in the backend server.
- `DEX_OAUTH_CALLBACK_URL`: This is the url that will be called back after user completes thier OAuth, this will be the litmusportal-frontend service - `DEX_OAUTH_CALLBACK_URL`: The URL to be called back after user completes OAuth verification, this will be the frontend service.
- `DEX_OAUTH_CLIENT_ID`: This parameter is defined in the `dex-deployment.yaml` file the defaults being `LitmusPortalAuthBackend` - `DEX_OAUTH_CLIENT_ID`: This parameter is defined in the `dex-deployment.yaml` file, defaults to `LitmusPortalAuthBackend`.
- `DEX_OAUTH_CLIENT_SECRET`: This parameter is defined in the `dex-deployment.yaml` file the defaults being `ZXhhbXBsZS1hcHAtc2VjcmV0` - `DEX_OAUTH_CLIENT_SECRET`: This parameter is defined in the `dex-deployment.yaml`, defaults to `ZXhhbXBsZS1hcHAtc2VjcmV0`.
Set your variables using Set the environment variables using the following command:
```bash ```bash
kubectl set env deployment/chaos-litmus-auth-server -n litmus --containers="auth-server" DEX_ENABLED=true OIDC_ISSUER=<REPLACE_NODE_IP>:32000 DEX_OAUTH_CALLBACK_URL=https://<REPLACE_FRONTEND_URL>/auth/dex/callback DEX_OAUTH_CLIENT_ID=LitmusPortalAuthBackend DEX_OAUTH_CLIENT_SECRET=ZXhhbXBsZS1hcHAtc2VjcmV0 kubectl set env deployment/chaos-litmus-auth-server -n litmus --containers="auth-server" DEX_ENABLED=true OIDC_ISSUER=<REPLACE_NODE_IP>:32000 DEX_OAUTH_CALLBACK_URL=https://<REPLACE_FRONTEND_URL>/auth/dex/callback DEX_OAUTH_CLIENT_ID=LitmusPortalAuthBackend DEX_OAUTH_CLIENT_SECRET=ZXhhbXBsZS1hcHAtc2VjcmV0
``` ```
Your chaos-litmus-auth-server pod(s) will be restarted and Dex features will be enabled! After this, your authentication server pod(s) will be restarted and Dex features will be enabled.
### Verifying if OAuth2 is enabled ### Verifying if OAuth2 is enabled
Run the following command to check the env variables of the `auth-server` Run the following command to check the environment variables for the authentication server.
```bash ```bash
kubectl describe deployment litmusportal-server -n litmus auth-server kubectl describe deployment litmusportal-server -n litmus auth-server
``` ```
Under `auth-server`, verify if the `DEX_ENABLED` variables are set Under `auth-server`, verify if the `DEX_ENABLED` variables are set.
<span style={{color: 'green'}}><b>Expected Output</b></span> <span style={{color: 'green'}}><b>Expected Output</b></span>
@ -151,7 +153,7 @@ Under `auth-server`, verify if the `DEX_ENABLED` variables are set
Mounts: <none> Mounts: <none>
``` ```
Go to http://litmusportal-frontend-service/auth/dex/login, you should be prompted with Google or GitHub login Go to http://litmusportal-frontend-service/auth/dex/login, you should be prompted with Google or GitHub login.
![litmus-oauth-image](https://user-images.githubusercontent.com/31009634/135559389-c8cdf53c-76cf-4f9d-acaa-99014540f9cf.png) ![litmus-oauth-image](https://user-images.githubusercontent.com/31009634/135559389-c8cdf53c-76cf-4f9d-acaa-99014540f9cf.png)

30
website/docs/user-guides/construct-experiment.md
View File

@ -1,29 +1,29 @@
--- ---
id: construct-experiment id: construct-experiment
title: Construct Chaos Scenario YAML without ChaosCenter title: Construct chaos experiment YAML without ChaosCenter
sidebar_label: Construct Chaos Scenario YAML sidebar_label: Construct chaos experiment YAML
--- ---
--- ---
**Chaos Scenario** is a set of different operations coupled together to achieve desired chaos imapact on a Kubernetes Cluster. <br/> **Chaos Experiment** is a set of different operations coupled together to achieve desired chaos impact on a Kubernetes Cluster.
A basic chaos scenario consists of these steps:
1. Install ChaosExperiment A basic chaos experiment consists of these steps:
2. Install ChaosEngine 1. Install ChaosExperiment CR
3. Revert Chaos 2. Install ChaosEngine CR
3. Cleanup Chaos resources
## Before we begin ## Before we begin
To construct a Chaos Scenario without ChaosCenter, make sure you are aware of [Chaos Scenario](../concepts/chaos-workflow.md), [ChaosEngine CR](../glossary.md) and the different steps present in it. To construct a Chaos Experiment without ChaosCenter, make sure you are aware of [Chaos Experiment](../concepts/chaos-workflow.md), [ChaosEngine CR](../glossary.md) and the different steps present in it.
## Steps to Construct a Chaos Scenario ## Steps to construct a chaos experiment
LitmusChaos leverages the popular chaos scenario and GitOps tool **Argo** to achieve this goal. Argo enables the orchestration of different chaos scenarios together in the form of chaos scenario which is extremly simple and efficient to use.<br/> LitmusChaos leverages the popular GitOps tool **Argo** to achieve this goal. Argo enables the orchestration of different chaos faults together in the form of a single chaos experiment which is extremely simple and efficient to setup and use.
The structure of a chaos scenario is similar to that of a Kubernetes Object. It consists of the mandatory fields like `apiVersion`, `kind`, `metadata`, `spec`. The structure of a chaos experiment is similar to that of a Kubernetes Object. It consists of the mandatory fields like `apiVersion`, `kind`, `metadata`, `spec`.
Few additional terms in an Argo chaos scenarios are: Few additional terms in an Argo chaos experiments are:
1. **Template** : It consists of different steps with their specific operations. 1. **Template** : It consists of different steps with their specific operations.
@ -39,7 +39,7 @@ Few additional terms in an Argo chaos scenarios are:
template: revert-chaos template: revert-chaos
``` ```
2. **Steps** : It is a single step inside a chaos scenario which runs a container based on the input parameters. 2. **Steps** : It is a single step inside a chaos experiment which runs a container based on the input parameters.
These can also be sequenced parallely. These can also be sequenced parallely.
```yaml ```yaml
@ -54,7 +54,7 @@ steps:
template: revert-chaos template: revert-chaos
``` ```
3. **Entrypoint** : The first step that executes in a chaos scenario is called its entrypoint. 3. **Entrypoint** : The first step that executes in a chaos experiment is called its entrypoint.
```yaml ```yaml
entrypoint: custom-chaos entrypoint: custom-chaos
@ -78,7 +78,7 @@ Here, the template with the name `custom-chaos` will be executed first.
message: |... message: |...
``` ```
Once the chaos scenario is constructed, it should look like this: Once the chaos experiment is constructed, it should look like this:
```yaml ```yaml
apiVersion: argoproj.io/v1alpha1 apiVersion: argoproj.io/v1alpha1

4
website/docs/user-guides/create-environment.md
View File

@ -10,13 +10,13 @@ You can learn about the concept of chaos environments [here](../concepts/infrast
## 1. Go to the Environments section ## 1. Go to the Environments section
Navigate to the `/environments` page (Environments on the left nav), and click on the `New Environment` button Navigate to the `/environments` page (**Environments** sidebar option on the left nav), and click on the **New Environment** button
<img src={require('../assets/user-guides/environment/create-environment/step-1.png').default} /> <img src={require('../assets/user-guides/environment/create-environment/step-1.png').default} />
## 2. Add Environment details ## 2. Add Environment details
Add the details of the environment to be created such as name, description, tags, as well as the type of environment, i.e. `Pre-Production` and `Production`, these are meant to help further categorize the environments you are working with. Add the details of the environment to be created such as name, description, tags, as well as the type of environment, i.e. **Pre-Production** and **Production**, these are meant to help further categorize the environments you are working with.
<img src={require('../assets/user-guides/environment/create-environment/step-2.png').default} /> <img src={require('../assets/user-guides/environment/create-environment/step-2.png').default} />

23
website/docs/user-guides/create-infrastructure.md
View File

@ -12,19 +12,19 @@ sidebar_label: Create an Infrastructure
## 1. Go to the Infrastructure section ## 1. Go to the Infrastructure section
Navigate to the `/environments` page (Environments on the left nav), and click on the environment you wish to install the chaos infrastructure in: Navigate to the `/environments` page (**Environments** sidebar option on the left nav), and click on the Environment you wish to install the chaos infrastructure in:
<img src={require('../assets/user-guides/infrastructure/create-infrastructure/step-1.png').default} /> <img src={require('../assets/user-guides/infrastructure/create-infrastructure/step-1.png').default} />
## 2. Enable Chaos ## 2. Enable Chaos
Click on the `Enable Chaos` button: Click on the **Enable Chaos** button:
<img src={require('../assets/user-guides/infrastructure/create-infrastructure/step-2.png').default} /> <img src={require('../assets/user-guides/infrastructure/create-infrastructure/step-2.png').default} />
## 3. Add details of the Infrastructure ## 3. Add details of the Infrastructure
Add the details of the infrastructure such as the name, description and tags, then click on the `Next` button: Add the details of the infrastructure such as the name, description and tags, then click on the **Next** button:
<img src={require('../assets/user-guides/infrastructure/create-infrastructure/step-3.png').default} /> <img src={require('../assets/user-guides/infrastructure/create-infrastructure/step-3.png').default} />
@ -32,12 +32,13 @@ Add the details of the infrastructure such as the name, description and tags, th
Choose one of the following modes: Choose one of the following modes:
- **Cluster Wide:** This mode of infrastructure installation allows targeting resources across the entire cluster, in all the namespaces, as part of an experiment. - **Cluster Wide:** This mode of infrastructure installation allows targeting workloads across the cluster, in all the namespaces.
- **Namespace Mode:** This mode of infrastructure installation allows targeting resources only in the namespace where the chaos infrastructure is deployed.
By default the installation will take place in the `litmus` namespace and uses `litmus` service account, which can be configured under the K8s cluster details. - **Namespace Mode:** This mode of infrastructure installation allows targeting workloads only in the namespace where the chaos infrastructure is deployed.
Optionally, you can also specify the node selectors and Kubernetes tolerations for chaos infrastructure deployment in the advanced section By default the installation will take place in the `litmus` namespace and uses `litmus` service account, which can be configured under the cluster details.
Optionally, you can also specify the node selectors and Kubernetes tolerations for chaos infrastructure deployment in the advanced section.
<img src={require('../assets/user-guides/infrastructure/create-infrastructure/step-4.png').default} /> <img src={require('../assets/user-guides/infrastructure/create-infrastructure/step-4.png').default} />
@ -46,7 +47,7 @@ Optionally, you can also specify the node selectors and Kubernetes tolerations f
- For cluster-wide access: - For cluster-wide access:
<ol type="a"> <ol type="a">
<li>Select Download, and then copy and run the kubectl command shown on your screen to install the chaos infrastructure.</li> <li>Select Download, and then copy and run the <code>kubectl</code> command shown on your screen to install the chaos infrastructure.</li>
</ol> </ol>
<img src={require('../assets/user-guides/infrastructure/create-infrastructure/step-5.png').default} /> <img src={require('../assets/user-guides/infrastructure/create-infrastructure/step-5.png').default} />
@ -54,14 +55,14 @@ Optionally, you can also specify the node selectors and Kubernetes tolerations f
- For namespace access: - For namespace access:
<ol type="a"> <ol type="a">
<li>Run the first kubectl command to create the target namespace.</li> <li>Run the first <code>kubectl</code> command to create the target namespace.</li>
<li>Run the second kubectl command to apply the chaos CRDs.</li> <li>Run the second <code>kubectl</code> command to apply the chaos CRDs.</li>
<li>Select Download, and then copy and run the third command to install the chaos infrastructure.</li> <li>Select Download, and then copy and run the third command to install the chaos infrastructure.</li>
</ol> </ol>
<img src={require('../assets/user-guides/infrastructure/create-infrastructure/step-6.png').default} /> <img src={require('../assets/user-guides/infrastructure/create-infrastructure/step-6.png').default} />
Click `Done` Click **Done**
**NOTE:** For HTTPS mode of installation of Chaoscenter, you will need to set `SKIP_SSL_VERIFY` as `true` in the infrastructure deployment yaml. **NOTE:** For HTTPS mode of installation of Chaoscenter, you will need to set `SKIP_SSL_VERIFY` as `true` in the infrastructure deployment yaml.

8
website/docs/user-guides/create-resilience-probe.md
View File

@ -10,19 +10,19 @@ You can learn about the concept of resilience probes [here](../concepts/probes.m
## 1. Go to the Resilience Probes section ## 1. Go to the Resilience Probes section
Navigate to the `/probes` page (Resilience Probes on the left nav), and click on the `New Probe` button Navigate to the `/probes` page (Resilience Probes on the left nav), and click on the **New Probe** button.
<img src={require('../assets/user-guides/resilience-probes/create-probe/step-1.png').default} /> <img src={require('../assets/user-guides/resilience-probes/create-probe/step-1.png').default} />
## 2. Select the type of probe ## 2. Select the type of probe
Select and click on the type of probe you would like to create, you can read about the available probe types [here](../concepts/probes.md) Select and click on the type of probe you would like to create, you can read about the available probe types [here](../concepts/probes.md).
<img src={require('../assets/user-guides/resilience-probes/create-probe/step-2.png').default} /> <img src={require('../assets/user-guides/resilience-probes/create-probe/step-2.png').default} />
## 3. Enter the details of the probe to create ## 3. Enter the details of the probe to create
Enter the details of the probe such as name, description (optional), tags (optional) Enter the details of the probe such as name, description (optional), tags (optional).
<img src={require('../assets/user-guides/resilience-probes/create-probe/step-3.png').default} /> <img src={require('../assets/user-guides/resilience-probes/create-probe/step-3.png').default} />
@ -34,7 +34,7 @@ Configure the properties for the probe you are creating, such as, Timeout, Inter
## 5. Configure the probe details ## 5. Configure the probe details
Configure the details for the probe you are creating, once completed, click the `Setup Probe` button Configure the details for the probe you are creating. Once completed, click the **Setup Probe** button.
<img src={require('../assets/user-guides/resilience-probes/create-probe/step-5.png').default} /> <img src={require('../assets/user-guides/resilience-probes/create-probe/step-5.png').default} />

14
website/docs/user-guides/create-user.md
View File

@ -1,32 +1,32 @@
--- ---
id: create-user id: create-user
title: Create a User title: Create a user
sidebar_label: Create User sidebar_label: Create user
--- ---
--- ---
This feature enables the admin to create a new user by assigning a unique username and password for the user. In addition to this, the admin can also provide the name and email address of the new user which is optional. This feature enables the **admin** user to create a new user by assigning a unique username and password for that user. In addition to this, the **admin** user can also provide the name and email address of the new user, which is optional.
## 1. Navigate to User Management ## 1. Navigate to User Management
Go to the `User Management` tab of the account settings page: Go to the **User Management** tab of the account settings page:
<img src={require('../assets/user-guides/user-management/create-user/step-1.png').default} /> <img src={require('../assets/user-guides/user-management/create-user/step-1.png').default} />
## 2. Create a new user ## 2. Create a new user
Click on the `New User` button to bring up the `Create New User` modal and enter the details of the new user to be created. Click on the **New User** button to bring up the **Create New User** modal and enter the details of the new user to be created.
<img src={require('../assets/user-guides/user-management/create-user/step-2.png').default} /> <img src={require('../assets/user-guides/user-management/create-user/step-2.png').default} />
## 3. Confirmation of creation ## 3. Confirmation of creation
After you have added the details of the new user to be created, click the `Confirm` button to create the new user. After you have added the details of the new user to be created, click the **Confirm** button to create the new user.
<img src={require('../assets/user-guides/user-management/create-user/step-3.png').default} /> <img src={require('../assets/user-guides/user-management/create-user/step-3.png').default} />
You will now be able to view the new user in the table in the `User Management` tab. You will now be able to view the new user in the table in the **User Management** tab.
## Learn more ## Learn more

10
website/docs/user-guides/deactivate-user.md
View File

@ -1,12 +1,12 @@
--- ---
id: deactivate-user id: deactivate-user
title: Deactivate a User title: Deactivate a user
sidebar_label: Deactivate User sidebar_label: Deactivate user
--- ---
--- ---
The Account of a created user can be deactivated if required. Once the user is deactivated, the user won’t be able to log in or access any of the APIs. Along with this, the project in which the user was the owner of will also get deactivated and everyone who is a member of the project will lose access to that project. Admin can also reactivate the account of a deactivated user. Once the user is reactivated, complete data will get restored. The Account of a created user can be deactivated, if required. Once the user is deactivated, the user won’t be able to log in or access any of the APIs. Along with this, the user's project where they have Owner permission will also get deactivated and everyone who is a member of that project will lose access to it. The admin user can also reactivate the account of a deactivated user. Once the user is reactivated, all of their data will get restored.
## 1. Locate and deactivate the user ## 1. Locate and deactivate the user
@ -16,13 +16,13 @@ In the user management tab, locate the user account that you'd like to deactivat
## 2. Confirm the deactivation ## 2. Confirm the deactivation
On clicking on the `Disable User` option, a confirmation prompt will pop up, click on the `Confirm` button in order to disable the user. On clicking on the **Disable User** option, a confirmation prompt will pop up, click on the **Confirm** button in order to disable the user.
<img src={require('../assets/user-guides/user-management/deactivate-user/step-2.png').default} /> <img src={require('../assets/user-guides/user-management/deactivate-user/step-2.png').default} />
## 3. Re-activate a user (Optional step) ## 3. Re-activate a user (Optional step)
Similarly, the admin can re-activate the user from the same drop-down menu as shown: Similarly, the admin user can re-activate the user from the same drop-down menu as shown:
<img src={require('../assets/user-guides/user-management/deactivate-user/step-3.png').default} /> <img src={require('../assets/user-guides/user-management/deactivate-user/step-3.png').default} />

4
website/docs/user-guides/delete-environment.md
View File

@ -6,13 +6,13 @@ sidebar_label: Delete an Environment
## 1. Go to the Environments section ## 1. Go to the Environments section
Navigate to the `/environments` page (Environments on the left nav), click on the `options` icon to open the options menu and select `Delete` option: Navigate to the `/environments` page (**Environments** sidebar option on the left nav), click on the **⋮** icon to open the options menu and select **Delete** option:
<img src={require('../assets/user-guides/environment/delete-environment/step-1.png').default} /> <img src={require('../assets/user-guides/environment/delete-environment/step-1.png').default} />
## 2. Confirm Environment deletion ## 2. Confirm Environment deletion
After opening the options menu and clicking on the `Delete` option, you'll see a prompt in order to confirm your action. Please ensure that you want to delete the selected environment and click the `Confirm` button: After opening the options menu and clicking on the **Delete** option, you'll see a prompt in order to confirm your action. Please ensure that you want to delete the selected environment and click the **Confirm** button:
<img src={require('../assets/user-guides/environment/delete-environment/step-2.png').default} /> <img src={require('../assets/user-guides/environment/delete-environment/step-2.png').default} />

12
website/docs/user-guides/delete-experiment.md
View File

@ -1,7 +1,7 @@
--- ---
id: delete-experiment id: delete-experiment
title: Delete a Chaos experiment title: Delete a chaos experiment
sidebar_label: Delete Chaos experiment sidebar_label: Delete chaos experiment
--- ---
--- ---
@ -18,17 +18,17 @@ You can learn about the concept of chaos experiments [here](../concepts/chaos-wo
## 1. Go to the chaos experiments sections ## 1. Go to the chaos experiments sections
In the `Chaos experiment` page, go to the specific experiment you wish to delete: In the **Chaos experiment** page, go to the specific experiment you wish to delete:
<img src={require('../assets/user-guides/injecting-fault/delete-workflow/step-1.png').default} width="1000" height="500" /> <img src={require('../assets/user-guides/injecting-fault/delete-workflow/step-1.png').default} width="1000" height="500" />
## 2. Click on the `Delete experiment` option ## 2. Select Delete Experiment option
After opening the options menu and clicking on the `Delete experiment` option, you'll see a prompt in order to confirm your action. Please ensure that you want to delete the selected chaos experiment and click the `Confirm` button: After opening the options menu and clicking on the **Delete Experiment** option, you'll see a prompt in order to confirm your action. Please ensure that you want to delete the selected chaos experiment and click the **Confirm** button:
<img src={require('../assets/user-guides/injecting-fault/delete-workflow/step-2.png').default} width="1000" height="500" /> <img src={require('../assets/user-guides/injecting-fault/delete-workflow/step-2.png').default} width="1000" height="500" />
## 3. The Chaos experiment has been deleted ## 3. Verify that experiment has been deleted
You will observe that the chaos experiment no longer appears in the list of schedules and has been removed. You will observe that the chaos experiment no longer appears in the list of schedules and has been removed.

4
website/docs/user-guides/delete-infrastructure.md
View File

@ -6,13 +6,13 @@ sidebar_label: Delete an Infrastructure
## 1. Go to the Infrastructure section ## 1. Go to the Infrastructure section
Navigate to the infrastructure you want to delete, and click on the `options` icon to open the options menu and select `Disable` option: Navigate to the infrastructure you want to delete, and click on the **⋮** icon to open the options menu and select **Disable** option:
<img src={require('../assets/user-guides/infrastructure/delete-infrastructure/step-1.png').default} /> <img src={require('../assets/user-guides/infrastructure/delete-infrastructure/step-1.png').default} />
## 2. Confirm Infrastructure deletion ## 2. Confirm Infrastructure deletion
After opening the options menu and clicking on the `Disable` option, you'll see a prompt in order to confirm your action. Please ensure that you want to delete the selected infrastructure and click the `Confirm` button: After opening the options menu and clicking on the **Disable** option, you'll see a prompt in order to confirm your action. Please ensure that you want to delete the selected infrastructure and click the **Confirm** button:
:::note :::note
The disabling of the infrastructure from the UI will clean-up the subscriber pod from the cluster, but the remaining resources are left to the user to clean up, please follow the steps and the commands provided in the deletion confirmation modal to do so. The disabling of the infrastructure from the UI will clean-up the subscriber pod from the cluster, but the remaining resources are left to the user to clean up, please follow the steps and the commands provided in the deletion confirmation modal to do so.

6
website/docs/user-guides/delete-resilience-probe.md
View File

@ -10,13 +10,13 @@ Deleting a probe will delete all the associations with experiment runs from the
## 1. Go to the probes sections ## 1. Go to the probes sections
In the `Resilience Probes` page, go to the specific probe you wish to delete: In the **Resilience Probes** page, go to the specific probe you wish to delete:
<img src={require('../assets/user-guides/resilience-probes/delete-probe/step-1.png').default} /> <img src={require('../assets/user-guides/resilience-probes/delete-probe/step-1.png').default} />
## 2. Click on the `Delete Probe` option ## 2. Click on the Delete Probe option
After opening the options menu and clicking on the `Delete Probe` option, you'll see a prompt in order to confirm your action. Please ensure that you want to delete the selected resilience probe and click the `Confirm` button: After opening the options menu and clicking on the **Delete Probe** option, you'll see a prompt in order to confirm your action. Please ensure that you want to delete the selected Resilience Probe and select the **Confirm** button:
<img src={require('../assets/user-guides/resilience-probes/delete-probe/step-2.png').default} /> <img src={require('../assets/user-guides/resilience-probes/delete-probe/step-2.png').default} />

12
website/docs/user-guides/download-experiment-manifest.md
View File

@ -1,12 +1,12 @@
--- ---
id: download-experiment-manifest id: download-experiment-manifest
title: Download Chaos Scenario Manifest title: Download chaos scenario manifest
sidebar_label: Download Chaos Scenario Manifest sidebar_label: Download chaos scenario manifest
--- ---
--- ---
You can save a schedule configurations manifest as a `YAML`. This section goes over the steps to achieve the same. You can save a schedule configurations manifest as a `yaml`. This section goes over the steps to achieve the same.
## Before you begin ## Before you begin
@ -14,13 +14,13 @@ You can learn how to schedule your first chaos scenario [here](schedule-experime
## 1. Go to the chaos scenarios sections ## 1. Go to the chaos scenarios sections
In the `Chaos Scenario` page, go to the `Schedules` tab and click on the options menu for the specific schedule you wish to download the manifest for: In the **Chaos Scenario** page, go to the **Schedules** tab and click on the options menu for the specific schedule you wish to download the manifest for:
<img src={require('../assets/user-guides/injecting-fault/download-workflow-manifest/step-1.png').default} width="1000" height="500" /> <img src={require('../assets/user-guides/injecting-fault/download-workflow-manifest/step-1.png').default} width="1000" height="500" />
## 2. Click on the `Download Manifest` option ## 2. Select Download Manifest option
After opening the options menu, click on the `Download Manifest` option. Having downloaded a particular schedule manifest, you can see the browser downloads list to see the status of the manifest download operation and then see the `YAML` file in your system's default download directory: After opening the options menu, click on the **Download Manifest** option. Having downloaded a particular schedule manifest, you can see the browser downloads list to see the status of the manifest download operation and then see the **yaml** file in your system's default download directory:
<img src={require('../assets/user-guides/injecting-fault/download-workflow-manifest/step-2.png').default} width="1000" height="500" /> <img src={require('../assets/user-guides/injecting-fault/download-workflow-manifest/step-2.png').default} width="1000" height="500" />

4
website/docs/user-guides/edit-environment.md
View File

@ -6,13 +6,13 @@ sidebar_label: Edit an Environment
## 1. Go to the Environments section ## 1. Go to the Environments section
Navigate to the `/environments` page (Environments on the left nav), click on the `options` icon to open the options menu and select `Edit Environment` option: Navigate to the `/environments` page (**Environments** sidebar option on the left nav), click on the **⋮** icon to open the options menu and select **Edit Environment** option:
<img src={require('../assets/user-guides/environment/edit-environment/step-1.png').default} /> <img src={require('../assets/user-guides/environment/edit-environment/step-1.png').default} />
## 2. Update Environment details ## 2. Update Environment details
Update the details of the environment as required and click the `Save` button. Update the details of the environment as required and click the **Save** button.
<img src={require('../assets/user-guides/environment/edit-environment/step-2.png').default} /> <img src={require('../assets/user-guides/environment/edit-environment/step-2.png').default} />

2
website/docs/user-guides/edit-invite.md
View File

@ -8,7 +8,7 @@ sidebar_label: Edit/Cancel invite
If you had a change of mind and you wanted to change the role of an invitation that has been already sent, we got you! If you had a change of mind and you wanted to change the role of an invitation that has been already sent, we got you!
Just go to the invited tab, change the role, and hit the `Resend` button. You can also cancel the invitation by just clicking on the `Remove` button. Just go to the invited tab, change the role, and hit the **Resend** button. You can also cancel the invitation by just clicking on the **Remove** button.
<img src={require('../assets/user-guides/teaming/edit-invite/step-1.png').default} /> <img src={require('../assets/user-guides/teaming/edit-invite/step-1.png').default} />

16
website/docs/user-guides/edit-schedule.md
View File

@ -1,22 +1,20 @@
--- ---
id: edit-schedule id: edit-schedule
title: Edit Chaos Experiment Schedule title: Edit chaos experiment schedule
sidebar_label: Edit Chaos Experiment Schedule sidebar_label: Edit chaos experiment schedule
--- ---
--- ---
## Before you begin ## Before you begin
You must schedule a chaos experiment. To know more about scheduling chaos experiments click [here](schedule-experiment.md) You must schedule a chaos experiment. To know more about scheduling chaos experiments, click [here](schedule-experiment.md).
---
After you have scheduled a chaos experiment, you might have a need of changing the schedule of a recurring chaos experiment. To edit the schedule follow these steps: After you have scheduled a chaos experiment, you might have a need of changing the schedule of a recurring chaos experiment. To edit the schedule follow these steps:
## 1. Select edit schedule from the menu ## 1. Select edit schedule from the menu
In the `Chaos experiments` page you can click on the triple dots of the experiment to access more options for it. From the menu select the `Edit Experiment` option. In the **Chaos Experiments** page you can click on the triple dots of the experiment to access more options for it. From the menu select the **Edit Experiment** option.
<figure> <figure>
<img src={require('../assets/user-guides/injecting-fault/edit-schedule/schedule-menu.png').default} alt="Selecting Edit Schedule from the Menu" /> <img src={require('../assets/user-guides/injecting-fault/edit-schedule/schedule-menu.png').default} alt="Selecting Edit Schedule from the Menu" />
@ -25,7 +23,7 @@ In the `Chaos experiments` page you can click on the triple dots of the experime
## 2. Click on edit button ## 2. Click on edit button
Now you'll be seeing the pipeline diagram of your chaos experiment and you can click on the `Schedule` tab to change the schedule. Now you'll be seeing the pipeline diagram of your chaos experiment and you can click on the **Schedule** tab to change the schedule.
<figure> <figure>
<img src={require('../assets/user-guides/injecting-fault/edit-schedule/edit-schedule-page.png').default} alt="Summary of the Chaos experiment with Edit button" /> <img src={require('../assets/user-guides/injecting-fault/edit-schedule/edit-schedule-page.png').default} alt="Summary of the Chaos experiment with Edit button" />
@ -34,7 +32,7 @@ Now you'll be seeing the pipeline diagram of your chaos experiment and you can c
## 3. Change the schedule ## 3. Change the schedule
Here you can change the schedule to the required interval and click on the `Set schedule` button. Here you can change the schedule to the required interval and click on the **Set schedule** button.
<figure> <figure>
<img src={require('../assets/user-guides/injecting-fault/edit-schedule/edit-schedule.png').default} alt="Editing the Schedule" /> <img src={require('../assets/user-guides/injecting-fault/edit-schedule/edit-schedule.png').default} alt="Editing the Schedule" />
@ -43,7 +41,7 @@ Here you can change the schedule to the required interval and click on the `Set
## 4. Save the changes ## 4. Save the changes
Click the `Save` button to save the changes to the experiment chaos experiment. Click the **Save** button to save the changes to the experiment chaos experiment.
## Learn more ## Learn more

26
website/docs/user-guides/gitops-configuration.md
View File

@ -20,30 +20,30 @@ GitOps enables you to configure a single source of truth for your chaos experime
- [Gitops](../concepts/gitops.md) - [Gitops](../concepts/gitops.md)
- [Chaos Infrastructure](../concepts/infrastructure.md) - [Chaos Infrastructure](../concepts/infrastructure.md)
- [Chaos Experiment](../concepts/chaos-workflow.md) - [Chaos Experiment](../concepts/chaos-workflow.md)
- Ensure that you have an active internet connection and a git repository. - Ensure that you have an active internet connection and a Git repository.
## Steps to configure GitOps ## Steps to configure GitOps
- Setup a git repository, so that the ChaosCenter can sync with it, and push all the chaos experiments in that repository. - Setup a hosted Git repository so that the ChaosCenter can sync with it and push all the chaos experiments in that repository.
- The git repo can be public or private but for authorization, you have to provide an access token or any other mode of authentication. - The Git repository can be public or private, but for authorization you have to provide an access token or any other mode of authentication.
- Login into ChaosCenter, go to `GitOps` (Project Setup > GitOps on the left nav). - Login to ChaosCenter and navigate to **GitOps** (**Project Setup** > **GitOps** on the left nav).
<br/><br/> <br/><br/>
<img src={require('../assets/user-guides/gitops/gitops.png').default} width="800" /> <img src={require('../assets/user-guides/gitops/gitops.png').default} width="800" />
<br/><br/> <br/><br/>
- Select the `Git Repository` radio button. - Select the **Git Repository** radio button.
- Copy the git URL of your git repository and paste it in the `Repository URL` text box. - Copy the URL of your Git repository and paste it in the **Repository URL** input field.
- Enter the branch where you want to sync your chaos experiments. - Enter the branch where you want to sync your chaos experiments.
<br/><br/> <br/><br/>
<img src={require('../assets/user-guides/gitops/gitops-config.png').default} width="800" /> <img src={require('../assets/user-guides/gitops/gitops-config.png').default} width="800" />
<br/><br/> <br/><br/>
- You can allow access of your repository either through an access token or through an SSH key. - You can allow access of your repository either through an access token or through an SSH key.
- In the case of the SSH key, click the button `Generate New SSH Key` and just copy the key and paste it in the `Deploy Keys` Tab inside `Settings` in your git - repository. Click on the allow write access checkbox, and then on the `Add key` button. - In the case of the SSH key, click the button **Generate New SSH Key** and just copy the key and paste it in the **Deploy Keys** Tab inside **Settings** in your Git - repository. Click on the allow write access checkbox, and then on the **Add key** button.
- Go back to the portal and click on the `Save` button. A snackbar will pop up showing, `Successfully updated GitOps!` message. - Go back to the portal and click on the **Save** button. A snackbar will pop up showing, **Successfully updated GitOps!** message.
- Some metadata will be pushed to your repository, that is the projectID of your project. - Some metadata will be pushed to your repository, that is the ID of your project.
- Now whenever you schedule a chaos experiment, it will automatically be pushed to your repository. And that repository will be the single source of truth. - Now whenever you schedule a chaos experiment, it will automatically be pushed to your repository, and that repository will be the single source of truth.
:::note :::note
It is also possible to account for the chaos experiments that are created and pushed to the git repository directly, after configuring GitOps. In this case, if the chaos experiment is a single run chaos experiment, then it starts executing as soon as it is pushed to the repository. Alternatively, if the chaos experiment is a scheduled chaos experiment, then it executes as per the defined schedule. On the other hand, updating an existing chaos experiment present in the git repository will not execute the chaos experiment but only sync the chaos experiment resource definition with the ChaosCenter, if applicable. It is also possible to account for the chaos experiments that are created and pushed to the Git repository directly, after configuring GitOps. In this case, if the chaos experiment is a single run chaos experiment, then it starts executing as soon as it is pushed to the repository. Alternatively, if the chaos experiment is a scheduled chaos experiment, then it executes as per the defined schedule. On the other hand, updating an existing chaos experiment present in the Git repository will not execute the chaos experiment but only sync the chaos experiment resource definition with the ChaosCenter, if applicable.
::: :::
## Steps to configure Event-Triggered Chaos Injection ## Steps to configure Event-Triggered Chaos Injection
@ -58,7 +58,7 @@ kubectl annotate deploy/target-application litmuschaos.io/experimentId=${experim
kubectl annotate deploy/target-application litmuschaos.io/gitops=true kubectl annotate deploy/target-application litmuschaos.io/gitops=true
``` ```
- You can check if the event-tracker is running using this command:<br/> - You can check if the event-tracker is running using this command:
``` ```
kubectl get pods -n litmus -w kubectl get pods -n litmus -w
@ -73,7 +73,7 @@ kubectl logs -f event-tracker-pod-name -n litmus
In the logs, you’ll notice that the event-tracker has started. In the logs, you’ll notice that the event-tracker has started.
If you make changes in the application the event tracker will trigger the chaos injection. If the policy conditions are met then the event tracker will inform the server to schedule a chaos experiment in that same target. For eg: if you have an Nginx app as your target application, you can just edit the deployment and change its image tag, this will trigger the chaos injection. If you make changes in the application the event tracker will trigger the chaos injection. If the policy conditions are met then the event tracker will inform the server to schedule a chaos experiment in that same target. For eg: if you have an Nginx app as your target application, you can just edit the deployment and change its image tag, this will trigger the chaos injection.
Below is a sample policy where two conditions are present and will be validated by the respective operator. The chaos experiment will be triggered if both conditions are met due to the `AND` condition type. Below is a sample policy where two conditions are present and will be validated by the respective operator. The chaos experiment will be triggered if both conditions are met due to the **AND** condition type.
``` ```
apiVersion: eventtracker.litmuschaos.io/v1 apiVersion: eventtracker.litmuschaos.io/v1

33
website/docs/user-guides/image-registry.md
View File

@ -1,45 +1,46 @@
--- ---
id: image-registry id: image-registry
title: Using different Image Registries in a Chaos Experiments title: Using custom image registries in a chaos experiment
sidebar_label: Using different Image Registries sidebar_label: Using different image registries
--- ---
--- ---
A container image registry can be defined as a collection of repositories that store container image. A custom container image registry can be defined as a collection of repositories that store container image. It can be either public or private. Few of the container image registries that can be used are Docker, Red Hat Quay, and Google Container Registry among others.
These can be either public or private. Few of the container image registries are Docker, Red Hat Quay, Google Container Registry.
By default LitmusChaos uses DockerHub for managing the different images. These images are then used in Chaos experiments. Few images that are used in the Litmus chaos experiments are `litmuschaos:k8s`, `litmuschaos:litmus-checker` etc. By default LitmusChaos uses DockerHub for managing the different images. These images are then used in Chaos experiments. A few images that are used for the chaos experiments are `litmuschaos:k8s`, `litmuschaos:litmus-checker`, etc.
With ChaosCenter, you get the privilege to use your own/custom image registries for Chaos experiments.
With ChaosCenter, you get the option to use your own custom image registries for Chaos experiments.
## Before you begin ## Before you begin
To understand the concept of Image Registry, make sure you are aware of [Chaos experiment](../concepts/chaos-workflow.md) and the different image registries that are used in it. To understand the concept of image registry, make sure you are aware of [Chaos experiment](../concepts/chaos-workflow.md) and the different image registries that are used in it.
## Steps to Update Chaos experiment Image Registry ## Steps to Update Chaos experiment image registry
To updated the Chaos experiment Image Registry, you can go to Image Registry in ChaosCenter (Project Setup > Image Registry on the left nav). On clicking the Image Registry tab, you can see that the default Registry server is `docker.io`, Registry name is `litmuschaos` and it is a Public registry. To updated the chaos experiment image registry, you can go to image registry in ChaosCenter (**Project Setup** > **image registry** on the left nav). On clicking the image registry tab, you can see that the default registry server is `docker.io`, registry name is `litmuschaos` and it is a public registry.
<img src={require('../assets/user-guides/image-registry/img-registry-tab.png').default} /> <img src={require('../assets/user-guides/image-registry/img-registry-tab.png').default} />
<br/><br/> <br/><br/>
To update this, click on the `Use Custom Values` option and provide the following details: To update this, click on the **Use Custom Values** option and provide the following details:
1. Custom Image Registry (Registry Server) 1. Custom Image Registry (Registry server)
2. Custom Repo (Registry Name) 2. Custom Repo (Registry name)
3. Registry Type `Public/Private` 3. Registry Type (**Public**/**Private**)
<img src={require('../assets/user-guides/image-registry/img-registry-update.png').default} /> <img src={require('../assets/user-guides/image-registry/img-registry-update.png').default} />
<br/><br/> <br/><br/>
If the Registry Type is `Private`, make sure to provide the secret. If the registry type is **Private**, make sure to provide the secret.
Once the details are provided, click on the `Save` button and you can see the updated Image Registry changes. Once the details are provided, click on the **Save** button and you can see the updated image registry changes.
<img src={require('../assets/user-guides/image-registry/img-registry-updated.png').default} /> <img src={require('../assets/user-guides/image-registry/img-registry-updated.png').default} />
<br/><br/> <br/><br/>
Now while scheduling a chaos experiment, the image registry changes will be visible. Here's the code snippet from a Chaos experiment after the image registry change. Now, when scheduling a chaos experiment, the image registry changes will be visible. Here's the code snippet from a chaos experiment after the image registry change.
```yaml ```yaml
- name: install-application - name: install-application

10
website/docs/user-guides/invite-team-member.md
View File

@ -1,14 +1,14 @@
--- ---
id: invite-team-member id: invite-team-member
title: Invite a Team Member title: Invite a team member
sidebar_label: Invite Team Member sidebar_label: Invite team member
--- ---
--- ---
> In the `/setup` route (Project Setup > Members on the sidebar) the `Active/Pending members` tabs can be used to access the teaming feature by the `owner`. We recommend learning about the concept of [teaming](../concepts/teaming.md) before proceeding with the following user guides. In the `/setup` route (Project Setup > Members on the sidebar) the **Active/Pending members** tabs can be used to access the teaming feature by the Owner. We recommend learning about the concept of [teaming](../concepts/teaming.md) before proceeding with the following user guides.
With this feature, you can select as many users you want, choose their roles individually and send the invitation at once! Once it is done successfully you can see the status of the sent invitation (whether it is in a pending/accepted/declined or exited state) along with all the other necessary details in the `Pending members` tab. With this feature, you can select as many users you want, choose their roles individually and send all the invitation at once. Once done, you can view the status of the sent invitation (whether it is in a pending/accepted/declined or exited state) along with all the other necessary details in the **Pending members** tab.
## 1. Find the user you want to invite ## 1. Find the user you want to invite
@ -22,7 +22,7 @@ From the list of all available members, choose the ones you want to collaborate
<img src={require('../assets/user-guides/teaming/invite-team-member/step-2.png').default} /> <img src={require('../assets/user-guides/teaming/invite-team-member/step-2.png').default} />
On successful acceptance of the invitation you will be able to collaborate over your project! Upon accepting the invitation, you will be able to collaborate over your project.
## Learn more ## Learn more

14
website/docs/user-guides/leave-project.md
View File

@ -1,22 +1,24 @@
--- ---
id: leave-project id: leave-project
title: Leave a Project title: Leave a project
sidebar_label: Leave Project sidebar_label: Leave project
--- ---
--- ---
You can leave a project that you no longer wish to be a part of. You can leave a project that you no longer wish to be a part of.
## 1. Identify the project you want to leave ## 1. Identify the project
In the settings page, scroll to the `Projects Joined` section. Here you will see a list of all the projects you are a part of, identify the project you’d like to leave and click on the `Leave Project` button: In the settings page, scroll to the **Projects Joined** section. Here you will see a list of all the projects you are a part of, identify the project you’d like to leave and click on the **Leave Project** button:
<img src={require('../assets/user-guides/managing-projects/leave-project/step-1.png').default} /> <img src={require('../assets/user-guides/managing-projects/leave-project/step-1.png').default} />
> Note: Having left the project, the number of active projects will change and the project you left can no longer be observed as a currently active project in the `Team` tab :::note
Note: Having left the project, the number of active projects will change and the project you left can no longer be observed as a currently active project in the **Team** tab.
:::
A confirmation dialog will pop up, click on the `Confirm` button to leave the project A confirmation dialog will pop up, click on the **Confirm** button to leave the project.
<img src={require('../assets/user-guides/managing-projects/leave-project/step-2.png').default} /> <img src={require('../assets/user-guides/managing-projects/leave-project/step-2.png').default} />

16
website/docs/user-guides/observe-experiment.md
View File

@ -1,32 +1,34 @@
--- ---
id: observe-experiment id: observe-experiment
title: Observe Chaos experiment title: Observe chaos experiment
sidebar_label: Observe Chaos experiment sidebar_label: Observe chaos experiment
--- ---
--- ---
Visualization is an important aspect while doing chaos engineering. It allows the user to discover and inspect different changes that occur during a Chaos Experiment execution. <br/> Visualization is an important aspect while doing chaos engineering. It allows the user to discover and inspect different changes that occur during a Chaos Experiment execution.
With ChaosCenter, the real-time data and status of the chaos experiments can be observed. Valuable information like pod logs, chaos experiment status, and chaos results can also be viewed. With ChaosCenter, the real-time data and status of the chaos experiments can be observed. Valuable information like pod logs, chaos experiment status, and chaos results can also be viewed.
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- ChaosCenter - ChaosCenter
- [Chaos Experiments](../concepts/chaos-workflow.md) - [Chaos Experiments](../concepts/chaos-workflow.md)
## Litmus Chaos Experiment ## Chaos experiment
If the user chooses to 'Save' and 'Run' the experiment, they will be redirected directly to the experiment execution page where the experiment can be visualised else they will be taken Chaos Experiment Page. If the user chooses to **Save** and **Run** the experiment, they will be redirected directly to the experiment execution page where the experiment execution steps will be visualized, else they will be taken Chaos Experiment Page.
## Observe a Litmus Chaos Experiment ## Observe an experiment
To observe a chaos experiment, user needs to select the highlighted experiment run box from the heatmap, it will redirect to experiment run execution page.<br/> To observe a chaos experiment, user needs to select the highlighted experiment run box from the heatmap, it will redirect to experiment run execution page.<br/>
<img src={require('../assets/workflow-observe-select.png').default} width="800" /> <img src={require('../assets/workflow-observe-select.png').default} width="800" />
In the chaos experiment, a realtime graph of the chaos experiment is displayed. This graph contains valuable information regarding the status of individual steps of the chaos experiment.<br/><br/> In the chaos experiment, a realtime graph of the chaos experiment is displayed. This graph contains valuable information regarding the status of individual steps of the chaos experiment.<br/><br/>
<img src={require('../assets/workflow-observe-running.png').default} width="800" /><br/><br/> <img src={require('../assets/workflow-observe-running.png').default} width="800" /><br/><br/>
To view the details of each step, the user can click on the individual nodes and the right side pane will display the node details, results(once the execution is complete), and the logs related to it. To view the details of each step, the user can click on the individual nodes and the right side pane will display the node details, results(once the execution is complete), and the logs related to it.
<br/><br/> <br/><br/>
<img src={require('../assets/workflow-observe-log.png').default} width="800" /> <img src={require('../assets/workflow-observe-log.png').default} width="800" />

6
website/docs/user-guides/re-run-experiment.md
View File

@ -6,7 +6,7 @@ sidebar_label: Re-run chaos experiment
--- ---
You can re-run any **_non-recurring_** schedule should you wish to test your application against it at any point. You can re-run any **non-recurring** schedule should you wish to test your application against it at any point.
## Before you begin ## Before you begin
@ -14,11 +14,11 @@ You can learn how to schedule your first chaos experiment [here](schedule-experi
## 1. Go to the chaos experiments sections ## 1. Go to the chaos experiments sections
In the `Chaos experiment` page, and click on the play icon for the specific schedule you wish to re-run: In the **Chaos experiment** page, and click on the play icon for the specific schedule you wish to re-run:
<img src={require('../assets/user-guides/injecting-fault/re-run-workflow/step-1.png').default} /> <img src={require('../assets/user-guides/injecting-fault/re-run-workflow/step-1.png').default} />
## 2. Click on the `Run Experiment` option ## 2. Select Run Experiment option
Having re-run a particular experiment, you will redirected to the chaos studio for the particular execution and see that it has started to run as per the experiment configurations: Having re-run a particular experiment, you will redirected to the chaos studio for the particular execution and see that it has started to run as per the experiment configurations:

12
website/docs/user-guides/remove-team-member.md
View File

@ -1,23 +1,23 @@
--- ---
id: remove-team-member id: remove-team-member
title: Remove a Team Member title: Remove a team member
sidebar_label: Remove Team Member sidebar_label: Remove team member
--- ---
--- ---
If you are the project owner, you have the ability to remove any members from your project as required. If you are the project owner, you have the ability to remove any user from your project.
## Steps ## Steps
### 1. Identify the member to remove ### 1. Identify the user to be removed
In the `Active members` tab in the Members page, you will be able to see all the members who have their invitation status as `accepted` for your project collaboration invite. Here, identify the user to remove and click on the `Options` icon as shown and select the `Remove Member` option. In the **Active members** tab in the Members page, you will be able to see all the members who have their invitation status as **accepted** for your project collaboration invite. Here, identify the user to remove and click on the **Options** icon as shown and select the **Remove Member** option.
<img src={require('../assets/user-guides/teaming/remove-team-member/step-1.png').default} /> <img src={require('../assets/user-guides/teaming/remove-team-member/step-1.png').default} />
### 2. Confirmation for removal ### 2. Confirmation for removal
On hitting the `Remove Member` option, you will be prompted to confirm the removal of the member, hit `Confirm` to confirm and remove the member from your project. On hitting the **Remove Member** option, you will be prompted to confirm the removal of the member, hit **Confirm** to confirm and remove the member from your project.
<img src={require('../assets/user-guides/teaming/remove-team-member/step-2.png').default} /> <img src={require('../assets/user-guides/teaming/remove-team-member/step-2.png').default} />

10
website/docs/user-guides/reset-password.md
View File

@ -1,22 +1,22 @@
--- ---
id: reset-password id: reset-password
title: Reset Password of a User title: Reset password of a user
sidebar_label: Reset Password sidebar_label: Reset password
--- ---
--- ---
The admin has the ability to reset the login password for any user in the portal. The admin user has the ability to reset the login password for any user in the portal.
## 1. Locate the user ## 1. Locate the user
Under the `User Management` tab find the user who's password needs to be updated and click on the options icon to open a drop-down and select `Reset Password` option Under the **User Management** tab find the user who's password needs to be updated and click on the options icon to open a drop-down and select **Reset Password** option
<img src={require('../assets/user-guides/user-management/reset-password/step-1.png').default} /> <img src={require('../assets/user-guides/user-management/reset-password/step-1.png').default} />
## 2. Change the password ## 2. Change the password
In the `Reset Password` modal type in the new password in the `New Password` & `Re-enter new password` fields. Once done hit the `Confirm` button to update the password. In the **Reset Password** modal type in the new password in the **New Password** & **Re-enter new password** fields. Once done hit the **Confirm** button to update the password.
<img src={require('../assets/user-guides/user-management/reset-password/step-2.png').default} /> <img src={require('../assets/user-guides/user-management/reset-password/step-2.png').default} />

6
website/docs/user-guides/schedule-experiment.md
View File

@ -1,14 +1,14 @@
--- ---
id: schedule-experiment id: schedule-experiment
title: Schedule a Chaos Experiment title: Schedule a chaos experiment
sidebar_label: Schedule Chaos Experiment sidebar_label: Schedule chaos experiment
--- ---
--- ---
## Before you begin ## Before you begin
You must connect an Chaos Infrastructure before scheduling a chaos experiment. You can [connect an external Chaos Infrastructure](../litmusctl/installation.md). You must connect a Chaos Infrastructure before scheduling a chaos experiment. You can [connect an external Chaos Infrastructure](../litmusctl/installation.md).
--- ---

25
website/docs/user-guides/setup-with-ingress.md
View File

@ -1,38 +1,41 @@
--- ---
id: setup-with-ingress id: setup-with-ingress
title: Install Litmus ChaosCenter with Ingress title: Install ChaosCenter with Ingress
sidebar_label: Setup With Ingress sidebar_label: Setup with Ingress
--- ---
--- ---
## Prerequisites ## Prerequisites
Before setting up endpoint with Ingress make sure the [Litmus ChaosCenter](../getting-started/resources.md#chaoscenter) is installed Before setting up endpoint with Ingress make sure the [Litmus ChaosCenter](../getting-started/resources.md#chaoscenter) is installed:
- [Install ChaosCenter with HTTP](../getting-started/installation.md)) - [Install ChaosCenter with HTTP](../getting-started/installation.md)
- [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md) - [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md)
## Install ChaosCenter with Ingress ## Install ChaosCenter with Ingress
With Litmus-2.0.0, ChaosCenter can be installed with ingress. Since Litmus 2.0.0, ChaosCenter can be installed with ingress. We will use the Nginx ingress controller for ingress setup.
In the following doc, we will use the Nginx ingress controller for ingress setup.
1. By default, the service type is `NodePort`. For Ingress, we need to change the service type to `ClusterIP` in the following services. 1. By default, the service type is `NodePort`. For Ingress, we need to change the service type to `ClusterIP` in the following services:
- `litmusportal-frontend-service` - `litmusportal-frontend-service`
- `litmusportal-server-service` - `litmusportal-server-service`
2. Install Nginx Ingress Controller along with Kubernetes RBAC roles and bindings, please refer [here](https://kubernetes.github.io/ingress-nginx/deploy/#installation-guide) 2. Install Nginx Ingress Controller along with Kubernetes RBAC roles and bindings, please refer [here](https://kubernetes.github.io/ingress-nginx/deploy/#installation-guide).
> - Set the environment variable **INGRESS** as true in the litmusportal-server deployment. :::note
Set the environment variable **INGRESS** as true in the litmusportal-server deployment.
:::
Example: Example:
```bash ```bash
kubectl set env deployment/litmusportal-server -n litmus --containers="graphql-server" INGRESS="true" kubectl set env deployment/litmusportal-server -n litmus --containers="graphql-server" INGRESS="true"
``` ```
> - If you're changing ingress name from **litmus-ingress** to a different name, make sure to update the **INGRESS_NAME** environment variable in the litmusportal-server deployment :::note
If you're changing ingress name from **litmus-ingress** to a different name, make sure to update the **INGRESS_NAME** environment variable in the litmusportal-server deployment.
:::
Example: Example:
```bash ```bash
@ -41,7 +44,7 @@ kubectl set env deployment/litmusportal-server -n litmus --containers="graphql-s
### With HTTP ### With HTTP
Sample litmus ingress manifest With HTTP Sample LitmusChaos Ingress manifest with HTTP:
```yaml ```yaml
apiVersion: networking.k8s.io/v1 apiVersion: networking.k8s.io/v1

28
website/docs/user-guides/setup-without-ingress.md
View File

@ -1,21 +1,21 @@
--- ---
id: setup-without-ingress id: setup-without-ingress
title: Setting up Endpoints without Ingress title: Setting up endpoints without ingress
sidebar_label: Setup without Ingress sidebar_label: Setup without ingress
--- ---
--- ---
## Prerequisites ## Prerequisites
Before setting up endpoint without Ingress make sure the [Litmus ChaosCenter](../getting-started/resources.md#chaoscenter) is installed in either one of these scopes Before setting up endpoint without Ingress, make sure [ChaosCenter](../getting-started/resources.md#chaoscenter) is installed in either one of these scopes:
- [Install ChaosCenter with HTTP](../getting-started/installation.md)) - [Install ChaosCenter with HTTP](../getting-started/installation.md))
- [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md) - [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md)
## **With NodePort** ## NodePort service setup
To setup and login to Litmus Portal expand the available services just created and copy the `PORT` of the `litmusportal-frontend-service` service To setup and login to ChaosCenter, list the services in the Litmus namespace and copy the `PORT` of the `litmusportal-frontend-service` service.
```bash ```bash
kubectl get svc -n <LITMUS_PORTAL_NAMESPACE> kubectl get svc -n <LITMUS_PORTAL_NAMESPACE>
@ -30,11 +30,13 @@ litmusportal-frontend-service NodePort 10.101.81.70 <none> 9091:
litmusportal-server-service NodePort 10.108.151.79 <none> 9002:32456/TCP,9003:31160/TCP 2m litmusportal-server-service NodePort 10.108.151.79 <none> 9002:32456/TCP,9003:31160/TCP 2m
``` ```
> **Note**: In this case, the PORT for `litmusportal-frontend-service` is `30385`. Yours will be different. :::note
In this case, the port for `litmusportal-frontend-service` is `30385`, in your case it will be different.
:::
## **With LoadBalancer** ## LoadBalancer service setup
To setup and login to Litmus Portal with LoadBalancer, patch the Frontend Service `litmusportal-frontend-service` and expose the External IP. To setup and login to ChaosCenter with LoadBalancer, patch the Frontend service `litmusportal-frontend-service` and expose the external IP:
```bash ```bash
kubectl patch svc litmusportal-frontend-service -p '{"spec": {"type": "LoadBalancer"}}' -n <LITMUS_PORTAL_NAMESPACE> kubectl patch svc litmusportal-frontend-service -p '{"spec": {"type": "LoadBalancer"}}' -n <LITMUS_PORTAL_NAMESPACE>
@ -49,9 +51,9 @@ litmusportal-frontend-service NodePort 10.101.81.70 <none> 9091:
litmusportal-server-service NodePort 10.108.151.79 <none> 9002:32456/TCP,9003:31160/TCP 2m litmusportal-server-service NodePort 10.108.151.79 <none> 9002:32456/TCP,9003:31160/TCP 2m
``` ```
## **Accessing the ChaosCenter** ## Accessing ChaosCenter
Once you have the PORT copied in your clipboard, simply use your IP and PORT in this manner `<IP>:<PORT>` to access the Litmus ChaosCenter. Once you have the port copied in your clipboard, simply use your IP and port in this manner `<IP>:<PORT>` to access the Litmus ChaosCenter.
For example: For example:
@ -59,9 +61,11 @@ For example:
http://172.17.0.3:30385/ http://172.17.0.3:30385/
``` ```
> Where `172.17.0.3` is my NodeIP and `30385` is the frontend service PORT. If using a LoadBalancer, the only change would be to provide a `<LoadBalancerIP>:<PORT>` :::note
Here `172.17.0.3` is the node's IP and `30385` is the frontend service port. If you're using a LoadBalancer service, use the load balancer IP and the port in the following manner: `<LoadBalancerIP>:<PORT>`
:::
You should be able to see the Login Page of Litmus ChaosCenter. The **default credentials** are You should be able to see the login page of ChaosCenter. The default credentials are following:
```yaml ```yaml
Username: admin Username: admin

8
website/docs/user-guides/uninstall-litmus.md
View File

@ -16,7 +16,9 @@ To disconnect the [Chaos Infrastructure](../getting-started/resources.md#chaosag
kubectl delete chaosengine <CHAOSENGINE_NAMEs> --all -<INFRA_NAMESPACE> kubectl delete chaosengine <CHAOSENGINE_NAMEs> --all -<INFRA_NAMESPACE>
``` ```
> If ChaosEngines is unable to delete successfully then the Kubernetes finalizers need to be removed manually. :::note
If ChaosEngines is unable to delete successfully then the Kubernetes finalizers need to be removed manually.
:::
2. Login to the ChaosCenter and navigate to the Chaos Infrastructures Page. 2. Login to the ChaosCenter and navigate to the Chaos Infrastructures Page.
3. Click on the three dot menu and select `Disable` of the respective Chaos Infrastructure you want to disconnect. 3. Click on the three dot menu and select `Disable` of the respective Chaos Infrastructure you want to disconnect.
@ -29,7 +31,7 @@ To disconnect the [Chaos Infrastructure](../getting-started/resources.md#chaosag
### Remove the CRs ### Remove the CRs
To remove the CRs Litmus uses, use the following command: To remove the CRs, use the following commands:
- To remove individual CRs - To remove individual CRs
@ -65,7 +67,7 @@ kubectl delete sa rolebindings role --all -n <NAMESPACE>
--- ---
## Remove the Litmus CRDs ## Remove the CRDs
To remove all the CRDs Litmus uses, use the following command: To remove all the CRDs Litmus uses, use the following command:

8
website/docs/user-guides/view-probe-details.md
View File

@ -1,19 +1,19 @@
--- ---
id: view-resilience-probe id: view-resilience-probe
title: View Resilience Probe Details title: View Resilience Probe details
sidebar_label: View Resilience Probe Details sidebar_label: View Resilience Probe details
--- ---
## 1. Go to the probes sections ## 1. Go to the probes sections
In the `Resilience Probes` page, go to the specific probe you wish to view the details of: In the **Resilience Probes** page, go to the specific probe you wish to view the details of:
<img src={require('../assets/user-guides/resilience-probes/view-probe/step-1.png').default} /> <img src={require('../assets/user-guides/resilience-probes/view-probe/step-1.png').default} />
## 2. View Execution history ## 2. View Execution history
Click on the specific probe you would like to see the details of, this will redirect you to the `Execution History` tab: Click on the specific probe you would like to see the details of, this will redirect you to the **Execution History** tab:
<img src={require('../assets/user-guides/resilience-probes/view-probe/step-2.png').default} /> <img src={require('../assets/user-guides/resilience-probes/view-probe/step-2.png').default} />

4
website/docs/user-guides/view-user.md
View File

@ -6,11 +6,11 @@ sidebar_label: View users
--- ---
> In the `settings` page the `User Management` tab can be used to access the user management feature by the admin. We recommend learning about the concept of [user management](../concepts/user-management.md) before proceeding with the following user guides. In the **Settings** page, the **User Management** tab can be used to access the user management feature by the admin. We recommend learning about the concept of [user management](../concepts/user-management.md) before proceeding with the following user guides.
## View users ## View users
The admin can access the `User Management` tab to check the list of all users present in the portal. The admin can access the **User Management** tab to check the list of all users present in the portal.
<img src={require('../assets/user-guides/user-management/view-user/step-1.png').default} width="1000" height="500" /> <img src={require('../assets/user-guides/user-management/view-user/step-1.png').default} width="1000" height="500" />

2
website/versioned_docs/version-3.0.0/concepts/chaos-workflow.md
View File

@ -22,7 +22,7 @@ The term **Chaos Scenario/Workflow** has been changed to **Chaos Experiment**.
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- [ChaosCenter](../getting-started/resources.md#chaoscenter) - [ChaosCenter](../getting-started/resources.md#chaoscenter)
- [Chaos Infrastructure](../getting-started/resources.md#chaosagents) - [Chaos Infrastructure](../getting-started/resources.md#chaosagents)

2
website/versioned_docs/version-3.0.0/integrations/grafana.md
View File

@ -10,7 +10,7 @@ Chaos Engineering is the discipline of experimenting on a system to build confid
## Before you begin ## Before you begin
The following should be required before integrating Grafana with litmus 2.0: The following are required before integrating Grafana with litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/) - [Prometheus TSDB](https://prometheus.io/)
- [Prometheus Integration](prometheus.md) - [Prometheus Integration](prometheus.md)

2
website/versioned_docs/version-3.0.0/integrations/prometheus.md
View File

@ -10,7 +10,7 @@ LitmusChaos facilitates real-time monitoring for events and metrics using it’s
## Before you begin ## Before you begin
The following should be required before integrating Prometheus in litmus 2.0: The following are required before integrating Prometheus in litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/) - [Prometheus TSDB](https://prometheus.io/)
- [Probes](../concepts/probes.md) - [Probes](../concepts/probes.md)

2
website/versioned_docs/version-3.0.0/user-guides/observe-experiment.md
View File

@ -11,7 +11,7 @@ With ChaosCenter, the real-time data and status of the chaos experiments can be
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- ChaosCenter - ChaosCenter
- [Chaos Experiments](../concepts/chaos-workflow.md) - [Chaos Experiments](../concepts/chaos-workflow.md)

2
website/versioned_docs/version-3.1.0/concepts/chaos-workflow.md
View File

@ -19,7 +19,7 @@ With the latest release of LitmusChaos 3.0.0:
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- [ChaosCenter](../getting-started/resources.md#chaoscenter) - [ChaosCenter](../getting-started/resources.md#chaoscenter)
- [Chaos Infrastructure](../getting-started/resources.md#chaosagents) - [Chaos Infrastructure](../getting-started/resources.md#chaosagents)

2
website/versioned_docs/version-3.1.0/concepts/visualize-experiment.md
View File

@ -11,7 +11,7 @@ With ChaosCenter, the real-time data and status of the chaos experiments can be
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- ChaosCenter - ChaosCenter
- [Chaos Experiments](chaos-workflow.md) - [Chaos Experiments](chaos-workflow.md)

2
website/versioned_docs/version-3.1.0/integrations/grafana.md
View File

@ -10,7 +10,7 @@ Chaos Engineering is the discipline of experimenting on a system to build confid
## Before you begin ## Before you begin
The following should be required before integrating Grafana with litmus 2.0: The following are required before integrating Grafana with litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/) - [Prometheus TSDB](https://prometheus.io/)
- [Prometheus Integration](prometheus.md) - [Prometheus Integration](prometheus.md)

2
website/versioned_docs/version-3.1.0/integrations/prometheus.md
View File

@ -10,7 +10,7 @@ LitmusChaos facilitates real-time monitoring for events and metrics using it’s
## Before you begin ## Before you begin
The following should be required before integrating Prometheus in litmus 2.0: The following are required before integrating Prometheus in litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/) - [Prometheus TSDB](https://prometheus.io/)
- [Probes](../concepts/probes.md) - [Probes](../concepts/probes.md)

2
website/versioned_docs/version-3.1.0/user-guides/observe-experiment.md
View File

@ -11,7 +11,7 @@ With ChaosCenter, the real-time data and status of the chaos experiments can be
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- ChaosCenter - ChaosCenter
- [Chaos Experiments](../concepts/chaos-workflow.md) - [Chaos Experiments](../concepts/chaos-workflow.md)

2
website/versioned_docs/version-3.2.0/concepts/chaos-workflow.md
View File

@ -19,7 +19,7 @@ With the latest release of LitmusChaos 3.0.0:
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- [ChaosCenter](../getting-started/resources.md#chaoscenter) - [ChaosCenter](../getting-started/resources.md#chaoscenter)
- [Chaos Infrastructure](../getting-started/resources.md#chaosagents) - [Chaos Infrastructure](../getting-started/resources.md#chaosagents)

2
website/versioned_docs/version-3.2.0/concepts/visualize-experiment.md
View File

@ -11,7 +11,7 @@ With ChaosCenter, the real-time data and status of the chaos experiments can be
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- ChaosCenter - ChaosCenter
- [Chaos Experiments](chaos-workflow.md) - [Chaos Experiments](chaos-workflow.md)

2
website/versioned_docs/version-3.2.0/integrations/grafana.md
View File

@ -10,7 +10,7 @@ Chaos Engineering is the discipline of experimenting on a system to build confid
## Before you begin ## Before you begin
The following should be required before integrating Grafana with litmus 2.0: The following are required before integrating Grafana with litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/) - [Prometheus TSDB](https://prometheus.io/)
- [Prometheus Integration](prometheus.md) - [Prometheus Integration](prometheus.md)

2
website/versioned_docs/version-3.2.0/integrations/prometheus.md
View File

@ -10,7 +10,7 @@ LitmusChaos facilitates real-time monitoring for events and metrics using it’s
## Before you begin ## Before you begin
The following should be required before integrating Prometheus in litmus 2.0: The following are required before integrating Prometheus in litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/) - [Prometheus TSDB](https://prometheus.io/)
- [Probes](../concepts/probes.md) - [Probes](../concepts/probes.md)

2
website/versioned_docs/version-3.2.0/user-guides/observe-experiment.md
View File

@ -11,7 +11,7 @@ With ChaosCenter, the real-time data and status of the chaos experiments can be
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- ChaosCenter - ChaosCenter
- [Chaos Experiments](../concepts/chaos-workflow.md) - [Chaos Experiments](../concepts/chaos-workflow.md)

2
website/versioned_docs/version-3.3.0/concepts/chaos-workflow.md
View File

@ -19,7 +19,7 @@ With the latest release of LitmusChaos 3.0.0:
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- [ChaosCenter](../getting-started/resources.md#chaoscenter) - [ChaosCenter](../getting-started/resources.md#chaoscenter)
- [Chaos Infrastructure](../getting-started/resources.md#chaosagents) - [Chaos Infrastructure](../getting-started/resources.md#chaosagents)

2
website/versioned_docs/version-3.3.0/concepts/visualize-experiment.md
View File

@ -11,7 +11,7 @@ With ChaosCenter, the real-time data and status of the chaos experiments can be
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- ChaosCenter - ChaosCenter
- [Chaos Experiments](chaos-workflow.md) - [Chaos Experiments](chaos-workflow.md)

2
website/versioned_docs/version-3.3.0/integrations/grafana.md
View File

@ -10,7 +10,7 @@ Chaos Engineering is the discipline of experimenting on a system to build confid
## Before you begin ## Before you begin
The following should be required before integrating Grafana with litmus 2.0: The following are required before integrating Grafana with litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/) - [Prometheus TSDB](https://prometheus.io/)
- [Prometheus Integration](prometheus.md) - [Prometheus Integration](prometheus.md)

2
website/versioned_docs/version-3.3.0/integrations/prometheus.md
View File

@ -10,7 +10,7 @@ LitmusChaos facilitates real-time monitoring for events and metrics using it’s
## Before you begin ## Before you begin
The following should be required before integrating Prometheus in litmus 2.0: The following are required before integrating Prometheus in litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/) - [Prometheus TSDB](https://prometheus.io/)
- [Probes](../concepts/probes.md) - [Probes](../concepts/probes.md)

2
website/versioned_docs/version-3.3.0/user-guides/observe-experiment.md
View File

@ -11,7 +11,7 @@ With ChaosCenter, the real-time data and status of the chaos experiments can be
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- ChaosCenter - ChaosCenter
- [Chaos Experiments](../concepts/chaos-workflow.md) - [Chaos Experiments](../concepts/chaos-workflow.md)

2
website/versioned_docs/version-3.4.0/concepts/chaos-workflow.md
View File

@ -19,7 +19,7 @@ With the latest release of LitmusChaos 3.0.0:
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- [ChaosCenter](../getting-started/resources.md#chaoscenter) - [ChaosCenter](../getting-started/resources.md#chaoscenter)
- [Chaos Infrastructure](../getting-started/resources.md#chaosagents) - [Chaos Infrastructure](../getting-started/resources.md#chaosagents)

2
website/versioned_docs/version-3.4.0/concepts/visualize-experiment.md
View File

@ -11,7 +11,7 @@ With ChaosCenter, the real-time data and status of the chaos experiments can be
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- ChaosCenter - ChaosCenter
- [Chaos Experiments](chaos-workflow.md) - [Chaos Experiments](chaos-workflow.md)

2
website/versioned_docs/version-3.4.0/integrations/grafana.md
View File

@ -10,7 +10,7 @@ Chaos Engineering is the discipline of experimenting on a system to build confid
## Before you begin ## Before you begin
The following should be required before integrating Grafana with litmus 2.0: The following are required before integrating Grafana with litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/) - [Prometheus TSDB](https://prometheus.io/)
- [Prometheus Integration](prometheus.md) - [Prometheus Integration](prometheus.md)

2
website/versioned_docs/version-3.4.0/integrations/prometheus.md
View File

@ -10,7 +10,7 @@ LitmusChaos facilitates real-time monitoring for events and metrics using it’s
## Before you begin ## Before you begin
The following should be required before integrating Prometheus in litmus 2.0: The following are required before integrating Prometheus in litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/) - [Prometheus TSDB](https://prometheus.io/)
- [Probes](../concepts/probes.md) - [Probes](../concepts/probes.md)

2
website/versioned_docs/version-3.4.0/user-guides/observe-experiment.md
View File

@ -11,7 +11,7 @@ With ChaosCenter, the real-time data and status of the chaos experiments can be
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- ChaosCenter - ChaosCenter
- [Chaos Experiments](../concepts/chaos-workflow.md) - [Chaos Experiments](../concepts/chaos-workflow.md)

2
website/versioned_docs/version-3.5.0/concepts/chaos-workflow.md
View File

@ -19,7 +19,7 @@ With the latest release of LitmusChaos 3.0.0:
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- [ChaosCenter](../getting-started/resources.md#chaoscenter) - [ChaosCenter](../getting-started/resources.md#chaoscenter)
- [Chaos Infrastructure](../getting-started/resources.md#chaosagents) - [Chaos Infrastructure](../getting-started/resources.md#chaosagents)

2
website/versioned_docs/version-3.5.0/concepts/visualize-experiment.md
View File

@ -11,7 +11,7 @@ With ChaosCenter, the real-time data and status of the chaos experiments can be
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- ChaosCenter - ChaosCenter
- [Chaos Experiments](chaos-workflow.md) - [Chaos Experiments](chaos-workflow.md)

2
website/versioned_docs/version-3.5.0/integrations/grafana.md
View File

@ -10,7 +10,7 @@ Chaos Engineering is the discipline of experimenting on a system to build confid
## Before you begin ## Before you begin
The following should be required before integrating Grafana with litmus 2.0: The following are required before integrating Grafana with litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/) - [Prometheus TSDB](https://prometheus.io/)
- [Prometheus Integration](prometheus.md) - [Prometheus Integration](prometheus.md)

2
website/versioned_docs/version-3.5.0/integrations/prometheus.md
View File

@ -10,7 +10,7 @@ LitmusChaos facilitates real-time monitoring for events and metrics using it’s
## Before you begin ## Before you begin
The following should be required before integrating Prometheus in litmus 2.0: The following are required before integrating Prometheus in litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/) - [Prometheus TSDB](https://prometheus.io/)
- [Probes](../concepts/probes.md) - [Probes](../concepts/probes.md)

2
website/versioned_docs/version-3.5.0/user-guides/observe-experiment.md
View File

@ -11,7 +11,7 @@ With ChaosCenter, the real-time data and status of the chaos experiments can be
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- ChaosCenter - ChaosCenter
- [Chaos Experiments](../concepts/chaos-workflow.md) - [Chaos Experiments](../concepts/chaos-workflow.md)

2
website/versioned_docs/version-3.6.0/concepts/chaos-workflow.md
View File

@ -19,7 +19,7 @@ With the latest release of LitmusChaos 3.0.0:
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- [ChaosCenter](../getting-started/resources.md#chaoscenter) - [ChaosCenter](../getting-started/resources.md#chaoscenter)
- [Chaos Infrastructure](../getting-started/resources.md#chaosagents) - [Chaos Infrastructure](../getting-started/resources.md#chaosagents)

2
website/versioned_docs/version-3.6.0/concepts/visualize-experiment.md
View File

@ -11,7 +11,7 @@ With ChaosCenter, the real-time data and status of the chaos experiments can be
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- ChaosCenter - ChaosCenter
- [Chaos Experiments](chaos-workflow.md) - [Chaos Experiments](chaos-workflow.md)

2
website/versioned_docs/version-3.6.0/integrations/grafana.md
View File

@ -10,7 +10,7 @@ Chaos Engineering is the discipline of experimenting on a system to build confid
## Before you begin ## Before you begin
The following should be required before integrating Grafana with litmus 2.0: The following are required before integrating Grafana with litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/) - [Prometheus TSDB](https://prometheus.io/)
- [Prometheus Integration](prometheus.md) - [Prometheus Integration](prometheus.md)

2
website/versioned_docs/version-3.6.0/integrations/prometheus.md
View File

@ -10,7 +10,7 @@ LitmusChaos facilitates real-time monitoring for events and metrics using it’s
## Before you begin ## Before you begin
The following should be required before integrating Prometheus in litmus 2.0: The following are required before integrating Prometheus in litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/) - [Prometheus TSDB](https://prometheus.io/)
- [Probes](../concepts/probes.md) - [Probes](../concepts/probes.md)

2
website/versioned_docs/version-3.6.0/user-guides/observe-experiment.md
View File

@ -11,7 +11,7 @@ With ChaosCenter, the real-time data and status of the chaos experiments can be
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- ChaosCenter - ChaosCenter
- [Chaos Experiments](../concepts/chaos-workflow.md) - [Chaos Experiments](../concepts/chaos-workflow.md)

2
website/versioned_docs/version-3.7.0/concepts/chaos-workflow.md
View File

@ -19,7 +19,7 @@ With the latest release of LitmusChaos 3.0.0:
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- [ChaosCenter](../getting-started/resources.md#chaoscenter) - [ChaosCenter](../getting-started/resources.md#chaoscenter)
- [Chaos Infrastructure](../getting-started/resources.md#chaosagents) - [Chaos Infrastructure](../getting-started/resources.md#chaosagents)

2
website/versioned_docs/version-3.7.0/concepts/visualize-experiment.md
View File

@ -11,7 +11,7 @@ With ChaosCenter, the real-time data and status of the chaos experiments can be
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- ChaosCenter - ChaosCenter
- [Chaos Experiments](chaos-workflow.md) - [Chaos Experiments](chaos-workflow.md)

2
website/versioned_docs/version-3.7.0/integrations/grafana.md
View File

@ -10,7 +10,7 @@ Chaos Engineering is the discipline of experimenting on a system to build confid
## Before you begin ## Before you begin
The following should be required before integrating Grafana with litmus 2.0: The following are required before integrating Grafana with litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/) - [Prometheus TSDB](https://prometheus.io/)
- [Prometheus Integration](prometheus.md) - [Prometheus Integration](prometheus.md)

2
website/versioned_docs/version-3.7.0/integrations/prometheus.md
View File

@ -10,7 +10,7 @@ LitmusChaos facilitates real-time monitoring for events and metrics using it’s
## Before you begin ## Before you begin
The following should be required before integrating Prometheus in litmus 2.0: The following are required before integrating Prometheus in litmus 2.0:
- [Prometheus TSDB](https://prometheus.io/) - [Prometheus TSDB](https://prometheus.io/)
- [Probes](../concepts/probes.md) - [Probes](../concepts/probes.md)

2
website/versioned_docs/version-3.7.0/user-guides/observe-experiment.md
View File

@ -11,7 +11,7 @@ With ChaosCenter, the real-time data and status of the chaos experiments can be
## Prerequisites ## Prerequisites
The following should be required before creating a Chaos Experiment: The following are required before creating a Chaos Experiment:
- ChaosCenter - ChaosCenter
- [Chaos Experiments](../concepts/chaos-workflow.md) - [Chaos Experiments](../concepts/chaos-workflow.md)

67
website/versioned_docs/version-3.8.0/user-guides/chaoscenter-cluster-scope-installation.md
View File

@ -1,7 +1,7 @@
--- ---
id: chaoscenter-cluster-scope-installation id: chaoscenter-cluster-scope-installation
title: ChaosCenter Cluster Scope Installation title: ChaosCenter cluster scope installation
sidebar_label: Cluster Scope sidebar_label: Cluster scope
--- ---
--- ---
@ -15,40 +15,40 @@ Before deploying LitmusChaos, make sure the following items are there
- A Persistent volume of 20GB - A Persistent volume of 20GB
:::note :::note
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 Although it is recommended 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 ChaosCenter. By default, Litmus would use the default storage class to allocate the PV.
::: :::
- [Helm3](https://v3.helm.sh/) or [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) - [Helm3](https://v3.helm.sh/) or [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
## Installation ## Installation
Installation of Litmus can be done using either of the below methods Installation of Litmus can be done using either of the below methods:
- [Helm3](#install-litmus-using-helm) chart - [Helm3](#install-litmus-using-helm) chart
- [Kubectl](#install-litmus-using-kubectl) yaml spec file - [Kubectl](#install-litmus-using-kubectl) yaml spec file
### Install Litmus using Helm ### Helm installation
The helm chart will install all the required service account configuration and ChaosCenter. The Helm chart will be install all the required service account configuration and ChaosCenter.
The following steps will help you install Litmus ChaosCenter via helm. The following steps will help you install Litmus ChaosCenter via Helm:
#### Step-1: Add the litmus helm repository #### Step-1: Add Helm repository
```bash ```bash
helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/ helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/
helm repo list helm repo list
``` ```
#### Step-2: Create the namespace on which you want to install Litmus ChaosCenter #### Step-2: Create deployment namespace
- The chaoscenter components can be placed in any namespace, though it is typically placed in "litmus". ChaosCenter components can be deployed in any namespace, though it is deployed in `litmus` namespace by default.
```bash ```bash
kubectl create ns litmus kubectl create ns litmus
``` ```
#### Step-3: Install Litmus ChaosCenter #### Step-3: Install ChaosCenter
```bash ```bash
helm install chaos litmuschaos/litmus --namespace=litmus helm install chaos litmuschaos/litmus --namespace=litmus
@ -71,11 +71,13 @@ Your release is named chaos and its installed to namespace: litmus.
Visit https://docs.litmuschaos.io to find more info. Visit https://docs.litmuschaos.io 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. :::info
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.
:::
### **Install Litmus using kubectl** ### Kubectl installation
#### **Install Litmus ChaosCenter** #### Install Litmus from ChaosCenter
Applying the manifest file will install all the required service account configuration and ChaosCenter. Applying the manifest file will install all the required service account configuration and ChaosCenter.
@ -85,11 +87,11 @@ kubectl apply -f https://litmuschaos.github.io/litmus/3.8.0/litmus-cluster-scope
> If you are installing Litmus in any other namespace apart from `litmus` namespace, make sure to change the same in the manifest too `https://litmuschaos.github.io/litmus/3.8.0/litmus-namespaced-3.8.0.yaml`. > If you are installing Litmus in any other namespace apart from `litmus` namespace, make sure to change the same in the manifest too `https://litmuschaos.github.io/litmus/3.8.0/litmus-namespaced-3.8.0.yaml`.
## **Verify your installation** ## Verify installation
#### **Verify if the frontend, server, and database pods are running** ### Verify frontend, auth server, backend server, and database pods
- Check the pods in the namespace where you installed Litmus: - Check the pods in the namespace where Litmus is installed:
```bash ```bash
kubectl get pods -n litmus kubectl get pods -n litmus
@ -105,7 +107,7 @@ kubectl apply -f https://litmuschaos.github.io/litmus/3.8.0/litmus-cluster-scope
litmusportal-frontend-55974fcf59-cxxrf 1/1 Running 0 58s litmusportal-frontend-55974fcf59-cxxrf 1/1 Running 0 58s
``` ```
- Check the services running in the namespace where you installed Litmus: - Check the services running in the namespace where Litmus is installed:
```bash ```bash
kubectl get svc -n litmus kubectl get svc -n litmus
@ -122,32 +124,9 @@ kubectl apply -f https://litmuschaos.github.io/litmus/3.8.0/litmus-cluster-scope
mongo-headless-service ClusterIP None <none> 27017/TCP 101s mongo-headless-service ClusterIP None <none> 27017/TCP 101s
``` ```
--- ## Resource requirements of control-plane components
#### **Verify Successful Registration of the Self Chaos Delegate post [Account Configuration](setup-without-ingress)** The resource requests provided here are estimated using the data gathered manually through different methods:
Once the project is created, the cluster is automatically registered as a chaos target via installation of [Chaos Delegate](../getting-started/resources.md#chaosagents). This is represented as [Self Chaos Delegate](../getting-started/resources.md#types-of-chaosagents) in [ChaosCenter](../getting-started/resources.md#chaoscenter).
```bash
kubectl get pods -n litmus
```
```bash
NAME READY STATUS RESTARTS AGE
chaos-exporter-547b59d887-4dm58 1/1 Running 0 5m27s
chaos-operator-ce-84ddc8f5d7-l8c6d 1/1 Running 0 5m27s
event-tracker-5bc478cbd7-xlflb 1/1 Running 0 5m28s
litmusportal-frontend-97c8bf86b-mx89w 1/1 Running 0 15m
litmusportal-server-6fd57cc89-6w5pn 1/1 Running 0 15m
litmusportal-auth-server-7b596fff9-5s6g5 1/1 Running 0 15m
mongo-0 1/1 Running 0 15m
subscriber-958948965-qbx29 1/1 Running 0 5m30s
workflow-controller-78fc7b6c6-w82m7 1/1 Running 0 5m32s
```
## Resource Requirements of Control-plane components
The Resource requests provided here have been estimated using data gathered manually through different methods -
- Using command `kubectl top` - Using command `kubectl top`
- Recommendations from Vertical-Pod-Autoscaler - Recommendations from Vertical-Pod-Autoscaler
@ -156,7 +135,7 @@ The Resource requests provided here have been estimated using data gathered manu
These resources are getting monitored continuously and the information below will be updated as the metrics changes. These resources are getting monitored continuously and the information below will be updated as the metrics changes.
:::note :::note
**The metrics given below shows resources consumed when ChaosCenter is used at medium scale.The resources may need to be increased when used at higher scale.** The metrics given below shows resources consumed when ChaosCenter is used at medium scale. The resources may need to be increased when used at higher scale.
::: :::
<table> <table>

83
website/versioned_docs/version-3.8.0/user-guides/chaoscenter-namespace-scope-installation.md
View File

@ -1,7 +1,7 @@
--- ---
id: chaoscenter-namespace-scope-installation id: chaoscenter-namespace-scope-installation
title: ChaosCenter Namespace Scope Installation title: ChaosCenter namespace scope installation
sidebar_label: Namespace Scope sidebar_label: Namespace scope
--- ---
--- ---
@ -15,7 +15,7 @@ Before deploying LitmusChaos, make sure the following items are there
- A Persistent volume of 20GB - A Persistent volume of 20GB
:::note :::note
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 Although it is recommended 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 ChaosCenter. By default, Litmus would use the default storage class to allocate the PV.
::: :::
- [Helm3](https://v3.helm.sh/) or [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) - [Helm3](https://v3.helm.sh/) or [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
@ -27,30 +27,32 @@ Installation of Litmus can be done using either of the below methods
- [Helm3](#install-litmus-using-helm) chart - [Helm3](#install-litmus-using-helm) chart
- [Kubectl](#install-litmus-using-kubectl) yaml spec file - [Kubectl](#install-litmus-using-kubectl) yaml spec file
### **Install Litmus using Helm** ### Helm installation
The helm chart will install all the required service account configuration and ChaosCenter. The Helm chart will install all the required service account configuration and ChaosCenter.
The following steps will help you install Litmus ChaosCenter via helm. The following steps will help you install Litmus ChaosCenter via Helm.
#### Step-1: Add the litmus helm repository #### Step-1: Add Helm repository
```bash ```bash
helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/ helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/
helm repo list helm repo list
``` ```
#### Step-2: Create the namespace on which you want to install Litmus ChaosCenter <span style={{color: '#909191'}}><b>[Required only if namespace isn't there]</b></span> #### Step-2: Create deployment namespace
- The chaoscenter components can be placed in any namespace, though it is typically placed in "litmus". :::note
Skip to the next step if the namespace already exists.
:::
The ChaosCenter components can be deployed in any namespace, though by default it is deployed to the `litmus` namespace.
```bash ```bash
kubectl create ns litmus kubectl create ns litmus
``` ```
> The ChaosCenter can be placed in any namespace, though it is typically placed in `litmus`. Ignore if you already have the namespace where you want to install Litmus created. #### Step-3: Install CRDs
#### Step-3: Install the required Litmus CRDs
The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront.
@ -71,7 +73,7 @@ customresourcedefinition.apiextensions.k8s.io/chaosresults.litmuschaos.io create
customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker.litmuschaos.io created customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker.litmuschaos.io created
``` ```
#### Step-4: Install Litmus ChaosCenter #### Step-4: Install ChaosCenter
```bash ```bash
helm install chaos litmuschaos/litmus --namespace=litmus --set portalScope=namespace helm install chaos litmuschaos/litmus --namespace=litmus --set portalScope=namespace
@ -95,18 +97,24 @@ Visit https://docs.litmuschaos.io/ 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. :::info
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.
:::
### **Install Litmus using kubectl** ### Kubectl installation
#### **Set the namespace on which you want to install Litmus ChaosCenter** #### Create deployment namespace
> Create a namespace `kubectl create ns <Your Namespace>` 1. Create a namespace, say `litmus`:
```bash ```bash
kubectl create ns litmus kubectl create ns litmus
``` ```
2. To verify if the namespace is created, run the following command:
```bash
kubectl get ns
```
<span style={{color: 'green'}}><b>Expected Output</b></span> <span style={{color: 'green'}}><b>Expected Output</b></span>
```bash ```bash
@ -114,7 +122,7 @@ NAME STATUS AGE
litmus Active 2s litmus Active 2s
``` ```
#### **Install the required Litmus CRDs** #### Install CRDs
The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront. The cluster-admin or an equivalent user with the right permissions are required to install the CRDs upfront.
@ -136,7 +144,7 @@ customresourcedefinition.apiextensions.k8s.io/chaosresults.litmuschaos.io create
customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker.litmuschaos.io created customresourcedefinition.apiextensions.k8s.io/eventtrackerpolicies.eventtracker.litmuschaos.io created
``` ```
#### **Install Litmus ChaosCenter** #### Install Litmus from ChaosCenter
Applying the manifest file will install all the required service account configuration and ChaosCenter. Applying the manifest file will install all the required service account configuration and ChaosCenter.
@ -144,7 +152,9 @@ Applying the manifest file will install all the required service account configu
kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.8.0/litmus-namespaced-3.8.0.yaml -n <Your Namespace> kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.8.0/litmus-namespaced-3.8.0.yaml -n <Your Namespace>
``` ```
> You need to provide the Namespace in place of `Your Namespace`, that you have created eariler for the litmuschaos Installation :::note
You need to provide the Namespace in place of `<Your Namespace>`, that you have created earlier for the LitmusChaos installation.
:::
<span style={{color: 'green'}}><b>Expected Output</b></span> <span style={{color: 'green'}}><b>Expected Output</b></span>
@ -178,11 +188,9 @@ service/mongo-service created
service/mongo-headless-service created service/mongo-headless-service created
``` ```
## **Verify your installation** ## Verify installation
--- ### Verify frontend, auth server, backend server, and database pods
#### **Verify if the frontend, server, and database pods are running**
- Check the pods in the namespace where you installed Litmus: - Check the pods in the namespace where you installed Litmus:
@ -217,7 +225,9 @@ service/mongo-headless-service created
mongo-headless-service ClusterIP None <none> 27017/TCP 101s mongo-headless-service ClusterIP None <none> 27017/TCP 101s
``` ```
> Note: With the namespace mode of the control panel, we need to set the endpoint of the chaos center ui according to the use case for external Chaos Delegates. By default, it is `http://litmusportal-frontend-service:9091` :::info
With the namespace mode of the control panel, we need to set the endpoint of the chaos center ui according to the use case for external Chaos Delegates. By default, it is `http://litmusportal-frontend-service:9091`
:::
To alter, Apply: To alter, Apply:
@ -225,29 +235,6 @@ To alter, Apply:
kubectl set env deployment/litmusportal-server -n litmus --containers="graphql-server" CHAOS_CENTER_UI_ENDPOINT="http://172.132.44.44:3231" kubectl set env deployment/litmusportal-server -n litmus --containers="graphql-server" CHAOS_CENTER_UI_ENDPOINT="http://172.132.44.44:3231"
``` ```
---
#### **Verify Successful Registration of the Self Chaos Delegate post [Account Configuration](setup-without-ingress)**
Once the project is created, the cluster is automatically registered as a chaos target via installation of [Chaos Delegate](../getting-started/resources.md#chaosagents). This is represented as [Self Chaos Delegate](../getting-started/resources.md#types-of-chaosagents) in [ChaosCenter](../getting-started/resources.md#chaosagents).
```bash
kubectl get pods -n litmus
```
```bash
NAME READY STATUS RESTARTS AGE
chaos-exporter-547b59d887-4dm58 1/1 Running 0 5m27s
chaos-operator-ce-84ddc8f5d7-l8c6d 1/1 Running 0 5m27s
event-tracker-5bc478cbd7-xlflb 1/1 Running 0 5m28s
litmusportal-frontend-97c8bf86b-mx89w 1/1 Running 0 15m
litmusportal-server-6fd57cc89-6w5pn 1/1 Running 0 15m
litmusportal-auth-server-7b596fff9-5s6g5 1/1 Running 0 15m
mongo-0 1/1 Running 0 15m
subscriber-958948965-qbx29 1/1 Running 0 5m30s
workflow-controller-78fc7b6c6-w82m7 1/1 Running 0 5m32s
```
## Resources ## Resources
<iframe width="560" height="315" src="https://www.youtube.com/embed/rOrKegj5ePI" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe> <iframe width="560" height="315" src="https://www.youtube.com/embed/rOrKegj5ePI" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>