Skip to content

Commit

Permalink
Add links to self-test instructions from deployment guides (#321)
Browse files Browse the repository at this point in the history
  • Loading branch information
JakeSCahill authored and kbatuigas committed Mar 14, 2024
1 parent c695237 commit cec9232
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -652,6 +652,8 @@ To find the versions that are installed on your machine, run the following:
helm list --namespace <namespace>
----

include::deploy:partial$self-test.adoc[leveloffset=+1]

include::deploy:partial$kubernetes/default-components.adoc[leveloffset=+1]

include::deploy:partial$kubernetes/guides/uninstall.adoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,8 @@ To create a topic:
rpk topic create panda
----

include::deploy:partial$self-test.adoc[leveloffset=+1]

== Next steps

* If clients connect from a different subnet, see xref:manage:security/listener-configuration.adoc[Configure Listeners].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,8 @@ If you choose to assign broker IDs, make sure to use a fresh `node_id` each time

CAUTION: Never reuse broker IDs, even for brokers that have been decommissioned and restarted empty. Doing so can result in an inconsistent state.

include::deploy:partial$self-test.adoc[leveloffset=+1]

=== Upgrade considerations

Deployment automation should place each broker into maintenance mode and wait for it to drain leadership before restarting it with a newer version of Redpanda. For more information, see xref:manage:cluster-maintenance/rolling-upgrade.adoc[Upgrade].
Expand Down
5 changes: 5 additions & 0 deletions modules/deploy/partials/self-test.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= Perform a self test

To understand the performance capabilities of your Redpanda cluster, Redpanda offers built-in self-test features that evaluate the performance of both disk and network operations.

For more information, see xref:manage:cluster-maintenance/cluster-diagnostics.adoc#self-test[Disk and network self-test benchmarks].
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

This topic provides guides for using tools and tests to help diagnose and debug a Redpanda cluster.

[[self-test]]
== Disk and network self-test benchmarks

When anomalous behavior arises in a cluster and you're trying to figure out whether it's caused by faulty hardware (disks, NICs) of a cluster's machines, run xref:reference:rpk/rpk-cluster/rpk-cluster-self-test.adoc[rpk cluster self-test] (self-test) to characterize their performance and compare it with their expected, vendor-specified performance.
Expand Down

0 comments on commit cec9232

Please sign in to comment.