[OSB Documentation] Remove generate documentation and update SigV4 documentation for OSB (#5174)
* Remove generate documentation and update SigV4 documentation for OSB Signed-off-by: Ian Hoang <hoangia@amazon.com> * Remove generate link reference in index page Signed-off-by: Ian Hoang <hoangia@amazon.com> --------- Signed-off-by: Ian Hoang <hoangia@amazon.com> Co-authored-by: Ian Hoang <hoangia@amazon.com>
This commit is contained in:
parent
464c663bf4
commit
6f196dec3c
|
@ -1,24 +0,0 @@
|
|||
---
|
||||
layout: default
|
||||
title: generate
|
||||
nav_order: 70
|
||||
parent: Command reference
|
||||
---
|
||||
|
||||
The `generate` command generates visualizations based on benchmark results.
|
||||
|
||||
## Usage
|
||||
|
||||
The following example generates a time-series chart, which outputs into the `.benchmark` directory:
|
||||
|
||||
```
|
||||
opensearch-benchmark generate --chart-type="time-series"
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
The following options customize the visualization produced by the `generate` command:
|
||||
|
||||
- `--chart-spec-path`: Sets the path to the JSON files containing chart specifications that can be used to generate charts.
|
||||
- `--chart-type`: Generates the indicated chart type, either `time-series` or `bar`. Default is `time-series`.
|
||||
- `--output-path`: The path and name where the chart outputs. Default is `stdout`.
|
|
@ -9,18 +9,17 @@ has_children: true
|
|||
|
||||
This section provides a list of commands supported by OpenSearch Benchmark, including commonly used commands such as `execute-test` and `list`.
|
||||
|
||||
- [compare]({{site.url}}{{site.baseurl}}/benchmark/commands/compare/)
|
||||
- [download]({{site.url}}{{site.baseurl}}/benchmark/commands/download/)
|
||||
- [execute-test]({{site.url}}{{site.baseurl}}/benchmark/commands/execute-test/)
|
||||
- [generate]({{site.url}}{{site.baseurl}}/benchmark/commands/generate/)
|
||||
- [info]({{site.url}}{{site.baseurl}}/benchmark/commands/info/)
|
||||
- [list]({{site.url}}{{site.baseurl}}/benchmark/commands/list/)
|
||||
- [compare]({{site.url}}{{site.baseurl}}/benchmark/commands/compare/)
|
||||
- [download]({{site.url}}{{site.baseurl}}/benchmark/commands/download/)
|
||||
- [execute-test]({{site.url}}{{site.baseurl}}/benchmark/commands/execute-test/)
|
||||
- [info]({{site.url}}{{site.baseurl}}/benchmark/commands/info/)
|
||||
- [list]({{site.url}}{{site.baseurl}}/benchmark/commands/list/)
|
||||
|
||||
## List of common options
|
||||
|
||||
All OpenSearch Benchmark commands support the following options:
|
||||
All OpenSearch Benchmark commands support the following options:
|
||||
|
||||
- `--h` or `--help`: Provides options and other useful information about each command.
|
||||
- `--quiet`: Hides as much of the results output as possible. Default is `false`.
|
||||
- `--offline`: Indicates whether OpenSearch Benchmark has a connection to the internet. Default is `false`.
|
||||
- `--h` or `--help`: Provides options and other useful information about each command.
|
||||
- `--quiet`: Hides as much of the results output as possible. Default is `false`.
|
||||
- `--offline`: Indicates whether OpenSearch Benchmark has a connection to the internet. Default is `false`.
|
||||
|
||||
|
|
|
@ -14,7 +14,7 @@ OpenSearch Benchmark supports AWS Signature Version 4 authentication. To run Ben
|
|||
2. Set up the following environment variables for your IAM user:
|
||||
|
||||
```bash
|
||||
OSB_AWS_ACCESS_KEY_ID=<<IAM USER AWS ACCESS KEY ID>
|
||||
OSB_AWS_ACCESS_KEY_ID=<IAM USER AWS ACCESS KEY ID>
|
||||
OSB_AWS_SECRET_ACCESS_KEY=<IAM USER AWS SECRET ACCESS KEY>
|
||||
OSB_REGION=<YOUR REGION>
|
||||
OSB_SERVICE=aos
|
||||
|
|
Loading…
Reference in New Issue