DOC-13306: Add documentation for indexer level scan timeout#177
Merged
Conversation
simon-dew
requested review from
VarunVelamuri,
amithk,
deepkaran,
ggray-cb and
ksaikrishnateja
rao-shwe
approved these changes
Aug 22, 2025
rao-shwe
left a comment
rao-shwe
left a comment
There was a problem hiding this comment.
-
A few links to the Rebalance page are in the .html format instead of the .adoc format. Please fix those.
-
I'm working on smart batching but not as a part of the 8.0 release. A link to it can be added after the Morpheus release.
Rest of the contents LGTM!
|
Hi This looks good. Just to add more Sorry for missing to mention this on the MB but i think its better to also mention the rationale behind having two timeouts one at query level and one at indexer level. This timeout at indexer was introduced as index scans will consume indexer resources like memory and cpu while holding snapshots and performing range scan. For a typical index scan we don't expect indexer to run for longer than 2 minutes hence the default. Thanks |
simon-dew
added a commit
that referenced
this pull request
Sep 10, 2025
* DOC-5669: Add indexer settings REST API * Add index batch size for rebalance * Add the default for `defer_build` * Default timeout for indexer * Update settings * Has examples and defaults * Add description * Add example titles * Update storage mode as a composite schema * Driveby: fix default preview config * Driveby: Update composed schema templates * Driveby: Add descriptions to REST API specs for composite schemas * Driveby: update overlay for Eventing REST API * Driveby: Include description for composite schemas * Driveby: fix maximum and minimum exclusives * Build output documentation --------- Co-authored-by: tech-comm-team-couchbase <tech-comm-team@couchbase.com>
2 tasks
dgnicholson
pushed a commit
that referenced
this pull request
Oct 21, 2025
* DOC-5669: Add indexer settings REST API * Add index batch size for rebalance * Add the default for `defer_build` * Default timeout for indexer * Update settings * Has examples and defaults * Add description * Add example titles * Update storage mode as a composite schema * Driveby: fix default preview config * Driveby: Update composed schema templates * Driveby: Add descriptions to REST API specs for composite schemas * Driveby: update overlay for Eventing REST API * Driveby: Include description for composite schemas * Driveby: fix maximum and minimum exclusives * Build output documentation --------- Co-authored-by: tech-comm-team-couchbase <tech-comm-team@couchbase.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Docs issue: DOC-13306
Adds documentation for the Index Settings REST API, including the
indexer.settings.scan_timeoutparameter.Also adds driveby fixes to the OpenAPI generator templates, including better handling of composite schemas.
We've had previous requests to document this REST API, but so far have always decided to leave it undocumented. However, over the years several references to this REST API have crept into the documentation. With this ticket, I've decided that it's time to drop the pretence and add a full reference page. I have added a warning near the top of the page to say that "you should only change the Index Service settings when advised to do so by Couchbase Support".
There are a lot of changed files, but the only ones you really need to review for this ticket are index-settings.yaml and the generated index.adoc.
Docs preview: Index Settings REST API
Credentials: Preview docs for internal review
Must be merged at the same time as the following PRs: