DOC-12444 add vector indexes to index+overview #3913
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request updates the Couchbase Server documentation to bring it up to current standards and adds vector index references to the Server's Indexes topic. The changes include:
- Updated metrics metadata files with new monitoring metrics and corrected version information
- Enhanced user and security management documentation with additional features like user account locking and password management
- Added comprehensive documentation for native encryption at rest management
- Improved audit management documentation with user activity tracking
- Updated various configuration and settings documentation
- Added utility documentation for xdcrDiffer and network configuration options
Reviewed Changes
Copilot reviewed 146 out of 372 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| modules/metrics-reference/attachments/*.json | Added new metrics for index, XDCR, FTS, cluster management, analytics, and backup services |
| modules/manage/pages/manage-security/*.adoc | Enhanced security documentation including new password management, user account locking, encryption at rest, and audit features |
| modules/manage/pages/manage-xdcr/*.adoc | Added xdcrDiffer utility documentation and incoming replications management |
| modules/manage/pages/manage-settings/*.adoc | Updated general settings, alerts configuration, and compaction settings |
| modules/manage/pages/manage-nodes/*.adoc | Added service modification capabilities and data service management |
| modules/manage/examples/*.sh, *.py | Added examples for bucket migration, ejection policy changes, and collection duplication |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| * `xdcrDiffer` (binary) | ||
|
|
||
| * `runDiffer.sh` (shell script) | ||
|
|
There was a problem hiding this comment.
The utility files section lacks information about file permissions and location. Consider adding details about where these files are located within the Couchbase Server installation and any required permissions for execution.
| By default, these files are located in the Couchbase Server installation directory, typically `/opt/couchbase/bin/` on Linux systems or `C:\Program Files\Couchbase\Server\bin\` on Windows. | |
| Ensure that both files have executable permissions before running the utility. On Linux, you may need to run `chmod +x xdcrDiffer runDiffer.sh` to set the correct permissions. |
Copilot uses AI. Check for mistakes.
|
|
||
| NOTE: You can authenticate the external users only using the `PLAIN` method. | ||
| By default, the Couchbase SDK uses PLAIN only when connecting over TLS ports. | ||
| Therefore, external users must connect through TLS ports. |
There was a problem hiding this comment.
The note about external user authentication should clarify what happens if external users attempt to connect over non-TLS ports - whether they receive an error or are simply denied authentication.
| Therefore, external users must connect through TLS ports. | |
| Therefore, external users must connect through TLS ports. If an external user attempts to connect over a non-TLS port, authentication will fail and an error will be returned. |
Copilot uses AI. Check for mistakes.
|
|
||
| As an administrator, to force a new user to change their password during their first login, do the following: | ||
|
|
||
| . Begin following steps from the section xref:manage:manage-security/manage-passwords.adoc#create-initial-password-ui[Create an Initial Password for a New User from the UI]. |
There was a problem hiding this comment.
The cross-reference anchor 'create-initial-password-ui' does not match the actual section heading 'set-initial-password-ui'. This will result in a broken internal link.
| . Begin following steps from the section xref:manage:manage-security/manage-passwords.adoc#create-initial-password-ui[Create an Initial Password for a New User from the UI]. | |
| . Begin following steps from the section xref:manage:manage-security/manage-passwords.adoc#set-initial-password-ui[Create an Initial Password for a New User from the UI]. |
Copilot uses AI. Check for mistakes.
| See xref:vector-index/vectors-and-indexes-overview.adoc[] for more information about using vector indexes. | ||
|
|
||
| Hyperscale Vector Indexes:: | ||
| The Index Service provides xref:vector-index/hyperscale-vector-index.adoc[Hyperscale Vector Indexes] which index a single vector column. |
There was a problem hiding this comment.
Does the link go to a specific page for Hyperscale vector indexes? it doesn't seem to go anywhere on the preview
There was a problem hiding this comment.
Sorry, I should have stated in the PR... the links to the vector docs won't work until the GSI vector index work has been merged to the devex release/8.0.
| These indexes can scale up to a billion documents containing vectors with a large number of dimensions. | ||
|
|
||
| Composite Vector Indexes:: | ||
| The Index Service provides xref:vector-index/composite-vector-index.adoc[Composite Vector Indexes] which are Global Secondary Indexes (GSIs) with a single vector column. |
| These indexes let your application use searches for scalar, array, and object index entries to pre-filter the dataset before performing a vector similarity search. | ||
|
|
||
| Search Vector Indexes:: | ||
| The Search Service provides xref:vector-search/vector-search.adoc[Search Vector Indexes] that support a single vector column. |
There was a problem hiding this comment.
I assume they go to a vector index page but again doesn't seem to work on the preview
2 participants
Adds references to the vector indexes to the Server's Indexes topic. Topic was also brought up to doc standards.
Here's the preview of the changes.