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 1 commit
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: Guides
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
nav_order: 70
has_children: true
---

# Guides for specific use cases
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

Here are a list of guides for specific OpenSearch Benchmark use cases.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

- [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:
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
parent: Guides
---

# Run with sigv4 support
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

Note: Sigv4 refers to AWS Signature Version 4
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

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=aoss
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
```

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

- `--distribution-version` = This is needed because OSB parses the distribution version (usually provided or fetched from curling the cluster’s settings) and uses that to determine which OSB Workload branch to use. This can be 2.3.0 should be sufficient for now as it will use the workload branches that correlate to OpenSearch version 2.X
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
- `--client-options=amazon_aws_log_in:environment` = tells OSB that you’ve exported the credentials in the environment in the previous step
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will replace these = signs with colons

Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
- `--exclude-tasks=check-cluster-health,refresh-after-index,force-merge,refresh-after-force-merge,wait-until-merges-finish` = this skips operations in the test that call APIs exclusive to OpenSearch and not found in serverless
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

Example command:
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
```
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
```