[ROB-1659] kubectl docs

[Avi-Robusta]

No description provided.

[coderabbitai]

Walkthrough

The documentation for remediation actions in the playbook reference has been updated to include a new section on the kubectl_command action. This section describes how to use the action for running arbitrary kubectl commands with dynamic placeholders and provides usage examples with YAML snippets and resulting commands.

Changes

File(s)	Change Summary
docs/playbook-reference/actions/remediation.rst	Added a "Kubectl" section documenting the kubectl_command action, usage, placeholders, examples

Estimated code review effort

1 (<30 minutes)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/playbook-reference/actions/remediation.rst (1)

29-34: Keep heading underline length consistent with peer sections

Node and the other peer sections use a 17-char underline, but Kubectl is only seven characters long. While Sphinx doesn’t enforce matching lengths, keeping underline length proportional to the heading text improves readability and avoids the “shouting” effect.

-Kubectl
-*****************
+Kubectl
+********

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 04282fa and f70816a.

📒 Files selected for processing (1)

• docs/playbook-reference/actions/remediation.rst (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: run_tests
• GitHub Check: run_tests
• GitHub Check: Deploy docs
• GitHub Check: Deploy docs

🔇 Additional comments (2)

docs/playbook-reference/actions/remediation.rst (2)

35-39: Confirm directive path & placeholder list completeness

1. Double-check that playbooks.robusta_playbooks.kubectl_enrichments.kubectl_command is the canonical import path exposed in __init__.py; otherwise the .. robusta-action:: directive won’t resolve.
2. If the action also supports $cluster (or other) placeholders, list them here to avoid future doc drift.

No code change needed if both items are correct.

---

42-59: Indent nested code blocks two spaces, not four

Within an RST directive body, Sphinx expects the content to be indented exactly two spaces relative to the directive. Using four spaces can make the block render as plain text rather than a code block.

-    .. code-block:: yaml
-
-        customPlaybooks:
-        - name: CrashLoopScaleDown
+  .. code-block:: yaml
+
+    customPlaybooks:
+    - name: CrashLoopScaleDown

Apply the same adjustment to the bash blocks below to guarantee correct syntax highlighting.

Likely an incorrect or invalid review comment.