Add vectorsearch Remote Index Build docs #9575
Conversation
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
owenhalpert
force-pushed
the
remote-vector-docs
branch
4 times, most recently
from
f342c79 to
d796b71
Compare
kolchfa-aws
added
v3.0.0
release-notes
owenhalpert
force-pushed
the
remote-vector-docs
branch
from
d796b71 to
a18739a
Compare
Signed-off-by: owenhalpert <[email protected]>
owenhalpert
force-pushed
the
remote-vector-docs
branch
from
a18739a to
2c68164
Compare
owenhalpert
changed the title
owenhalpert
requested review from
kolchfa-aws,
Naarcha-AWS,
AMoo-Miki,
natebower,
dlvenable and
epugh
as code owners
|
@owenhalpert Please let me know when you finish addressing technical comments and the PR is ready for doc review. Thanks! |
|
@kolchfa-aws I just resolved the open comment — ready for doc review! Thanks. |
_vector-search/remote-index-build.md
Outdated
|
|
||
| ### Step 2: Create and register the remote vector repository | ||
|
|
||
| The remote vector repository will act as an intermediate object store between the OpenSearch cluster and the remote build service. The cluster will upload vectors and doc IDs to this repository. The remote build service will download these and eventually upload a completed index build in response. To create and register the repository, follow the [Register repository](https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore/#register-repository) steps in the Snapshots documentation. Then, set `knn.remote_index_build.vector_repo` to be the name of this registered repository. |
There was a problem hiding this comment.
Is knn.remote_index_build.vector_repo a dynamic setting that users can update via the API or yaml file?
There was a problem hiding this comment.
Does "completed index build" mean "built index"? Does "in response" mean that the build service uploads the finished (built) index as a result of processing the uploaded vectors and document IDs?
There was a problem hiding this comment.
- Yes, a dynamic setting as per the definition in the "Dynamic settings" link you provided above.
- "Built index" is better here, thanks.
- Yes. It uploads the built index once it finishes the operation.
Signed-off-by: owenhalpert <[email protected]>
owenhalpert
force-pushed
the
remote-vector-docs
branch
from
2c68164 to
8040d0b
Compare
…tion-website into remote-vector-docs
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
There was a problem hiding this comment.
Thank you, @owenhalpert! Please review my suggestions and let me know if they preserve technical accuracy. Once you confirm, we can move the PR to editorial review.
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: owenhalpert <[email protected]>
|
Thanks so much for your review and comments @kolchfa-aws. Please let me know if there are other unresolved points, otherwise the PR is ready for the next stage of review. |
|
Thanks, @owenhalpert! Moving to editorial review. |
There was a problem hiding this comment.
@kolchfa-aws @owenhalpert Please see my changes and let me know if you have any questions. Thanks!
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
* Initial Remote Index Build draft Signed-off-by: owenhalpert <[email protected]> * Initial Remote Index Build draft Signed-off-by: owenhalpert <[email protected]> * Doc review Signed-off-by: Fanit Kolchina <[email protected]> * Slight rewording based on answers Signed-off-by: Fanit Kolchina <[email protected]> * Don't refer to feature flag Signed-off-by: Fanit Kolchina <[email protected]> * Update _vector-search/api/knn.md Signed-off-by: kolchfa-aws <[email protected]> * Update _vector-search/remote-index-build.md Signed-off-by: kolchfa-aws <[email protected]> * Update _vector-search/remote-index-build.md Signed-off-by: kolchfa-aws <[email protected]> * Apply suggestions from code review Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: owenhalpert <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: owenhalpert <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
Description
Add documentation for the Remote Build Service (META issue, blog post, metrics)
Issues Resolved
Closes #9574
Version
3.0.0 and above
Frontend features
N/A
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.