Skip to content

Commit

Permalink
[OSB Documentation] Remove generate documentation and update SigV4 do…
Browse files Browse the repository at this point in the history
…cumentation for OSB (opensearch-project#5174)

* Remove generate documentation and update SigV4 documentation for OSB

Signed-off-by: Ian Hoang <[email protected]>

* Remove generate link reference in index page

Signed-off-by: Ian Hoang <[email protected]>

---------

Signed-off-by: Ian Hoang <[email protected]>
Co-authored-by: Ian Hoang <[email protected]>
  • Loading branch information
2 people authored and harshavamsi committed Oct 31, 2023
1 parent 0302b28 commit e3d31b7
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 35 deletions.
24 changes: 0 additions & 24 deletions _benchmark/commands/generate.md

This file was deleted.

19 changes: 9 additions & 10 deletions _benchmark/commands/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

2 changes: 1 addition & 1 deletion _benchmark/tutorials/sigv4.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e3d31b7

Please sign in to comment.