Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Guides sand SigV4 support guide #4997

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions _benchmark/guides/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
layout: default
title: Use cases
nav_order: 70
has_children: true
---

# OpenSearch Benchmark use cases

The following section provides guides for specific use cases of OpenSearch Benchmark. To get started, select from the following guides:

- [AWS Signature Version 4 (SigV4) Support]({{site.url}}{{site.baseurl}}/benchmark/guides/sigv4-support/)

37 changes: 37 additions & 0 deletions _benchmark/guides/sigv4-support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
layout: default
title: SigV4 Support
nav_order: 70
parent: Guides
---

# Running OpenSearch Benchmark with AWS Sigv4

OpenSearch Benchmark supports AWS Signature Version 4 (Sigv4) authentication. To run with Sigv4, use the following steps:

1. Provision a serverless collection with proper access policies and security policies. Serverless usually requires that users specify an IAM User or Role ARN in the access policy.

2. Set up environment variables where you are running OSB
```
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=aos
```

3. Invoke OSB like the command below. Ensure that you are specifying:

- `--client-options=amazon_aws_log_in:environment`: Tells OpenSearch Benchmark when you've exported your environment's credentials.

## Example

The following example `execute-test` command run a benchmark test with sigv4 enabled:
```
opensearch-benchmark execute-test \
--distribution-version=2.3.0 \
--target-hosts=<YOUR COLLECTION ENDPOINT> \
--pipeline=benchmark-only \
--workload percolator \
--client-options=timeout:120,amazon_aws_log_in:environment \
--exclude-tasks=check-cluster-health,refresh-after-index,force-merge,refresh-after-force-merge,wait-until-merges-finish,percolator_with_content_ignore_me
```