Skip to content

Conversation

@paulohtb6
Copy link
Collaborator

@paulohtb6 paulohtb6 commented Nov 13, 2025

Description

Resolves https://redpandadata.atlassian.net/browse/DOC-1829
Review deadline:

Fix flags to match https://github.com/redpanda-data/redpanda/blob/dev/src/go/rpk/pkg/cli/debug/bundle/bundle.go

Page previews

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@paulohtb6 paulohtb6 requested a review from a team as a code owner November 13, 2025 17:16
@netlify
Copy link

netlify bot commented Nov 13, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 15f3e2e
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/69161288abf3a20008748719
😎 Deploy Preview https://deploy-preview-1453--redpanda-docs-preview.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
Copy link
Contributor

coderabbitai bot commented Nov 13, 2025

📝 Walkthrough

Walkthrough

This pull request updates the documentation for the rpk-debug-bundle command in the reference guide. The changes include: updating the default controller logs size limit from 20MB to 132MB, refining the logs-until parameter description with a Kubernetes-specific note, adjusting the metrics-interval default from 12s to 10s with formatting improvements, and clarifying Kubernetes-specific flags including the namespace flag (-n, --namespace) with a "Kubernetes only" designation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

  • This is a documentation-only change affecting a single .adoc file with straightforward updates to default values, parameter descriptions, and formatting consistency
  • Changes are homogeneous in nature (similar types of updates across related parameter descriptions)

Possibly related PRs

  • docs: update rpk v25.1.9 #1241: Also modifies the same rpk-debug-bundle.adoc file and includes updates to Kubernetes namespace flag formatting alongside other default value changes.

Suggested reviewers

  • kbatuigas
  • r-vasquez
  • micheleRP

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main change: fixing default flags for the rpk debug bundle command.
Description check ✅ Passed The description includes the required JIRA ticket reference, a clear purpose, and a source link, though page preview and check boxes remain incomplete.
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
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-default-flags

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • DOCS-1829: Request failed with status code 404

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc (1)

121-123: Added documentation for Kubernetes namespace flag.

The --namespace flag is now clearly documented with a "Kubernetes only" designation. However, note that formatting for Kubernetes-specific designations is currently inconsistent across the flags table: line 102 uses inline (k8s only) while this section and line 111 use a bold separate-line format. Consider standardizing this formatting across the entire table for consistency.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 74b3334 and 15f3e2e.

📒 Files selected for processing (1)
  • modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc (2 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). (3)
  • GitHub Check: Redirect rules - redpanda-docs-preview
  • GitHub Check: Header rules - redpanda-docs-preview
  • GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (4)
modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc (4)

94-96: Updated controller logs default to match implementation.

The controller logs size limit has been updated from 20MB to 132MB, aligning the documentation with the actual default in the codebase.


110-111: Clarified --logs-until limitation in Kubernetes environments.

The addition of the "Not supported in Kubernetes" note appropriately highlights that this flag (which uses journalctl format) only applies to bare-metal deployments.


113-117: Updated --metrics-interval default to 10s with improved formatting.

The default has been updated from 12s to 10s and the description formatting has been clarified for consistency.


94-123: Defaults verified and confirmed accurate.

Both documented defaults match the current implementation in the redpanda repository:

  • --controller-logs-size-limit: documented as 132MB, implementation default is "132MB"
  • --metrics-interval: documented as 10s, implementation default is 10*time.Second

@paulohtb6 paulohtb6 merged commit 90470fb into main Nov 18, 2025
5 checks passed
@paulohtb6 paulohtb6 deleted the fix-default-flags branch November 18, 2025 01:53
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