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

Conversation

IanHoang
Copy link
Contributor

@IanHoang IanHoang commented Sep 8, 2023

Description

Added Guides section and Sigv4 Support Guide to OpenSearch Benchmark documentation.

  • Validated with Vale
  • Built website and viewed changes.

Issues Resolved

N/A

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

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
- `--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 Naarcha-AWS self-assigned this Sep 8, 2023
@Naarcha-AWS Naarcha-AWS added the 4 - Doc review PR: Doc review in progress label Sep 8, 2023
_benchmark/guides/index.md Outdated Show resolved Hide resolved
_benchmark/guides/index.md Outdated Show resolved Hide resolved
_benchmark/guides/index.md Outdated Show resolved Hide resolved
_benchmark/guides/sigv4-support.md Outdated Show resolved Hide resolved
_benchmark/guides/sigv4-support.md Outdated Show resolved Hide resolved
_benchmark/guides/sigv4-support.md Outdated Show resolved Hide resolved
_benchmark/guides/sigv4-support.md Outdated Show resolved Hide resolved
_benchmark/guides/sigv4-support.md Outdated Show resolved Hide resolved
_benchmark/guides/sigv4-support.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4 - Doc review PR: Doc review in progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants