Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added documentation for Litmusctl, FAQs, troubleshooting, other fixes #229

Merged
merged 2 commits into from
Sep 28, 2023

Conversation

Saranya-jena
Copy link
Contributor

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:

  • Fixes #
  • Signed the commit for DCO to be passed
  • Labelled this PR & related issue with documentation tag

Signed-off-by: Saranya-jena <saranya.jena@harness.io>
@vercel
Copy link

vercel bot commented Sep 27, 2023

@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.

---

---

In Litmus, Probes are pluggable checks that can be defined within the ChaosEngine for any Chaos Experiment. The fault pods execute these checks based on the mode they are defined in & factor their success as necessary conditions in determining the verdict of the fault (along with the standard `in-built` checks).
In Litmus, Resilience Probes are pluggable checks that can be defined within the ChaosEngine for any Chaos Experiment. The fault pods execute these checks based on the mode they are defined in & factor their success as necessary conditions in determining the verdict of the fault (along with the standard `in-built` checks).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In Litmus, Resilience Probes are pluggable checks that can be defined within the ChaosEngine for any Chaos Experiment. The fault pods execute these checks based on the mode they are defined in & factor their success as necessary conditions in determining the verdict of the fault (along with the standard `in-built` checks).
Resilience Probes are pluggable checks that can be defined within the ChaosEngine for any Chaos Experiment. The fault pods execute these checks based on the mode they are defined in & factor their success as necessary conditions in determining the verdict of the fault (along with the standard `in-built` checks).


### How can users integrate Litmuschaos in their environment with Gitops?

Gitops feature in Litmus enables users to sync chaos scenarios from a configured git repo, any chaos scenario inserts/updates made to the repo will be monitored and picked up by litmus portal and will be executed on the target cluster. Litmus portal gitops also includes an event-driven chaos injection feature where users can annotate an application to be watched for changes and if and when the change happens chaos scenarios can be triggered automatically. This integrates with other gitops tools like flux/argo cd and enables users to automatically run chaos scenarios whenever a new release happens or a particular change occurs in the application.
Gitops feature in Litmus enables users to sync chaos experiments from a configured git repo, any chaos experiment inserts/updates made to the repo will be monitored and picked up by Chaoscenter and will be executed on the target cluster. Chaoscenter gitops also includes an event-driven chaos injection feature where users can annotate an application to be watched for changes and if and when the change happens chaos experiments can be triggered automatically. This integrates with other gitops tools like flux/argo cd and enables users to automatically run chaos experiments whenever a new release happens or a particular change occurs in the application.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Gitops feature in Litmus enables users to sync chaos experiments from a configured git repo, any chaos experiment inserts/updates made to the repo will be monitored and picked up by Chaoscenter and will be executed on the target cluster. Chaoscenter gitops also includes an event-driven chaos injection feature where users can annotate an application to be watched for changes and if and when the change happens chaos experiments can be triggered automatically. This integrates with other gitops tools like flux/argo cd and enables users to automatically run chaos experiments whenever a new release happens or a particular change occurs in the application.
Gitops feature in Litmus enables users to sync chaos experiments from a configured git repo, any chaos experiment inserts/updates made to the repo will be monitored and picked up by ChaosCenter and will be executed on the target cluster. ChaosCenter gitops also includes an event-driven chaos injection feature where users can annotate an application to be watched for changes and if and when the change happens chaos experiments can be triggered automatically. This integrates with other gitops tools like flux/argo cd and enables users to automatically run chaos experiments whenever a new release happens or a particular change occurs in the application.

Comment on lines 57 to 59
In private mode, we have two types of authentication; Access token and SSH key.
For the access token, go to the settings of GitLab and in the Access token section, add a token with read repository permission. After getting the token, go to the Chaoscenter and provide the GitLab URL and branch name along with the access token. After submitting, your own chaos hub is connected to the Chaoscenter.
For the SSH key, click on the SSH and it will generate a public key. You have to use this public key and put it in your GitLab account. Just go to the settings of GitLab, you can see the SSH key section, go to the SSH key section and add your public key. After adding the public key. Get the ssh type URL of the git repository and put it in the Chaoscenter along with the branch. After submitting, your own chaoshub is connected to the Chaoscenter.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In private mode, we have two types of authentication; Access token and SSH key.
For the access token, go to the settings of GitLab and in the Access token section, add a token with read repository permission. After getting the token, go to the Chaoscenter and provide the GitLab URL and branch name along with the access token. After submitting, your own chaos hub is connected to the Chaoscenter.
For the SSH key, click on the SSH and it will generate a public key. You have to use this public key and put it in your GitLab account. Just go to the settings of GitLab, you can see the SSH key section, go to the SSH key section and add your public key. After adding the public key. Get the ssh type URL of the git repository and put it in the Chaoscenter along with the branch. After submitting, your own chaoshub is connected to the Chaoscenter.
In private mode, we have two types of authentication; Access token and SSH key.
For the access token, go to the settings of GitLab, and in the Access token section, add a token with read repository permission. After getting the token, go to the Chaoscenter and provide the GitLab URL and branch name along with the access token. After submitting, your own chaos hub is connected to the Chaoscenter.
For the SSH key, click on the SSH and it will generate a public key. You shall use this public key and put it in your GitLab account. Just go to the settings of GitLab, and you can see the SSH key section, go to the SSH key section and add your public key. After adding the public key. Get the SSH type URL of the git repository and put it in the Chaoscenter along with the branch. After submitting, your own ChaosHub is connected to the Chaoscenter.

Signed-off-by: Saranya-jena <saranya.jena@harness.io>
@vercel
Copy link

vercel bot commented Sep 28, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
litmus-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 28, 2023 6:58am

@Saranya-jena Saranya-jena merged commit 1d253af into litmuschaos:v3-docs Sep 28, 2023
4 checks passed
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants