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.

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

Updates to RP self test #604

Merged
merged 31 commits into from
Jul 29, 2024
Merged

Conversation

kbatuigas
Copy link
Contributor

@kbatuigas kbatuigas commented Jul 16, 2024

Description

Resolves https://github.com/redpanda-data/documentation-private/issues/2426
Resolves https://github.com/redpanda-data/documentation-private/issues/2424
Review deadline: 24 July 2024

Add cloud storage test to cluster diagnostics doc
Related PR: #599 (update rpk reference)

Page previews

Cluster Diagnostics
rpk self test status -- add single sourced content, change to single broker example
What's New

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

Deflaimun and others added 15 commits June 19, 2024 19:18
Co-authored-by: Paulo Borges <paulohtb@hotmail.com>
Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com>
Co-authored-by: Michele Cyran <michele@redpanda.com>
Co-authored-by: Mike Boquard <michael@redpanda.com>
Co-authored-by: Michele Cyran <michele@redpanda.com>
Co-authored-by: tris0laris <57298792+tris0laris@users.noreply.github.com>
Co-authored-by: Paulo Borges <paulohtb@hotmail.com>
Co-authored-by: Dave Voutila <voutilad@gmail.com>
Co-authored-by: Angela Simms <102690377+asimms41@users.noreply.github.com>
Co-authored-by: Andrew Hsu <xuzuan@gmail.com>
Co-authored-by: Oren Leiman <mumblemumble777@gmail.com>
Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com>
Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Copy link

netlify bot commented Jul 16, 2024

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 21aefb6
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/66a40f3298463a000848fc42
😎 Deploy Preview https://deploy-preview-604--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@kbatuigas kbatuigas force-pushed the rpk-self-test-cluster-diagnostics branch from 4aa4a3e to f98a441 Compare July 22, 2024 16:28
@kbatuigas kbatuigas force-pushed the rpk-self-test-cluster-diagnostics branch from f98a441 to cb6961e Compare July 22, 2024 17:25
@kbatuigas kbatuigas marked this pull request as ready for review July 22, 2024 20:30
@kbatuigas kbatuigas requested a review from a team as a code owner July 22, 2024 20:30
@kbatuigas kbatuigas requested a review from Deflaimun July 22, 2024 20:30
Copy link
Member

@travisdowns travisdowns left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks Kat!

@@ -11,7 +11,24 @@ When anomalous behavior arises in a cluster and you're trying to figure out whet

Self-test runs a set of benchmarks to determine the maximum performance of a machine's disks and network connections. For disks, it runs throughput and latency tests by performing concurrent sequential operations. For networks, it selects unique pairs of Redpanda nodes as client/server pairs, then it runs throughput tests between them. Self-test runs each benchmark for a configurable duration, and it returns IOPS, throughput, and latency metrics.

=== Self-test command examples
== Cloud storage tests
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
== Cloud storage tests
== Object storage tests


If you use xref:manage:tiered-storage.adoc[Tiered Storage], run self-test to verify that you have configured your cloud storage accounts correctly.

Self-test performs the following tests to validate cloud storage configuration:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Self-test performs the following tests to validate cloud storage configuration:
Self-test performs the following tests to validate object storage configuration:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kbatuigas I think all instances of "cloud storage" here should be "object storage", similar to our Tiered Storage doc page. And I think "bucket" should be "bucket or container".

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Deflaimun
Copy link
Contributor

@micheleRP We kept some references as "Cloud storage" because the code itself references it as cloud storage. The test type is called cloud , the errors say "cloud storage is not X", and the test name also says cloud storage.

Maybe it's something that we can keep it like that, and fix it in the future when the product moves to "object storage"

. Delete the uploaded object from the bucket.
. Upload and then delete multiple objects (random buffers) at once from the bucket.

See the xref:reference:rpk/rpk-cluster/rpk-cluster-self-test.adoc[`rpk cluster self-test`] reference for cloud storage test details.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to test start instead.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@WillemKauf @Lazin
surprised we don't test the throttling behavior based on bucket prefixes. Is that something we can easily test?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mattschumpert

Currently the cloud storage self-test is more intended for configuration verification, rather than being a true benchmark/stress test.

We can always expand upon this in the future to cover more rigorous workloads.

@kbatuigas kbatuigas requested review from Deflaimun and micheleRP July 25, 2024 16:36
@kbatuigas kbatuigas requested a review from micheleRP July 26, 2024 15:02
@kbatuigas kbatuigas force-pushed the rpk-self-test-cluster-diagnostics branch from abf93b0 to b616eea Compare July 26, 2024 16:22
Co-authored-by: Michele Cyran <michele@redpanda.com>
Copy link
Contributor

@micheleRP micheleRP left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@kbatuigas kbatuigas merged commit 1ba762c into v-WIP/24.2 Jul 29, 2024
5 checks passed
Deflaimun added a commit that referenced this pull request Jul 29, 2024
Co-authored-by: Paulo Borges <paulohtb@hotmail.com>
Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com>
Co-authored-by: Michele Cyran <michele@redpanda.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Co-authored-by: Mike Boquard <michael@redpanda.com>
Co-authored-by: tris0laris <57298792+tris0laris@users.noreply.github.com>
Co-authored-by: Dave Voutila <voutilad@gmail.com>
Co-authored-by: Angela Simms <102690377+asimms41@users.noreply.github.com>
Co-authored-by: Andrew Hsu <xuzuan@gmail.com>
Co-authored-by: Oren Leiman <mumblemumble777@gmail.com>
Deflaimun added a commit that referenced this pull request Jul 31, 2024
Co-authored-by: Paulo Borges <paulohtb@hotmail.com>
Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com>
Co-authored-by: Michele Cyran <michele@redpanda.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Co-authored-by: Mike Boquard <michael@redpanda.com>
Co-authored-by: tris0laris <57298792+tris0laris@users.noreply.github.com>
Co-authored-by: Dave Voutila <voutilad@gmail.com>
Co-authored-by: Angela Simms <102690377+asimms41@users.noreply.github.com>
Co-authored-by: Andrew Hsu <xuzuan@gmail.com>
Co-authored-by: Oren Leiman <mumblemumble777@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants