Skip to content

Docs: clarify pod_ps shows global host PID, not container PID - #2145

Open
gitanshulbisht wants to merge 2 commits into
robusta-dev:masterfrom
gitanshulbisht:docs/pod-ps-global-pid
Open

Docs: clarify pod_ps shows global host PID, not container PID#2145
gitanshulbisht wants to merge 2 commits into
robusta-dev:masterfrom
gitanshulbisht:docs/pod-ps-global-pid

Conversation

@gitanshulbisht

Copy link
Copy Markdown

Fixes #162

The pod_ps action lists processes using a debugger pod with hostPID=True, so the reported PIDs are global host PIDs, not container-namespaced PIDs. This was not documented and caused confusion (issue #162).

This updates the action's docstring, which the autorobusta Sphinx extension renders into the docs site.

@CLAassistant

CLAassistant commented Aug 14, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@coderabbitai

coderabbitai Bot commented Aug 14, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: b9ed0884-53e6-4155-a18d-00f00520ee88

📥 Commits

Reviewing files that changed from the base of the PR and between 4847afb and 4dc9bc3.

📒 Files selected for processing (1)
  • playbooks/robusta_playbooks/pod_troubleshooting.py

Walkthrough

The pod_ps action documentation now states that its pid column reports the global host PID, not the container-namespaced PID.

Changes

pod_ps documentation

Layer / File(s) Summary
Clarify pid column
playbooks/robusta_playbooks/pod_troubleshooting.py
The documentation identifies the PID namespace used by the pod_ps output.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 4dc9b

This is a localized documentation clarification about the PIDs reported by pod_ps, with no production behavior change or actionable merge-blocking risk remaining after normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation change to the PID behavior.
Description check ✅ Passed The description explains the documentation update and its relation to issue #162.
Linked Issues check ✅ Passed The PR documents that pod_ps reports global host PIDs, which satisfies issue #162.
Out of Scope Changes check ✅ Passed The changes are limited to the requested pod_ps documentation clarification.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

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.

Documentation for Pod ps does not explain what is the result PID

2 participants