Added 3.0.0 docs for concepts and glossary #221
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Saranya-jena <saranya.jena@harness.io>
Signed-off-by: Saranya-jena <saranya.jena@harness.io>
Signed-off-by: Saranya-jena <saranya.jena@harness.io>
Saranya-jena
requested review from
vanshBhatia-A4k9,
Jonsy13 and
neelanjan00
Saranya-jena
requested review from
divya-mohan0209,
ksatchit and
k8s-dev
as code owners
|
@Saranya-jena is attempting to deploy a commit to the Harness Chaos Team Team on Vercel. A member of the Team first needs to authorize it. |
vanshBhatia-A4k9
approved these changes
Sep 25, 2023
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Signed-off-by: Saranya-jena <saranya.jena@harness.io>
Signed-off-by: Saranya-jena <saranya.jena@harness.io>
Signed-off-by: Saranya-jena <saranya.jena@harness.io>
Signed-off-by: Saranya-jena <saranya.jena@harness.io>
Signed-off-by: Saranya-jena <saranya.jena@harness.io>
SahilKr24
approved these changes
Sep 26, 2023
Signed-off-by: Saranya-jena <saranya.jena@harness.io>
neelanjan00
approved these changes
Sep 26, 2023
| It is useful in automating a series of pre-conditioning steps or action which is necessary to be performed before triggering the chaos injection.<br/> | ||
| A Chaos Scenario can also be used to perform different operations parallelly to achieve a desired chaos injection scenario. | ||
| A Chaos Experiment can also be used to perform different operations parallelly to achieve a desired chaos injection experiment. |
There was a problem hiding this comment.
Suggested change
| A Chaos Experiment can also be used to perform different operations parallelly to achieve a desired chaos injection experiment. | |
| A Chaos Experiment can also be used to perform different operations parallelly to achieve a desired chaos impact. |
|
|
||
| LitmusChaos leverages the popular chaos scenario and GitOps tool **Argo** to achieve this goal. Argo enables the creation of different chaos scenarios together in from of chaos scenarios which are extremly simple and efficient to use.<br/> | ||
| With the help of **ChaosCenter**, chaos scenarios with different type of experiments can be created. In a Chaos Scenario, the experiments can be added in a parallel way and the user can tune the chaos scenario by adding additional steps to simulate a desired fault that might occur in production stage. | ||
| LitmusChaos leverages the popular chaos experiment and GitOps tool **Argo** to achieve this goal. Argo enables the creation of different chaos experiments together in from of chaos experiments which are extremly simple and efficient to use.<br/> |
There was a problem hiding this comment.
Suggested change
| LitmusChaos leverages the popular chaos experiment and GitOps tool **Argo** to achieve this goal. Argo enables the creation of different chaos experiments together in from of chaos experiments which are extremly simple and efficient to use.<br/> | |
| LitmusChaos leverages the popular GitOps tool **Argo** to achieve this goal. Argo enables the creation of different chaos experiments together in form of chaos experiments which are extremely simple and efficient to use.<br/> |
| LitmusChaos leverages the popular chaos scenario and GitOps tool **Argo** to achieve this goal. Argo enables the creation of different chaos scenarios together in from of chaos scenarios which are extremly simple and efficient to use.<br/> | ||
| With the help of **ChaosCenter**, chaos scenarios with different type of experiments can be created. In a Chaos Scenario, the experiments can be added in a parallel way and the user can tune the chaos scenario by adding additional steps to simulate a desired fault that might occur in production stage. | ||
| LitmusChaos leverages the popular chaos experiment and GitOps tool **Argo** to achieve this goal. Argo enables the creation of different chaos experiments together in from of chaos experiments which are extremly simple and efficient to use.<br/> | ||
| With the help of **ChaosCenter**, chaos experiments with different type of faults can be created. In a Chaos Experiment, the faults can be added in a parallel way and the user can tune the chaos experiment by adding additional steps to simulate a desired fault that might occur in production stage. |
There was a problem hiding this comment.
Suggested change
| With the help of **ChaosCenter**, chaos experiments with different type of faults can be created. In a Chaos Experiment, the faults can be added in a parallel way and the user can tune the chaos experiment by adding additional steps to simulate a desired fault that might occur in production stage. | |
| With the help of **ChaosCenter**, chaos experiments with different types of faults can be created. In a Chaos Experiment, the faults can be set to execute in parallel to each other and the user can tune the chaos experiment by adding additional steps to simulate a desired fault that might occur in the production stage. |
| @@ -204,10 +209,10 @@ spec: | |||
| strategy: OnWorkflowCompletion | |||
| ``` | |||
|
|
|||
| 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`. | |||
There was a problem hiding this comment.
Suggested change
| 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`. | |
| The structure of a chaos experiment is similar to that of a Kubernetes Object. It consists of mandatory fields like `apiVersion`, `kind`, `metadata`, `spec`. |
| @@ -222,40 +227,40 @@ templates: | |||
| ``` | |||
|
|
|||
| Here in this template, we can see different steps are present. | |||
| These include installing the chaos experiments, executing the chaos engine of the experiment and at the end we have the revert chaos step which deletes/removes the resources that were created as part of the chaos scenario. | |||
| These include installing the chaos faults, executing the chaos engine of the faults and at the end we have the revert chaos step which deletes/removes the resources that were created as part of the chaos experiment. | |||
There was a problem hiding this comment.
Suggested change
| These include installing the chaos faults, executing the chaos engine of the faults and at the end we have the revert chaos step which deletes/removes the resources that were created as part of the chaos experiment. | |
| These include installing the chaos faults, executing the chaos engine of the faults, and at the end we have the revert chaos step which deletes/removes the resources that were created as part of the chaos experiment. |
Comment on lines
9
to
10
| 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. <br/> | ||
| With ChaosCenter, the real-time data and status of the chaos experiments can be observed. Valuable information like pod logs, chaos experiment status, chaos results can also be viewed. |
There was a problem hiding this comment.
Suggested change
| 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. <br/> | |
| With ChaosCenter, the real-time data and status of the chaos experiments can be observed. Valuable information like pod logs, chaos experiment status, chaos results can also be viewed. | |
| 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. <br/> | |
| 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. |
Comment on lines
28
to
33
| 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.<br/><br/> | ||
| <img src={require('../assets/workflow-observe-running.png').default} width="800" /><br/><br/> | ||
| To view the details of each step, user can click on the individual nodes and right side pane will display the node details, results(once the execution is complete) and the logs related to it. | ||
| <br/><br/> | ||
| <img src={require('../assets/workflow-observe-log.png').default} width="800" /> | ||
| <img src={require('../assets/workflow-observe-completed.png').default} width="800" /> |
There was a problem hiding this comment.
Suggested change
| 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.<br/><br/> | |
| <img src={require('../assets/workflow-observe-running.png').default} width="800" /><br/><br/> | |
| To view the details of each step, user can click on the individual nodes and right side pane will display the node details, results(once the execution is complete) and the logs related to it. | |
| <br/><br/> | |
| <img src={require('../assets/workflow-observe-log.png').default} width="800" /> | |
| <img src={require('../assets/workflow-observe-completed.png').default} width="800" /> | |
| 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.<br/><br/> | |
| <img src={require('../assets/workflow-observe-running.png').default} width="800" /><br/><br/> | |
| 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. | |
| <br/><br/> | |
| <img src={require('../assets/workflow-observe-log.png').default} width="800" /> | |
| <img src={require('../assets/workflow-observe-completed.png').default} width="800" /> |
|
|
||
| ## Summary | ||
|
|
||
| After scheduling a chaos scenario, a user can view the details of the running chaos scenario from the ChaosCenter. ChaosCenter provides a realtime graph that is used to visualise the chaos scenario and get the details of individual step of the chaos scenario. Important details like the logs and target applications can be viewed from ChaosCenter. These logs are also downloadable. User can view the details in 2 different ways i.e `Graph View` and `Table View`. Once the chaos scenario exection is completed, the resiliency score is calcualted and the ChaosResult for the ChaosEngine pods are available now. | ||
| After scheduling a chaos experiment, a user can view the details of the running chaos experiment from the ChaosCenter. ChaosCenter provides a realtime graph that is used to visualise the chaos experiment and get the details of individual step of the chaos experiment. Important details like the logs and target applications can be viewed from ChaosCenter. Once the chaos experiment exection is completed, the resiliency score is calculated and the ChaosResult for the ChaosEngine pods are available. |
There was a problem hiding this comment.
Suggested change
| After scheduling a chaos experiment, a user can view the details of the running chaos experiment from the ChaosCenter. ChaosCenter provides a realtime graph that is used to visualise the chaos experiment and get the details of individual step of the chaos experiment. Important details like the logs and target applications can be viewed from ChaosCenter. Once the chaos experiment exection is completed, the resiliency score is calculated and the ChaosResult for the ChaosEngine pods are available. | |
| After scheduling a chaos experiment, a user can view the details of the running chaos experiment from the ChaosCenter. ChaosCenter provides a real-time graph that is used to visualize the chaos experiment and get the details of individual steps of the chaos experiment. Important details like the logs and target applications can be viewed from ChaosCenter. Once the chaos experiment execution is completed, the resiliency score is calculated and the ChaosResult for the ChaosEngine pods is available. |
| ## Coming Soon | ||
| ## Chaos Resources | ||
|
|
||
| At the heart of the Litmus Platform are the chaos custom resources. This section consists of the specification (details of each field within the .spec & .status of the resources) as well as standard examples for tuning the supported parameters. |
There was a problem hiding this comment.
Suggested change
| At the heart of the Litmus Platform are the chaos custom resources. This section consists of the specification (details of each field within the .spec & .status of the resources) as well as standard examples for tuning the supported parameters. | |
| At the heart of the Litmus platform are the chaos custom resources. This section consists of the specification (details of each field within the .spec & .status of the resources) as well as standard examples for tuning the supported parameters. |
| @@ -15,7 +15,7 @@ A basic chaos scenario consists of these steps: | |||
|
|
|||
| ## Before we begin | |||
|
|
|||
| To construct a Chaos Scenario without ChaosCenter, make sure you are aware of [Chaos Scenario](../concepts/chaos-workflow.md), [ChaosEngine CR](../concepts/chaos-engine.md) and the different steps present in it. | |||
| 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. | |||
There was a problem hiding this comment.
Suggested change
| 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 Scenario](../concepts/chaos-workflow.md), [ChaosEngine CR](../glossary.md), and the different steps present in it. |
Signed-off-by: Saranya-jena <saranya.jena@harness.io>
vanshBhatia-A4k9
added a commit
that referenced
this pull request
Oct 9, 2023
* 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 <vansh.bhatia@harness.io> * fix: [CHAOS-2493]: updated file names and TOC Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * fix: [CHAOS-2493]: fixed all broken links, build passing Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * feat: [CHAOS-2493]: removed 3.0-beta version docs, added v2-docs external link Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> --------- Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * Empty commit to trigger deployment Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * Added 3.0.0 docs for concepts and glossary (#221) * Added thr concept section for litmus 3.0.0 Signed-off-by: Saranya-jena <saranya.jena@harness.io> * Removed Chaos experiment,engine and result concepts Signed-off-by: Saranya-jena <saranya.jena@harness.io> * Added 3.0.0 docs for concepts and glosaary Signed-off-by: Saranya-jena <saranya.jena@harness.io> * fixed broken links Signed-off-by: Saranya-jena <saranya.jena@harness.io> * dummy commit Signed-off-by: Saranya-jena <saranya.jena@harness.io> * updated config Signed-off-by: Saranya-jena <saranya.jena@harness.io> * removed package-lock file Signed-off-by: Saranya-jena <saranya.jena@harness.io> * updated package.json file Signed-off-by: Saranya-jena <saranya.jena@harness.io> * Added version Signed-off-by: Saranya-jena <saranya.jena@harness.io> * resolved comments Signed-off-by: Saranya-jena <saranya.jena@harness.io> --------- Signed-off-by: Saranya-jena <saranya.jena@harness.io> * account-settings user guide added (#222) Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * Removed litmus v2 references and tutorial links (#225) * removed litmus v2 references and tutorial links Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * added link for teaming in multi-tenancy Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * typo fix Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> --------- Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * added user management user guide (#224) Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * added managing project section user guides (#223) Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * Added user guide for teaming (#226) Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * added image registry user guide, removed upgrade section for 3.0, added note in glossary (#228) Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * Added gitOps updated user guide (#227) * Added gitOps updated user guide Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * review comments addressed Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> --------- Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * Added documentation for Litmusctl, FAQs, troubleshooting, other fixes (#229) * Added documentation for Litmusctl, FAQs, troubleshooting, other fixes Signed-off-by: Saranya-jena <saranya.jena@harness.io> * resolved comments Signed-off-by: Saranya-jena <saranya.jena@harness.io> --------- Signed-off-by: Saranya-jena <saranya.jena@harness.io> * Chaos experiment user guide (#230) * chaos-experiments WIP Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * added experiment user guides Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * fixed broken likns Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> --------- Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * added user guide for resilience probes (#231) Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * Added installation docs for litmus 3.0 (#232) * updated installation docs Signed-off-by: Saranya-jena <saranya.jena@harness.io> * updated installation docs Signed-off-by: Saranya-jena <saranya.jena@harness.io> --------- Signed-off-by: Saranya-jena <saranya.jena@harness.io> * fixes broken link for v2-docs (#235) Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * chore: Update introduction and getting started sections (#233) * updates getting-started and introduction sections Signed-off-by: neelanjan00 <neelanjan.manna@harness.io> * updates litmus hosted docs Signed-off-by: neelanjan00 <neelanjan.manna@harness.io> * removes broken links Signed-off-by: neelanjan00 <neelanjan.manna@harness.io> * moves the changes to version 3.0 docs from master Signed-off-by: neelanjan00 <neelanjan.manna@harness.io> * restores master docs Signed-off-by: neelanjan00 <neelanjan.manna@harness.io> * removes broken links Signed-off-by: neelanjan00 <neelanjan.manna@harness.io> --------- Signed-off-by: neelanjan00 <neelanjan.manna@harness.io> * Main/unreleased fix for adding new sidebar (#236) * fix: added master/unreleased docs Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * fix: fixed sidebar json for migrating to 3.0.0 for master/unreleased Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> --------- Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * fix: fixed embedmd (#237) Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * feat: add backstage plugin page to the integrations category (#238) Signed-off-by: namkyu1999 <lak9348@konkuk.ac.kr> * Updated documentation in Architecture section for 3.0 (#239) * Updated architecture section for 3.0 Signed-off-by: Saranya-jena <saranya.jena@harness.io> * fixed embedmd issues Signed-off-by: Saranya-jena <saranya.jena@harness.io> * removed unecessary sections from getting started Signed-off-by: Saranya-jena <saranya.jena@harness.io> * fixed broken links Signed-off-by: Saranya-jena <saranya.jena@harness.io> --------- Signed-off-by: Saranya-jena <saranya.jena@harness.io> * feat: added environments user guides + backstage integration fix (#240) Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> * feat: Added chaos infrastructure user guides (#241) Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> --------- Signed-off-by: Vansh Bhatia <vansh.bhatia@harness.io> Signed-off-by: Saranya-jena <saranya.jena@harness.io> Signed-off-by: neelanjan00 <neelanjan.manna@harness.io> Signed-off-by: namkyu1999 <lak9348@konkuk.ac.kr> Co-authored-by: Saranya Jena <saranya.jena@harness.io> Co-authored-by: Neelanjan Manna <neelanjan.manna@harness.io> Co-authored-by: Namkyu Park <53862866+namkyu1999@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Which issue this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close that issue when PR gets merged): fixes #Special notes for your reviewer:
Checklist:
documentationtag