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 Benchmark 2.0 #7888

Closed
wants to merge 4 commits into from
Closed

Add Benchmark 2.0 #7888

wants to merge 4 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.

Copy link

github-actions bot commented Aug 1, 2024

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 added 3 - Tech review PR: Tech review in progress backport 2.15 labels Aug 1, 2024
@@ -142,21 +143,21 @@ The following options help customize how OpenSearch Benchmark provisions OpenSea

### Workload

The following options determine which workload is used to run the test:
The following options determine which workload is used during the run:
Copy link
Contributor

Choose a reason for hiding this comment

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

I think during the test sounds more natural

Copy link
Contributor

@IanHoang IanHoang left a comment

Choose a reason for hiding this comment

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

Some changes requested. Also, is it possible to have this merged in only when we release 2.0.0?


## Usage

The following example executes a test using the `geonames` workload in test mode:
The following example tests a run using the `geonames` workload in test mode:
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
The following example tests a run using the `geonames` workload in test mode:
The following example performs a quick test using the `geonames` workload in test mode.


## General settings

The following options shape how each test runs and how results appear:
The following options customize each run and affects how run results appear:
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
The following options customize each run and affects how run results appear:
The following options customize each test run and affects how run results appear:

@@ -142,21 +143,21 @@ The following options help customize how OpenSearch Benchmark provisions OpenSea

### Workload

The following options determine which workload is used to run the test:
The following options determine which workload is used during the run:
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
The following options determine which workload is used during the run:
The following options determine which workload is used during the test:


- `--workload-repository`: Defines the repository from which OpenSearch Benchmark loads workloads.
- `--workload-path`: Defines the path to a downloaded or custom workload.
- `--workload-revision`: Defines a specific revision from the workload source tree that OpenSearch Benchmark should use.
- `--workload`: Defines the workload to use based on the workload's name. You can find a list of preloaded workloads using `opensearch-benchmark list workloads`.

### Test procedures
### Run procedures
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
### Run procedures
### Scenarios

@@ -199,7 +199,7 @@ After running OpenSearch Benchmark for the first time, you can search through al
* `benchmark.ini`: Contains any adjustable configurations for tests. For information about how to configure OpenSearch Benchmark, see [Configuring OpenSearch Benchmark]({{site.url}}{{site.baseurl}}/benchmark/configuring-benchmark/).
* `data`: Contains all the data corpora and documents related to OpenSearch Benchmark's [official workloads](https://github.com/opensearch-project/opensearch-benchmark-workloads/tree/main/geonames).
* `distributions`: Contains all the OpenSearch distributions downloaded from [OpenSearch.org](http://opensearch.org/) and used to provision clusters.
* `test_executions`: Contains all the test `execution_id`s from previous runs of OpenSearch Benchmark.
* `test_runs`: Contains all the test `execution_id`s from previous runs of OpenSearch Benchmark.
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
* `test_runs`: Contains all the test `execution_id`s from previous runs of OpenSearch Benchmark.
* `test_runs`: Contains all the test `test_run_id`s from previous runs of OpenSearch Benchmark.

@Naarcha-AWS Naarcha-AWS mentioned this pull request Aug 12, 2024
1 task
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS
Copy link
Collaborator Author

Some changes requested. Also, is it possible to have this merged in only when we release 2.0.0?

We'll hold the PR until then!

@Naarcha-AWS Naarcha-AWS mentioned this pull request Aug 12, 2024
1 task
* Update installing-benchmark.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _benchmark/user-guide/installing-benchmark.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
@IanHoang
Copy link
Contributor

IanHoang commented Oct 3, 2024

Let's close this PR as we don't have a concrete date yet. OSB 2.0.0 should be thoroughly tested before we release. We'll revisit this once we have an idea of when we're going to release it.

@Naarcha-AWS
Copy link
Collaborator Author

Closing until we have a firm date for Benchmark 2.0

@Naarcha-AWS
Copy link
Collaborator Author

Since this is still TBD, going to close this and loop back around when necessary.

@Naarcha-AWS Naarcha-AWS closed this Dec 3, 2024
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.15 Blocked PR: Cannot move forward without assistance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants