Skip to content

Commit b14bc58

Browse files
paulohtb6kbatuigas
andauthored
docs: update rpk v25.1.9 (#1241)
Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com>
1 parent ddae5f1 commit b14bc58

5 files changed

Lines changed: 29 additions & 19 deletions

File tree

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ rpk cluster self-test start [flags]
4343

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

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

4848
|--disk-duration-ms |uint | The duration in milliseconds of individual
4949
disk test runs (default `30000`).

modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ time. Default: `12s`.
119119
|--metrics-samples |int |Number of metrics samples to take (at the interval of `--metrics-interval`). Must be higher or equals 2 (default 2).
120120

121121
|-n, --namespace |string |The Kubernetes namespace in which the Redpanda
122-
cluster is running. Default: `redpanda` +
122+
cluster is running. +
123123
*Kubernetes only*.
124124

125125
|-o, --output |string |The file path where the debug file will be

modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-download.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ rpk debug remote-bundle download [flags]
2929

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

32+
|--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[].
33+
3234
|--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`.
3335

3436
|-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.

modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-start.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ rpk debug remote-bundle start [flags]
4141

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

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

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

modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission-status.adoc

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ partition size in a human-readable format.
1313
$ rpk redpanda admin brokers decommission-status 4
1414
DECOMMISSION PROGRESS
1515
=====================
16-
NAMESPACE-TOPIC PARTITION MOVING-TO COMPLETION-% PARTITION-SIZE
17-
kafka/test 0 3 9 1699470920
18-
kafka/test 4 3 0 1614258779
19-
kafka/test2 3 3 3 2722706514
20-
kafka/test2 4 3 4 2945518089
21-
kafka_internal/id_allocator 0 3 0 3562
16+
PARTITION MOVING-TO COMPLETION-% PARTITION-SIZE
17+
kafka/test/0 3 9 1699470920
18+
kafka/test/4 3 0 1614258779
19+
kafka/test2/3 3 3 2722706514
20+
kafka/test2/4 3 4 2945518089
21+
kafka_internal/id_allocator/0 3 0 3562
2222
----
2323

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

38-
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.
38+
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:
39+
40+
* Insufficient broker storage space to allocate a partition
41+
* Brokers that cannot satisfy rack constraints
3942
4043
[,bash]
4144
----
42-
ALLOCATION FAILURES
43-
==================
44-
kafka/foo/2
45-
kafka/test/0
45+
REALLOCATION FAILURE DETAILS
46+
47+
============================
48+
49+
PARTITION REASON
50+
51+
kafka/foo/1 Missing partition size information, all replicas may be offline
52+
53+
kafka/foo/7 Missing partition size information, all replicas may be offline
4654
----
4755
4856

0 commit comments

Comments
 (0)