docs: T9145: document WLB health script variables by jeleel-muibi · Pull Request #2221 · vyos/vyos-documentation

jeleel-muibi · 2026-08-24T19:21:29Z

Change Summary

Document the environment variables available to user-defined WAN load-balancing health-check scripts.

Related Task(s)

https://vyos.dev/T9145

Related PR(s)

wan-load-balance: T9145: add health script interface env vyos-1x#5399

Backport

None.

Validation

Targeted scripts/doc-linter.py check passed.
Sphinx HTML build passed.
git diff --check passed.

Checklist:

I have read the CONTRIBUTING document

coderabbitai · 2026-08-24T19:21:38Z

Important

Review skipped

No new commits to review since the last review.

⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 6f0826e4-a466-4639-b812-b0a65ce871cc

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 70aeea3f-5454-460c-b028-3aed22f61d61

📥 Commits

Reviewing files that changed from the base of the PR and between 3a1c6c3 and 4941868.

📒 Files selected for processing (1)

docs/configuration/loadbalancing/wan.md

🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

ansible/ansible (manual)

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.

📜 Recent review details

⏰ Context from checks skipped due to timeout. (2)

GitHub Check: Mergify Merge Protections
GitHub Check: Summary

⚠️ CI failures not shown inline (4)

GitHub Actions: AI Validation / validate: docs: T9145: document WLB health script variables

Conclusion: failure

View job details

##[group]Removing auth
 Removing SSH command configuration
 [command]/usr/bin/git config --local --name-only --get-regexp core\.sshCommand
 [command]/usr/bin/git submodule foreach --recursive sh -c "git config --local --name-only --get-regexp 'core\.sshCommand' && git config --local --unset-all 'core.sshCommand' || :"
 Removing HTTP extra header
 [command]/usr/bin/git config --local --name-only --get-regexp http\.https\:\/\/github\.com\/\.extraheader
 [command]/usr/bin/git submodule foreach --recursive sh -c "git config --local --name-only --get-regexp 'http\.https\:\/\/github\.com\/\.extraheader' && git config --local --unset-all 'http.https://github.com/.extraheader' || :"
 Removing includeIf entries pointing to credentials config files
 [command]/usr/bin/git config --local --name-only --get-regexp ^includeIf\.gitdir:
 includeif.gitdir:/home/runner/work/vyos-documentation/vyos-documentation/reviewer/.git.path
 includeif.gitdir:/home/runner/work/vyos-documentation/vyos-documentation/reviewer/.git/worktrees/*.path
 includeif.gitdir:/github/workspace/reviewer/.git.path
 includeif.gitdir:/github/workspace/reviewer/.git/worktrees/*.path
 [command]/usr/bin/git config --local --get-all includeif.gitdir:/home/runner/work/vyos-documentation/vyos-documentation/reviewer/.git.path
 /home/runner/work/_temp/git-credentials-da89b64e-58b0-405e-8c38-f121eab2f391.config
 [command]/usr/bin/git config --local --unset includeif.gitdir:/home/runner/work/vyos-documentation/vyos-documentation/reviewer/.git.path /home/runner/work/_temp/git-credentials-da89b64e-58b0-405e-8c38-f121eab2f391.config
 [command]/usr/bin/git config --local --get-all includeif.gitdir:/home/runner/work/vyos-documentation/vyos-documentation/reviewer/.git/worktrees/*.path
 /home/runner/work/_temp/git-credentials-da89b64e-58b0-405e-8c38-f121eab2f391.config
 [command]/usr/bin/git config --local --unset includeif.gitdir:/home/runner/work/vyos-documentation/vyos-documentation/reviewer/.git/worktrees/*.path /home/runne...

GitHub Actions: AI Validation / 1_prepare.txt: docs: T9145: document WLB health script variables

Conclusion: failure

View job details

##[group]Run set -euo pipefail
 �[36;1mset -euo pipefail�[0m
 �[36;1m# Fetch the base branch explicitly by refname to avoid ambiguity with�[0m
 �[36;1m# same-named tags (e.g., a `rolling` tag), then diff against FETCH_HEAD.�[0m
 �[36;1mgit fetch --no-tags --depth=1 origin "refs/heads/rolling"�[0m
 �[36;1mBASE="FETCH_HEAD"�[0m
 �[36;1m# --diff-filter=ACMRT excludes Deleted entries so the bundling�[0m
 �[36;1m# loop below (`git show HEAD:<path>`) doesn't try to extract�[0m
 �[36;1m# blobs for files that no longer exist in the merge ref.�[0m
 �[36;1m# Deletions still appear in diff-md.patch (full diff) but not�[0m
 �[36;1m# in changed-md.txt (which drives the bundling step).�[0m
 �[36;1mgit diff "$BASE...HEAD" --name-only --diff-filter=ACMRT -z -- ':(glob)docs/**/*.md'  > changed-md.z�[0m
 �[36;1mgit diff "$BASE...HEAD" --name-only --diff-filter=ACMRT -z -- ':(glob)docs/**/*.rst' > changed-rst.z�[0m
 �[36;1m# Reject paths containing line-disrupting control bytes (LF, CR,�[0m
 �[36;1m# other 0x01-0x1F + 0x7F) before generating the newline-delimited�[0m
 �[36;1m# *.txt manifests. NUL itself can't appear in a git pathname�[0m
 �[36;1m# (it's the on-disk tree-entry terminator), so it stays out of�[0m
 �[36;1m# the rejection class and remains the legitimate record delimiter�[0m
 �[36;1m# for `git diff -z` — `grep -z` honors that contract.�[0m
 �[36;1m#�[0m
 �[36;1m# POSIX filesystems generally allow LF/CR in filenames and git�[0m
 �[36;1m# stores them fine; the hazard is purely in our line-delimited�[0m
 �[36;1m# downstream tooling. Without this guard, `tr '\0' '\n'` on a�[0m
 �[36;1m# path like `docs/foo\nbar.md` would split it into two logical�[0m
 �[36;1m# lines — downstream consumers reading line-by-line would miss�[0m
 �[36;1m# validation coverage on the real file (or worse, act on a�[0m
 �[36;1m# synthetic path). Fail fast at this seam.�[0m
 �[36;1m#�[0m
 �[36;1m# An earlier `tr -d '\0\n\r' | grep [\x00-\x1F\x7F]` form�[0m
 �[36;1m# stripped the very bytes it was m...

GitHub Actions: AI Validation / prepare: docs: T9145: document WLB health script variables

Conclusion: failure

View job details

##[group]Run set -euo pipefail
 �[36;1mset -euo pipefail�[0m
 �[36;1m# Fetch the base branch explicitly by refname to avoid ambiguity with�[0m
 �[36;1m# same-named tags (e.g., a `rolling` tag), then diff against FETCH_HEAD.�[0m
 �[36;1mgit fetch --no-tags --depth=1 origin "refs/heads/rolling"�[0m
 �[36;1mBASE="FETCH_HEAD"�[0m
 �[36;1m# --diff-filter=ACMRT excludes Deleted entries so the bundling�[0m
 �[36;1m# loop below (`git show HEAD:<path>`) doesn't try to extract�[0m
 �[36;1m# blobs for files that no longer exist in the merge ref.�[0m
 �[36;1m# Deletions still appear in diff-md.patch (full diff) but not�[0m
 �[36;1m# in changed-md.txt (which drives the bundling step).�[0m
 �[36;1mgit diff "$BASE...HEAD" --name-only --diff-filter=ACMRT -z -- ':(glob)docs/**/*.md'  > changed-md.z�[0m
 �[36;1mgit diff "$BASE...HEAD" --name-only --diff-filter=ACMRT -z -- ':(glob)docs/**/*.rst' > changed-rst.z�[0m
 �[36;1m# Reject paths containing line-disrupting control bytes (LF, CR,�[0m
 �[36;1m# other 0x01-0x1F + 0x7F) before generating the newline-delimited�[0m
 �[36;1m# *.txt manifests. NUL itself can't appear in a git pathname�[0m
 �[36;1m# (it's the on-disk tree-entry terminator), so it stays out of�[0m
 �[36;1m# the rejection class and remains the legitimate record delimiter�[0m
 �[36;1m# for `git diff -z` — `grep -z` honors that contract.�[0m
 �[36;1m#�[0m
 �[36;1m# POSIX filesystems generally allow LF/CR in filenames and git�[0m
 �[36;1m# stores them fine; the hazard is purely in our line-delimited�[0m
 �[36;1m# downstream tooling. Without this guard, `tr '\0' '\n'` on a�[0m
 �[36;1m# path like `docs/foo\nbar.md` would split it into two logical�[0m
 �[36;1m# lines — downstream consumers reading line-by-line would miss�[0m
 �[36;1m# validation coverage on the real file (or worse, act on a�[0m
 �[36;1m# synthetic path). Fail fast at this seam.�[0m
 �[36;1m#�[0m
 �[36;1m# An earlier `tr -d '\0\n\r' | grep [\x00-\x1F\x7F]` form�[0m
 �[36;1m# stripped the very bytes it was m...

GitHub Actions: AI Validation / 0_validate.txt: docs: T9145: document WLB health script variables

Conclusion: failure

View job details

##[group]Removing auth
 Removing SSH command configuration
 [command]/usr/bin/git config --local --name-only --get-regexp core\.sshCommand
 [command]/usr/bin/git submodule foreach --recursive sh -c "git config --local --name-only --get-regexp 'core\.sshCommand' && git config --local --unset-all 'core.sshCommand' || :"
 Removing HTTP extra header
 [command]/usr/bin/git config --local --name-only --get-regexp http\.https\:\/\/github\.com\/\.extraheader
 [command]/usr/bin/git submodule foreach --recursive sh -c "git config --local --name-only --get-regexp 'http\.https\:\/\/github\.com\/\.extraheader' && git config --local --unset-all 'http.https://github.com/.extraheader' || :"
 Removing includeIf entries pointing to credentials config files
 [command]/usr/bin/git config --local --name-only --get-regexp ^includeIf\.gitdir:
 includeif.gitdir:/home/runner/work/vyos-documentation/vyos-documentation/reviewer/.git.path
 includeif.gitdir:/home/runner/work/vyos-documentation/vyos-documentation/reviewer/.git/worktrees/*.path
 includeif.gitdir:/github/workspace/reviewer/.git.path
 includeif.gitdir:/github/workspace/reviewer/.git/worktrees/*.path
 [command]/usr/bin/git config --local --get-all includeif.gitdir:/home/runner/work/vyos-documentation/vyos-documentation/reviewer/.git.path
 /home/runner/work/_temp/git-credentials-da89b64e-58b0-405e-8c38-f121eab2f391.config
 [command]/usr/bin/git config --local --unset includeif.gitdir:/home/runner/work/vyos-documentation/vyos-documentation/reviewer/.git.path /home/runner/work/_temp/git-credentials-da89b64e-58b0-405e-8c38-f121eab2f391.config
 [command]/usr/bin/git config --local --get-all includeif.gitdir:/home/runner/work/vyos-documentation/vyos-documentation/reviewer/.git/worktrees/*.path
 /home/runner/work/_temp/git-credentials-da89b64e-58b0-405e-8c38-f121eab2f391.config
 [command]/usr/bin/git config --local --unset includeif.gitdir:/home/runner/work/vyos-documentation/vyos-documentation/reviewer/.git/worktrees/*.path /home/runne...

🧰 Additional context used

📓 Path-based instructions (1)

docs/**/*.md

📄 CodeRabbit inference engine (AGENTS.md)

Markers must always come in pairs.

Files:

docs/configuration/loadbalancing/wan.md

🧠 Learnings (8)

📚 Learning: 2026-05-06T20:48:49.689Z

Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 1902
File: CLAUDE.md:71-71
Timestamp: 2026-05-06T20:48:49.689Z
Learning: In vyos/vyos-documentation, the 80-character line-length rule documented under Source conventions / Formatting applies only to documentation source files located under docs/ (e.g., docs/**/*.rst and docs/**/*.md). The rule is enforced by the vyoslinter (doc-linter.py from vyos/.github) when reviewing changed files via lint-doc.yml, and only for files within docs/**. Do not suggest hard-wrapping CLAUDE.md (repo-root documentation) because GitHub renders and reflows content. For CLAUDE.md, reviews should not enforce the 80-char wrapping; apply the rule only to files matching **/docs/**/*.{rst,md}.

Applied to files:

docs/configuration/loadbalancing/wan.md

📚 Learning: 2026-05-06T20:48:54.578Z

Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 1902
File: CLAUDE.md:80-84
Timestamp: 2026-05-06T20:48:54.578Z
Learning: Enforce the 80-character line-length limit only for documentation source files under docs/ (docs/**/*.rst and docs/**/*.md). Do not flag repo-root files like CLAUDE.md or README.md, since they are rendered by GitHub and not subject to this rule. The doc-linter (doc-linter.py via lint-doc.yml) only lints docs/**, so CI checks won't flag root files for line length.

Applied to files:

docs/configuration/loadbalancing/wan.md

📚 Learning: 2026-05-06T20:48:57.970Z

Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 1902
File: CLAUDE.md:91-93
Timestamp: 2026-05-06T20:48:57.970Z
Learning: The 80-character line limit applies only to documentation sources under docs/** (RST/MD). Do not enforce this limit on repo-root Markdown files like CLAUDE.md or README.md. The vyoslinter (doc-linter.py, run via lint-doc.yml from vyos/.github) lints only changed files within docs/**; root files are excluded. GitHub renders root Markdown with viewport-width reflow, so hard-wrapping these files reduces readability without tooling benefit.

Applied to files:

docs/configuration/loadbalancing/wan.md

📚 Learning: 2026-05-06T20:49:00.044Z

Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 1902
File: CLAUDE.md:108-108
Timestamp: 2026-05-06T20:49:00.044Z
Learning: Limit the 80-character line length check and vyoslinter (doc-linter.py) enforcement to documentation source files under docs/**/*.{rst,md}. Do not apply or flag line-length issues in repo-root files like CLAUDE.md or README.md, which are rendered directly by GitHub and are not linted by lint-doc.yml. This pattern narrows checks to Sphinx source docs and prevents false positives in non-doc files.

Applied to files:

docs/configuration/loadbalancing/wan.md

📚 Learning: 2026-05-06T20:48:53.302Z

Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 1902
File: CLAUDE.md:79-79
Timestamp: 2026-05-06T20:48:53.302Z
Learning: Limit line length to 80 characters only for documentation sources under the docs directory (docs/**/*.rst and docs/**/*.md). This is enforced by the vyoslinter doc-linter.py (from the vyos/.github repo) via lint-doc.yml on changed files under docs/**. Do not flag line-length violations in repository-root Markdown files like CLAUDE.md or README.md, as they are rendered by GitHub and reflow in the UI.

Applied to files:

docs/configuration/loadbalancing/wan.md

📚 Learning: 2026-05-06T20:49:15.361Z

Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 1902
File: CLAUDE.md:163-163
Timestamp: 2026-05-06T20:49:15.361Z
Learning: In vyos/vyos-documentation, enforce the 80-character line-length limit (Source conventions / Formatting) only for Sphinx documentation source files under docs/**/*.rst and docs/**/*.md. The lint-doc.yml workflow runs the doc-linter (doc-linter.py) and checks only docs/** changed files. Files in the repository root (e.g., CLAUDE.md, README.md) are rendered by GitHub and are not subject to this rule; do not flag line-length violations in those files.

Applied to files:

docs/configuration/loadbalancing/wan.md

📚 Learning: 2026-05-06T20:48:50.446Z

Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 1902
File: CLAUDE.md:64-64
Timestamp: 2026-05-06T20:48:50.446Z
Learning: Enforce the 80-character line-length limit only for documentation source files under docs/ (docs/**/*.md and docs/**/*.rst rendered by Sphinx and linted by vyoslinter via lint-doc.yml). Do not flag line-length issues in repository-root Markdown files such as CLAUDE.md or README.md, which GitHub renders with viewport-width reflow. This applies to all files within docs/ that are part of the documentation source.

Applied to files:

docs/configuration/loadbalancing/wan.md

📚 Learning: 2026-05-06T20:49:10.359Z

Learnt from: andamasov
Repo: vyos/vyos-documentation PR: 1902
File: CLAUDE.md:142-142
Timestamp: 2026-05-06T20:49:10.359Z
Learning: In vyos/vyos-documentation, the 80-character line limit and vyoslinter enforcement apply only to documentation source files under docs/**/*.rst and docs/**/*.md that Sphinx renders. Repo-root files such as CLAUDE.md and README.md are outside the linter's scope (lint-doc.yml runs on docs/**) and are rendered by GitHub with automatic paragraph reflow — do not flag line-length violations in these files.

Applied to files:

docs/configuration/loadbalancing/wan.md

🔍 Remote MCP vyos.dev

Relevant task context

T9145 is titled “WAN Load Balancing: User-defined health-check scripts do not receive interface context (WLB_INTERFACE_NAME)” and is currently Open with Normal priority.
The task reports that user-defined WAN health-check scripts lacked interface context, preventing generic scripts from identifying the interface under test.
VyOS 1.4 exposed WLB_SCRIPT_IFACE; the task discussion requests retaining it for backward compatibility while also providing WLB_INTERFACE_NAME.
This supports the PR’s documentation of both environment variables and its stated backward-compatibility behavior.

🔇 Additional comments (1)

docs/configuration/loadbalancing/wan.md (1)

177-179: LGTM!

📝 Walkthrough

Summary by CodeRabbit

Documentation
- Clarified that WAN load-balancing test scripts receive the interface name through WLB_INTERFACE_NAME.
- Documented WLB_SCRIPT_IFACE as a backward-compatible variable.

Walkthrough

Changes

WAN health-check documentation

Layer / File(s)	Summary
Document test-script interface variables `docs/configuration/loadbalancing/wan.md:177-179`	The `test-script` guidance now documents `WLB_INTERFACE_NAME` and the backward-compatible `WLB_SCRIPT_IFACE` variable.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Title check	✅ Passed	The title clearly identifies the documentation change for WAN load-balancing health-script variables.
Description check	✅ Passed	The description directly explains the documented environment variables, related task, and validation results.

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

Create stacked PR
Commit on current branch

✨ Simplify code

Create PR with simplified code

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

jeleel-muibi · 2026-08-24T19:21:48Z

@copilot review

jeleel-muibi · 2026-08-24T19:25:32Z

@coderabbitai review

coderabbitai · 2026-08-24T19:27:49Z

⚠️ Action not completed

Already reviewed the last commit. Use @coderabbitai full review to rerun a review of the entire changeset.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

sarthurdev

Documents env variables available to custom interface check script. Merge with parent vyos-1x PR.

mergify · 2026-08-24T19:33:01Z

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

Queue this pull request

docs: T9145: document WLB health script variables

4941868

mergify Bot added the rolling label Aug 24, 2026

mergify Bot assigned jeleel-muibi Aug 24, 2026

jeleel-muibi marked this pull request as ready for review August 24, 2026 19:25

jeleel-muibi mentioned this pull request Aug 24, 2026

wan-load-balance: T9145: add health script interface env vyos/vyos-1x#5399

Merged

13 tasks

sarthurdev approved these changes Aug 24, 2026

View reviewed changes

Navigation Menu

Uh oh!

docs: T9145: document WLB health script variables - #2221

docs: T9145: document WLB health script variables#2221
jeleel-muibi wants to merge 1 commit into
vyos:rollingfrom
jeleel-muibi:docs-t9145-wlb-health-script-env

jeleel-muibi commented Aug 24, 2026

Uh oh!

coderabbitai Bot commented Aug 24, 2026 •

edited

Loading

Review skipped

Relevant task context

Summary by CodeRabbit

Walkthrough

Changes

Uh oh!

jeleel-muibi commented Aug 24, 2026

Uh oh!

jeleel-muibi commented Aug 24, 2026

Uh oh!

coderabbitai Bot commented Aug 24, 2026 •

edited

Loading

Uh oh!

sarthurdev left a comment

Uh oh!

mergify Bot commented Aug 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

jeleel-muibi commented Aug 24, 2026

Change Summary

Related Task(s)

Related PR(s)

Backport

Validation

Checklist:

Uh oh!

coderabbitai Bot commented Aug 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Relevant task context

Summary by CodeRabbit

Walkthrough

Changes

Uh oh!

jeleel-muibi commented Aug 24, 2026

Uh oh!

jeleel-muibi commented Aug 24, 2026

Uh oh!

coderabbitai Bot commented Aug 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sarthurdev left a comment

Choose a reason for hiding this comment

Uh oh!

mergify Bot commented Aug 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

coderabbitai Bot commented Aug 24, 2026 •

edited

Loading

coderabbitai Bot commented Aug 24, 2026 •

edited

Loading