You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _benchmark/user-guide/install-and-configure/configuring-benchmark.md
+22-2Lines changed: 22 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -195,7 +195,26 @@ OpenSearch Benchmark supports AWS Signature Version 4 authentication. To run Ope
195
195
196
196
Whether to use an IAM role or user depends on your test cluster's access management requirements. For more information about whether to use an IAM role or user, see [When to create an IAM user (instead of a role)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html#id_which-to-choose).
197
197
198
-
Use the following steps to set up AWS Signature Version 4:
198
+
### OpenSearch Benchmark version 1.15.0 and later
199
+
200
+
Starting with OpenSearch Benchmark version 1.15.0, you can use session-based authentication that automatically handles temporary credential generation and refresh. This method eliminates the need to manually export AWS credentials:
201
+
202
+
1. Create an IAM role or user in the AWS Management Console that has the necessary permissions to access your OpenSearch cluster. Ensure that the role or user has the required policies attached for OpenSearch access.
203
+
204
+
2. Run the following `execute-test` command with the `--client-options=amazon_aws_log_in:session` flag. OpenSearch Benchmark will automatically generate temporary credentials and handle auto-refresh:
205
+
206
+
```bash
207
+
opensearch-benchmark execute-test \
208
+
--target-hosts=<CLUSTER ENDPOINT> \
209
+
--pipeline=benchmark-only \
210
+
--workload=geonames \
211
+
--client-options=timeout:120,amazon_aws_log_in:session,region:<region>,service:<aoss for serverless, es for managed service>
212
+
```
213
+
{% include copy.html %}
214
+
215
+
### OpenSearch Benchmark version 1.14.0 and earlier
216
+
217
+
For OpenSearch Benchmark versions prior to 1.15.0, use the environment variable method:
199
218
200
219
1. Create an IAM role or user in the AWS Management Console.
201
220
@@ -230,8 +249,9 @@ Use the following steps to set up AWS Signature Version 4:
0 commit comments