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

Add custom parameters benchmark page #8495

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add custom parameters benchmark page #8495

wants to merge 5 commits into from

Conversation

Naarcha-AWS
Copy link
Collaborator

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@Naarcha-AWS Naarcha-AWS added 3 - Tech review PR: Tech review in progress backport 2.17 Backport for version 2.17 labels Oct 10, 2024
@Naarcha-AWS Naarcha-AWS self-assigned this Oct 10, 2024
Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@Naarcha-AWS Naarcha-AWS changed the title Add custom parameters page Add custom parameters benchmark page Oct 10, 2024
Copy link
Contributor

@gkamat gkamat left a comment

Choose a reason for hiding this comment

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

The sections for Parameter Sources and Custom Runners should be completely separate, since they pertain to entirely different items. Also, the examples should be re-written, to make them easier to understand.

We can provide new examples, but for now, the existing text should suffice. Separating the sections can perhaps be done as part of the current PR.

@Naarcha-AWS
Copy link
Collaborator Author

@gkamat: I separated both files. Let me know what additional modifications you would like me to make.


# Adding custom runners

**Runners** are operation types performed on an OpenSearch cluster.
Copy link
Collaborator Author

@Naarcha-AWS Naarcha-AWS Oct 25, 2024

Choose a reason for hiding this comment

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

For adding support for an operation that doesn't exist in OSB already.


# Adding custom parameter sources

A **parameter source** is a source outside of OpenSearch Benchmark that provides parameters to an operation.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
A **parameter source** is a source outside of OpenSearch Benchmark that provides parameters to an operation.
A **parameter source** is a source outside of OpenSearch Benchmark that provides parameters to an operation. You can add parameters to an existing operation in OpenSearch Benchmark or add custom parameters to a [runner]({{site.url}}{{site.baseurl}}/benchmark/user-guide/optimizing-benchmarks/custom-runners/).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Tech review PR: Tech review in progress backport 2.17 Backport for version 2.17
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants