Skip to content

Commit 4dab525

Browse files
committed
add OSB instructions to use session credentials
Signed-off-by: Rishabh Singh <[email protected]>
1 parent 1f90c87 commit 4dab525

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

_benchmark/user-guide/install-and-configure/configuring-benchmark.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,28 @@ OpenSearch Benchmark supports AWS Signature Version 4 authentication. To run Ope
195195

196196
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).
197197

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:<service>
212+
```
213+
{% include copy.html %}
214+
```
215+
{% include copy.html %}
216+
217+
### OpenSearch Benchmark version 1.14.0 and earlier
218+
219+
For OpenSearch Benchmark versions prior to 1.15.0, use the environment variable method:
199220
200221
1. Create an IAM role or user in the AWS Management Console.
201222
@@ -222,16 +243,16 @@ Use the following steps to set up AWS Signature Version 4:
222243
```
223244
{% include copy.html %}
224245

225-
226246
3. Customize and run the following `execute-test` command with the `--client-options=amazon_aws_log_in:environment` flag. This flag provides the location of your exported credentials to OpenSearch Benchmark.
227247

228248
```bash
229249
opensearch-benchmark execute-test \
230250
--target-hosts=<CLUSTER ENDPOINT> \
231251
--pipeline=benchmark-only \
232252
--workload=geonames \
233-
--client-options=timeout:120,amazon_aws_log_in:environment \
253+
--client-options=timeout:120,amazon_aws_log_in:environment
234254
```
255+
{% include copy.html %}
235256

236257

237258
## Proxy configurations

0 commit comments

Comments
 (0)