Skip to content

[8.17] Update missed documentation change for new watcher index settings (#125758) #125926

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 31, 2025
Merged

[8.17] Update missed documentation change for new watcher index settings (#125758) #125926

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/reference/rest-api/watcher/update-settings.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,17 @@
For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
--

This API allows a user to modify the settings for the Watcher internal index (`.watches`). Only a subset of settings are allowed to by modified. This includes:
This API allows a user to modify the settings for the Watcher internal index (`.watches`). Only a subset of settings
are allowed to be modified. This includes:

- `index.auto_expand_replicas`
- `index.number_of_replicas`
- Any setting with the prefix `index.routing.allocation.exclude.`
- Any setting with the prefix `index.routing.allocation.include.`
- Any setting with the prefix `index.routing.allocation.require.`

Modification of `index.routing.allocation.include._tier_preference` is an exception and is not allowed as the Watcher
shards must always be in the `data_content` tier.

An example of modifying the Watcher settings:

Expand Down