Browse Source

[DOCS] Add impact sections to API, search, transport, thread pool 8.0 breaking changes (#56437)

James Rodewig 5 years ago
parent
commit
754a3e98e6

+ 9 - 0
docs/reference/migration/migrate_8_0/api.asciidoc

@@ -18,6 +18,10 @@ to determine the nodes returned by the API rather than the cluster state from
 the master, but this API requests information from each selected node
 regardless of the `?local` parameter which means this API does not run in a
 fully node-local fashion.
+
+*Impact* +
+Discontinue use of the `?local` query parameter. {ref}/cat-nodes.html[cat node
+API] requests that include this parameter will return an error.
 ====
 
 .The get field mapping API's `local` query parameter has been removed.
@@ -27,4 +31,9 @@ fully node-local fashion.
 The `local` parameter for get field mapping API was deprecated in 7.8 and is
 removed in 8.0. This parameter is a no-op and field mappings are always retrieved
 locally.
+
+*Impact* +
+Discontinue use of the `local` query parameter.
+{ref}/indices-get-field-mapping.html[get field mapping API] requests that
+include this parameter will return an error.
 ====

+ 37 - 0
docs/reference/migration/migrate_8_0/search.asciidoc

@@ -17,6 +17,10 @@ The `/{index}/{type}/_search`, `/{index}/{type}/_msearch`, `/{index}/{type}/_sea
 The `/{index}/{type}/_termvectors`, `/{index}/{type}/{id}/_termvectors` and `/{index}/{type}/_mtermvectors` REST endpoints have been removed in favour of `/{index}/_termvectors`, `/{index}/{id}/_termvectors` and `/{index}/_mtermvectors`; since indexes no longer contain types, these typed endpoints are obsolete..
 
 The `/{index}/{type}/{doc}` and `/{index}/{type}/_mget` REST endpoints have been removed in favour of `/{index}/_doc/{doc}` and `/{index}/_mget`; since indexes no longer contain types, these typed endpoints are obsolete.
+
+*Impact* +
+Use the replacement REST API endpoints. Requests submitted to API endpoints that
+contain a mapping type will return an error.
 ====
 
 .The `common` query has been removed.
@@ -25,6 +29,10 @@ The `/{index}/{type}/{doc}` and `/{index}/{type}/_mget` REST endpoints have been
 *Details* +
 The `common` query, deprecated in 7.x, has been removed in 8.0.
 The same functionality can be achieved by the `match` query if the total number of hits is not tracked.
+
+*Impact* +
+Discontinue use of the `common` query. Search requests containing a `common`
+query will return an error.
 ====
 
 .The `cutoff_frequency` parameter has been removed from the `match` and `multi_match` query.
@@ -33,6 +41,10 @@ The same functionality can be achieved by the `match` query if the total number
 *Details* +
 The `cutoff_frequency` parameter, deprecated in 7.x, has been removed in 8.0 from `match` and `multi_match` queries.
 The same functionality can be achieved without any configuration provided that the total number of hits is not tracked.
+
+*Impact* +
+Discontinue use of the `cutoff_frequency` parameter. Search requests containing
+this parameter in a `match` or `multi_match` query will return an error.
 ====
 
 .The `nested_filter` and `nested_path` properties have been removed from the search API's `sort` request body parameter.
@@ -40,6 +52,11 @@ The same functionality can be achieved without any configuration provided that t
 ====
 *Details* +
 The `nested_filter` and `nested_path` options, deprecated in 6.x, have been removed in favor of the `nested` context.
+
+*Impact* +
+Discontinue use of the `sort` request body parameter's `nested_filter` and
+`nested_path` properties. Requests containing these properties will return an
+error.
 ====
 
 .Search and get requests are now routed to shards using adaptive replica selection by default.
@@ -49,6 +66,9 @@ The `nested_filter` and `nested_path` options, deprecated in 6.x, have been remo
 {es} will no longer prefer using shards in the same location (with the same awareness attribute values) to process
 `_search` and `_get` requests. Adaptive replica selection (activated by default in this version) will route requests
 more efficiently using the service time of prior inter-node communications.
+
+*Impact* +
+No action needed.
 ====
 
 .The `sparse_vector` field datatype has been removed.
@@ -60,6 +80,10 @@ The `sparse_vector` field type was deprecated in 7.6 and is now removed in
 see a clear use case as it's currently designed. If you have feedback or
 suggestions around sparse vector functionality, please let us know through
 GitHub or the 'discuss' forums.
+
+*Impact* +
+Discontinue use of the `sparse_vector` field datatype. Requests containing 
+a mapping for this field datatype will return an error.
 ====
 
 .Vector functions using `(query, doc['field'])` are no longer supported.
@@ -71,6 +95,11 @@ deprecated in 7.6, and are now removed in 8.x. The form
 `function(query, 'field')` should be used instead. For example,
 `cosineSimilarity(query, doc['field'])` is replaced by
 `cosineSimilarity(query, 'field')`.
+
+*Impact* +
+Use the `function(query, 'field')` form. Discontinue use of the `function(query,
+doc['field'])` form. Requests containing the `function(query,
+doc['field'])` form will return an error.
 ====
 
 .The search API's `indices_boost` request body parameter no longer accepts object values.
@@ -80,6 +109,10 @@ deprecated in 7.6, and are now removed in 8.x. The form
 The `indices_boost` option in the search request used to accept the boosts
 both as an object and as an array. The object format has been deprecated since
 5.2 and is now removed in 8.0.
+
+*Impact* +
+Use only array values in the `indices_boost` parameter. Requests containing an
+object value in the `indices_boost` parameter will return an error.
 ====
 
 .The search API's `use_field_mapping` request body parameter has been removed.
@@ -90,4 +123,8 @@ In 7.0, we began formatting `docvalue_fields` by default using each field's
 mapping definition. To ease the transition from 6.x, we added the format
 option `use_field_mapping`. This parameter was deprecated in 7.0, and is now
 removed in 8.0.
+
+*Impact* +
+Discontinue use of the `use_field_mapping` request body parameter. Requests
+containing this parameter will return an error.
 ====

+ 3 - 0
docs/reference/migration/migrate_8_0/threadpool.asciidoc

@@ -15,4 +15,7 @@
 The `fixed_auto_queue_size` thread pool type, previously marked as an
 experimental feature, was deprecated in 7.x and has been removed in 8.0.
 The `search` and `search_throttled` thread pools have the `fixed` type now.
+
+*Impact* +
+No action needed.
 ====

+ 5 - 0
docs/reference/migration/migrate_8_0/transport.asciidoc

@@ -19,6 +19,11 @@ setting that was introduced in 6.7.
 - `transport.profiles.profile_name.reuse_address` replaced by `transport.profiles.profile_name.tcp.reuse_address`
 - `transport.profiles.profile_name.send_buffer_size` replaced by `transport.profiles.profile_name.tcp.send_buffer_size`
 - `transport.profiles.profile_name.receive_buffer_size` replaced by `transport.profiles.profile_name.tcp.receive_buffer_size`
+
+*Impact* +
+Use the replacement settings. Discontinue use of the removed settings.
+Specifying the removed settings in `elasticsearch.yml` will result in an error
+on startup.
 ====
 
 // end::notable-breaking-changes[]