Improving litmus-docs by some characteristics and experiment creation #250
Conversation
anshikavashistha
requested review from
divya-mohan0209,
ksatchit and
k8s-dev
as code owners
❌ Deploy Preview for litmus-docs-411023 failed.
|
|
@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
force-pushed
the
Improvement-of-litmus-docs
branch
from
2408ba4 to
eb5d308
Compare
|
@divya-mohan0209 @ksatchit Please review the PR |
| ### 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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
We can take the changes in this PR itself.
anshikavashistha
force-pushed
the
Improvement-of-litmus-docs
branch
from
cf81223 to
0e9fc71
Compare
|
@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. |
anshikavashistha
force-pushed
the
Improvement-of-litmus-docs
branch
from
3455bd0 to
07708a8
Compare
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
* 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]>
Signed-off-by: anshikavashistha <[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]>
Signed-off-by: Your Full Name <[email protected]>
Signed-off-by: Your Full Name <[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
force-pushed
the
Improvement-of-litmus-docs
branch
from
65a23cb to
c0c31a5
Compare
|
@neelanjan00 I have done the requested changes which you have mentioned. |
|
Please resolve the conflicts |
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 #4378Special notes for your reviewer:
Checklist:
documentationtag