Skip to content

docs: update rpk v25.1.9 #1241

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jul 29, 2025
Merged

docs: update rpk v25.1.9 #1241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b554b6
docs: update rpk v25.1.9
paulohtb6 Jul 28, 2025
5533f3d
Apply suggestions from code review
paulohtb6 Jul 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ rpk cluster self-test start [flags]

|--cloud-backoff-ms |uint | The backoff in milliseconds for a cloud storage request (default `100`).

|--cloud-timeout-ms |uint | The timeout in milliseconds for a cloud storage request (default `5000`).
|--cloud-timeout-ms |uint | The timeout in milliseconds for a cloud storage request (default `10000`).

|--disk-duration-ms |uint | The duration in milliseconds of individual
disk test runs (default `30000`).
Expand Down
2 changes: 1 addition & 1 deletion modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ time. Default: `12s`.
|--metrics-samples |int |Number of metrics samples to take (at the interval of `--metrics-interval`). Must be higher or equals 2 (default 2).

|-n, --namespace |string |The Kubernetes namespace in which the Redpanda
cluster is running. Default: `redpanda` +
cluster is running. +
Copy link
Collaborator Author

@paulohtb6 paulohtb6 Jul 28, 2025

Choose a reason for hiding this comment

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

@r-vasquez we captured on help text that this default value has been removed. Is this correct?

Copy link
Contributor

@r-vasquez r-vasquez Jul 29, 2025

Choose a reason for hiding this comment

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

That's correct 👍

*Kubernetes only*.

|-o, --output |string |The file path where the debug file will be
Expand Down
2 changes: 2 additions & 0 deletions modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-download.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ rpk debug remote-bundle download [flags]

|-o, --output |string |The file path where the debug file will be written (default `./<timestamp>-remote-bundle.zip`).

|--upload-url |string |Upload URL provided by Redpanda Support. When specified, uploads the bundle to Redpanda in addition to creating a local copy. For details, see xref:troubleshoot:debug-bundle/generate/kubernetes.adoc#debug-bundle[].

|--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`.

|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail.
Expand Down
2 changes: 1 addition & 1 deletion modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-start.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ rpk debug remote-bundle start [flags]

|--metrics-samples |int |Number of metrics samples to take (at the interval of `--metrics-interval` flag). Must be >= `2` (default `2`).

|-n, --namespace |string |(K8s only) The namespace to use to collect the resources from (default `redpanda`).
|-n, --namespace |string |(K8s only) The namespace to use to collect data from the resources.

|--no-confirm |- |Disable confirmation prompt.

Expand Down
40 changes: 24 additions & 16 deletions ...ence/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission-status.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ partition size in a human-readable format.
$ rpk redpanda admin brokers decommission-status 4
DECOMMISSION PROGRESS
=====================
NAMESPACE-TOPIC PARTITION MOVING-TO COMPLETION-% PARTITION-SIZE
kafka/test 0 3 9 1699470920
kafka/test 4 3 0 1614258779
kafka/test2 3 3 3 2722706514
kafka/test2 4 3 4 2945518089
kafka_internal/id_allocator 0 3 0 3562
PARTITION MOVING-TO COMPLETION-% PARTITION-SIZE
kafka/test/0 3 9 1699470920
kafka/test/4 3 0 1614258779
kafka/test2/3 3 3 2722706514
kafka/test2/4 3 4 2945518089
kafka_internal/id_allocator/0 3 0 3562
----

Using --detailed / -d, it additionally prints granular reports.
Expand All @@ -28,21 +28,29 @@ Using --detailed / -d, it additionally prints granular reports.
$ rpk redpanda admin brokers decommission-status 4 -d
DECOMMISSION PROGRESS
=====================
NAMESPACE-TOPIC PARTITION MOVING-TO COMPLETION-% PARTITION-SIZE BYTES-MOVED BYTES-REMAINING
kafka/test 0 3 13 1731773243 228114727 1503658516
kafka/test 4 3 1 1645952961 18752660 1627200301
kafka/test2 3 3 5 2752632301 140975805 2611656496
kafka/test2 4 3 6 2975443783 181581219 2793862564
PARTITION MOVING-TO COMPLETION-% PARTITION-SIZE BYTES-MOVED BYTES-REMAINING
kafka/test/0 3 13 1731773243 228114727 1503658516
kafka/test/4 3 1 1645952961 18752660 1627200301
kafka/test2/3 3 5 2752632301 140975805 2611656496
kafka/test2/4 3 6 2975443783 181581219 2793862564
----

If for some reason a partition cannot be moved, the command reports the problematic partition in the 'ALLOCATION FAILURES' section and the decommission fails. A typical failure scenario would be when no node has enough space to allocate a partition, or cannot satisfy rack constraints.
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:

* Insufficient broker storage space to allocate a partition
* Brokers that cannot satisfy rack constraints

[,bash]
----
ALLOCATION FAILURES
==================
kafka/foo/2
kafka/test/0
REALLOCATION FAILURE DETAILS

============================

PARTITION REASON

kafka/foo/1 Missing partition size information, all replicas may be offline

kafka/foo/7 Missing partition size information, all replicas may be offline
----


Expand Down