Ian Hoang 6f196dec3c
[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>
2023-10-10 12:38:11 -05:00

1.1 KiB

layout title nav_order parent
default AWS Signature Version 4 support 70 Tutorials

Running OpenSearch Benchmark with AWS Signature Version 4

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 and provide it access to the OpenSearch cluster using Signature Version 4 authentication.

  2. Set up the following environment variables for your IAM user:

    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
    

    {% include copy.html %}

  3. Customize and run the following execute-test command with the --client-options=amazon_aws_log_in:environment flag. This flag tells OpenSearch Benchmark the location of your exported credentials.

    opensearch-benchmark execute-test \
    --target-hosts=<CLUSTER ENDPOINT> \
    --pipeline=benchmark-only \
    --workload=geonames \
    --client-options=timeout:120,amazon_aws_log_in:environment \