Skip to content
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

Add links to self-test instructions from deployment guides #321

Merged
merged 1 commit into from
Feb 29, 2024
Merged

Add links to self-test instructions from deployment guides #321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 2 additions & 0 deletions ...loy/pages/deployment-option/self-hosted/kubernetes/k-production-deployment.adoc
View file
Open in desktop
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
2 changes: 2 additions & 0 deletions ...eploy/pages/deployment-option/self-hosted/manual/production/dev-deployment.adoc
View file
Open in desktop
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
2 changes: 2 additions & 0 deletions ...ages/deployment-option/self-hosted/manual/production/production-deployment.adoc
View file
Open in desktop
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
View file
Open in desktop
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].
1 change: 1 addition & 0 deletions modules/manage/pages/cluster-maintenance/cluster-diagnostics.adoc
View file
Open in desktop
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