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

Jump to bottom

Rpk self test #599

Merged
merged 7 commits into from
Jul 18, 2024
Merged

Rpk self test #599

merged 7 commits into from
Jul 18, 2024

Conversation

Deflaimun
Copy link
Contributor

@Deflaimun Deflaimun commented Jul 11, 2024 •
edited
Loading

Description

Resolves https://github.com/redpanda-data/documentation-private/issues/2505
Review deadline: July 15

Page previews

Checks

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

@Deflaimun Deflaimun requested a review from a team as a code owner July 11, 2024 19:06
@netlify Netlify
Copy link

netlify bot commented Jul 11, 2024 •
edited
Loading

✅ Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 66e5310
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/66995ee1d184df0008c291b4
😎 Deploy Preview https://deploy-preview-599--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.

@Deflaimun Deflaimun changed the base branch from main to v-WIP/24.2 July 11, 2024 19:07
Feediver1
Feediver1 reviewed Jul 12, 2024
View reviewed changes
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc Outdated
** Latency test: 1024-bit object.
** Depending on cluster read/write permissions (xref:reference:properties/object-storage-properties.adoc#cloud_storage_enable_remote_read[`cloud_storage_enable_remote_read`], xref:reference:properties/object-storage-properties.adoc#cloud_storage_enable_remote_write[`cloud_storage_enable_remote_write`]), a series of cloud storage operations are performed:
*** Upload an object to an object storage.
*** List objects in the object storage.
*** Download an object from the object storage.
*** Delete the original object from the object storage, if it was uploaded.

This command immediately returns on success, and the tests run asynchronously. The
user polls for results with the xref:./rpk-cluster-self-test-status.adoc[rpk cluster self-test status]
This command asks for users confirmation (unless when the flag `--no-confirm` is used.), then returns with a test identifier ID, and starts to run the tests run. To see the status and the results pool with the xref:./rpk-cluster-self-test-status.adoc[rpk cluster self-test status]
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
This command asks for users confirmation (unless when the flag `--no-confirm` is used.), then returns with a test identifier ID, and starts to run the tests run. To see the status and the results pool with the xref:./rpk-cluster-self-test-status.adoc[rpk cluster self-test status]
This command prompts users for confirmation (unless the flag `--no-confirm` is specified), then returns a test identifier ID, and runs the tests. To view the status and the results pool, run xref:./rpk-cluster-self-test-status.adoc[rpk cluster self-test status].

Copy link
Contributor Author

@Deflaimun Deflaimun Jul 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
This command asks for users confirmation (unless when the flag `--no-confirm` is used.), then returns with a test identifier ID, and starts to run the tests run. To see the status and the results pool with the xref:./rpk-cluster-self-test-status.adoc[rpk cluster self-test status]
This command prompts users for confirmation (unless the flag `--no-confirm` is specified), then returns a test identifier ID, and runs the tests.
To view the test status, poll xref:./rpk-cluster-self-test-status.adoc[rpk cluster self-test status]. Once the tests end, the cached results will be available with `rpk cluster self-test status`.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Rewrote to better convey the actual implementation. What happens is that you run the test with rpk cluster self-test start then the command asks for confirmation. After confirming, it starts and the command stops since the tests run async. To check the status, we have to poll the status with rpk cluster self-test status .

When the tests finish, the cached results will be displayed on the same command.

@Deflaimun
Copy link
Contributor Author

There's a product issue with the latest output. Waiting for the fix to include the new example output.

@kbatuigas kbatuigas mentioned this pull request Jul 16, 2024
Merged
4 tasks
Deflaimun and others added 4 commits July 17, 2024 12:43
@Deflaimun
improves rpk-self-test
049509d
@Deflaimun @Feediver1
Update modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-…
39af905 
…start.adoc

Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
@Deflaimun @Feediver1
Apply suggestions from code review
3f2e045 
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
@Deflaimun
update tests
83ba267
@Deflaimun
Copy link
Contributor Author

Updated with the fix

kbatuigas
kbatuigas approved these changes Jul 18, 2024
View reviewed changes
Copy link
Contributor

@kbatuigas kbatuigas left a comment

Choose a reason for hiding this comment

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

A few comments but no blockers

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-status.adoc Outdated
@@ -1,15 +1,37 @@
= rpk cluster self-test status
:description: Reference for the 'rpk cluster self-test status' command. Queries the status of the currently running or last completed self-test run.

Queries the status of the currently running or last completed self-test run. Returns the status of the currently running or last completed self-test run.
Queries the status of the currently running or last completed self-test run. Returns the status of the currently running or the results of the last completed self-test.
Copy link
Contributor

Choose a reason for hiding this comment

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

Are the two sentences redundant? Could we do with just one (the second sentence "Returns the status...")?

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc Outdated
@@ -3,6 +3,8 @@

Starts one or more benchmark tests on one or more nodes of the cluster.

NOTE: Redpanda self-test runs benchmarks of disk and network hardware that consume significant system resources. Do not start self-test if large workloads are already running on the system.
Copy link
Contributor

Choose a reason for hiding this comment

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

Correct me if my understanding is wrong -- isn't the self test itself the one that consumes significant resources? This makes it sound like it's the disk/network hardware

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Rephrased to make it more simple, and removed the specific tests to make it a bit more future proof.

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-status.adoc Outdated Show resolved Hide resolved
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-status.adoc Outdated Show resolved Hide resolved
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-status.adoc Outdated Show resolved Hide resolved
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-status.adoc Outdated Show resolved Hide resolved
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-status.adoc Outdated Show resolved Hide resolved
@Deflaimun @kbatuigas
Apply suggestions from code review
b812dea 
Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com>
@Deflaimun Deflaimun merged commit 0d37799 into v-WIP/24.2 Jul 18, 2024
4 of 5 checks passed
@Deflaimun Deflaimun deleted the rpk-self-test branch July 18, 2024 18:30
WillemKauf added a commit to WillemKauf/redpanda that referenced this pull request Jul 18, 2024
@WillemKauf
rpk/cluster: update rpk self-test docs.
5732466 
Updated with changes made in redpanda-docs here:
redpanda-data/docs#599
WillemKauf added a commit to WillemKauf/redpanda that referenced this pull request Jul 18, 2024
@WillemKauf
rpk/cluster: update rpk self-test docs
38c2e56 
Updated with changes made in redpanda-docs here:
redpanda-data/docs#599
@WillemKauf WillemKauf mentioned this pull request Jul 18, 2024
Merged
7 tasks
Deflaimun added a commit that referenced this pull request Jul 29, 2024
@Deflaimun @Feediver1 @kbatuigas
Rpk self test (#599)
f3dc137 
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com>
Deflaimun added a commit that referenced this pull request Jul 31, 2024
@Deflaimun @Feediver1 @kbatuigas
Rpk self test (#599)
9e2794d 
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Feediver1 Feediver1 Feediver1 left review comments

@WillemKauf WillemKauf WillemKauf left review comments

@kbatuigas kbatuigas kbatuigas approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Deflaimun @WillemKauf @kbatuigas @Feediver1