Skip to content

docs: add missing common ENV variables to node experiment Tunables - #5533

Merged
ispeakc0de merged 9 commits into
litmuschaos:masterfrom
Yeongeunn:docs/add-node-experiment-env-vars
Jun 30, 2026
Merged

docs: add missing common ENV variables to node experiment Tunables#5533
ispeakc0de merged 9 commits into
litmuschaos:masterfrom
Yeongeunn:docs/add-node-experiment-env-vars

Conversation

@Yeongeunn

Copy link
Copy Markdown
Contributor

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>/types and environment) but were not documented in the mkdocs tables.

Added rows (with defaults from litmus-go):

  • STATUS_CHECK_DELAY — Defaults to 2
  • STATUS_CHECK_TIMEOUT — Defaults to 180
  • TERMINATION_GRACE_PERIOD_SECONDS — Defaults to 0

Affected files:

  • mkdocs/docs/experiments/categories/nodes/docker-service-kill.md
  • mkdocs/docs/experiments/categories/nodes/kubelet-service-kill.md
  • mkdocs/docs/experiments/categories/nodes/node-cpu-hog.md
  • mkdocs/docs/experiments/categories/nodes/node-drain.md
  • mkdocs/docs/experiments/categories/nodes/node-io-stress.md
  • mkdocs/docs/experiments/categories/nodes/node-memory-hog.md
  • mkdocs/docs/experiments/categories/nodes/node-restart.md
  • mkdocs/docs/experiments/categories/nodes/node-taint.md

Fixes #5531

Types of changes

What types of changes does your code introduce to Litmus? Put an x in the boxes that apply

  • New feature (non-breaking change which adds functionality)
  • Bugfix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices applies)

Checklist

Put an x in 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.

  • I have read the CONTRIBUTING doc
  • I have signed the commit for DCO to be passed.
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have added necessary documentation (if appropriate)

Dependency

  • N/A

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.

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>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread mkdocs/docs/experiments/categories/nodes/node-restart.md Outdated
@PriteshKiri

Copy link
Copy Markdown
Contributor

Hey @Yeongeunn
Could you please check the Co-Pilot review comments?

@PriteshKiri

Copy link
Copy Markdown
Contributor

Hey @Yeongeunn
Any updates?

Signed-off-by: Na Yeongeun <115203177+Yeongeunn@users.noreply.github.com>
@Yeongeunn

Copy link
Copy Markdown
Contributor Author

Hey @Yeongeunn Any updates?

Sorry for the late update!

I’ve addressed the Copilot review comment by fixing the broken HTML tag in the LIB row of node-restart.md.

Thanks for the reminder, and please let me know if anything else needs to be updated.

@ispeakc0de
ispeakc0de merged commit a23bec2 into litmuschaos:master Jun 30, 2026
18 checks passed
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add missing common ENV variables to node experiment Tunables

5 participants