Skip to content

Commit 4731814

Browse files
DeflaimunDeflaimun
authored
add rpk-debug-remote-bundle (#921)
1 parent 204da32 commit 4731814

File tree

7 files changed

+201
-1
lines changed

7 files changed

+201
-1
lines changed

‎modules/ROOT/nav.adoc‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,11 @@
331331
**** xref:reference:rpk/rpk-container/rpk-container-stop.adoc[]
332332
*** xref:reference:rpk/rpk-debug/rpk-debug.adoc[]
333333
**** xref:reference:rpk/rpk-debug/rpk-debug-bundle.adoc[]
334+
**** xref:reference:rpk/rpk-debug/rpk-debug-remote-bundle-cancel.adoc[]
335+
**** xref:reference:rpk/rpk-debug/rpk-debug-remote-bundle-download.adoc[]
336+
**** xref:reference:rpk/rpk-debug/rpk-debug-remote-bundle-start.adoc[]
337+
**** xref:reference:rpk/rpk-debug/rpk-debug-remote-bundle-status.adoc[]
338+
**** xref:reference:rpk/rpk-debug/rpk-debug-remote-bundle.adoc[]
334339
*** xref:reference:rpk/rpk-generate/rpk-generate.adoc[]
335340
**** xref:reference:rpk/rpk-generate/rpk-generate-app.adoc[]
336341
**** xref:reference:rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc[]

‎modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ rpk cluster storage list-mount --filter planned
5454
|===
5555
|*Value* |*Type* |*Description*
5656

57-
|-f, --filter |string |Filter the list of migrations by state. Only valid for text.
57+
|-f, --filter |string |Filter the list of migrations by state. Only valid for text (default `all`).
5858

5959
|--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`.
6060

‎modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-cancel.adoc‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
= rpk debug remote-bundle cancel
2+
3+
Cancel a remote bundle execution.
4+
5+
This command cancels the debug collection process in a remote cluster that you configured in flags, environment variables, or your rpk profile.
6+
7+
Use the flag `--job-id` to only cancel the debug bundle with the given job ID.
8+
9+
Use the flag `--no-confirm` to avoid the confirmation prompt.
10+
11+
== Usage
12+
13+
[,bash]
14+
----
15+
rpk debug remote-bundle cancel [flags]
16+
----
17+
18+
== Flags
19+
20+
[cols="1m,1a,2a"]
21+
|===
22+
|*Value* |*Type* |*Description*
23+
24+
|-h, --help |- |Help for cancel.
25+
26+
|--job-id |string |ID of the job to cancel the debug bundle.
27+
28+
|--no-confirm |- |Disable confirmation prompt.
29+
30+
|--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`.
31+
32+
|-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.
33+
34+
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
35+
36+
|-v, --verbose |- |Enable verbose logging.
37+
|===

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

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
= rpk debug remote-bundle download
2+
3+
Download a remote debug bundle.
4+
5+
This command downloads the debug collection process in a remote cluster that you configured in flags, environment variables, or your rpk profile.
6+
7+
Use the flag `--job-id` to only download the debug bundle with the given job ID.
8+
9+
Use the flag `--no-confirm` to avoid the confirmation prompt.
10+
11+
== Usage
12+
13+
[,bash]
14+
----
15+
rpk debug remote-bundle download [flags]
16+
----
17+
18+
== Flags
19+
20+
[cols="1m,1a,2a"]
21+
|===
22+
|*Value* |*Type* |*Description*
23+
24+
|-h, --help |- |Help for download.
25+
26+
|--job-id |string |ID of the job to download the debug bundle from.
27+
28+
|--no-confirm |- |Disable confirmation prompt.
29+
30+
|-o, --output |string |The file path where the debug file will be written (default `./<timestamp>-remote-bundle.zip`).
31+
32+
|--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`.
33+
34+
|-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.
35+
36+
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
37+
38+
|-v, --verbose |- |Enable verbose logging.
39+
|===

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

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
= rpk debug remote-bundle start
2+
3+
Start a remote debug bundle collection in your cluster.
4+
5+
This command starts the debug collection process in a remote cluster that you configured in flags, environment variables, or your rpk profile.
6+
7+
After starting the debug collection process, you can query the status with `rpk debug remote-bundle status`. When it completes, you can download it with `rpk debug remote-bundle download`.
8+
9+
Use the flag `--no-confirm` to avoid the confirmation prompt.
10+
11+
== Usage
12+
13+
[,bash]
14+
----
15+
rpk debug remote-bundle start [flags]
16+
----
17+
18+
== Flags
19+
20+
[cols="1m,1a,2a"]
21+
|===
22+
|*Value* |*Type* |*Description*
23+
24+
|--controller-logs-size-limit |string |The size limit of the controller logs that can be stored in the bundle. For example: 3MB, 1GiB (default `132MB`).
25+
26+
|--cpu-profiler-wait |duration |How long to collect samples for the CPU profiler. For example: `30s`, `1.5m`. Must be higher than `15s` (default `30s`).
27+
28+
|-h, --help |- |Help for start.
29+
30+
|--job-id |string |ID of the job to start debug bundle in.
31+
32+
|-l, --label-selector |stringArray |(K8s only) Comma-separated label selectors to filter your resources. For example: `<label>=<value>,<label>=<value>` (default `[app.kubernetes.io/name=redpanda]`).
33+
34+
|--logs-since |string |Include logs dated from specified date onward; (journalctl date format: `YYYY-MM-DD`, 'yesterday', or 'today'). See the journalctl documentation for more options (default `yesterday`).
35+
36+
|--logs-size-limit |string |Read the logs until the given size is reached. For example: `3MB`, `1GiB` (default `100MiB`).
37+
38+
|--logs-until |string |Include logs older than the specified date; (journalctl date format: `YYYY-MM-DD`, `yesterday`, or `today`). See the journalctl documentation for more options.
39+
40+
|--metrics-interval |duration |Interval between metrics snapshots. For example: `30s`, `1.5m` (default `10s`).
41+
42+
|--metrics-samples |int |Number of metrics samples to take (at the interval of `--metrics-interval` flag). Must be >= `2` (default `2`).
43+
44+
|-n, --namespace |string |(K8s only) The namespace to use to collect the resources from (default `redpanda`).
45+
46+
|--no-confirm |- |Disable confirmation prompt.
47+
48+
|-p, --partition |stringArray |Comma-separated partition IDs. When provided, `rpk` saves extra Admin API requests for those partitions. See the help for extended usage.
49+
50+
|--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`.
51+
52+
|-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.
53+
54+
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
55+
56+
|-v, --verbose |- |Enable verbose logging.
57+
|===

‎modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-status.adoc‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
= rpk debug remote-bundle status
2+
3+
Get the status of the current debug bundle process.
4+
5+
This command prints the status of the debug bundle process in a remote cluster that you configured in flags, environment variables, or your rpk profile.
6+
7+
When the process completes, you can download it with `rpk debug remote-bundle download`.
8+
9+
== Usage
10+
11+
[,bash]
12+
----
13+
rpk debug remote-bundle status [flags]
14+
----
15+
16+
== Flags
17+
18+
[cols="1m,1a,2a"]
19+
|===
20+
|*Value* |*Type* |*Description*
21+
22+
|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`) (default `text`).
23+
24+
|-h, --help |- |Help for status.
25+
26+
|--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`.
27+
28+
|-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.
29+
30+
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
31+
32+
|-v, --verbose |- |Enable verbose logging.
33+
|===

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
= rpk debug remote-bundle
2+
3+
Create a debug bundle from a remote cluster.
4+
5+
The remote-bundle commands can be used to get a debug bundle of your remote cluster configured in flags, environment variables, or your rpk profile.
6+
7+
== Usage
8+
9+
[,bash]
10+
----
11+
rpk debug remote-bundle [command] [flags]
12+
----
13+
14+
== Flags
15+
16+
[cols="1m,1a,2a"]
17+
|===
18+
|*Value* |*Type* |*Description*
19+
20+
|-h, --help |- |Help for remote-bundle.
21+
22+
|--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`.
23+
24+
|-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.
25+
26+
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
27+
28+
|-v, --verbose |- |Enable verbose logging.
29+
|===

0 commit comments

Comments
 (0)