Browse Source

Update missed documentation change for new watcher index settings (#125758)

* Update missed documentation change for new watcher index settings

* Update docs/reference/rest-api/watcher/update-settings.asciidoc

Co-authored-by: Keith Massey <keith.massey@elastic.co>

---------

Co-authored-by: Keith Massey <keith.massey@elastic.co>
Luke Whiting 6 months ago
parent
commit
dd192cb82e
1 changed files with 8 additions and 1 deletions
  1. 8 1
      docs/reference/rest-api/watcher/update-settings.asciidoc

+ 8 - 1
docs/reference/rest-api/watcher/update-settings.asciidoc

@@ -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: