-
Notifications
You must be signed in to change notification settings - Fork 47
rpk: fix default flags for rpk debug bundle #1453
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis pull request updates the documentation for the Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes
Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
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. Comment |
There was a problem hiding this 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
--namespaceflag 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.
📒 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-untillimitation in Kubernetes environments.The addition of the "Not supported in Kubernetes" note appropriately highlights that this flag (which uses
journalctlformat) only applies to bare-metal deployments.
113-117: Updated--metrics-intervaldefault 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 as132MB, implementation default is"132MB"✓--metrics-interval: documented as10s, implementation default is10*time.Second✓
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