Skip to content

Commit

Permalink
chore: Refactors user guide pages
Browse files Browse the repository at this point in the history
Signed-off-by: neelanjan00 <neelanjan.manna@harness.io>
  • Loading branch information
neelanjan00 committed Jun 13, 2024
1 parent bb07640 commit df368c0
Show file tree
Hide file tree
Showing 80 changed files with 387 additions and 398 deletions.
2 changes: 1 addition & 1 deletion website/docs/architecture/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A very high level overview of the entire Litmus architecture with the objective

### [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)

Expand Down
2 changes: 1 addition & 1 deletion website/docs/concepts/chaos-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ With the latest release of LitmusChaos 3.0.0:

## 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)
- [Chaos Infrastructure](../getting-started/resources.md#chaosagents)
Expand Down
2 changes: 1 addition & 1 deletion website/docs/concepts/visualize-experiment.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ With ChaosCenter, the real-time data and status of the chaos experiments can be

## Prerequisites

The following should be required before creating a Chaos Experiment:
The following are required before creating a Chaos Experiment:

- ChaosCenter
- [Chaos Experiments](chaos-workflow.md)
Expand Down
2 changes: 1 addition & 1 deletion website/docs/integrations/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Chaos Engineering is the discipline of experimenting on a system to build confid

## 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 Integration](prometheus.md)
Expand Down
2 changes: 1 addition & 1 deletion website/docs/integrations/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ LitmusChaos facilitates real-time monitoring for events and metrics using it’s

## 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/)
- [Probes](../concepts/probes.md)
Expand Down
2 changes: 1 addition & 1 deletion website/docs/user-guides/accept-invite.md
Original file line number Diff line number Diff line change
Expand Up @@ -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} />

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} />
20 changes: 11 additions & 9 deletions website/docs/user-guides/account-settings.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,46 @@
---
id: account-settings
title: Account Settings
sidebar_label: Account Settings
title: Account settings
sidebar_label: Account settings
---

---

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>
<img src={require('../assets/user-guides/my-account/step-1.png').default} alt="avatar nav" />
</figure>

## Edit Personal Details
## Edit personal details

Click the edit icon to open the edit modal:

<figure>
<img src={require('../assets/user-guides/my-account/step-2.png').default} alt="edit icon" />
</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>
<img src={require('../assets/user-guides/my-account/step-3.png').default} alt="edit information" />
</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>
<img src={require('../assets/user-guides/my-account/step-4.png').default} alt="edit information" />
</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>
<img src={require('../assets/user-guides/my-account/step-5.png').default} alt="edit information" />
Expand Down
2 changes: 1 addition & 1 deletion website/docs/user-guides/analyze-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@ On clicking on a bar, more details about the chaos scenario run represented by t

## Learn more

- [Compare Chaos Scenarios](comparative-analysis.md)
- [Compare Chaos Experiments](comparative-analysis.md)
- [Manage Application Dashboard](manage-app-dashboard.md)
- [Configure Datasource](configure-datasource.md)
14 changes: 7 additions & 7 deletions website/docs/user-guides/change-project-name.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
id: change-project-name
title: Changing Project Name
sidebar_label: Change Project Name
title: Changing 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

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

### 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" />

Expand All @@ -28,7 +28,7 @@ Click options icon to open the options menu and click on the edit option (demons

### 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} />

Expand Down
133 changes: 57 additions & 76 deletions website/docs/user-guides/chaoscenter-cluster-scope-installation.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: chaoscenter-cluster-scope-installation
title: ChaosCenter Cluster Scope Installation
sidebar_label: Cluster Scope
title: ChaosCenter cluster scope installation
sidebar_label: Cluster scope
---

---
Expand All @@ -15,40 +15,40 @@ Before deploying LitmusChaos, make sure the following items are there
- A Persistent volume of 20GB

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

## 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
- [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
helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/
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
kubectl create ns litmus
```

#### Step-3: Install Litmus ChaosCenter
#### Step-3: Install ChaosCenter

```bash
helm install chaos litmuschaos/litmus --namespace=litmus
Expand All @@ -71,25 +71,29 @@ Your release is named chaos and its installed to namespace: litmus.
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.

```bash
kubectl apply -f https://litmuschaos.github.io/litmus/3.7.0/litmus-cluster-scope-3.7.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.7.0/litmus-namespaced-3.7.0.yaml`.
:::info
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.7.0/litmus-namespaced-3.7.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
kubectl get pods -n litmus
Expand All @@ -98,14 +102,14 @@ kubectl apply -f https://litmuschaos.github.io/litmus/3.7.0/litmus-cluster-scope
<span style={{color: 'green'}}><b>Expected Output</b></span>

```bash
NAME READY STATUS RESTARTS AGE
NAME READY STATUS RESTARTS AGE
litmusportal-server-6fd57cc89-6w5pn 1/1 Running 0 57s
litmusportal-auth-server-7b596fff9-5s6g5 1/1 Running 0 57s
mongo-0 1/1 Running 0 57s
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
kubectl get svc -n litmus
Expand All @@ -122,32 +126,9 @@ kubectl apply -f https://litmuschaos.github.io/litmus/3.7.0/litmus-cluster-scope
mongo-headless-service ClusterIP None <none> 27017/TCP 101s
```

---

#### **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#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
## Resource requirements of control-plane components

The Resource requests provided here have been estimated using data gathered manually through different methods -
The resource requests provided here are estimated using the data gathered manually through different methods:

- Using command `kubectl top`
- Recommendations from Vertical-Pod-Autoscaler
Expand All @@ -156,40 +137,40 @@ 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.

:::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>
<tr>
<th>Pod</th>
<th>Container</th>
<th>CPU</th>
<th>Memory</th>
</tr>
<tr>
<td>litmusportal-frontend</td>
<td>litmusportal-frontend</td>
<td>25m</td>
<td>300M</td>
</tr>
<tr>
<td>litmusportal-server</td>
<td>auth-server</td>
<td>25m</td>
<td>150M</td>
</tr>
<tr>
<td>litmusportal-server</td>
<td>graphql-server</td>
<td>25m</td>
<td>350M</td>
</tr>
<tr>
<td>mongodb</td>
<td>mongodb</td>
<td>25m</td>
<td>350M</td>
</tr>
<tr>
<th>Pod</th>
<th>Container</th>
<th>CPU</th>
<th>Memory</th>
</tr>
<tr>
<td>litmusportal-frontend</td>
<td>litmusportal-frontend</td>
<td>25m</td>
<td>300M</td>
</tr>
<tr>
<td>litmusportal-server</td>
<td>auth-server</td>
<td>25m</td>
<td>150M</td>
</tr>
<tr>
<td>litmusportal-server</td>
<td>graphql-server</td>
<td>25m</td>
<td>350M</td>
</tr>
<tr>
<td>mongodb</td>
<td>mongodb</td>
<td>25m</td>
<td>350M</td>
</tr>
</table>

## Resources
Expand Down
Loading

0 comments on commit df368c0

Please sign in to comment.