Add initial documentation for the execute_test command #198
Conversation
Signed-off-by: Travis Benedict <benedtra@amazon.com>
|
@Naarcha-AWS would you mind looking this over? |
docs/api/execute-test.md
Outdated
| `bool-expression` | Specify an expression that evaluates to a boolean value. | No | ||
| ### Arguments | ||
|
|
||
| **Note**: This is not an exhaustive list of arguments. |
There was a problem hiding this comment.
Any specific reason we're not able to make it exhaustive list?
There was a problem hiding this comment.
There's somewhere around 20 more arguments to document that deal with things like specific configurations for provisioning or reporting. I didn't think it was worth taking the time to add those here since they're used for very advanced use cases.
I can add them in but it will take a little while
There was a problem hiding this comment.
@travisbenedict: Is there a place where users can find additional arguments? Ok with not documenting the majority of them, just need to provide another resource if possible.
There was a problem hiding this comment.
I can add a section to the bottom for "Advanced Arguments" that lists them all
There was a problem hiding this comment.
These are already documented in the help text 🤦♂️ I'll update the table
There was a problem hiding this comment.
Decided to split the exhaustive list into a separate table to avoid burying the examples
docs/api/execute-test.md
Outdated
| `bool-expression` | Specify an expression that evaluates to a boolean value. | No | ||
| ### Arguments | ||
|
|
||
| **Note**: This is not an exhaustive list of arguments. |
There was a problem hiding this comment.
@travisbenedict: Is there a place where users can find additional arguments? Ok with not documenting the majority of them, just need to provide another resource if possible.
Signed-off-by: Travis Benedict <benedtra@amazon.com>
Signed-off-by: Travis Benedict <benedtra@amazon.com>
a72f3d6 to
8b0e9a0
Compare
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Travis Benedict <benedtra@amazon.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Travis Benedict <benedtra@amazon.com>
8b0e9a0 to
3b2dfdd
Compare
docs/api/execute-test.md
Outdated
| Argument | Description | Required | ||
| :--- | :--- |:--- | ||
| `workload` | The dataset and operations that execute during a test. See [OpenSearch Benchmark Workloads repository](https://github.com/opensearch-project/opensearch-benchmark-workloads) for more details on workloads. | Yes | ||
| `workload-params` | Parameters defined within each workload that can be overwritten, defined in the README of each workload. You can find an example of the eventdata workload [here](https://github.com/opensearch-project/opensearch-benchmark-workloads/tree/main/eventdata#parameters). | No |
There was a problem hiding this comment.
Nit: "You can find an example of the parameters for the eventdata workload"
docs/api/execute-test.md
Outdated
| :--- | :--- |:--- | ||
| `workload` | The dataset and operations that execute during a test. See [OpenSearch Benchmark Workloads repository](https://github.com/opensearch-project/opensearch-benchmark-workloads) for more details on workloads. | Yes | ||
| `workload-params` | Parameters defined within each workload that can be overwritten, defined in the README of each workload. You can find an example of the eventdata workload [here](https://github.com/opensearch-project/opensearch-benchmark-workloads/tree/main/eventdata#parameters). | No | ||
| `test_procedure` | Test Procedures define the sequence of operations and parameters for a specific workload. When there is `test_procedure` specified, Benchmark selects the default. Define test procedures within each workload directory. You can fine an example test procedure [here](https://github.com/opensearch-project/opensearch-benchmark-workloads/blob/main/eventdata/test_procedures/default.json). | No |
There was a problem hiding this comment.
- Nit: "When there is
test_procedurespecified" --> "Whentest_procedurespecified". Also regarding this sentence, I think it should be "When there is notest_procedurespecified, Benchmark selects the default"? - Spelling error: fine--> find in the last sentence
|
Added a couple comments but otherwise looks good to me |
Signed-off-by: Travis Benedict benedtra@amazon.com
Description
This PR is a first step towards documenting the usage of the
execute_testcommand. This command can take a large number of arguments so I've only added the most common use cases for now.Issues Resolved
Testing
No testing required
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.