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:
-
Set up an IAM user or an IAM Role and provide it access to the OpenSearch cluster using Signature Version 4 authentication.
-
Set up the following environment variables for your IAM user:
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
If you want to set up an IAM role instead of an IAM user, use the following environment variables instead:
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
If you’re testing against Amazon OpenSearch Serverless, set OSB_SERVICE
to aoss
.
-
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 \