Skip to content

Commit c9a8987

Browse files
authored
Update what-is-litmus.md (#255)
Updates what-is-litmus Signed-off-by: SmritiSatya <[email protected]>
1 parent a01ca4a commit c9a8987

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ cd litmus-docs
3333

3434
The docs website server can be setup manually or through docker compose
3535

36-
## Use embedmd command before commiting changes
36+
## Use embedmd command before committing changes
3737

3838
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://.`
3939

@@ -45,7 +45,7 @@ _Installation:_
4545
go install github.com/campoy/embedmd@latest
4646
```
4747

48-
_Run embedmd (needs to be done before commiting the changes):_
48+
_Run embedmd (needs to be done before committing the changes):_
4949

5050
- Follow the steps (from root directory) to run embedmd:
5151

@@ -72,7 +72,7 @@ npm start
7272

7373
## Using Docker compose
7474

75-
### Install docker compose
75+
### Install Docker compose
7676

7777
```bash
7878
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

website/versioned_docs/version-3.0.0/introduction/what-is-litmus.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,27 @@ sidebar_label: Litmus
88

99
<img align='right' src={require("../assets/litmus-logo.png").default} alt="Litmus Logo" width="120" />
1010

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

13-
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).
13+
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).
1414

15-
## Importance of Resilience
15+
## Significance of Resilience
1616

1717
<img src={require("../assets/introduction/litmus/importance-of-resilience.png").default} alt="Importance Of Resilience" />
1818

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

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

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

25-
## What is a Chaos Experiment
25+
## What is a chaos experiment?
2626

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

29-
## What is a Chaos Scenarios
29+
## What is a Chaos Scenario?
3030

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

3333
## How to Contribute
3434

0 commit comments

Comments
 (0)