From 6628b7c693b3670ceae00a2ba4220614ee41a307 Mon Sep 17 00:00:00 2001 From: Chinmay Gadgil Date: Wed, 25 Oct 2023 11:22:51 -0700 Subject: [PATCH] update benchmarking sigv4 documentation (#5356) * update benchmarking sigv4 documentation Signed-off-by: Chinmay Gadgil * Update sigv4.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Chinmay Gadgil Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- _benchmark/tutorials/sigv4.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/_benchmark/tutorials/sigv4.md b/_benchmark/tutorials/sigv4.md index 7a5ea2ea..08138012 100644 --- a/_benchmark/tutorials/sigv4.md +++ b/_benchmark/tutorials/sigv4.md @@ -9,15 +9,26 @@ parent: Tutorials 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. +1. Set up an [IAM user or an IAM Role](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= - OSB_AWS_SECRET_ACCESS_KEY= - OSB_REGION= - OSB_SERVICE=es + export OSB_AWS_ACCESS_KEY_ID= + export OSB_AWS_SECRET_ACCESS_KEY= + export OSB_REGION= + export OSB_SERVICE=es + ``` + {% include copy.html %} + + If you want to set up an IAM role instead of an IAM user, use the following environment variables instead: + + ```bash + export OSB_AWS_ACCESS_KEY_ID= + export OSB_AWS_SECRET_ACCESS_KEY= + export OSB_AWS_SESSION_TOKEN= + export OSB_REGION= + export OSB_SERVICE=es ``` {% include copy.html %} @@ -32,4 +43,4 @@ If you're testing against Amazon OpenSearch Serverless, set `OSB_SERVICE` to `ao --pipeline=benchmark-only \ --workload=geonames \ --client-options=timeout:120,amazon_aws_log_in:environment \ - ``` \ No newline at end of file + ```