-
Notifications
You must be signed in to change notification settings - Fork 505
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
Add Benchmark 2.0 #7888
Conversation
Signed-off-by: Archer <[email protected]>
Signed-off-by: Archer <[email protected]>
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. |
_benchmark/reference/commands/run.md
Outdated
@@ -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: |
There was a problem hiding this comment.
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
There was a problem hiding this 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?
_benchmark/reference/commands/run.md
Outdated
|
||
## 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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
_benchmark/reference/commands/run.md
Outdated
|
||
## 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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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: |
_benchmark/reference/commands/run.md
Outdated
@@ -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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The following options determine which workload is used during the run: | |
The following options determine which workload is used during the test: |
_benchmark/reference/commands/run.md
Outdated
|
||
- `--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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
### 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* `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. |
Signed-off-by: Naarcha-AWS <[email protected]>
We'll hold the PR until then! |
* 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]>
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. |
Closing until we have a firm date for Benchmark 2.0 |
Since this is still TBD, going to close this and loop back around when necessary. |
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.