From d25b7fcd6239804b0daf78f092fcc35050ac3650 Mon Sep 17 00:00:00 2001 From: Neelanjan Manna Date: Thu, 19 Sep 2024 21:26:31 +0530 Subject: [PATCH] chore: Refactors user guide pages (#270) Signed-off-by: neelanjan00 --- website/docs/architecture/overview.md | 2 +- website/docs/concepts/chaos-workflow.md | 2 +- website/docs/integrations/grafana.md | 2 +- website/docs/integrations/prometheus.md | 2 +- website/docs/user-guides/accept-invite.md | 2 +- website/docs/user-guides/account-settings.md | 20 +-- website/docs/user-guides/analyze-workflow.md | 2 +- .../docs/user-guides/change-project-name.md | 14 +- .../chaoscenter-oauth-dex-installation.md | 44 +++--- .../docs/user-guides/construct-experiment.md | 30 ++-- .../docs/user-guides/create-environment.md | 4 +- .../docs/user-guides/create-infrastructure.md | 23 ++-- .../user-guides/create-resilience-probe.md | 8 +- website/docs/user-guides/create-user.md | 14 +- website/docs/user-guides/deactivate-user.md | 10 +- .../docs/user-guides/delete-environment.md | 4 +- website/docs/user-guides/delete-experiment.md | 12 +- .../docs/user-guides/delete-infrastructure.md | 4 +- .../user-guides/delete-resilience-probe.md | 6 +- .../download-experiment-manifest.md | 12 +- website/docs/user-guides/edit-environment.md | 4 +- website/docs/user-guides/edit-invite.md | 2 +- website/docs/user-guides/edit-schedule.md | 16 +-- .../docs/user-guides/gitops-configuration.md | 26 ++-- website/docs/user-guides/image-registry.md | 33 ++--- .../docs/user-guides/invite-team-member.md | 10 +- website/docs/user-guides/leave-project.md | 14 +- .../docs/user-guides/observe-experiment.md | 16 ++- website/docs/user-guides/re-run-experiment.md | 6 +- .../docs/user-guides/remove-team-member.md | 12 +- website/docs/user-guides/reset-password.md | 10 +- .../docs/user-guides/schedule-experiment.md | 8 +- .../docs/user-guides/setup-with-ingress.md | 25 ++-- .../docs/user-guides/setup-without-ingress.md | 28 ++-- website/docs/user-guides/uninstall-litmus.md | 14 +- .../docs/user-guides/view-probe-details.md | 8 +- website/docs/user-guides/view-user.md | 4 +- .../version-3.0.0/concepts/chaos-workflow.md | 2 +- .../version-3.0.0/integrations/grafana.md | 2 +- .../version-3.0.0/integrations/prometheus.md | 2 +- .../user-guides/observe-experiment.md | 2 +- .../version-3.1.0/concepts/chaos-workflow.md | 2 +- .../concepts/visualize-experiment.md | 2 +- .../version-3.1.0/integrations/grafana.md | 2 +- .../version-3.1.0/integrations/prometheus.md | 2 +- .../user-guides/observe-experiment.md | 2 +- .../version-3.2.0/concepts/chaos-workflow.md | 2 +- .../concepts/visualize-experiment.md | 2 +- .../version-3.2.0/integrations/grafana.md | 2 +- .../version-3.2.0/integrations/prometheus.md | 2 +- .../user-guides/observe-experiment.md | 2 +- .../version-3.3.0/concepts/chaos-workflow.md | 2 +- .../concepts/visualize-experiment.md | 2 +- .../version-3.3.0/integrations/grafana.md | 2 +- .../version-3.3.0/integrations/prometheus.md | 2 +- .../user-guides/observe-experiment.md | 2 +- .../version-3.4.0/concepts/chaos-workflow.md | 2 +- .../concepts/visualize-experiment.md | 2 +- .../version-3.4.0/integrations/grafana.md | 2 +- .../version-3.4.0/integrations/prometheus.md | 2 +- .../user-guides/observe-experiment.md | 2 +- .../version-3.5.0/concepts/chaos-workflow.md | 2 +- .../concepts/visualize-experiment.md | 2 +- .../version-3.5.0/integrations/grafana.md | 2 +- .../version-3.5.0/integrations/prometheus.md | 2 +- .../user-guides/observe-experiment.md | 2 +- .../version-3.6.0/concepts/chaos-workflow.md | 2 +- .../concepts/visualize-experiment.md | 2 +- .../version-3.6.0/integrations/grafana.md | 2 +- .../version-3.6.0/integrations/prometheus.md | 2 +- .../user-guides/observe-experiment.md | 2 +- .../version-3.7.0/concepts/chaos-workflow.md | 2 +- .../concepts/visualize-experiment.md | 2 +- .../version-3.7.0/integrations/grafana.md | 2 +- .../version-3.7.0/integrations/prometheus.md | 2 +- .../user-guides/observe-experiment.md | 2 +- .../chaoscenter-cluster-scope-installation.md | 129 ++++++++---------- ...haoscenter-namespace-scope-installation.md | 83 +++++------ 78 files changed, 363 insertions(+), 380 deletions(-) diff --git a/website/docs/architecture/overview.md b/website/docs/architecture/overview.md index 71d9a6cf..2a1f0332 100644 --- a/website/docs/architecture/overview.md +++ b/website/docs/architecture/overview.md @@ -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) diff --git a/website/docs/concepts/chaos-workflow.md b/website/docs/concepts/chaos-workflow.md index 824590e6..6b341082 100644 --- a/website/docs/concepts/chaos-workflow.md +++ b/website/docs/concepts/chaos-workflow.md @@ -22,7 +22,7 @@ The term **Chaos Scenario/Workflow** has been changed to **Chaos Experiment**. ## 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) diff --git a/website/docs/integrations/grafana.md b/website/docs/integrations/grafana.md index af717f1a..0df98d56 100644 --- a/website/docs/integrations/grafana.md +++ b/website/docs/integrations/grafana.md @@ -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) diff --git a/website/docs/integrations/prometheus.md b/website/docs/integrations/prometheus.md index c0d370d5..23bce3b7 100644 --- a/website/docs/integrations/prometheus.md +++ b/website/docs/integrations/prometheus.md @@ -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) diff --git a/website/docs/user-guides/accept-invite.md b/website/docs/user-guides/accept-invite.md index 6f2991db..6e54cbb2 100644 --- a/website/docs/user-guides/accept-invite.md +++ b/website/docs/user-guides/accept-invite.md @@ -10,6 +10,6 @@ Once the invitation is received, you can take a look at invitation project name, -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: diff --git a/website/docs/user-guides/account-settings.md b/website/docs/user-guides/account-settings.md index a7c1bbee..6103c304 100644 --- a/website/docs/user-guides/account-settings.md +++ b/website/docs/user-guides/account-settings.md @@ -1,22 +1,24 @@ --- 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:
avatar nav
-## Edit Personal Details +## Edit personal details Click the edit icon to open the edit modal: @@ -24,21 +26,21 @@ Click the edit icon to open the edit modal: edit icon -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.
edit information
-## 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.
edit information
-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**.
edit information diff --git a/website/docs/user-guides/analyze-workflow.md b/website/docs/user-guides/analyze-workflow.md index d2b24d6a..eee6f4c2 100644 --- a/website/docs/user-guides/analyze-workflow.md +++ b/website/docs/user-guides/analyze-workflow.md @@ -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) diff --git a/website/docs/user-guides/change-project-name.md b/website/docs/user-guides/change-project-name.md index 4e117af6..9404c674 100644 --- a/website/docs/user-guides/change-project-name.md +++ b/website/docs/user-guides/change-project-name.md @@ -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: @@ -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. diff --git a/website/docs/user-guides/chaoscenter-oauth-dex-installation.md b/website/docs/user-guides/chaoscenter-oauth-dex-installation.md index 88b8aea0..9fed10ee 100644 --- a/website/docs/user-guides/chaoscenter-oauth-dex-installation.md +++ b/website/docs/user-guides/chaoscenter-oauth-dex-installation.md @@ -1,21 +1,21 @@ --- id: chaoscenter-oauth-dex-installation -title: ChaosCenter with OAuth2 Login Support -sidebar_label: OAuth2 Support using Dex +title: ChaosCenter with OAuth2 login support +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 - 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. ::: - [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 -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 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://: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: @@ -94,7 +96,7 @@ kubectl get pods -n litmus Expected Output -```bash +``` NAME READY STATUS RESTARTS AGE litmusportal-dex-server-7f7658b57-lbbxc 1/1 Running 0 107s 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 ``` -### 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` -- `DEX_ENABLED`: This variable enables dex features in the litmusportal-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_CLIENT_ID`: This parameter is defined in the `dex-deployment.yaml` file the defaults being `LitmusPortalAuthBackend` -- `DEX_OAUTH_CLIENT_SECRET`: This parameter is defined in the `dex-deployment.yaml` file the defaults being `ZXhhbXBsZS1hcHAtc2VjcmV0` +- `OIDC_ISSUER`: The address where the Dex OIDC is hosted, i.e. `NODE_IP:32000` or `https://dex.yourdomain.com`. +- `DEX_ENABLED`: Toggle Dex features in the backend server. +- `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, defaults to `LitmusPortalAuthBackend`. +- `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 kubectl set env deployment/chaos-litmus-auth-server -n litmus --containers="auth-server" DEX_ENABLED=true OIDC_ISSUER=:32000 DEX_OAUTH_CALLBACK_URL=https:///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 -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 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. Expected Output @@ -151,7 +153,7 @@ Under `auth-server`, verify if the `DEX_ENABLED` variables are set Mounts: ``` -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) diff --git a/website/docs/user-guides/construct-experiment.md b/website/docs/user-guides/construct-experiment.md index e6a14802..57e1a6d8 100644 --- a/website/docs/user-guides/construct-experiment.md +++ b/website/docs/user-guides/construct-experiment.md @@ -1,29 +1,29 @@ --- id: construct-experiment -title: Construct Chaos Scenario YAML without ChaosCenter -sidebar_label: Construct Chaos Scenario YAML +title: Construct chaos experiment YAML without ChaosCenter +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.
-A basic chaos scenario consists of these steps: +**Chaos Experiment** is a set of different operations coupled together to achieve desired chaos impact on a Kubernetes Cluster. -1. Install ChaosExperiment -2. Install ChaosEngine -3. Revert Chaos +A basic chaos experiment consists of these steps: +1. Install ChaosExperiment CR +2. Install ChaosEngine CR +3. Cleanup Chaos resources ## 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.
+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. @@ -39,7 +39,7 @@ Few additional terms in an Argo chaos scenarios are: 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. ```yaml @@ -54,7 +54,7 @@ steps: 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 entrypoint: custom-chaos @@ -78,7 +78,7 @@ Here, the template with the name `custom-chaos` will be executed first. message: |... ``` -Once the chaos scenario is constructed, it should look like this: +Once the chaos experiment is constructed, it should look like this: ```yaml apiVersion: argoproj.io/v1alpha1 diff --git a/website/docs/user-guides/create-environment.md b/website/docs/user-guides/create-environment.md index 681efcf0..a0bf2032 100644 --- a/website/docs/user-guides/create-environment.md +++ b/website/docs/user-guides/create-environment.md @@ -10,13 +10,13 @@ You can learn about the concept of chaos environments [here](../concepts/infrast ## 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 ## 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. diff --git a/website/docs/user-guides/create-infrastructure.md b/website/docs/user-guides/create-infrastructure.md index 077348c2..a53e1810 100644 --- a/website/docs/user-guides/create-infrastructure.md +++ b/website/docs/user-guides/create-infrastructure.md @@ -12,19 +12,19 @@ sidebar_label: Create an Infrastructure ## 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: ## 2. Enable Chaos -Click on the `Enable Chaos` button: +Click on the **Enable Chaos** button: ## 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: @@ -32,12 +32,13 @@ Add the details of the infrastructure such as the name, description and tags, th 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. -- **Namespace Mode:** This mode of infrastructure installation allows targeting resources only in the namespace where the chaos infrastructure is deployed. +- **Cluster Wide:** This mode of infrastructure installation allows targeting workloads across the cluster, in all the namespaces. -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. @@ -46,7 +47,7 @@ Optionally, you can also specify the node selectors and Kubernetes tolerations f - For cluster-wide access:
    -
  1. Select Download, and then copy and run the kubectl command shown on your screen to install the chaos infrastructure.
    2. +
  2. Select Download, and then copy and run the kubectl command shown on your screen to install the chaos infrastructure.
@@ -54,14 +55,14 @@ Optionally, you can also specify the node selectors and Kubernetes tolerations f - For namespace access:
    -
  1. Run the first kubectl command to create the target namespace.
    2. -
  2. Run the second kubectl command to apply the chaos CRDs.
    3. +
  3. Run the first kubectl command to create the target namespace.
    4. +
  4. Run the second kubectl command to apply the chaos CRDs.
  5. Select Download, and then copy and run the third command to install the chaos infrastructure.
-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. diff --git a/website/docs/user-guides/create-resilience-probe.md b/website/docs/user-guides/create-resilience-probe.md index 650e7007..9d3ba2c8 100644 --- a/website/docs/user-guides/create-resilience-probe.md +++ b/website/docs/user-guides/create-resilience-probe.md @@ -10,19 +10,19 @@ You can learn about the concept of resilience probes [here](../concepts/probes.m ## 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. ## 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). ## 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). @@ -34,7 +34,7 @@ Configure the properties for the probe you are creating, such as, Timeout, Inter ## 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. diff --git a/website/docs/user-guides/create-user.md b/website/docs/user-guides/create-user.md index 3f8aa73d..a4b9add6 100644 --- a/website/docs/user-guides/create-user.md +++ b/website/docs/user-guides/create-user.md @@ -1,32 +1,32 @@ --- id: create-user -title: Create a User -sidebar_label: Create User +title: Create a 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 -Go to the `User Management` tab of the account settings page: +Go to the **User Management** tab of the account settings page: ## 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. ## 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. -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 diff --git a/website/docs/user-guides/deactivate-user.md b/website/docs/user-guides/deactivate-user.md index ecec52b9..3d4d2f8e 100644 --- a/website/docs/user-guides/deactivate-user.md +++ b/website/docs/user-guides/deactivate-user.md @@ -1,12 +1,12 @@ --- id: deactivate-user -title: Deactivate a User -sidebar_label: Deactivate User +title: Deactivate a 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 @@ -16,13 +16,13 @@ In the user management tab, locate the user account that you'd like to deactivat ## 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. ## 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: diff --git a/website/docs/user-guides/delete-environment.md b/website/docs/user-guides/delete-environment.md index 0c4c92f2..1680c2e9 100644 --- a/website/docs/user-guides/delete-environment.md +++ b/website/docs/user-guides/delete-environment.md @@ -6,13 +6,13 @@ sidebar_label: Delete an Environment ## 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: ## 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: diff --git a/website/docs/user-guides/delete-experiment.md b/website/docs/user-guides/delete-experiment.md index fce711f2..2fbe0b1e 100644 --- a/website/docs/user-guides/delete-experiment.md +++ b/website/docs/user-guides/delete-experiment.md @@ -1,7 +1,7 @@ --- id: delete-experiment -title: Delete a Chaos experiment -sidebar_label: Delete Chaos experiment +title: Delete a 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 -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: -## 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: -## 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. diff --git a/website/docs/user-guides/delete-infrastructure.md b/website/docs/user-guides/delete-infrastructure.md index 60075843..9744b4fa 100644 --- a/website/docs/user-guides/delete-infrastructure.md +++ b/website/docs/user-guides/delete-infrastructure.md @@ -6,13 +6,13 @@ sidebar_label: Delete an Infrastructure ## 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: ## 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 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. diff --git a/website/docs/user-guides/delete-resilience-probe.md b/website/docs/user-guides/delete-resilience-probe.md index 75bb90f9..58b09f56 100644 --- a/website/docs/user-guides/delete-resilience-probe.md +++ b/website/docs/user-guides/delete-resilience-probe.md @@ -10,13 +10,13 @@ Deleting a probe will delete all the associations with experiment runs from the ## 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: -## 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: diff --git a/website/docs/user-guides/download-experiment-manifest.md b/website/docs/user-guides/download-experiment-manifest.md index a2229dd0..284274de 100644 --- a/website/docs/user-guides/download-experiment-manifest.md +++ b/website/docs/user-guides/download-experiment-manifest.md @@ -1,12 +1,12 @@ --- id: download-experiment-manifest -title: Download Chaos Scenario Manifest -sidebar_label: Download Chaos Scenario Manifest +title: 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 @@ -14,13 +14,13 @@ You can learn how to schedule your first chaos scenario [here](schedule-experime ## 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: -## 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: diff --git a/website/docs/user-guides/edit-environment.md b/website/docs/user-guides/edit-environment.md index 4656dd31..8d9513c1 100644 --- a/website/docs/user-guides/edit-environment.md +++ b/website/docs/user-guides/edit-environment.md @@ -6,13 +6,13 @@ sidebar_label: Edit an Environment ## 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: ## 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. diff --git a/website/docs/user-guides/edit-invite.md b/website/docs/user-guides/edit-invite.md index 3328bbcb..91c2da98 100644 --- a/website/docs/user-guides/edit-invite.md +++ b/website/docs/user-guides/edit-invite.md @@ -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! -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. diff --git a/website/docs/user-guides/edit-schedule.md b/website/docs/user-guides/edit-schedule.md index d30b8a32..2927de42 100644 --- a/website/docs/user-guides/edit-schedule.md +++ b/website/docs/user-guides/edit-schedule.md @@ -1,22 +1,20 @@ --- id: edit-schedule -title: Edit Chaos Experiment Schedule -sidebar_label: Edit Chaos Experiment Schedule +title: Edit chaos experiment schedule +sidebar_label: Edit chaos experiment schedule --- --- ## 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: ## 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.
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 -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.
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 -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.
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 -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 diff --git a/website/docs/user-guides/gitops-configuration.md b/website/docs/user-guides/gitops-configuration.md index 911ba0ea..e81efc4d 100644 --- a/website/docs/user-guides/gitops-configuration.md +++ b/website/docs/user-guides/gitops-configuration.md @@ -20,30 +20,30 @@ GitOps enables you to configure a single source of truth for your chaos experime - [Gitops](../concepts/gitops.md) - [Chaos Infrastructure](../concepts/infrastructure.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 -- Setup a 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. -- Login into ChaosCenter, go to `GitOps` (Project Setup > GitOps on the left nav). +- Setup a hosted Git repository so that the ChaosCenter can sync with it and push all the chaos experiments in that repository. +- 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 to ChaosCenter and navigate to **GitOps** (**Project Setup** > **GitOps** on the left nav).



-- Select the `Git Repository` radio button. -- Copy the git URL of your git repository and paste it in the `Repository URL` text box. +- Select the **Git Repository** radio button. +- 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.



- 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. -- 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. -- 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. +- 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. +- 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. :::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 @@ -58,7 +58,7 @@ kubectl annotate deploy/target-application litmuschaos.io/experimentId=${experim kubectl annotate deploy/target-application litmuschaos.io/gitops=true ``` -- You can check if the event-tracker is running using this command:
+- You can check if the event-tracker is running using this command: ``` 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. 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 diff --git a/website/docs/user-guides/image-registry.md b/website/docs/user-guides/image-registry.md index 32bdaaa7..b8f9d97c 100644 --- a/website/docs/user-guides/image-registry.md +++ b/website/docs/user-guides/image-registry.md @@ -1,45 +1,46 @@ --- id: image-registry -title: Using different Image Registries in a Chaos Experiments -sidebar_label: Using different Image Registries +title: Using custom image registries in a chaos experiment +sidebar_label: Using different image registries --- --- -A container image registry can be defined as a collection of repositories that store container image. -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. -With ChaosCenter, you get the privilege to use your own/custom image registries for Chaos experiments. +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. + +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 option to use your own custom image registries for Chaos experiments. ## 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.

-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) -2. Custom Repo (Registry Name) -3. Registry Type `Public/Private` +1. Custom Image Registry (Registry server) +2. Custom Repo (Registry name) +3. Registry Type (**Public**/**Private**)

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

-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 - name: install-application diff --git a/website/docs/user-guides/invite-team-member.md b/website/docs/user-guides/invite-team-member.md index 1afe8527..71b58b92 100644 --- a/website/docs/user-guides/invite-team-member.md +++ b/website/docs/user-guides/invite-team-member.md @@ -1,14 +1,14 @@ --- id: invite-team-member -title: Invite a Team Member -sidebar_label: Invite Team Member +title: Invite a 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 @@ -22,7 +22,7 @@ From the list of all available members, choose the ones you want to collaborate -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 diff --git a/website/docs/user-guides/leave-project.md b/website/docs/user-guides/leave-project.md index 293417fb..e20fe8b8 100644 --- a/website/docs/user-guides/leave-project.md +++ b/website/docs/user-guides/leave-project.md @@ -1,22 +1,24 @@ --- id: leave-project -title: Leave a Project -sidebar_label: Leave Project +title: Leave a project +sidebar_label: Leave project --- --- 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: -> 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. diff --git a/website/docs/user-guides/observe-experiment.md b/website/docs/user-guides/observe-experiment.md index 9de1408e..0e1d20e5 100644 --- a/website/docs/user-guides/observe-experiment.md +++ b/website/docs/user-guides/observe-experiment.md @@ -1,32 +1,34 @@ --- id: observe-experiment -title: Observe Chaos experiment -sidebar_label: Observe Chaos experiment +title: 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.
+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. ## Prerequisites -The following should be required before creating a Chaos Experiment: +The following are required before creating a Chaos Experiment: - ChaosCenter - [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.
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.



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

diff --git a/website/docs/user-guides/re-run-experiment.md b/website/docs/user-guides/re-run-experiment.md index 93caf784..14cf555a 100644 --- a/website/docs/user-guides/re-run-experiment.md +++ b/website/docs/user-guides/re-run-experiment.md @@ -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 @@ -14,11 +14,11 @@ You can learn how to schedule your first chaos experiment [here](schedule-experi ## 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: -## 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: diff --git a/website/docs/user-guides/remove-team-member.md b/website/docs/user-guides/remove-team-member.md index 5fa2af38..36e375fe 100644 --- a/website/docs/user-guides/remove-team-member.md +++ b/website/docs/user-guides/remove-team-member.md @@ -1,23 +1,23 @@ --- id: remove-team-member -title: Remove a Team Member -sidebar_label: Remove Team Member +title: Remove a 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 -### 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. ### 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. diff --git a/website/docs/user-guides/reset-password.md b/website/docs/user-guides/reset-password.md index 45781ebb..e722b9d8 100644 --- a/website/docs/user-guides/reset-password.md +++ b/website/docs/user-guides/reset-password.md @@ -1,22 +1,22 @@ --- id: reset-password -title: Reset Password of a User -sidebar_label: Reset Password +title: Reset password of a user +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 -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 ## 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. diff --git a/website/docs/user-guides/schedule-experiment.md b/website/docs/user-guides/schedule-experiment.md index dd3444b2..1a542961 100644 --- a/website/docs/user-guides/schedule-experiment.md +++ b/website/docs/user-guides/schedule-experiment.md @@ -1,18 +1,18 @@ --- id: schedule-experiment -title: Schedule a Chaos Experiment -sidebar_label: Schedule Chaos Experiment +title: Schedule a chaos experiment +sidebar_label: Schedule chaos experiment --- --- ## 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). --- -Click on the **Schedule a chaos scenario ** button on the home page or **Schedule chaos scenario ** button in Litmus Chaos Scenarios page to get started. +Click on the **Schedule a chaos scenario** button on the home page or **Schedule chaos scenario** button in Litmus Chaos Scenarios page to get started.
Home Page diff --git a/website/docs/user-guides/setup-with-ingress.md b/website/docs/user-guides/setup-with-ingress.md index 29df17c0..18097773 100644 --- a/website/docs/user-guides/setup-with-ingress.md +++ b/website/docs/user-guides/setup-with-ingress.md @@ -1,38 +1,41 @@ --- id: setup-with-ingress -title: Install Litmus ChaosCenter with Ingress -sidebar_label: Setup With Ingress +title: Install ChaosCenter with Ingress +sidebar_label: Setup with Ingress --- --- ## 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 Ingress -With Litmus-2.0.0, ChaosCenter can be installed with ingress. -In the following doc, we will use the Nginx ingress controller for ingress setup. +Since Litmus 2.0.0, ChaosCenter can be installed with ingress. 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-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: ```bash 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: ```bash @@ -41,7 +44,7 @@ kubectl set env deployment/litmusportal-server -n litmus --containers="graphql-s ### With HTTP -Sample litmus ingress manifest With HTTP +Sample LitmusChaos Ingress manifest with HTTP: ```yaml apiVersion: networking.k8s.io/v1 diff --git a/website/docs/user-guides/setup-without-ingress.md b/website/docs/user-guides/setup-without-ingress.md index 97f47338..0be84d93 100644 --- a/website/docs/user-guides/setup-without-ingress.md +++ b/website/docs/user-guides/setup-without-ingress.md @@ -1,21 +1,21 @@ --- id: setup-without-ingress -title: Setting up Endpoints without Ingress -sidebar_label: Setup without Ingress +title: Setting up endpoints without ingress +sidebar_label: Setup without ingress --- --- ## 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 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 kubectl get svc -n @@ -30,11 +30,13 @@ litmusportal-frontend-service NodePort 10.101.81.70 9091: litmusportal-server-service NodePort 10.108.151.79 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 kubectl patch svc litmusportal-frontend-service -p '{"spec": {"type": "LoadBalancer"}}' -n @@ -49,9 +51,9 @@ litmusportal-frontend-service NodePort 10.101.81.70 9091: litmusportal-server-service NodePort 10.108.151.79 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 `:` to access the Litmus ChaosCenter. +Once you have the port copied in your clipboard, simply use your IP and port in this manner `:` to access the Litmus ChaosCenter. For example: @@ -59,9 +61,11 @@ For example: 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 `:` +:::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: `:` +::: -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 Username: admin diff --git a/website/docs/user-guides/uninstall-litmus.md b/website/docs/user-guides/uninstall-litmus.md index 9237d9c4..441ef211 100644 --- a/website/docs/user-guides/uninstall-litmus.md +++ b/website/docs/user-guides/uninstall-litmus.md @@ -12,11 +12,13 @@ To disconnect the [Chaos Infrastructure](../getting-started/resources.md#chaosag 1. Remove the ChaosEngines of the respective Chaos Infrastructure - ```bash - kubectl delete chaosengine --all - - ``` + ```bash + kubectl delete chaosengine --all - + ``` - > 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. 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 -To remove the CRs Litmus uses, use the following command: +To remove the CRs, use the following commands: - To remove individual CRs @@ -65,7 +67,7 @@ kubectl delete sa rolebindings role --all -n --- -## Remove the Litmus CRDs +## Remove the CRDs To remove all the CRDs Litmus uses, use the following command: diff --git a/website/docs/user-guides/view-probe-details.md b/website/docs/user-guides/view-probe-details.md index e47b3258..1d3f8eb2 100644 --- a/website/docs/user-guides/view-probe-details.md +++ b/website/docs/user-guides/view-probe-details.md @@ -1,19 +1,19 @@ --- id: view-resilience-probe -title: View Resilience Probe Details -sidebar_label: View Resilience Probe Details +title: View Resilience Probe details +sidebar_label: View Resilience Probe details --- ## 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: ## 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: diff --git a/website/docs/user-guides/view-user.md b/website/docs/user-guides/view-user.md index 49d25e3d..7cb8c38d 100644 --- a/website/docs/user-guides/view-user.md +++ b/website/docs/user-guides/view-user.md @@ -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 -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. diff --git a/website/versioned_docs/version-3.0.0/concepts/chaos-workflow.md b/website/versioned_docs/version-3.0.0/concepts/chaos-workflow.md index 824590e6..6b341082 100644 --- a/website/versioned_docs/version-3.0.0/concepts/chaos-workflow.md +++ b/website/versioned_docs/version-3.0.0/concepts/chaos-workflow.md @@ -22,7 +22,7 @@ The term **Chaos Scenario/Workflow** has been changed to **Chaos Experiment**. ## 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) diff --git a/website/versioned_docs/version-3.0.0/integrations/grafana.md b/website/versioned_docs/version-3.0.0/integrations/grafana.md index af717f1a..0df98d56 100644 --- a/website/versioned_docs/version-3.0.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.0.0/integrations/grafana.md @@ -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) diff --git a/website/versioned_docs/version-3.0.0/integrations/prometheus.md b/website/versioned_docs/version-3.0.0/integrations/prometheus.md index c0d370d5..23bce3b7 100644 --- a/website/versioned_docs/version-3.0.0/integrations/prometheus.md +++ b/website/versioned_docs/version-3.0.0/integrations/prometheus.md @@ -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) diff --git a/website/versioned_docs/version-3.0.0/user-guides/observe-experiment.md b/website/versioned_docs/version-3.0.0/user-guides/observe-experiment.md index 9de1408e..40b4b655 100644 --- a/website/versioned_docs/version-3.0.0/user-guides/observe-experiment.md +++ b/website/versioned_docs/version-3.0.0/user-guides/observe-experiment.md @@ -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](../concepts/chaos-workflow.md) diff --git a/website/versioned_docs/version-3.1.0/concepts/chaos-workflow.md b/website/versioned_docs/version-3.1.0/concepts/chaos-workflow.md index c2c69abb..fcf9b081 100644 --- a/website/versioned_docs/version-3.1.0/concepts/chaos-workflow.md +++ b/website/versioned_docs/version-3.1.0/concepts/chaos-workflow.md @@ -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) diff --git a/website/versioned_docs/version-3.1.0/concepts/visualize-experiment.md b/website/versioned_docs/version-3.1.0/concepts/visualize-experiment.md index d0129178..56cdab46 100644 --- a/website/versioned_docs/version-3.1.0/concepts/visualize-experiment.md +++ b/website/versioned_docs/version-3.1.0/concepts/visualize-experiment.md @@ -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) diff --git a/website/versioned_docs/version-3.1.0/integrations/grafana.md b/website/versioned_docs/version-3.1.0/integrations/grafana.md index af717f1a..0df98d56 100644 --- a/website/versioned_docs/version-3.1.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.1.0/integrations/grafana.md @@ -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) diff --git a/website/versioned_docs/version-3.1.0/integrations/prometheus.md b/website/versioned_docs/version-3.1.0/integrations/prometheus.md index c0d370d5..23bce3b7 100644 --- a/website/versioned_docs/version-3.1.0/integrations/prometheus.md +++ b/website/versioned_docs/version-3.1.0/integrations/prometheus.md @@ -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) diff --git a/website/versioned_docs/version-3.1.0/user-guides/observe-experiment.md b/website/versioned_docs/version-3.1.0/user-guides/observe-experiment.md index 9de1408e..40b4b655 100644 --- a/website/versioned_docs/version-3.1.0/user-guides/observe-experiment.md +++ b/website/versioned_docs/version-3.1.0/user-guides/observe-experiment.md @@ -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](../concepts/chaos-workflow.md) diff --git a/website/versioned_docs/version-3.2.0/concepts/chaos-workflow.md b/website/versioned_docs/version-3.2.0/concepts/chaos-workflow.md index c2c69abb..fcf9b081 100644 --- a/website/versioned_docs/version-3.2.0/concepts/chaos-workflow.md +++ b/website/versioned_docs/version-3.2.0/concepts/chaos-workflow.md @@ -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) diff --git a/website/versioned_docs/version-3.2.0/concepts/visualize-experiment.md b/website/versioned_docs/version-3.2.0/concepts/visualize-experiment.md index d0129178..56cdab46 100644 --- a/website/versioned_docs/version-3.2.0/concepts/visualize-experiment.md +++ b/website/versioned_docs/version-3.2.0/concepts/visualize-experiment.md @@ -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) diff --git a/website/versioned_docs/version-3.2.0/integrations/grafana.md b/website/versioned_docs/version-3.2.0/integrations/grafana.md index af717f1a..0df98d56 100644 --- a/website/versioned_docs/version-3.2.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.2.0/integrations/grafana.md @@ -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) diff --git a/website/versioned_docs/version-3.2.0/integrations/prometheus.md b/website/versioned_docs/version-3.2.0/integrations/prometheus.md index c0d370d5..23bce3b7 100644 --- a/website/versioned_docs/version-3.2.0/integrations/prometheus.md +++ b/website/versioned_docs/version-3.2.0/integrations/prometheus.md @@ -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) diff --git a/website/versioned_docs/version-3.2.0/user-guides/observe-experiment.md b/website/versioned_docs/version-3.2.0/user-guides/observe-experiment.md index 9de1408e..40b4b655 100644 --- a/website/versioned_docs/version-3.2.0/user-guides/observe-experiment.md +++ b/website/versioned_docs/version-3.2.0/user-guides/observe-experiment.md @@ -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](../concepts/chaos-workflow.md) diff --git a/website/versioned_docs/version-3.3.0/concepts/chaos-workflow.md b/website/versioned_docs/version-3.3.0/concepts/chaos-workflow.md index c2c69abb..fcf9b081 100644 --- a/website/versioned_docs/version-3.3.0/concepts/chaos-workflow.md +++ b/website/versioned_docs/version-3.3.0/concepts/chaos-workflow.md @@ -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) diff --git a/website/versioned_docs/version-3.3.0/concepts/visualize-experiment.md b/website/versioned_docs/version-3.3.0/concepts/visualize-experiment.md index d0129178..56cdab46 100644 --- a/website/versioned_docs/version-3.3.0/concepts/visualize-experiment.md +++ b/website/versioned_docs/version-3.3.0/concepts/visualize-experiment.md @@ -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) diff --git a/website/versioned_docs/version-3.3.0/integrations/grafana.md b/website/versioned_docs/version-3.3.0/integrations/grafana.md index af717f1a..0df98d56 100644 --- a/website/versioned_docs/version-3.3.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.3.0/integrations/grafana.md @@ -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) diff --git a/website/versioned_docs/version-3.3.0/integrations/prometheus.md b/website/versioned_docs/version-3.3.0/integrations/prometheus.md index c0d370d5..23bce3b7 100644 --- a/website/versioned_docs/version-3.3.0/integrations/prometheus.md +++ b/website/versioned_docs/version-3.3.0/integrations/prometheus.md @@ -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) diff --git a/website/versioned_docs/version-3.3.0/user-guides/observe-experiment.md b/website/versioned_docs/version-3.3.0/user-guides/observe-experiment.md index 9de1408e..40b4b655 100644 --- a/website/versioned_docs/version-3.3.0/user-guides/observe-experiment.md +++ b/website/versioned_docs/version-3.3.0/user-guides/observe-experiment.md @@ -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](../concepts/chaos-workflow.md) diff --git a/website/versioned_docs/version-3.4.0/concepts/chaos-workflow.md b/website/versioned_docs/version-3.4.0/concepts/chaos-workflow.md index c2c69abb..fcf9b081 100644 --- a/website/versioned_docs/version-3.4.0/concepts/chaos-workflow.md +++ b/website/versioned_docs/version-3.4.0/concepts/chaos-workflow.md @@ -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) diff --git a/website/versioned_docs/version-3.4.0/concepts/visualize-experiment.md b/website/versioned_docs/version-3.4.0/concepts/visualize-experiment.md index d0129178..56cdab46 100644 --- a/website/versioned_docs/version-3.4.0/concepts/visualize-experiment.md +++ b/website/versioned_docs/version-3.4.0/concepts/visualize-experiment.md @@ -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) diff --git a/website/versioned_docs/version-3.4.0/integrations/grafana.md b/website/versioned_docs/version-3.4.0/integrations/grafana.md index 0b2daf4e..f58b5121 100644 --- a/website/versioned_docs/version-3.4.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.4.0/integrations/grafana.md @@ -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) diff --git a/website/versioned_docs/version-3.4.0/integrations/prometheus.md b/website/versioned_docs/version-3.4.0/integrations/prometheus.md index c0d370d5..23bce3b7 100644 --- a/website/versioned_docs/version-3.4.0/integrations/prometheus.md +++ b/website/versioned_docs/version-3.4.0/integrations/prometheus.md @@ -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) diff --git a/website/versioned_docs/version-3.4.0/user-guides/observe-experiment.md b/website/versioned_docs/version-3.4.0/user-guides/observe-experiment.md index 9de1408e..40b4b655 100644 --- a/website/versioned_docs/version-3.4.0/user-guides/observe-experiment.md +++ b/website/versioned_docs/version-3.4.0/user-guides/observe-experiment.md @@ -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](../concepts/chaos-workflow.md) diff --git a/website/versioned_docs/version-3.5.0/concepts/chaos-workflow.md b/website/versioned_docs/version-3.5.0/concepts/chaos-workflow.md index c2c69abb..fcf9b081 100644 --- a/website/versioned_docs/version-3.5.0/concepts/chaos-workflow.md +++ b/website/versioned_docs/version-3.5.0/concepts/chaos-workflow.md @@ -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) diff --git a/website/versioned_docs/version-3.5.0/concepts/visualize-experiment.md b/website/versioned_docs/version-3.5.0/concepts/visualize-experiment.md index d0129178..56cdab46 100644 --- a/website/versioned_docs/version-3.5.0/concepts/visualize-experiment.md +++ b/website/versioned_docs/version-3.5.0/concepts/visualize-experiment.md @@ -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) diff --git a/website/versioned_docs/version-3.5.0/integrations/grafana.md b/website/versioned_docs/version-3.5.0/integrations/grafana.md index af717f1a..0df98d56 100644 --- a/website/versioned_docs/version-3.5.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.5.0/integrations/grafana.md @@ -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) diff --git a/website/versioned_docs/version-3.5.0/integrations/prometheus.md b/website/versioned_docs/version-3.5.0/integrations/prometheus.md index c0d370d5..23bce3b7 100644 --- a/website/versioned_docs/version-3.5.0/integrations/prometheus.md +++ b/website/versioned_docs/version-3.5.0/integrations/prometheus.md @@ -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) diff --git a/website/versioned_docs/version-3.5.0/user-guides/observe-experiment.md b/website/versioned_docs/version-3.5.0/user-guides/observe-experiment.md index 9de1408e..40b4b655 100644 --- a/website/versioned_docs/version-3.5.0/user-guides/observe-experiment.md +++ b/website/versioned_docs/version-3.5.0/user-guides/observe-experiment.md @@ -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](../concepts/chaos-workflow.md) diff --git a/website/versioned_docs/version-3.6.0/concepts/chaos-workflow.md b/website/versioned_docs/version-3.6.0/concepts/chaos-workflow.md index c2c69abb..fcf9b081 100644 --- a/website/versioned_docs/version-3.6.0/concepts/chaos-workflow.md +++ b/website/versioned_docs/version-3.6.0/concepts/chaos-workflow.md @@ -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) diff --git a/website/versioned_docs/version-3.6.0/concepts/visualize-experiment.md b/website/versioned_docs/version-3.6.0/concepts/visualize-experiment.md index d0129178..56cdab46 100644 --- a/website/versioned_docs/version-3.6.0/concepts/visualize-experiment.md +++ b/website/versioned_docs/version-3.6.0/concepts/visualize-experiment.md @@ -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) diff --git a/website/versioned_docs/version-3.6.0/integrations/grafana.md b/website/versioned_docs/version-3.6.0/integrations/grafana.md index af717f1a..0df98d56 100644 --- a/website/versioned_docs/version-3.6.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.6.0/integrations/grafana.md @@ -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) diff --git a/website/versioned_docs/version-3.6.0/integrations/prometheus.md b/website/versioned_docs/version-3.6.0/integrations/prometheus.md index c0d370d5..23bce3b7 100644 --- a/website/versioned_docs/version-3.6.0/integrations/prometheus.md +++ b/website/versioned_docs/version-3.6.0/integrations/prometheus.md @@ -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) diff --git a/website/versioned_docs/version-3.6.0/user-guides/observe-experiment.md b/website/versioned_docs/version-3.6.0/user-guides/observe-experiment.md index 9de1408e..40b4b655 100644 --- a/website/versioned_docs/version-3.6.0/user-guides/observe-experiment.md +++ b/website/versioned_docs/version-3.6.0/user-guides/observe-experiment.md @@ -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](../concepts/chaos-workflow.md) diff --git a/website/versioned_docs/version-3.7.0/concepts/chaos-workflow.md b/website/versioned_docs/version-3.7.0/concepts/chaos-workflow.md index c2c69abb..fcf9b081 100644 --- a/website/versioned_docs/version-3.7.0/concepts/chaos-workflow.md +++ b/website/versioned_docs/version-3.7.0/concepts/chaos-workflow.md @@ -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) diff --git a/website/versioned_docs/version-3.7.0/concepts/visualize-experiment.md b/website/versioned_docs/version-3.7.0/concepts/visualize-experiment.md index d0129178..56cdab46 100644 --- a/website/versioned_docs/version-3.7.0/concepts/visualize-experiment.md +++ b/website/versioned_docs/version-3.7.0/concepts/visualize-experiment.md @@ -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) diff --git a/website/versioned_docs/version-3.7.0/integrations/grafana.md b/website/versioned_docs/version-3.7.0/integrations/grafana.md index af717f1a..0df98d56 100644 --- a/website/versioned_docs/version-3.7.0/integrations/grafana.md +++ b/website/versioned_docs/version-3.7.0/integrations/grafana.md @@ -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) diff --git a/website/versioned_docs/version-3.7.0/integrations/prometheus.md b/website/versioned_docs/version-3.7.0/integrations/prometheus.md index c0d370d5..23bce3b7 100644 --- a/website/versioned_docs/version-3.7.0/integrations/prometheus.md +++ b/website/versioned_docs/version-3.7.0/integrations/prometheus.md @@ -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) diff --git a/website/versioned_docs/version-3.7.0/user-guides/observe-experiment.md b/website/versioned_docs/version-3.7.0/user-guides/observe-experiment.md index 9de1408e..40b4b655 100644 --- a/website/versioned_docs/version-3.7.0/user-guides/observe-experiment.md +++ b/website/versioned_docs/version-3.7.0/user-guides/observe-experiment.md @@ -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](../concepts/chaos-workflow.md) diff --git a/website/versioned_docs/version-3.8.0/user-guides/chaoscenter-cluster-scope-installation.md b/website/versioned_docs/version-3.8.0/user-guides/chaoscenter-cluster-scope-installation.md index cd23323f..294926b3 100644 --- a/website/versioned_docs/version-3.8.0/user-guides/chaoscenter-cluster-scope-installation.md +++ b/website/versioned_docs/version-3.8.0/user-guides/chaoscenter-cluster-scope-installation.md @@ -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 --- --- @@ -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 @@ -71,11 +71,13 @@ 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. @@ -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`. -## **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 @@ -98,14 +100,14 @@ kubectl apply -f https://litmuschaos.github.io/litmus/3.8.0/litmus-cluster-scope Expected Output ```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 @@ -122,32 +124,9 @@ kubectl apply -f https://litmuschaos.github.io/litmus/3.8.0/litmus-cluster-scope mongo-headless-service ClusterIP 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 @@ -156,40 +135,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. ::: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PodContainerCPUMemory
litmusportal-frontendlitmusportal-frontend25m300M
litmusportal-serverauth-server25m150M
litmusportal-servergraphql-server25m350M
mongodbmongodb25m350M
PodContainerCPUMemory
litmusportal-frontendlitmusportal-frontend25m300M
litmusportal-serverauth-server25m150M
litmusportal-servergraphql-server25m350M
mongodbmongodb25m350M
## Resources diff --git a/website/versioned_docs/version-3.8.0/user-guides/chaoscenter-namespace-scope-installation.md b/website/versioned_docs/version-3.8.0/user-guides/chaoscenter-namespace-scope-installation.md index bf904f2c..d07ddcf3 100644 --- a/website/versioned_docs/version-3.8.0/user-guides/chaoscenter-namespace-scope-installation.md +++ b/website/versioned_docs/version-3.8.0/user-guides/chaoscenter-namespace-scope-installation.md @@ -1,7 +1,7 @@ --- id: chaoscenter-namespace-scope-installation -title: ChaosCenter Namespace Scope Installation -sidebar_label: Namespace Scope +title: ChaosCenter namespace scope installation +sidebar_label: Namespace scope --- --- @@ -15,7 +15,7 @@ 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) @@ -27,30 +27,32 @@ 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 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 [Required only if namespace isn't there] +#### 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 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 the required Litmus CRDs +#### Step-3: Install CRDs 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 ``` -#### Step-4: Install Litmus ChaosCenter +#### Step-4: Install ChaosCenter ```bash 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 ` +1. Create a namespace, say `litmus`: ```bash kubectl create ns litmus ``` +2. To verify if the namespace is created, run the following command: +```bash +kubectl get ns +``` Expected Output ```bash @@ -114,7 +122,7 @@ NAME STATUS AGE 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. @@ -136,7 +144,7 @@ customresourcedefinition.apiextensions.k8s.io/chaosresults.litmuschaos.io create 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. @@ -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 ``` -> 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 ``, that you have created earlier for the LitmusChaos installation. +::: Expected Output @@ -178,11 +188,9 @@ service/mongo-service created service/mongo-headless-service created ``` -## **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: @@ -217,7 +225,9 @@ service/mongo-headless-service created mongo-headless-service ClusterIP 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: @@ -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" ``` ---- - -#### **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