Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/workflows/Pull_Request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ jobs:
tput setaf 3; echo "Please follow the instructions to run embedmd:"
tput setaf 3; echo "cd website/docs"
tput setaf 3; echo "embedmd -w \$(find **/*.md)"
tput setaf 6; echo "For more info visit https://github.com/litmuschaos/litmus-docs/blob/master/CONTRIBUTING.md"
tput setaf 6; echo "For more info visit https://github.com/litmuschaos/litmus-docs/blob/main/CONTRIBUTING.md"
exit 1
else
tput setaf 2; echo "Nothing to embed"
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/docker_Push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: CD-Build
on:
push:
branches:
- master
- main
paths:
- "website/**"

Expand Down Expand Up @@ -42,7 +42,7 @@ jobs:
- name: Checking out CD repository
uses: actions/checkout@v2
with:
ref: "master"
ref: "main"
repository: litmuschaos/litmus-cd
token: ${{ secrets.CD_PUSH_TOKEN }}

Expand All @@ -57,5 +57,5 @@ jobs:
git config user.email litmusbot@github.com
git add .
git commit -m "Manifest updated for litmus-docs"
git push origin master
git push origin main

6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ Litmus documentation currently runs using [Docusaurus](https://docusaurus.io/) s
- Find an issue to work on or create a new issue. The issues are maintained at [litmuschaos/litmus](https://github.com/litmuschaos/litmus/issues). For new contributors, you can pick up from a list of [good first issues](https://github.com/litmuschaos/litmus/issues?q=is%3Aissue+is%3Aopen+label%3Aarea%2Flitmus-docs+label%3A%22good+first+issue%22+)
- Claim your issue by commenting your intent to work on it to avoid duplication of efforts.
- Fork the repository on GitHub.
- Create a branch from where you want to base your work (usually master).
- Create a branch from where you want to base your work (usually main).
- Make your changes, test locally, see preview by starting server and seeing in Preview Mode.
- Execute embedmd command before commiting your changes, so that it can embed source code into documentation, refer [README](/README.md) for steps.
- Commit your changes by making sure the commit messages convey the need and notes about the commit. Also make sure to [sign your commit](https://github.com/litmuschaos/litmus-docs/blob/master/CONTRIBUTING.md#sign-your-work) while making a new commit.
- Commit your changes by making sure the commit messages convey the need and notes about the commit. Also make sure to [sign your commit](https://github.com/litmuschaos/litmus-docs/blob/main/CONTRIBUTING.md#sign-your-work) while making a new commit.
- Push your changes to the branch in your fork of the repository.
- Submit a pull request to the original repository.

Expand All @@ -41,7 +41,7 @@ embedmd -w $(find **/*.md)

## Pull Request Checklist

- Rebase to the current master branch before submitting your pull request.
- Rebase to the current main branch before submitting your pull request.

- Commits should be kept small if possible. Each commit should follow the checklist below:

Expand Down
2 changes: 1 addition & 1 deletion website/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ This command generates static content into the `build` directory and can be serv
npm run docusaurus docs:version <VERSION>
```

This command will tag a new version from master docs.
This command will tag a new version from main docs.
It will copy the docs/ folder contents into a new versioned_docs/version-`<version>`/ folder, create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as versioned_sidebars/version-`<version>`-sidebars.json and append the new version number to versions.json.
4 changes: 2 additions & 2 deletions website/docs/developer-guide/chaoscenter-developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ export VERSION=ci
export HUB_BRANCH_NAME=v2.0.x
export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]"
export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]'
export DEFAULT_HUB_BRANCH_NAME=master
export DEFAULT_HUB_BRANCH_NAME=main
export ENABLE_INTERNAL_TLS=false
export REST_PORT=3000
export GRPC_PORT=3030
Expand Down Expand Up @@ -191,7 +191,7 @@ export VERSION=ci
export HUB_BRANCH_NAME=v2.0.x
export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]"
export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]'
export DEFAULT_HUB_BRANCH_NAME=master
export DEFAULT_HUB_BRANCH_NAME=main
```

Step-2: Run the go application
Expand Down
2 changes: 1 addition & 1 deletion website/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Without this label, the Workflow controller will not be able to reconcile the Wo

### Does Litmusctl support actions that are currently performed from the portal dashboard?

Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md).
Yes, Chaos Infrastructure connection, creation and chaos experiment execution are now being supported in Litmusctl. [documentation of litmusctl](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md).

### How to solve `invalid token` issue in litmusctl?

Expand Down
4 changes: 2 additions & 2 deletions website/docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Visit https://docs.litmuschaos.io to find more info.

## Install Litmus using kubectl

In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/master/chaoscenter#installation-steps-for-litmus-300-beta9).
In this method the users need to install mongo first via helm and then apply the installation manifest. Follow the instructions [here](https://github.com/litmuschaos/litmus/tree/main/chaoscenter#installation-steps-for-litmus-300-beta9).

### Install mongo

Expand Down Expand Up @@ -163,7 +163,7 @@ Litmus supports for HTTP and HTTPS mode of installation.
Applying the manifest file will install all the required service account configuration and ChaosCenter in namespaced scope.

```bash
kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/3.20.0/litmus-getting-started.yaml -n <NAMESPACE>
kubectl apply -f https://raw.githubusercontent.com/litmuschaos/litmus/main/mkdocs/docs/3.20.0/litmus-getting-started.yaml -n <NAMESPACE>
```

### Advanced installation (HTTPS based and CORS rules apply)
Expand Down
8 changes: 4 additions & 4 deletions website/docs/integrations/backstage.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ sidebar_label: Backstage
- See representative information about Litmus (number of Chaos Hubs, GitOps status, etc.).
- Provide a direct link to Litmus.

![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusCard.png)
![EntityLitmusCard](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusCard.png)

### EntityLitmusContent

Expand All @@ -29,7 +29,7 @@ sidebar_label: Backstage
- If you hover over 'RECENT EXPERIMENT RUNS', you can view detailed information about the experiments including resiliency score and status.
- We can directly launch chaos experiments by clicking the play button.

![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/EntityLitmusContent.png)
![EntityLitmusContent](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/EntityLitmusContent.png)

## Before you begin

Expand All @@ -47,9 +47,9 @@ sidebar_label: Backstage

1. Click "SETTINGS" in the sidebar.
2. Click "+ New Token" Button in the 'API Tokens' section.
![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/settings_tab.png)
![settings_tab](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/settings_tab.png)
3. Enter your information and click "Confirm".
![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/master/docs/create_dialog.png)
![create_dialog](https://raw.githubusercontent.com/litmuschaos/backstage-plugin/main/docs/create_dialog.png)
4. Get the token in the "VALUE" column.

3. In the `app-config.yaml` file root directory, add litmus proxy and info like below
Expand Down
26 changes: 13 additions & 13 deletions website/docs/integrations/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_label: Grafana

---

Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/master/monitoring/grafana-dashboards)
Chaos Engineering is the discipline of experimenting on a system to build confidence in the system’s capability to withstand turbulent conditions in production. Monitoring a system's resilience and its performance under chaos are one of the fundamental principles of chaos engineering. Litmus has sample chaos interleaved dashboards available on Grafana’s community dashboards as well as provisioned dashboards along with provisioned data sources. Some sample chaos interleaved dashboards can be found [here](https://github.com/litmuschaos/litmus/tree/main/monitoring/grafana-dashboards)

## Before you begin

Expand Down Expand Up @@ -73,51 +73,51 @@ Default username/password credentials: `admin/admin`

#### Chaos Result selector dropdown:

![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true)
![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-selector.png?raw=true)

#### Chaos Engine Context (Target application's NAMESPACE_LABEL) selector dropdown:

![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true)
![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-engine-context-selector.png?raw=true)

#### Chaos Engines with Experiments as Chaos Results:

![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true)
![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-experiments.png?raw=true)

#### Chaos event annotations:

![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true)
![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-event-annotation.png?raw=true)

#### Chaos Result verdict annotations:

![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true)
![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/chaos-result-verdict-annotation.png?raw=true)

#### Interleaved Chaos events:

![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true)
![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-events.png?raw=true)

#### Interleaved Chaos Result verdicts:

![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true)
![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/interleaved-results.png?raw=true)

#### Chaos Result verdict failure alerts:

![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true)
![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/verdict-failure-alert.png?raw=true)

#### Chaos Result probe failure alerts:

![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true)
![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/probe-failure-alert.png?raw=true)

#### Systems healthy / in steady state OR no alerts to be issued:

![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true)
![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/no-alerts-issued.png?raw=true)

#### Systems un-healthy / failed to regain steady state after chaos / meet SLO OR alerts are issued:

![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-active.png?raw=true)
![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-active.png?raw=true)

#### Alerts issued:

![image](https://github.com/litmuschaos/litmus/blob/master/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true)
![image](https://github.com/litmuschaos/litmus/blob/main/monitoring/screenshots/sock-shop/alerts-sent.png?raw=true)

## Chaos interleaving over infra and application metrics

Expand Down
10 changes: 5 additions & 5 deletions website/docs/introduction/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,16 +72,16 @@ Read about [chaos experiments](https://litmuschaos.github.io/litmus/).

We invite contributions in all forms. Join us in writing blogs on [Dev.to](https://dev.to/t/litmuschaos/latest) about experiments, features, and your experience. Use the `#litmuschaos` tag for your post to be featured.

Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/master/CODE_OF_CONDUCT.md).
Participation in the Litmus community is governed by our [code of conduct](https://github.com/litmuschaos/litmus/blob/main/CODE_OF_CONDUCT.md).

Checkout the [contribution guide](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md).
Checkout the [contribution guide](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md).

Contributors meet twice a month. See [Contributor meetings](#contributor-meetings).

- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#steps-to-contribute-).
- If you are a first-time contributor, please read [Steps to Contribute](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#steps-to-contribute-).
- If you would like to suggest new tests to be added to Litmus, [create a new issue](https://github.com/litmuschaos/litmus/issues/new) describing your test. Specify the workload type and the operations that you would like to perform on the workload.
- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/master/MAINTAINERS.md).
- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md#sign-your-work).
- If you would like to work on something more involved, connect with the [Litmus Maintainers](https://github.com/litmuschaos/litmus/blob/main/MAINTAINERS.md).
- If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](https://github.com/litmuschaos/litmus/blob/main/CONTRIBUTING.md#sign-your-work).

Other Litmus open source links:

Expand Down
2 changes: 1 addition & 1 deletion website/docs/litmusctl/additional-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_label: Additional Commands

This guide covers additional litmusctl commands for managing your ChaosCenter account, projects, environments, and chaos infrastructures.

Follow this [guide](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md#additional-commands) to learn more about litmusctl commands.
Follow this [guide](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md#additional-commands) to learn more about litmusctl commands.

---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/litmusctl/connect-chaos-infrastructure.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,4 +153,4 @@ To verify the connection, open your ChaosCenter and go to the Targets section. Y

---

For additional details or examples, you can also refer to this [guide](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md#steps-to-connect-a-chaos-infrastucture).
For additional details or examples, you can also refer to this [guide](https://github.com/litmuschaos/litmusctl/blob/main/Usage_0.23.0.md#steps-to-connect-a-chaos-infrastucture).
Loading