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.

Sign up for GitHub

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

Update run.md #7970

Merged
merged 1 commit into from
Aug 12, 2024
Merged

Update run.md #7970

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions _benchmark/reference/commands/run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

## Usage

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:

```
opensearch-benchmark run --workload=geonames --test-mode
Expand Down Expand Up @@ -91,7 +91,7 @@

## General settings

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:

- `--test-mode`: Runs the given workload in test mode, which is useful when checking a workload for errors.
- `--user-tag`: Defines user-specific key-value pairs to be used in metric record as meta information, for example, `intention:baseline-ticket-12345`.
Expand Down Expand Up @@ -143,16 +143,16 @@

### Workload

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`.

### Run procedures
### Scenerios

Check failure on line 153 in _benchmark/reference/commands/run.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _benchmark/reference/commands/run.md#L153 

[OpenSearch.Spelling] Error: Scenerios. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output 
{"message": "[OpenSearch.Spelling] Error: Scenerios. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_benchmark/reference/commands/run.md", "range": {"start": {"line": 153, "column": 5}}}, "severity": "ERROR"}

The following options define what run procedures the run uses and which operations are contained inside the procedure:
The following options define what scenarios the test uses and which operations are contained inside the procedure:

- `--test-run-id`: Defines a unique ID for this run.
Defines the run procedures to use with each workload. You can find a list of run procedures that the workload supports by specifying the workload in the `info` command, for example, `opensearch-benchmark info --workload=<workload_name>`. To look up information on a specific run procedure, use the command `opensearch-benchmark info --workload=<workload_name> --scenario=<scenario>`.
Expand Down
Loading