Skip to content

Commit 529168b

Browse files
vanshBhatia-A4k9Saranya-jenaneelanjan00namkyu1999
authored
Merging V3 docs to master (#242)
* feat: [CHAOS-2493]: (OSS) revamp the Table of contents for Litmus v3 docs (#220) * feat: [CHAOS-2493]: removed 2.x version docs, added 3.0.0 version json with updated terminology Signed-off-by: Vansh Bhatia <[email protected]> * fix: [CHAOS-2493]: updated file names and TOC Signed-off-by: Vansh Bhatia <[email protected]> * fix: [CHAOS-2493]: fixed all broken links, build passing Signed-off-by: Vansh Bhatia <[email protected]> * feat: [CHAOS-2493]: removed 3.0-beta version docs, added v2-docs external link Signed-off-by: Vansh Bhatia <[email protected]> --------- Signed-off-by: Vansh Bhatia <[email protected]> * Empty commit to trigger deployment Signed-off-by: Vansh Bhatia <[email protected]> * Added 3.0.0 docs for concepts and glossary (#221) * Added thr concept section for litmus 3.0.0 Signed-off-by: Saranya-jena <[email protected]> * Removed Chaos experiment,engine and result concepts Signed-off-by: Saranya-jena <[email protected]> * Added 3.0.0 docs for concepts and glosaary Signed-off-by: Saranya-jena <[email protected]> * fixed broken links Signed-off-by: Saranya-jena <[email protected]> * dummy commit Signed-off-by: Saranya-jena <[email protected]> * updated config Signed-off-by: Saranya-jena <[email protected]> * removed package-lock file Signed-off-by: Saranya-jena <[email protected]> * updated package.json file Signed-off-by: Saranya-jena <[email protected]> * Added version Signed-off-by: Saranya-jena <[email protected]> * resolved comments Signed-off-by: Saranya-jena <[email protected]> --------- Signed-off-by: Saranya-jena <[email protected]> * account-settings user guide added (#222) Signed-off-by: Vansh Bhatia <[email protected]> * Removed litmus v2 references and tutorial links (#225) * removed litmus v2 references and tutorial links Signed-off-by: Vansh Bhatia <[email protected]> * added link for teaming in multi-tenancy Signed-off-by: Vansh Bhatia <[email protected]> * typo fix Signed-off-by: Vansh Bhatia <[email protected]> --------- Signed-off-by: Vansh Bhatia <[email protected]> * added user management user guide (#224) Signed-off-by: Vansh Bhatia <[email protected]> * added managing project section user guides (#223) Signed-off-by: Vansh Bhatia <[email protected]> * Added user guide for teaming (#226) Signed-off-by: Vansh Bhatia <[email protected]> * added image registry user guide, removed upgrade section for 3.0, added note in glossary (#228) Signed-off-by: Vansh Bhatia <[email protected]> * Added gitOps updated user guide (#227) * Added gitOps updated user guide Signed-off-by: Vansh Bhatia <[email protected]> * review comments addressed Signed-off-by: Vansh Bhatia <[email protected]> --------- Signed-off-by: Vansh Bhatia <[email protected]> * Added documentation for Litmusctl, FAQs, troubleshooting, other fixes (#229) * Added documentation for Litmusctl, FAQs, troubleshooting, other fixes Signed-off-by: Saranya-jena <[email protected]> * resolved comments Signed-off-by: Saranya-jena <[email protected]> --------- Signed-off-by: Saranya-jena <[email protected]> * Chaos experiment user guide (#230) * chaos-experiments WIP Signed-off-by: Vansh Bhatia <[email protected]> * added experiment user guides Signed-off-by: Vansh Bhatia <[email protected]> * fixed broken likns Signed-off-by: Vansh Bhatia <[email protected]> --------- Signed-off-by: Vansh Bhatia <[email protected]> * added user guide for resilience probes (#231) Signed-off-by: Vansh Bhatia <[email protected]> * Added installation docs for litmus 3.0 (#232) * updated installation docs Signed-off-by: Saranya-jena <[email protected]> * updated installation docs Signed-off-by: Saranya-jena <[email protected]> --------- Signed-off-by: Saranya-jena <[email protected]> * fixes broken link for v2-docs (#235) Signed-off-by: Vansh Bhatia <[email protected]> * chore: Update introduction and getting started sections (#233) * updates getting-started and introduction sections Signed-off-by: neelanjan00 <[email protected]> * updates litmus hosted docs Signed-off-by: neelanjan00 <[email protected]> * removes broken links Signed-off-by: neelanjan00 <[email protected]> * moves the changes to version 3.0 docs from master Signed-off-by: neelanjan00 <[email protected]> * restores master docs Signed-off-by: neelanjan00 <[email protected]> * removes broken links Signed-off-by: neelanjan00 <[email protected]> --------- Signed-off-by: neelanjan00 <[email protected]> * Main/unreleased fix for adding new sidebar (#236) * fix: added master/unreleased docs Signed-off-by: Vansh Bhatia <[email protected]> * fix: fixed sidebar json for migrating to 3.0.0 for master/unreleased Signed-off-by: Vansh Bhatia <[email protected]> --------- Signed-off-by: Vansh Bhatia <[email protected]> * fix: fixed embedmd (#237) Signed-off-by: Vansh Bhatia <[email protected]> * feat: add backstage plugin page to the integrations category (#238) Signed-off-by: namkyu1999 <[email protected]> * Updated documentation in Architecture section for 3.0 (#239) * Updated architecture section for 3.0 Signed-off-by: Saranya-jena <[email protected]> * fixed embedmd issues Signed-off-by: Saranya-jena <[email protected]> * removed unecessary sections from getting started Signed-off-by: Saranya-jena <[email protected]> * fixed broken links Signed-off-by: Saranya-jena <[email protected]> --------- Signed-off-by: Saranya-jena <[email protected]> * feat: added environments user guides + backstage integration fix (#240) Signed-off-by: Vansh Bhatia <[email protected]> * feat: Added chaos infrastructure user guides (#241) Signed-off-by: Vansh Bhatia <[email protected]> --------- Signed-off-by: Vansh Bhatia <[email protected]> Signed-off-by: Saranya-jena <[email protected]> Signed-off-by: neelanjan00 <[email protected]> Signed-off-by: namkyu1999 <[email protected]> Co-authored-by: Saranya Jena <[email protected]> Co-authored-by: Neelanjan Manna <[email protected]> Co-authored-by: Namkyu Park <[email protected]>
1 parent 08a2a52 commit 529168b

File tree

7,619 files changed

+14575
-437396
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

7,619 files changed

+14575
-437396
lines changed

website/docs/architecture/architecture-summary.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,16 @@ sidebar_label: Architecture Summary
1010

1111
The Litmus architecture can be segregated into two parts:
1212

13-
1. **Control Plane:** Contains the components required for the functioning of Chaos Center, the website-based portal for Litmus.
13+
1. **Control Plane:** Contains the components required for the functioning of ChaosCenter, the website-based portal for Litmus.
1414

1515
2. **Execution Plane:** Contains the components required for the injection of chaos in the target resources.
1616

17-
Chaos Center can be used for creating, scheduling, and monitoring Chaos Scenarios, a set of chaos experiments defined in a definitive sequence to achieve desired chaos impact on the target resources upon execution. Users can log in to the Chaos Center using valid login credentials and leverage the interactive web UI to define their chaos scenario to target multiple aspects of their infrastructure. Once the user creates a Chaos Scenario using the Chaos Center, it is passed on to the Execution Plane. The Execution Plane can be present either in the host cluster containing the Control Plane if the self chaos delegate is being used, or in the target cluster if an external chaos delegate is being used. The Execution Plane interprets the Chaos Scenario as a list of steps required for injecting chaos into the target resources. It ensures efficient orchestration of chaos in cloud-native environments using various Kubernetes CRs. Once the Chaos Scenario is executed, Execution Plane sends the chaos result to the Control Plane for their post-processing using either the built-in monitoring dashboard of Litmus or using external observability tools such as Prometheus DB and Grafana dashboard. Litmus also achieves automated Chaos Scenario runs to execute chaos as part of the CI/CD pipeline based on a set of defined conditions using GitOps.
17+
ChaosCenter can be used for creating and scheduling Chaos Experiments, a set of chaos faults defined in a definitive sequence to achieve desired chaos impact on the target resources upon execution. Users can log in to the ChaosCenter using valid login credentials and leverage the interactive web UI to define their chaos experiment to target multiple aspects of their infrastructure. Once the user creates a Chaos Experiment using the ChaosCenter, it is passed on to the Execution Plane. The Execution Plane can be present either in the host cluster containing the Control Plane if the self chaos infrastructure is being used, or in the target cluster if an external chaos infrastructure is being used. The Execution Plane interprets the Chaos Experiment as a list of steps required for injecting chaos into the target resources. It ensures efficient orchestration of chaos in cloud-native environments using various Kubernetes CRs. Once the Chaos Experiment is executed, Execution Plane sends the chaos result to the Control Plane for their post-processing using either the built-in monitoring dashboard of Litmus or using external observability tools such as Prometheus DB and Grafana dashboard. Litmus also achieves automated Chaos Experiment runs to execute chaos as part of the CI/CD pipeline based on a set of defined conditions using GitOps.
18+
19+
:::note
20+
With the latest release of LitmusChaos 3.0.0:
21+
22+
<li>The term <b>Chaos Delegate/Agent</b> has been changed to <b>Chaos Infrastructure.</b> </li>
23+
<li>The term <b>Chaos Experiment</b> has been changed to <b>Chaos Fault.</b> </li>
24+
<li>The term <b>Chaos Scenario/Workflow</b> has been changed to <b>Chaos Experiment.</b></li>
25+
:::

website/docs/architecture/chaos-control-plane.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,33 @@ sidebar_label: Chaos Control Plane
88

99
<img src={require("../assets/chaos-control-plane.png").default} alt="Chaos Control Plane" />
1010

11-
Chaos Control Plane consists of micro-services responsible for the functioning of the Chaos Center, the website-based portal that can be used for interacting with Litmus, apart from the CLI. Chaos Plane facilitates the creation and scheduling of chaos scenarios, system observability during the event of chaos, and post-processing and analysis of experiment results.
11+
Chaos Control Plane consists of micro-services responsible for the functioning of the ChaosCenter, the website-based portal that can be used for interacting with Litmus, apart from the CLI. Chaos Plane facilitates the creation and scheduling of chaos experiments, system observability during the event of chaos, and post-processing and analysis of fault results.
1212

1313
## Chaos Control Plane Components
1414

15-
- **Authentication Server:** A Golang micro-service that is responsible for authorizing, authenticating the requests received from Chaos Center and managing users along with their projects. It primarily serves the cause of user creation, user login, resetting the password, updating user information, creating project, managing project related operations.
15+
- **Authentication Server:** A Golang micro-service that is responsible for authorizing, authenticating the requests received from ChaosCenter and managing users along with their projects. It primarily serves the cause of user creation, user login, resetting the password, updating user information, creating project, managing project related operations.
1616

17-
- **Backend Server:** A GraphQL based Golang micro-service that serves the requests received from Chaos Center, by either querying the database for the relevant information or by fetching information from the Execution Plane.
17+
- **Backend Server:** A GraphQL based Golang micro-service that serves the requests received from ChaosCenter, by either querying the database for the relevant information or by fetching information from the Execution Plane.
1818

19-
- **Database:** A NoSQL MongoDB database micro-service that is accountable for storing users' information, past chaos scenarios, saved chaos scenario templates, user projects, ChaosHubs, and GitOps details, among the other information.
19+
- **Database:** A NoSQL MongoDB database micro-service that is accountable for storing users' information, past chaos experiments, saved chaos experiment templates, user projects, ChaosHubs, and GitOps details, among the other information.
2020

21-
- **Chaos Center:** Refers to the interfaces used by Litmus for creation and scheduling of chaos scenarios, system observability during chaos injection, and post chaos result analysis. It includes:
21+
- **ChaosCenter:** Refers to the interfaces used by Litmus for creation and scheduling of chaos experiments, system observability during chaos injection, and post chaos result analysis. It includes:
2222

23-
- **Web UI:** A React.js based frontend application micro-service with built-in system observability capabilities and an analytics dashboard. It also facilitates teams of users to collaborate over chaos scenarios using role-based user accounts.
23+
- **Web UI:** A React.js based frontend application micro-service with built-in system observability capabilities and an analytics dashboard. It also facilitates teams of users to collaborate over chaos experiments using role-based user accounts.
2424

25-
- **Litmusctl:** A command-line tool that allows management of Litmus Chaos Delegate Infrastructure components. It can be used to create chaos delegates, project, and manage multiple Litmus accounts.
25+
- **Litmusctl:** A command-line tool that allows management of Litmus Chaos Infrastructure Infrastructure components. It can be used to create chaos infrastructures, project, and manage multiple Litmus accounts.
2626

2727
- **Litmus API:** Refers to two different Litmus APIs, namely Litmus Authentication API and Litmus Portal API:
2828

2929
- **Litmus Authentication API:** Used to authenticate the identity of a user and to perform several user and project specific tasks like create new users, update profile, update password, create project, invite users to project, get project details etc. It uses the Authentication Server to perform these tasks.
3030

31-
- **Litmus Portal API:** Provides command-line and UI experience for managing and monitoring the events around chaos scenarios. It uses the Backend Server to perform its functions.
31+
- **Litmus Portal API:** Provides command-line and UI experience for managing and monitoring the events around chaos experiments. It uses the Backend Server to perform its functions.
3232

3333
## Standard Chaos Control Plane Flow
3434

35-
1. The User logs in to the ChaosCenter using a valid login credential. A default project is created for the user on initial login. Every user is a part of a project and has a role assigned to them. To schedule a chaos scenario, the user needs to have an Editor or Owner role assigned in the project.
36-
2. The user uploads a Chaos Scenario manifest using the ChaosCenter, which is received by the Backend Server.
37-
3. Backend Server stores the manifest in the Database and also sends it to the Chaos Delegate.
38-
4. Chaos Delegate uses the Chaos Scenario manifest to inject chaos into the target resources. The steps of the Chaos Scenario execution can be visualized using the ChaosCenter.
39-
5. Chaos Delegate returns the results of the chaos experiments that were a part of the chaos scenario back to the Backend Server, along with the experiment logs.
40-
6. Backend Server then sends the chaos experiment results and logs to the ChaosCenter. It also stores the results into the Database for generating post-chaos scenario statistics and information.
35+
1. The User logs in to the ChaosCenter using a valid login credential. A default project is created for the user on initial login. Every user is a part of a project and has a role assigned to them. To schedule a chaos experiment, the user needs to have an Editor or Owner role assigned in the project.
36+
2. The user uploads a Chaos Experiment manifest using the ChaosCenter, which is received by the Backend Server.
37+
3. Backend Server stores the manifest in the Database and also sends it to the Chaos Infrastructure.
38+
4. Chaos Infrastructure uses the Chaos Experiment manifest to inject chaos into the target resources. The steps of the Chaos Experiment execution can be visualized using the ChaosCenter.
39+
5. Chaos Infrastructure returns the results of the chaos faults that were a part of the chaos experiment back to the Backend Server, along with the fault logs.
40+
6. Backend Server then sends the chaos fault results and logs to the ChaosCenter. It also stores the results into the Database for generating post-chaos experiment statistics and information.

0 commit comments

Comments
 (0)