Skip to content

Refactor Kubernetes toolsets documentation and consolidate permissions - #1893

Merged
aantn merged 4 commits into
masterfrom
claude/remove-emoji-section-titles-nRmny
Apr 12, 2026
Merged

aantn merged 4 commits into
masterfrom
claude/remove-emoji-section-titles-nRmny

Conversation

@aantn

@aantn aantn commented Apr 9, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

This PR restructures the Kubernetes toolsets documentation to better organize content and improve clarity. The main changes include consolidating permissions documentation into a dedicated page, updating toolset descriptions, and clarifying which toolsets are enabled by default.

Key Changes

  • Removed checkmarks from section headers - Replaced "Core ✓" and "Logs ✓" with plain "Core" and "Logs" for cleaner formatting
  • Simplified Core toolset - Replaced 13 individual kubectl tools with 3 higher-level tools:
    • kubernetes_jq_query - Query resources with jq filters and pagination
    • kubernetes_tabular_query - Extract fields in tabular format with filtering
    • kubernetes_count - Count resources matching jq filters
  • Enhanced Logs toolset - Updated descriptions for previous logs tools to clarify they work with crashed pods, added new kubectl_container_previous_logs tool
  • Reorganized optional toolsets - Added "Not Enabled by Default" notices to:
    • Live Metrics (requires Metrics Server)
    • Kube Prometheus Stack (renamed from "Prometheus Stack")
    • Resource Lineage (renamed from "Resource Lineage Extras", requires kube-lineage)
  • Updated Kube Prometheus Stack - Clarified it uses kubectl proxy to connect to in-cluster Prometheus, distinguished from direct Prometheus connections
  • Extracted permissions documentation - Moved "Adding Permissions for Additional Resources" section to new dedicated kubernetes-permissions.md file for better organization
  • Updated configuration examples - Changed toolset IDs to use kebab-case (kube-prometheus-stack, kube-lineage-extras, krew-extras)
  • Updated navigation - Added new Kubernetes Permissions page to .nav.yml

Notable Implementation Details

  • The Core toolset consolidation represents a shift toward more flexible, query-based tools rather than specific kubectl commands
  • All optional toolsets now have explicit "Not Enabled by Default" notices with requirements clearly stated
  • Permissions documentation is now separated from toolset documentation for better maintainability

https://claude.ai/code/session_01Ep5yCqMFDyqCCjKPoVYFAY

Summary by CodeRabbit

  • Documentation
    • Reorganized Kubernetes toolsets documentation for improved clarity
    • Added explicit "Not Enabled by Default" designations for Live Metrics and Kube Prometheus Stack capabilities
    • Updated core Kubernetes tools with new query capabilities
    • Clarified logs handling for crashed pods and their containers
    • Simplified Prometheus Stack tool configuration examples and identifiers

claude added 3 commits April 9, 2026 15:36
The "Core ✓" and "Logs ✓" headers rendered as odd emoji in the docs.
The "Enabled by Default" admonition already conveys this information.

https://claude.ai/code/session_01Ep5yCqMFDyqCCjKPoVYFAY
Signed-off-by: Claude <noreply@anthropic.com>
…t permissions

- Update Core capabilities: replace 10 outdated tools with actual 3
  (kubernetes_jq_query, kubernetes_tabular_query, kubernetes_count)
- Add missing kubectl_container_previous_logs to Logs capabilities
- Fix toolset names to match code (kube-prometheus-stack, krew-extras,
  kube-lineage-extras)
- Fix Prometheus Stack capabilities: 1 tool not 3
- Add "Not Enabled by Default" admonitions to Live Metrics, Kube
  Prometheus Stack, and Resource Lineage sections
- Add note distinguishing kube-prometheus-stack from standalone
  Prometheus toolset
- Move "Adding Permissions" section to its own page
  (kubernetes-permissions.md) to declutter the toolsets ToC

https://claude.ai/code/session_01Ep5yCqMFDyqCCjKPoVYFAY
Signed-off-by: Claude <noreply@anthropic.com>
Use Option B structure: toolsets live under "## Toolsets" as ### subsections,
and "## Adding Permissions" is a peer heading clearly separate in the ToC.
Also demote "Configuration" and "Capabilities" sub-headers to bold text
since they're inside ### sections now (avoids deep nesting).

Removes the separate kubernetes-permissions.md page from previous commit
in favor of keeping everything on one page.

https://claude.ai/code/session_01Ep5yCqMFDyqCCjKPoVYFAY
Signed-off-by: Claude <noreply@anthropic.com>

@claude claude Bot 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.

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.

Tip: disable this comment in your organization's Code Review settings.

@coderabbitai

coderabbitai Bot commented Apr 9, 2026 •

Copy link
Copy Markdown
Contributor

Walkthrough

Documentation reorganization of the Kubernetes toolsets guide, including restructuring sections under a unified "Toolsets" header, updating tool identifiers and capabilities descriptions, and adding explicit "Not Enabled by Default" notes for Live Metrics and resource lineage toolsets.

Changes

Cohort / File(s) Summary
Documentation
docs/data-sources/builtin-toolsets/kubernetes.md
Reorganized Kubernetes toolsets documentation structure into a unified "Toolsets" section with named sub-sections. Updated Core capabilities with three tools (kubernetes_jq_query, kubernetes_tabular_query, kubernetes_count), adjusted Logs semantics for crashed pod scenarios, and updated tool identifiers (kubernetes/kube-prometheus-stack, kubernetes/kube-lineage-extras, kubernetes/krew-extras). Added explicit "Not Enabled by Default" availability notes with supporting constraints.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested reviewers

  • arikalon1
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Refactor Kubernetes toolsets documentation and consolidate permissions' is closely related to the changeset. The PR refactors the Kubernetes toolsets documentation by reorganizing section structure, updating tool descriptions, and consolidating permissions information within the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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 and usage tips.

@netlify

netlify Bot commented Apr 9, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for holmes-docs ready!

Name Link
🔨 Latest commit 275806b
🔍 Latest deploy log https://app.netlify.com/projects/holmes-docs/deploys/69db7e8f93dec6000845d099
😎 Deploy Preview https://deploy-preview-1893--holmes-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 5

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/data-sources/builtin-toolsets/kubernetes.md`:
- Around line 76-81: Remove the entire "Capabilities:" section including the
heading "Capabilities:" and the markdown table rows referencing kubectl_top_pods
and kubectl_top_nodes; locate the block containing the table and delete it so
the document no longer lists toolset capabilities (remove the "Capabilities:"
heading plus the pipe-table that lists kubectl_top_pods and kubectl_top_nodes).
- Around line 105-129: Remove the "Capabilities" markdown table in the Resource
Lineage section that lists kubectl_lineage_children and kubectl_lineage_parents;
specifically delete the table block (the header row, separator, and the two rows
naming the tools) so the section only includes the note, description, and
configuration examples (i.e., remove references to the symbols
kubectl_lineage_children and kubectl_lineage_parents from
docs/data-sources/builtin-toolsets/kubernetes.md).
- Around line 83-103: Remove the entire "Capabilities" section and its Markdown
table under the "Kube Prometheus Stack" heading in kubernetes.md (the block
starting with "**Capabilities:**" and the table rows including
"get_prometheus_target"), leaving the rest of the toolset description and
configuration example intact.
- Around line 47-58: Remove the entire "Capabilities:" section from the
Kubernetes builtin toolset doc (the header "Capabilities:" and the markdown
table listing kubectl_logs, kubectl_logs_all_containers, kubectl_previous_logs,
kubectl_previous_logs_all_containers, kubectl_container_previous_logs,
kubectl_container_logs, kubectl_logs_grep, kubectl_logs_all_containers_grep);
leave any surrounding descriptive content intact and ensure no broken markdown
remains after deleting that header and table.
- Around line 21-27: Remove the "Capabilities:" section and its table (the
header and the rows listing kubernetes_jq_query, kubernetes_tabular_query,
kubernetes_count) from the markdown so the doc no longer enumerates tool
capabilities; simply delete that block and ensure surrounding content remains
valid markdown (no leftover orphaned blank lines or table separators) in
kubernetes.md.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 31e541e7-2a6d-4e05-b85e-8c4dc0b56f3d

📥 Commits

Reviewing files that changed from the base of the PR and between 146ca66 and 7c0485f.

📒 Files selected for processing (1)
  • docs/data-sources/builtin-toolsets/kubernetes.md

Comment thread docs/data-sources/builtin-toolsets/kubernetes.md
Comment thread docs/data-sources/builtin-toolsets/kubernetes.md
Comment thread docs/data-sources/builtin-toolsets/kubernetes.md
Comment thread docs/data-sources/builtin-toolsets/kubernetes.md
Comment thread docs/data-sources/builtin-toolsets/kubernetes.md
@aantn
aantn enabled auto-merge (squash) April 12, 2026 11:14
@aantn
aantn merged commit 1642c34 into master Apr 12, 2026
13 of 14 checks passed
@aantn
aantn deleted the claude/remove-emoji-section-titles-nRmny branch April 12, 2026 11:24
@coderabbitai coderabbitai Bot mentioned this pull request Apr 14, 2026
1 of 2 tasks
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.

3 participants