Skip to content

Commit 45401a2

Browse files
committed
Apply suggestions from review
1 parent d61b3c6 commit 45401a2

File tree

2 files changed

+17
-3
lines changed

2 files changed

+17
-3
lines changed

modules/troubleshoot/partials/debug-bundle/configure.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
NOTE: These configuration options apply only when you trigger a debug bundle remotely. For example using Redpanda Console, `rpk debug remote-bundle`, or the Admin API. They do not apply to the `rpk debug bundle` command.
2+
13
[[remove]]
24
== Automatically remove debug bundles
35

modules/troubleshoot/partials/debug-bundle/generate-rpk.adoc

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -168,8 +168,6 @@ ifndef::env-kubernetes[]
168168
rm /var/lib/redpanda/<bundle-name>.zip
169169
endif::[]
170170
----
171-
+
172-
TIP: To avoid manually deleting debug bundles, you can configure the xref:reference:properties/cluster-properties.adoc#debug_bundle_auto_removal_seconds[`debug_bundle_auto_removal_seconds`] property to automatically remove them after a period of time. See xref:{link-configure-bundles}#remove[Automatically remove debug bundles].
173171

174172
When you've finished troubleshooting, remove the debug bundle from your host machine:
175173

@@ -182,7 +180,21 @@ rm -r debug-bundle
182180

183181
The xref:reference:rpk/rpk-debug/rpk-debug-remote-bundle.adoc[`rpk debug remote-bundle`] command allows you to remotely generate a consolidated debug bundle from all brokers in your cluster. This command is useful when you do not want to log into each broker's node individually using `rpk debug bundle`.
184182

185-
. Create an xref:get-started:config-rpk-profile.adoc[`rpk` profile] to connect to your cluster. Include all brokers you want to collect data from in the `admin.hosts` configuration. For example:
183+
. Create an xref:get-started:config-rpk-profile.adoc[`rpk` profile] to connect to your cluster. Include all brokers you want to collect data from in the `admin.hosts` configuration.
184+
+
185+
[,bash]
186+
----
187+
rpk profile create <profile-name> --set admin.hosts=<brokers>
188+
----
189+
190+
. Check the configured addresses in your profile:
191+
+
192+
[,bash]
193+
----
194+
rpk profile print
195+
----
196+
+
197+
Example output:
186198
+
187199
.`profile.yml`
188200
```yaml

0 commit comments

Comments
 (0)