docs: update rpk v25.1.9 #1241
docs: update rpk v25.1.9 #1241
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThis set of changes updates documentation for several Sequence Diagram(s)sequenceDiagram
participant User
participant rpk CLI
participant Cloud Storage
participant Upload Destination
User->>rpk CLI: rpk debug remote-bundle download --upload-url=<url>
rpk CLI->>Cloud Storage: Download debug bundle
Cloud Storage-->>rpk CLI: Bundle data
rpk CLI->>User: Save bundle locally
alt --upload-url specified
rpk CLI->>Upload Destination: Upload bundle to <url>
end
rpk CLI->>User: Notify completion
Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Suggested reviewers
✨ Finishing Touches🧪 Generate 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-start.adoc (1)
44-45: Clarify wording and verify removed default
- “The namespace to use to collect the resources from” is a bit clunky. Consider “Namespace from which to collect resources.”
- The previous docs showed a default of
redpanda. If the CLI no longer sets a default, this update is correct; otherwise the documentation now diverges from behaviour.Please run
rpk debug remote-bundle start --help | grep -- '--namespace'and confirm that the tool indeed has no default value.modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-download.adoc (1)
32-33: Flag added – add cross-reference to upload guidance
--upload-urlis documented here, but users may also look at the earlier start command for upload instructions. Consider adding a short “See alsorpk debug bundle --upload-urlfor details” note to help discoverability.modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission-status.adoc (3)
8-10: Clarify the new unified PARTITION column in the introductory sentenceNow that the output collapses namespace, topic, and partition number into a single
PARTITIONcolumn, consider mentioning this explicitly so readers immediately understand the new format.Example diff:
-When a node is in the process of being decommissioned, this command reports the decommissioning progress as follows, where PARTITION-SIZE is in bytes. +When a node is being decommissioned, the command shows progress as follows. +The `PARTITION` column combines namespace, topic, and partition number (for example `kafka/test/0`). +`PARTITION-SIZE` is in bytes.
38-42: Tighten wording & make decommission failure behaviour explicitThe current sentence is slightly long and uses “for some reason”. Rephrase for conciseness and to state that the command exits with failure.
-If a partition cannot be moved for some reason, the command reports the problematic partition in the 'REALLOCATION FAILURE DETAILS' or 'ALLOCATION FAILURES' section and decommission fails. Typical scenarios for failure include: +If a partition cannot be moved, the command lists it under **REALLOCATION FAILURE DETAILS** (or **ALLOCATION FAILURES**) and the decommission operation fails. Typical failure scenarios include:
45-54: Sample failure block reflects updated headingThe new REALLOCATION FAILURE DETAILS section correctly mirrors the wording used above. Consider shortening the underline delimiter so its length matches the heading (purely cosmetic).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc(1 hunks)modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc(1 hunks)modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-download.adoc(1 hunks)modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-start.adoc(1 hunks)modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission-status.adoc(2 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: Feediver1
PR: redpanda-data/docs#1153
File: antora.yml:3-5
Timestamp: 2025-07-14T19:28:43.296Z
Learning: In Redpanda docs, during beta releases, the version metadata may intentionally show inconsistencies where the header displays the beta version (e.g., 25.2 Beta) while internal attributes like full-version, latest-redpanda-tag, operator-beta-tag still reference the stable version (e.g., 25.1). This is resolved during the GA merge process when all version references are synchronized.
modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-start.adoc (1)
Learnt from: kbatuigas
PR: #1113
File: modules/manage/partials/iceberg/use-iceberg-catalogs.adoc:100-107
Timestamp: 2025-05-07T01:06:00.937Z
Learning: In AsciiDoc documentation for Redpanda, the syntax + and -- around content blocks within a [tabs] section are valid AsciiDoc formatting elements for tabbed content. The + after a tab name (like rpk::) indicates that the following block belongs to that tab, and the -- markers enclose the content for that tab. These are not diff artifacts and should not be removed.
modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc (1)
Learnt from: kbatuigas
PR: #1113
File: modules/manage/partials/iceberg/use-iceberg-catalogs.adoc:100-107
Timestamp: 2025-05-07T01:06:00.937Z
Learning: In AsciiDoc documentation for Redpanda, the syntax + and -- around content blocks within a [tabs] section are valid AsciiDoc formatting elements for tabbed content. The + after a tab name (like rpk::) indicates that the following block belongs to that tab, and the -- markers enclose the content for that tab. These are not diff artifacts and should not be removed.
modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission-status.adoc (2)
Learnt from: kbatuigas
PR: #1113
File: modules/manage/partials/iceberg/use-iceberg-catalogs.adoc:100-107
Timestamp: 2025-05-07T01:06:00.937Z
Learning: In AsciiDoc documentation for Redpanda, the syntax + and -- around content blocks within a [tabs] section are valid AsciiDoc formatting elements for tabbed content. The + after a tab name (like rpk::) indicates that the following block belongs to that tab, and the -- markers enclose the content for that tab. These are not diff artifacts and should not be removed.
Learnt from: Feediver1
PR: #1153
File: modules/reference/pages/properties/topic-properties.adoc:45-50
Timestamp: 2025-07-16T19:33:20.420Z
Learning: In the Redpanda documentation, topic property cross-references like <<max.compaction.lag.ms>> and <<min.compaction.lag.ms>> require corresponding property definition sections with anchors like [[maxcompactionlagms]] and [[mincompactionlagms]] to prevent broken links.
⏰ 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 (1)
121-123: LGTM – AsciiDoc multi-line cell is correctThe split description using
+follows the Redpanda AsciiDoc tabular style. No further action needed.modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission-status.adoc (2)
16-21: Column consolidation looks goodThe switch to a single
PARTITIONcolumn makes the sample output easier to scan and matches currentrpkbehaviour. No issues spotted.
31-35: Detailed view sample output aligns with CLI changesThe detailed view reflects the same column consolidation and adds the extra byte-tracking columns. Output order and spacing are accurate.
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc (1)
46-46: Confirm--cloud-timeout-msflag implementation and defaultI wasn’t able to locate any definition of
--cloud-timeout-msin the Go sources despite searching for common naming patterns. Please verify that in rpk v25.1.9:
- The Cobra command (e.g. in
cmd/rpk/cluster/self_test_start.go) registers a--cloud-timeout-msflag.- Its default value is set to
10000(10 s).You can also run
rpk cluster self-test start --helpto confirm the displayed default matches the docs.
|
|
||
| |-n, --namespace |string |The Kubernetes namespace in which the Redpanda | ||
| cluster is running. Default: `redpanda` + | ||
| cluster is running. + |
There was a problem hiding this comment.
@r-vasquez we captured on help text that this default value has been removed. Is this correct?
modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-download.adoc
Outdated
Show resolved
Hide resolved
kbatuigas
left a comment
kbatuigas
left a comment
There was a problem hiding this comment.
No blockers but made a couple of suggestions
modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-start.adoc
Outdated
Show resolved
Hide resolved
modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission-status.adoc
Outdated
Show resolved
Hide resolved
Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com>
Description
Resolves https://redpandadata.atlassian.net/browse/
Review deadline: July 29th
Page previews
Checks