iSharkFly-Docs/OpenSearch-Docs-Cn
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update benchmarking sigv4 documentation (#5356)

Browse Source 
* update benchmarking sigv4 documentation

Signed-off-by: Chinmay Gadgil <[email protected]>

* Update sigv4.md

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Chinmay Gadgil <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
This commit is contained in:
Chinmay Gadgil
2023-10-25 13:22:51 -05:00
committed by GitHub
co-authored by Naarcha-AWS
parent 24a65bd4a1
commit 6628b7c693
1 changed files with 17 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
_benchmark/tutorials/sigv4.md
+17 -6
View File
@@ -9,15 +9,26 @@ parent: Tutorials
OpenSearch Benchmark supports AWS Signature Version 4 authentication. To run Benchmark with Signature Version 4, use the following steps:
1. Set up an [IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html) and provide it access to the OpenSearch cluster using Signature Version 4 authentication.
1. Set up an [IAM user or an IAM Role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html) and provide it access to the OpenSearch cluster using Signature Version 4 authentication.
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_SECRET_ACCESS_KEY=<IAM USER AWS SECRET ACCESS KEY>
OSB_REGION=<YOUR REGION>
OSB_SERVICE=es
export OSB_AWS_ACCESS_KEY_ID=<IAM USER AWS ACCESS KEY ID>
export OSB_AWS_SECRET_ACCESS_KEY=<IAM USER AWS SECRET ACCESS KEY>
export OSB_REGION=<YOUR REGION>
export OSB_SERVICE=es
```
{% include copy.html %}
If you want to set up an IAM role instead of an IAM user, use the following environment variables instead:
```bash
export OSB_AWS_ACCESS_KEY_ID=<IAM Role AWS ACCESS KEY ID>
export OSB_AWS_SECRET_ACCESS_KEY=<IAM Role AWS SECRET ACCESS KEY>
export OSB_AWS_SESSION_TOKEN=<IAM Role SESSION TOKEN>
export OSB_REGION=<YOUR REGION>
export OSB_SERVICE=es
```
{% include copy.html %}
@@ -32,4 +43,4 @@ If you're testing against Amazon OpenSearch Serverless, set `OSB_SERVICE` to `ao
--pipeline=benchmark-only \
--workload=geonames \
--client-options=timeout:120,amazon_aws_log_in:environment \
```
```