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

Improving litmus-docs by some characteristics and experiment creation #250

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

anshikavashistha
Copy link

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 #4378

Special notes for your reviewer:

Checklist:

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

Copy link

netlify bot commented Feb 22, 2024

Deploy Preview for litmus-docs-411023 failed.

Name Link
🔨 Latest commit c0c31a5
🔍 Latest deploy log https://app.netlify.com/sites/litmus-docs-411023/deploys/6648a99899a4f000082ac035

Copy link

vercel bot commented Feb 22, 2024

@anshikavashistha is attempting to deploy a commit to the Harness Chaos Team Team on Vercel.

A member of the Team first needs to authorize it.

@anshikavashistha
Copy link
Author

@divya-mohan0209 @ksatchit Please review the PR

website/docs/user-guides/create-resilience-probe.md Outdated Show resolved Hide resolved
Comment on lines 51 to 61
### Experiment Creation

When creating an experiment, it's imperative to include the Resilience Probe as part of the setup. This step is now mandatory to ensure accurate chaos injection and monitoring during the experiment. Follow these steps to add the probe to the experiment configuration:

1. **Identify Chaos Injection Points**: Determine the points within your system where chaos will be injected.

2. **Select Resilience Probe**: Choose the appropriate Resilience Probe that aligns with your experimentation goals and the type of chaos you want to inject as discussed above.

3. **Integrate Probe into Experiment YAML**: Add the Resilience Probe configuration to your experiment YAML file. Ensure that the probe is properly configured and referenced within the experiment setup.

4. **Validate Experiment Configuration**: Before initiating the experiment, validate the experiment configuration to ensure that the Resilience Probe is correctly included and configured.
Copy link
Member

Choose a reason for hiding this comment

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

We don't need these changes here, rather in the Schedule a Chaos Experiment page we need to add one more step for adding a probe to a fault.

We can just add a note here that at least one resilience probe needs to be added to each fault now.

Copy link
Author

Choose a reason for hiding this comment

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

I have added the note for the same you have mentioned to be in create-resilience-probe.md
For further changes in Schedule a Chaos Experiment,Should I do these changes in the same PR or opened a new issue?

Copy link
Member

Choose a reason for hiding this comment

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

We can take the changes in this PR itself.

@anshikavashistha
Copy link
Author

@neelanjan00 I have done the suggested changes .Kindly review the PR

@neelanjan00
Copy link
Member

@neelanjan00 I have done the suggested changes .Kindly review the PR

Please add the remaining changes for modifying the Schedule a Chaos Experiment page, will review once all the changes are in place.

website/docs/troubleshooting.md Outdated Show resolved Hide resolved
website/docs/user-guides/create-resilience-probe.md Outdated Show resolved Hide resolved
website/docs/user-guides/create-resilience-probe.md Outdated Show resolved Hide resolved
website/docs/troubleshooting.md Outdated Show resolved Hide resolved
website/versioned_docs/version-3.0.0/troubleshooting.md Outdated Show resolved Hide resolved
website/versioned_docs/version-3.0.0/troubleshooting.md Outdated Show resolved Hide resolved
Copy link

vercel bot commented May 14, 2024

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 May 18, 2024 1:14pm

namkyu1999 and others added 12 commits May 18, 2024 06:13
* chore: add faq

Signed-off-by: namkyu1999 <[email protected]>

* fix: add latest crds link

Signed-off-by: namkyu1999 <[email protected]>

* Update website/docs/troubleshooting.md

Co-authored-by: Vedant Shrotria <[email protected]>

---------

Signed-off-by: namkyu1999 <[email protected]>
Co-authored-by: Vedant Shrotria <[email protected]>
Signed-off-by: Your Full Name <[email protected]>
Co-authored-by: Neelanjan Manna <[email protected]>
Signed-off-by: Your Full Name <[email protected]>
Co-authored-by: Neelanjan Manna <[email protected]>
Signed-off-by: Your Full Name <[email protected]>
Co-authored-by: Neelanjan Manna <[email protected]>
Signed-off-by: Your Full Name <[email protected]>
Co-authored-by: Neelanjan Manna <[email protected]>
Signed-off-by: Your Full Name <[email protected]>
Updating the troubleshooting.md

Co-authored-by: Neelanjan Manna <[email protected]>
Signed-off-by: Your Full Name <[email protected]>
Co-authored-by: Neelanjan Manna <[email protected]>
Signed-off-by: Your Full Name <[email protected]>
Adding note

Co-authored-by: Neelanjan Manna <[email protected]>
Signed-off-by: Your Full Name <[email protected]>
@anshikavashistha
Copy link
Author

@neelanjan00 I have done the requested changes which you have mentioned.
PTAL

@neelanjan00
Copy link
Member

Please resolve the conflicts

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.

Improve Litmus documentation for Resilience probes
3 participants