K8SPSMDB-1654 Documented support for vector search#361
Conversation
new file: docs/assets/images/vector-search-arch.svg
modified: docs/cr-statuses.md
modified: docs/operator.md
new file: docs/vector-search-setup.md
new file: docs/vector-search.md
modified: mkdocs-base.yml
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for Vector Search (tech preview) support in Percona Operator for MongoDB, including conceptual/architecture docs, a configuration walkthrough, and navigation/status references.
Changes:
- Adds new Vector Search docs: overview/architecture (
docs/vector-search.md) and setup guide (docs/vector-search-setup.md) - Extends Operator and CR status documentation to include
search/status.search - Updates MkDocs navigation and adds an architecture diagram asset
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs-base.yml | Adds “Vector search” section to site navigation. |
| docs/vector-search.md | New Vector Search overview (concepts, architecture, requirements/limits). |
| docs/vector-search-setup.md | New step-by-step enablement + example index/query workflow. |
| docs/operator.md | Documents search and replsets.search.* CR options for mongot. |
| docs/cr-statuses.md | Documents status.search and how it relates to readiness. |
| docs/assets/images/vector-search-arch.svg | Adds architecture diagram referenced by the new docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
|
||
| | Value type | Example | | ||
| | ----------- | ---------- | | ||
| | :material-code-string: string | `percona/percona-server-mongodb-mongot:1.70.1` | |
There was a problem hiding this comment.
would people think this is a legit image?
There was a problem hiding this comment.
It should. Upstream has tagged this version https://github.com/mongodb/mongot/tags. AFAIU we're going to switch to upstream versioning and have 1.70.1-1.
I did test with currently available 0.51.0-1 though
|
|
||
| * Percona Operator for MongoDB 1.23.0 | ||
| * Percona Server for MongoDB 8.3 | ||
| * mongot 1.70.1. |
There was a problem hiding this comment.
what's this version?
$ docker run -it --rm perconalab/percona-server-mongodb-mongot:0.51.0 bash
[mongodb@1690e8276f63 /]$ mongot --version
0.51.0
| image: perconalab/percona-server-mongodb:8.3 | ||
| search: | ||
| enabled: true | ||
| image: percona/percona-server-mongodb-mongot:1.70.1 |
There was a problem hiding this comment.
shouldn't we set an existing image here? perconalab/percona-server-mongodb-mongot:0.51.0
There was a problem hiding this comment.
I will replace it with the variable to update it everywhere shoud the version change.
…h-support' into K8SPSMDB-1654-Doc-vector-search-support
| search: | ||
| enabled: true | ||
| image: percona/percona-server-mongodb-mongot:1.70.1 | ||
| image: percona/percona-server-mongodb-mongot:{{mongot}} |
There was a problem hiding this comment.
one thing i don't understand is that we use perconalab/percona-server-mongodb for PSMDB but percona/percona-server-mongodb-mongot for mongot.
if we're okay with documenting non-existent image, can't we also use percona/percona-server-mongodb:8.3?
There was a problem hiding this comment.
My bad for not updating the path to perconalab. Thank you for pointing it out. Updated. Reg mongot version, it will be 1.70.1
There was a problem hiding this comment.
sorry for being a pain in the ass but if, as of today, there's no 1.70.1 image why we're using it in our docs?
nastena1606
added
the
pending release
| Vector search is in the tech preview stage. Use it in staging or testing | ||
| environments and share your feedback. | ||
|
|
||
| This guide shows how to enable vector search on a cluster managed by |
There was a problem hiding this comment.
| This guide shows how to enable vector search on a cluster managed by | |
| This guide shows how to provision Percona Search for MongoDB on a cluster managed by |
| * Percona Server for MongoDB 8.3 | ||
| * mongot {{mongot}}. | ||
|
|
||
| To learn how vector search works with the Operator, see |
There was a problem hiding this comment.
| To learn how vector search works with the Operator, see | |
| To learn how Percona Search for MongoDB works with the Operator, see |
| * mongot {{mongot}}. | ||
|
|
||
| To learn how vector search works with the Operator, see | ||
| [Vector search](vector-search.md). |
There was a problem hiding this comment.
| [Vector search](vector-search.md). | |
| [Percona Search for MongoDB](vector-search.md). |
|
|
||
| ## Before you start | ||
|
|
||
| 1. Make sure you understand [requirements](vector-search.md#availability-and-requirements) and [limitations](vector-search.md#limitations) of using vector search. |
There was a problem hiding this comment.
| 1. Make sure you understand [requirements](vector-search.md#availability-and-requirements) and [limitations](vector-search.md#limitations) of using vector search. | |
| 1. Make sure you understand [requirements](vector-search.md#availability-and-requirements) and [limitations](vector-search.md#limitations) of using Percona Search for MongoDB. |
|
|
||
| As the result you will have the Operator Pod up and running. | ||
|
|
||
| ## Install Percona Server for MongoDB and enable vector search |
There was a problem hiding this comment.
| ## Install Percona Server for MongoDB and enable vector search | |
| ## Install Percona Server for MongoDB and Percona Search for MongoDB |
| kubectl apply -f deploy/cr.yaml -n $NAMESPACE | ||
| ``` | ||
|
|
||
| ### Verify that search is ready |
There was a problem hiding this comment.
| ### Verify that search is ready | |
| ### Verify that `mongot` is ready |
| with `readWrite` and `dbAdmin` (or equivalent) on the database where you will | ||
| store vectors — not the Operator's `searchCoordinator` system user. | ||
|
|
||
| The examples below use: |
There was a problem hiding this comment.
I think that part we should cover within Percona Search for MongoDB documentation and reference this - we'll have an example of that - I think we shouldn't duplicate that content.
There was a problem hiding this comment.
We have no Search docs at the moment.
There was a problem hiding this comment.
OK. So we can remove it the next version than.
Renamed files to be more generic
There was a problem hiding this comment.
IMHO should be multiple PVC icons for Search, too.
There was a problem hiding this comment.
I show the diagram for a single replica set. 1 search sts (1 pod) for 1 replica set sts.
| environment and share your feedback. Your feedback helps us shape the | ||
| feature in future releases. |
There was a problem hiding this comment.
should we be specific how we want to get feedback? GitHub issues? Forum?
| Restore completion does **not** wait for Percona Search for MongoDB to become ready. Database | ||
| availability returns when the restore finishes; search availability is eventual | ||
| and depends on how long index rebuild takes for your dataset. | ||
|
|
There was a problem hiding this comment.
You can back up Percona Search and Vector Search for MongoDB index data using filesystem snapshots. A filesystem snapshot creates a point-in-time copy of the mongot data directory, which you can use to restore your indexes without rebuilding them from source data.
details: https://www.mongodb.com/docs/search/self-managed/current/deployment/backup-restore/
There was a problem hiding this comment.
As I understand it's out of scope. @egegunes please confirm
| * **No automated embedding.** Generating and managing embeddings through an | ||
| external embedding API (for example automated / Voyage AI embedding) is not supported. You provide and store vector embeddings yourself. |
There was a problem hiding this comment.
Why? There's no connection (egress) from a mongot pod to Voyage AI API endpoint?
There was a problem hiding this comment.
Co-authored-by: Radoslaw Szulgo <radoslaw.szulgo@percona.com>
Co-authored-by: Radoslaw Szulgo <radoslaw.szulgo@percona.com>
| * **Logical restores on sharded clusters with MongoDB 8.3 can leave the | ||
| cluster broken.** This is a known PBM limitation tracked in | ||
| [PBM-1764 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PBM-1764). | ||
| * **Search indexes are not included in backups.** Plan for reindex time after |
There was a problem hiding this comment.
| * **Search indexes are not included in backups.** Plan for reindex time after | |
| * **Search indexes data are not included in backups.** Plan for reindex time after |
Co-authored-by: Radoslaw Szulgo <radoslaw.szulgo@percona.com>
|
|
||
| !!! warning "Tech preview" | ||
|
|
||
| Search capabilities feature is in the tech preview stage. Use it in staging or testing |
There was a problem hiding this comment.
I think the warning content should be the same as in search-overview.md page
| @@ -0,0 +1,286 @@ | |||
| # Configure full-text / vector search | |||
There was a problem hiding this comment.
| # Configure full-text / vector search | |
| # Configure Percona Search for MongoDB |
new file: docs/assets/images/vector-search-arch.svg
modified: docs/cr-statuses.md
modified: docs/operator.md
new file: docs/vector-search-setup.md
new file: docs/vector-search.md
modified: mkdocs-base.yml