docs: add missing common ENV variables to node experiment Tunables - #5533
Merged
ispeakc0de merged 9 commits intoJun 30, 2026
Merged
Conversation
Add STATUS_CHECK_DELAY, STATUS_CHECK_TIMEOUT, and TERMINATION_GRACE_PERIOD_SECONDS rows to the Optional Fields table in all 8 node experiment docs. These ENVs are defined in litmus-go source code but were missing from the mkdocs tables. Fixes litmuschaos#5531 Signed-off-by: Yeongeunn <nye0817@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for three common environment variables used by node experiments so the “Experiment tunables” tables match the defaults/behavior implemented in litmus-go.
Changes:
- Document
STATUS_CHECK_DELAY(default 2) across node experiment tunables. - Document
STATUS_CHECK_TIMEOUT(default 180) across node experiment tunables. - Document
TERMINATION_GRACE_PERIOD_SECONDS(default 0) across node experiment tunables.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| mkdocs/docs/experiments/categories/nodes/docker-service-kill.md | Adds missing common ENV tunables rows to the Optional Fields table. |
| mkdocs/docs/experiments/categories/nodes/kubelet-service-kill.md | Adds missing common ENV tunables rows to the Optional Fields table. |
| mkdocs/docs/experiments/categories/nodes/node-cpu-hog.md | Adds missing common ENV tunables rows to the Optional Fields table. |
| mkdocs/docs/experiments/categories/nodes/node-drain.md | Adds missing common ENV tunables rows to the Optional Fields table. |
| mkdocs/docs/experiments/categories/nodes/node-io-stress.md | Adds missing common ENV tunables rows to the Optional Fields table. |
| mkdocs/docs/experiments/categories/nodes/node-memory-hog.md | Adds missing common ENV tunables rows to the Optional Fields table. |
| mkdocs/docs/experiments/categories/nodes/node-restart.md | Adds missing common ENV tunables rows; table area also contains a malformed <code> tag in the LIB row (flagged in review). |
| mkdocs/docs/experiments/categories/nodes/node-taint.md | Adds missing common ENV tunables rows to the Optional Fields table. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
|
Hey @Yeongeunn |
Contributor
|
Hey @Yeongeunn |
Signed-off-by: Na Yeongeun <115203177+Yeongeunn@users.noreply.github.com>
Contributor
Author
Sorry for the late update! I’ve addressed the Copilot review comment by fixing the broken HTML tag in the LIB row of Thanks for the reminder, and please let me know if anything else needs to be updated. |
ispeakc0de
approved these changes
Jun 30, 2026
taeyoung0823
pushed a commit
to taeyoung0823/litmus
that referenced
this pull request
Jul 6, 2026
…itmuschaos#5533) * docs: add missing common ENV variables to node experiment Tunables Add STATUS_CHECK_DELAY, STATUS_CHECK_TIMEOUT, and TERMINATION_GRACE_PERIOD_SECONDS rows to the Optional Fields table in all 8 node experiment docs. These ENVs are defined in litmus-go source code but were missing from the mkdocs tables. Fixes litmuschaos#5531 Signed-off-by: Yeongeunn <nye0817@gmail.com> * docs: fix broken code tag in node restart tunables Signed-off-by: Na Yeongeun <115203177+Yeongeunn@users.noreply.github.com> --------- Signed-off-by: Yeongeunn <nye0817@gmail.com> Signed-off-by: Na Yeongeun <115203177+Yeongeunn@users.noreply.github.com> Co-authored-by: Pritesh Kiri <77957844+PriteshKiri@users.noreply.github.com> Co-authored-by: Shubham Chaudhary <shubham.chaudhary@harness.io>
This file contains hidden or 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
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.
Proposed changes
This PR adds the missing common ENV variables (
STATUS_CHECK_DELAY,STATUS_CHECK_TIMEOUT,TERMINATION_GRACE_PERIOD_SECONDS) to the Experiment Tunables tables of all 8 node experiment docs.These ENVs are defined in the litmus-go source code (under
pkg/generic/<experiment>/typesandenvironment) but were not documented in the mkdocs tables.Added rows (with defaults from litmus-go):
STATUS_CHECK_DELAY— Defaults to 2STATUS_CHECK_TIMEOUT— Defaults to 180TERMINATION_GRACE_PERIOD_SECONDS— Defaults to 0Affected files:
mkdocs/docs/experiments/categories/nodes/docker-service-kill.mdmkdocs/docs/experiments/categories/nodes/kubelet-service-kill.mdmkdocs/docs/experiments/categories/nodes/node-cpu-hog.mdmkdocs/docs/experiments/categories/nodes/node-drain.mdmkdocs/docs/experiments/categories/nodes/node-io-stress.mdmkdocs/docs/experiments/categories/nodes/node-memory-hog.mdmkdocs/docs/experiments/categories/nodes/node-restart.mdmkdocs/docs/experiments/categories/nodes/node-taint.mdFixes #5531
Types of changes
What types of changes does your code introduce to Litmus? Put an
xin the boxes that applyChecklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.Dependency
Special notes for your reviewer:
This is a documentation-only change. The new ENV rows follow the same HTML table pattern already used in the Optional Fields section of each node experiment doc.