iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[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:
Ian Hoang 2023-10-10 12:38:11 -05:00 committed by GitHub
parent 464c663bf4
commit 6f196dec3c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
_benchmark/commands/generate.md
View File

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

1
_benchmark/commands/index.md
View File

@ -12,7 +12,6 @@ This section provides a list of commands supported by OpenSearch Benchmark, incl
- [compare]({{site.url}}{{site.baseurl}}/benchmark/commands/compare/) - [compare]({{site.url}}{{site.baseurl}}/benchmark/commands/compare/)
- [download]({{site.url}}{{site.baseurl}}/benchmark/commands/download/) - [download]({{site.url}}{{site.baseurl}}/benchmark/commands/download/)
- [execute-test]({{site.url}}{{site.baseurl}}/benchmark/commands/execute-test/) - [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/) - [info]({{site.url}}{{site.baseurl}}/benchmark/commands/info/)
- [list]({{site.url}}{{site.baseurl}}/benchmark/commands/list/) - [list]({{site.url}}{{site.baseurl}}/benchmark/commands/list/)

2
_benchmark/tutorials/sigv4.md
View File

@ -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: 2. Set up the following environment variables for your IAM user:
```bash ```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_AWS_SECRET_ACCESS_KEY=<IAM USER AWS SECRET ACCESS KEY>
OSB_REGION=<YOUR REGION> OSB_REGION=<YOUR REGION>
OSB_SERVICE=aos OSB_SERVICE=aos