opensearch-benchmark execute_test -> execute-test (#8366)

Signed-off-by: Finn Carroll <[email protected]>
opensearch-project · Sep 24, 2024 · 7780da9 · 7780da9
1 parent 85a9fce
commit 7780da9
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/_benchmark/quickstart.md b/_benchmark/quickstart.md
@@ -116,7 +116,7 @@ You can now run your first benchmark. The following benchmark uses the [percolat
 
 Benchmarks are run using the [`execute-test`]({{site.url}}{{site.baseurl}}/benchmark/commands/execute-test/) command with the following command flags:
 
-For additional `execute_test` command flags, see the [execute-test]({{site.url}}{{site.baseurl}}/benchmark/commands/execute-test/) reference. Some commonly used options are `--workload-params`, `--exclude-tasks`, and `--include-tasks`.
+For additional `execute-test` command flags, see the [execute-test]({{site.url}}{{site.baseurl}}/benchmark/commands/execute-test/) reference. Some commonly used options are `--workload-params`, `--exclude-tasks`, and `--include-tasks`.
 {: .tip}
 
 * `--pipeline=benchmark-only` : Informs OSB that users wants to provide their own OpenSearch cluster.
@@ -136,7 +136,7 @@ opensearch-benchmark execute-test --pipeline=benchmark-only --workload=percolato
 ```
 {% include copy.html %}
 
-When the `execute_test` command runs, all tasks and operations in the `percolator` workload run sequentially.
+When the `execute-test` command runs, all tasks and operations in the `percolator` workload run sequentially.
 
 ### Validating the test
 

diff --git a/_benchmark/user-guide/creating-custom-workloads.md b/_benchmark/user-guide/creating-custom-workloads.md
@@ -263,7 +263,7 @@ opensearch-benchmark list workloads --workload-path=</path/to/workload/>
 Use the `opensearch-benchmark execute-test` command to invoke your new workload and run a benchmark test against your OpenSearch cluster, as shown in the following example. Replace `--workload-path` with the path to your custom workload, `--target-host` with the `host:port` pairs for your cluster, and `--client-options` with any authorization options required to access the cluster.
 
 ```
-opensearch-benchmark execute_test \
+opensearch-benchmark execute-test \
 --pipeline="benchmark-only" \
 --workload-path="<PATH OUTPUTTED IN THE OUTPUT OF THE CREATE-WORKLOAD COMMAND>" \
 --target-host="<CLUSTER ENDPOINT>" \
@@ -289,7 +289,7 @@ head -n 1000 <index>-documents.json > <index>-documents-1k.json
 Then, run `opensearch-benchmark execute-test` with the option `--test-mode`. Test mode runs a quick version of the workload test.
 
 ```
-opensearch-benchmark execute_test \
+opensearch-benchmark execute-test \
 --pipeline="benchmark-only"  \
 --workload-path="<PATH OUTPUTTED IN THE OUTPUT OF THE CREATE-WORKLOAD COMMAND>" \
 --target-host="<CLUSTER ENDPOINT>" \

diff --git a/_benchmark/user-guide/distributed-load.md b/_benchmark/user-guide/distributed-load.md
@@ -64,7 +64,7 @@ With OpenSearch Benchmark running on all three nodes and the worker nodes set to
 On **Node 1**, run a benchmark test with the `worker-ips` set to the IP addresses for your worker nodes, as shown in the following example:
 
 ```
-opensearch-benchmark execute_test --pipeline=benchmark-only --workload=eventdata --worker-ips=198.52.100.0,198.53.100.0 --target-hosts=<DOMAIN_ENDPOINT> --client-options=<STANDARD_CLIENT_OPTIONS> --kill-running-processes
+opensearch-benchmark execute-test --pipeline=benchmark-only --workload=eventdata --worker-ips=198.52.100.0,198.53.100.0 --target-hosts=<DOMAIN_ENDPOINT> --client-options=<STANDARD_CLIENT_OPTIONS> --kill-running-processes
 ```
 
 After the test completes, the logs generated by the test appear on your worker nodes.