Create USER_GUIDE.md #55
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: owenhalpert <[email protected]>
owenhalpert
requested review from
Rajrahane,
navneet1v,
yigithub,
vamshin,
jed326,
rchitale7 and
neetikasinghal
as code owners
rchitale7
reviewed
Apr 17, 2025
| - NVIDIA GPU powered machine with CUDA Toolkit and Docker installed. | ||
| - ex. AWS EC2 `g5.2xlarge` instance running Deep Learning OSS Nvidia Driver AMI. | ||
|
|
||
| ### 2. Clone the Repository |
There was a problem hiding this comment.
If users are just running the Remote Vector Index Builder image, no need to clone the repo or build all of the images in sequence. All they need to do is do docker pull opensearchstaging/remote-vector-index-builder:api-latest. The reason i included those other steps in the developer guide was if someone wanted to make some modifications to the images, and test locally. That may need to be clarified there.
rchitale7
reviewed
Apr 17, 2025
|
|
||
| ## Getting Started | ||
|
|
||
| ### 1. Provision an Instance |
There was a problem hiding this comment.
should mention that an instance should have an IAM role attached, and link to the EC2 documentation that explains how to do that. And that IAM role must have permissions to read/write to the remote s3 bucket that gets attached with OpenSearch cluster
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add
USER_GUIDE.mdto describe setup steps for the Remote Vector Index BuilderIssues Resolved
N/A
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.