settings.asciidoc 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302
  1. [discrete]
  2. [[breaking_80_settings_changes]]
  3. ==== Settings changes
  4. //NOTE: The notable-breaking-changes tagged regions are re-used in the
  5. //Installation and Upgrade Guide
  6. //tag::notable-breaking-changes[]
  7. [[search-remote-settings-removed]]
  8. .The `search.remote.*` settings have been removed.
  9. [%collapsible]
  10. ====
  11. *Details* +
  12. In 6.5 these settings were deprecated in favor of `cluster.remote`. In 7.x we
  13. provided automatic upgrading of these settings to their `cluster.remote`
  14. counterparts. In 8.0.0, these settings have been removed. Elasticsearch will
  15. refuse to start if you have these settings in your configuration or cluster
  16. state.
  17. *Impact* +
  18. Use the replacement `cluster.remote` settings. Discontinue use of the
  19. `search.remote.*` settings. Specifying these settings in `elasticsearch.yml`
  20. will result in an error on startup.
  21. ====
  22. [[remove-pidfile]]
  23. .The `pidfile` setting has been replaced by `node.pidfile`.
  24. [%collapsible]
  25. ====
  26. *Details* +
  27. To ensure that all settings are in a proper namespace, the `pidfile` setting was
  28. previously deprecated in version 7.4.0 of Elasticsearch, and is removed in
  29. version 8.0.0. Instead, use `node.pidfile`.
  30. *Impact* +
  31. Use the `node.pidfile` setting. Discontinue use of the `pidfile` setting.
  32. Specifying the `pidfile` setting in `elasticsearch.yml` will result in an error
  33. on startup.
  34. ====
  35. [[remove-processors]]
  36. .The `processors` setting has been replaced by `node.processors`.
  37. [%collapsible]
  38. ====
  39. *Details* +
  40. To ensure that all settings are in a proper namespace, the `processors` setting
  41. was previously deprecated in version 7.4.0 of Elasticsearch, and is removed in
  42. version 8.0.0. Instead, use `node.processors`.
  43. *Impact* +
  44. Use the `node.processors` setting. Discontinue use of the `processors` setting.
  45. Specifying the `processors` setting in `elasticsearch.yml` will result in an
  46. error on startup.
  47. ====
  48. .The `node.processors` setting can no longer exceed the available number of processors.
  49. [%collapsible]
  50. ====
  51. *Details* +
  52. Previously it was possible to set the number of processors used to set the
  53. default sizes for the thread pools to be more than the number of available
  54. processors. As this leads to more context switches and more threads but without
  55. an increase in the number of physical CPUs on which to schedule these additional
  56. threads, the `node.processors` setting is now bounded by the number of available
  57. processors.
  58. *Impact* +
  59. If specified, ensure the value of `node.processors` setting does not exceed the
  60. number of available processors. Setting the `node.processors` value greater than
  61. the number of available processors in `elasticsearch.yml` will result in an
  62. error on startup.
  63. ====
  64. .The `cluster.remote.connect` setting has been removed.
  65. [%collapsible]
  66. ====
  67. *Details* +
  68. In Elasticsearch 7.7.0, the setting `cluster.remote.connect` was deprecated in
  69. favor of setting `node.remote_cluster_client`. In Elasticsearch 8.0.0, the
  70. setting `cluster.remote.connect` is removed.
  71. *Impact* +
  72. Use the `node.remote_cluster_client` setting. Discontinue use of the
  73. `cluster.remote.connect` setting. Specifying the `cluster.remote.connect`
  74. setting in `elasticsearch.yml` will result in an error on startup.
  75. ====
  76. .The `node.local_storage` setting has been removed.
  77. [%collapsible]
  78. ====
  79. *Details* +
  80. In Elasticsearch 7.8.0, the setting `node.local_storage` was deprecated and
  81. beginning in Elasticsearch 8.0.0 all nodes will require local storage. Therefore,
  82. the `node.local_storage` setting has been removed.
  83. *Impact* +
  84. Discontinue use of the `node.local_storage` setting. Specifying this setting in
  85. `elasticsearch.yml` will result in an error on startup.
  86. ====
  87. .The `auth.password` setting for HTTP monitoring has been removed.
  88. [%collapsible]
  89. ====
  90. *Details* +
  91. In Elasticsearch 7.7.0, the setting `xpack.monitoring.exporters.<exporterName>.auth.password`
  92. was deprecated in favor of setting `xpack.monitoring.exporters.<exporterName>.auth.secure_password`.
  93. In Elasticsearch 8.0.0, the setting `xpack.monitoring.exporters.<exporterName>.auth.password` is
  94. removed.
  95. *Impact* +
  96. Use the `xpack.monitoring.exporters.<exporterName>.auth.secure_password`
  97. setting. Discontinue use of the
  98. `xpack.monitoring.exporters.<exporterName>.auth.password` setting. Specifying
  99. the `xpack.monitoring.exporters.<exporterName>.auth.password` setting in
  100. `elasticsearch.yml` will result in an error on startup.
  101. ====
  102. .Settings used to disable basic license features have been removed.
  103. [%collapsible]
  104. ====
  105. *Details* +
  106. The following settings were deprecated in {es} 7.8.0 and have been removed
  107. in {es} 8.0.0:
  108. * `xpack.enrich.enabled`
  109. * `xpack.flattened.enabled`
  110. * `xpack.ilm.enabled`
  111. * `xpack.monitoring.enabled`
  112. * `xpack.rollup.enabled`
  113. * `xpack.slm.enabled`
  114. * `xpack.sql.enabled`
  115. * `xpack.transform.enabled`
  116. * `xpack.vectors.enabled`
  117. These basic license features are now always enabled.
  118. If you have disabled ILM so that you can use another tool to manage Watcher
  119. indices, the newly introduced `xpack.watcher.use_ilm_index_management` setting
  120. may be set to false.
  121. *Impact* +
  122. Discontinue use of the removed settings. Specifying these settings in
  123. `elasticsearch.yml` will result in an error on startup.
  124. ====
  125. .Settings used to defer cluster recovery pending a certain number of master nodes have been removed.
  126. [%collapsible]
  127. ====
  128. *Details* +
  129. The following settings were deprecated in {es} 7.8.0 and have been removed in
  130. {es} 8.0.0:
  131. * `gateway.expected_nodes`
  132. * `gateway.expected_master_nodes`
  133. * `gateway.recover_after_nodes`
  134. * `gateway.recover_after_master_nodes`
  135. It is safe to recover the cluster as soon as a majority of master-eligible
  136. nodes have joined so there is no benefit in waiting for any additional
  137. master-eligible nodes to start.
  138. *Impact* +
  139. Discontinue use of the removed settings. If needed, use
  140. `gateway.expected_data_nodes` or `gateway.recover_after_data_nodes` to defer
  141. cluster recovery pending a certain number of data nodes.
  142. ====
  143. .You can no longer set `xpack.searchable.snapshot.shared_cache.size` on non-frozen nodes.
  144. [%collapsible]
  145. ====
  146. *Details* +
  147. Setting `xpack.searchable.snapshot.shared_cache.size` to be positive on a node
  148. that does not have the `data_frozen` role was deprecated in {es} 7.12.0 and has
  149. been removed in {es} 8.0.0.
  150. *Impact* +
  151. {es} only allocates partially mounted indices to nodes with the `data_frozen`
  152. role. Do not set `xpack.searchable.snapshot.shared_cache.size` on nodes without
  153. the `data_frozen` role. Removing the setting on nodes without the `data_frozen`
  154. role will not impact functionality.
  155. ====
  156. .By default, destructive index actions do not allow wildcards.
  157. [%collapsible]
  158. ====
  159. *Details* +
  160. The default value of the setting `action.destructive_requires_name` changes from `false`
  161. to `true` in {es} 8.0.0.
  162. In previous versions, the default setting allowed users to use wildcard
  163. patterns to delete, close, or change index blocks on indices. In order
  164. to prevent the accidental deletion of indices that happen to match a
  165. wildcard pattern, we now require, by default, that any such destructive
  166. operation explicitly name the indices it intends to modify.
  167. *Impact* +
  168. If you would like to use wildcard patterns for destructive actions, set
  169. `action.destructive_requires_name` to `false` using the
  170. {ref}/cluster-update-settings.html[] cluster settings API].
  171. ====
  172. .Legacy role settings have been removed.
  173. [%collapsible]
  174. ====
  175. *Details* +
  176. The legacy role settings:
  177. * `node.data`
  178. * `node.ingest`
  179. * `node.master`
  180. * `node.ml`
  181. * `node.remote_cluster_client`
  182. * `node.transform`
  183. * `node.voting_only`
  184. have been removed. Instead, use the `node.roles` setting. If you were previously
  185. using the legacy role settings on a 7.13 or later cluster, you will have a
  186. deprecation log message on each of your nodes indicating the exact replacement
  187. value for `node.roles`.
  188. *Impact* +
  189. Discontinue use of the removed settings. Specifying these settings in
  190. `elasticsearch.yml` will result in an error on startup.
  191. ====
  192. [[system-call-filter-setting]]
  193. .System call filter setting removed
  194. [%collapsible]
  195. ====
  196. *Details* +
  197. Elasticsearch uses system call filters to remove its ability to fork another
  198. process. This is useful to mitigate remote code exploits. These system call
  199. filters are enabled by default, and were previously controlled via the setting
  200. `bootstrap.system_call_filter`. Starting in Elasticsearch 8.0, system call
  201. filters will be required. As such, the setting `bootstrap.system_call_filter`
  202. was deprecated in Elasticsearch 7.13.0, and is removed as of Elasticsearch
  203. 8.0.0.
  204. *Impact* +
  205. Discontinue use of the removed setting. Specifying this setting in Elasticsearch
  206. configuration will result in an error on startup.
  207. ====
  208. [[tier-filter-setting]]
  209. .Tier filtering settings removed
  210. [%collapsible]
  211. ====
  212. *Details* +
  213. The cluster and index level settings ending in `._tier` used for filtering the allocation of a shard
  214. to a particular set of nodes have been removed. Instead, the
  215. {ref}/data-tier-shard-filtering.html#tier-preference-allocation-filter[tier
  216. preference setting], `index.routing.allocation.include._tier_preference` should
  217. be used. The removed settings are:
  218. Cluster level settings:
  219. - `cluster.routing.allocation.include._tier`
  220. - `cluster.routing.allocation.exclude._tier`
  221. - `cluster.routing.allocation.require._tier`
  222. Index settings:
  223. - `index.routing.allocation.include._tier`
  224. - `index.routing.allocation.exclude._tier`
  225. - `index.routing.allocation.require._tier`
  226. *Impact* +
  227. Discontinue use of the removed settings. Specifying any of these cluster settings in Elasticsearch
  228. configuration will result in an error on startup. Any indices using these settings will have the
  229. settings archived (and they will have no effect) when the index metadata is loaded.
  230. ====
  231. [[shared-data-path-setting]]
  232. .Shared data path and per index data path settings deprecated
  233. [%collapsible]
  234. ====
  235. *Details* +
  236. Elasticsearch uses the shared data path as the base path of per index data
  237. paths. This feature was previously used with shared replicas. Starting in
  238. 7.13.0, these settings are deprecated. Starting in 8.0 only existing
  239. indices created in 7.x will be capable of using the shared data path and
  240. per index data path settings.
  241. *Impact* +
  242. Discontinue use of the deprecated settings.
  243. ====
  244. [[single-data-node-watermark-setting]]
  245. .Single data node watermark setting only accept true and is deprecated
  246. [%collapsible]
  247. ====
  248. *Details* +
  249. In 7.14, setting `cluster.routing.allocation.disk.watermark.enable_for_single_data_node`
  250. to false was deprecated. Starting in 8.0, the only legal value will be
  251. true. In a future release, the setting will be removed completely, with same
  252. behavior as if the setting was `true`.
  253. If the old behavior is desired for a single data node cluster, disk based
  254. allocation can be disabled by setting
  255. `cluster.routing.allocation.disk.threshold_enabled: false`
  256. *Impact* +
  257. Discontinue use of the deprecated setting.
  258. ====
  259. //end::notable-breaking-changes[]