From c9a8987dfc0196b7aabb8224e9d4223b2f99b808 Mon Sep 17 00:00:00 2001 From: SmritiSatya <117705907+SmritiSatya@users.noreply.github.com> Date: Fri, 3 May 2024 11:06:54 +0530 Subject: [PATCH] Update what-is-litmus.md (#255) Updates what-is-litmus Signed-off-by: SmritiSatya --- README.md | 6 +++--- .../introduction/what-is-litmus.md | 20 +++++++++---------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 1f94fbf0..9406a978 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ cd litmus-docs The docs website server can be setup manually or through docker compose -## Use embedmd command before commiting changes +## Use embedmd command before committing changes The embedded code will be extracted from the file at `URL`, which can either be a relative path to a file in the local file system (using forward slashes as directory separator) or a URL starting with `http://` or `https://.` @@ -45,7 +45,7 @@ _Installation:_ go install github.com/campoy/embedmd@latest ``` -_Run embedmd (needs to be done before commiting the changes):_ +_Run embedmd (needs to be done before committing the changes):_ - Follow the steps (from root directory) to run embedmd: @@ -72,7 +72,7 @@ npm start ## Using Docker compose -### Install docker compose +### Install Docker compose ```bash sudo curl -L "https://github.com/docker/compose/releases/download/1.24.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose diff --git a/website/versioned_docs/version-3.0.0/introduction/what-is-litmus.md b/website/versioned_docs/version-3.0.0/introduction/what-is-litmus.md index 360a9241..8bc69a56 100644 --- a/website/versioned_docs/version-3.0.0/introduction/what-is-litmus.md +++ b/website/versioned_docs/version-3.0.0/introduction/what-is-litmus.md @@ -8,27 +8,27 @@ sidebar_label: Litmus Litmus Logo -LitmusChaos is a Cloud-Native Chaos Engineering Framework with cross-cloud support. It is a CNCF Incubating project with adoption across several organizations. Its mission is to help Kubernetes SREs and Developers to find weaknesses in both Non-Kubernetes as well as platforms and applications running on Kubernetes by providing a complete Chaos Engineering framework and associated Chaos Experiments. +LitmusChaos is a cloud-native chaos engineering framework with cross-cloud support. It is a CNCF-incubating project with adoption across several organizations. Its mission is to help Kubernetes SREs and developers find weaknesses in both non-Kubernetes as well as platforms and applications running on Kubernetes by providing a complete Chaos Engineering framework and associated Chaos Experiments. -Litmus can be used to run chaos experiments initially in the staging environment and eventually in production to find bugs and vulnerabilities, fixing which leads to an increased resilience of the system. Litmus adopts a "Kubernetes-native" approach to define chaos intent in a declarative manner via Kubernetes custom resources (CRs). +Litmus can be used to run chaos experiments initially in the staging environment and eventually in production to find bugs and vulnerabilities and fix them, which leads to an increased resilience of the system. Litmus adopts a "Kubernetes-native" approach to define chaos intent in a declarative manner via Kubernetes custom resources (CRs). -## Importance of Resilience +## Significance of Resilience Importance Of Resilience -Kubernetes is being run on a variety of infrastructure, ranging from virtual machines to bare metal and a combination of them. The platform’s physical nature is a source of faults to the application that runs inside containers, as shown in the tip of the above diagram. The next layer of dependency is Kubernetes itself. +A variety of infrastructure, ranging from virtual machines to bare metal and a combination of them, uses Kubernetes. The platform’s physical nature is a source of faults for the application that runs inside containers, as shown in the tip of the above diagram. The next layer of dependency is Kubernetes itself. -Your application resilience really depends more on the underlying stack than your application itself. It is possible that once your application is stabilized, the resilience of your service that runs on Kubernetes depends on other components and infrastructure more than 90% of the time. +Your application's resilience really depends more on the underlying stack than on your application itself. Once your application is stable, the service resilience (which runs on Kubernetes) depends on other components and infrastructure more than 90% of the time. -Thus it is important to verify your application resilience whenever a change has happened in the underlying stack. **Keep verifying** is the key. Robust testing before upgrades is not good enough, mainly because you cannot possibly consider all sorts of faults during upgrade testing. This introduces the concept of Chaos Engineering. The process of "**continuously verifying** if your service is resilient against faults" is called Chaos Engineering. +Thus, it is important to verify your application's resilience whenever a change has happened in the underlying stack. **Keep verifying** is the key. Robust testing before upgrades is not good enough, mainly because you cannot possibly consider all sorts of faults during upgrade testing. This introduces the concept of chaos engineering. The process of "**continuously verifying** if your service is resilient against faults" is called chaos engineering. -## What is a Chaos Experiment +## What is a chaos experiment? -Chaos Experiments are fundamental units within the LitmusChaos architecture. Users can choose between readily available chaos experiments or create new ones to construct a required Chaos Scenario. +Chaos experiments are fundamental units within the LitmusChaos architecture. You can choose between readily available chaos experiments or create new ones to construct a required chaos scenario. -## What is a Chaos Scenarios +## What is a Chaos Scenario? -A chaos scenario is much more than a simple chaos experiment. It supports the user in defining the expected result, observing the result, analysing the overall system behaviour, and in the decision-making process if the system needs to be tuned for improving the resilience. +A chaos scenario is much more than a simple chaos experiment. It supports the user in defining the expected result, observing the result, analysing the overall system behaviour, and in the decision-making process if the system needs to be tuned for improving resilience. ## How to Contribute