35 lines
1.2 KiB
Markdown
35 lines
1.2 KiB
Markdown
---
|
|
layout: default
|
|
title: AWS Signature Version 4 support
|
|
nav_order: 70
|
|
parent: 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](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
|
|
```
|
|
{% include copy.html %}
|
|
|
|
If you're testing against Amazon OpenSearch Serverless, set `OSB_SERVICE` to `aoss`.
|
|
{: .note}
|
|
|
|
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.
|
|
|
|
```bash
|
|
opensearch-benchmark execute-test \
|
|
--target-hosts=<CLUSTER ENDPOINT> \
|
|
--pipeline=benchmark-only \
|
|
--workload=geonames \
|
|
--client-options=timeout:120,amazon_aws_log_in:environment \
|
|
``` |