Skip to content

Commit 9ab920c

Browse files
authored
[DOCS] Collapse remaining 8.0 breaking changes (#56418)
1 parent 01d71d2 commit 9ab920c

9 files changed

+196
-119
lines changed

docs/reference/migration/migrate_8_0.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ coming[8.0.0]
4040

4141
//tag::notable-breaking-changes[]
4242

43-
.Indices created in {es} 7.0 and earlier versions are not supported.
43+
.Indices created in {es} 6.x and earlier versions are not supported.
4444
[%collapsible]
4545
====
4646
*Details* +

docs/reference/migration/migrate_8_0/api.asciidoc

+10-6
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,23 @@
88

99
// end::notable-breaking-changes[]
1010

11-
[float]
12-
==== Deprecated `?local` parameter removed from `GET _cat/nodes` API
13-
11+
.The cat node API's `local` query parameter has been removed.
12+
[%collapsible]
13+
====
14+
*Details* +
1415
The `?local` parameter to the `GET _cat/nodes` API was deprecated in 7.x and is
1516
rejected in 8.0. This parameter caused the API to use the local cluster state
1617
to determine the nodes returned by the API rather than the cluster state from
1718
the master, but this API requests information from each selected node
1819
regardless of the `?local` parameter which means this API does not run in a
1920
fully node-local fashion.
21+
====
2022

21-
[float]
22-
==== Deprecated `local` parameter removed from get field mapping API
23-
23+
.The get field mapping API's `local` query parameter has been removed.
24+
[%collapsible]
25+
====
26+
*Details* +
2427
The `local` parameter for get field mapping API was deprecated in 7.8 and is
2528
removed in 8.0. This parameter is a no-op and field mappings are always retrieved
2629
locally.
30+
====

docs/reference/migration/migrate_8_0/ilm.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[float]
22
[[breaking_80_ilm_changes]]
3-
=== Index Lifecycle Management changes
3+
=== {ilm-cap} changes
44

55
//NOTE: The notable-breaking-changes tagged regions are re-used in the
66
//Installation and Upgrade Guide

docs/reference/migration/migrate_8_0/search.asciidoc

+45-24
Original file line numberDiff line numberDiff line change
@@ -8,65 +8,86 @@
88
//tag::notable-breaking-changes[]
99
//end::notable-breaking-changes[]
1010

11-
[float]
12-
==== Removal of types
13-
11+
.Search-related REST API endpoints containing mapping types have been removed.
12+
[%collapsible]
13+
====
14+
*Details* +
1415
The `/{index}/{type}/_search`, `/{index}/{type}/_msearch`, `/{index}/{type}/_search/template` and `/{index}/{type}/_msearch/template` REST endpoints have been removed in favour of `/{index}/_search`, `/{index}/_msearch`, `/{index}/_search/template` and `/{index}/_msearch/template`; since indexes no longer contain types, these typed endpoints are obsolete..
1516
1617
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..
1718
1819
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.
20+
====
1921

20-
[float]
21-
==== Removal of queries
22-
22+
.The `common` query has been removed.
23+
[%collapsible]
24+
====
25+
*Details* +
2326
The `common` query, deprecated in 7.x, has been removed in 8.0.
2427
The same functionality can be achieved by the `match` query if the total number of hits is not tracked.
28+
====
2529

26-
[float]
27-
===== Removal of query parameters
28-
30+
.The `cutoff_frequency` parameter has been removed from the `match` and `multi_match` query.
31+
[%collapsible]
32+
====
33+
*Details* +
2934
The `cutoff_frequency` parameter, deprecated in 7.x, has been removed in 8.0 from `match` and `multi_match` queries.
3035
The same functionality can be achieved without any configuration provided that the total number of hits is not tracked.
36+
====
3137

32-
[float]
33-
===== Removal of sort parameters
34-
38+
.The `nested_filter` and `nested_path` properties have been removed from the search API's `sort` request body parameter.
39+
[%collapsible]
40+
====
41+
*Details* +
3542
The `nested_filter` and `nested_path` options, deprecated in 6.x, have been removed in favor of the `nested` context.
43+
====
3644

37-
38-
[float]
39-
===== Shard allocation awareness in Search and Get requests
40-
45+
.Search and get requests are now routed to shards using adaptive replica selection by default.
46+
[%collapsible]
47+
====
48+
*Details* +
4149
{es} will no longer prefer using shards in the same location (with the same awareness attribute values) to process
4250
`_search` and `_get` requests. Adaptive replica selection (activated by default in this version) will route requests
4351
more efficiently using the service time of prior inter-node communications.
52+
====
4453

45-
[float]
46-
==== Removal of sparse vector fields
54+
.The `sparse_vector` field datatype has been removed.
55+
[%collapsible]
56+
====
57+
*Details* +
4758
The `sparse_vector` field type was deprecated in 7.6 and is now removed in
4859
8.0. We have not seen much interest in this experimental field type, and don't
4960
see a clear use case as it's currently designed. If you have feedback or
5061
suggestions around sparse vector functionality, please let us know through
5162
GitHub or the 'discuss' forums.
63+
====
5264

53-
[float]
54-
==== Update to vector function signatures
65+
.Vector functions using `(query, doc['field'])` are no longer supported.
66+
[%collapsible]
67+
====
68+
*Details* +
5569
The vector functions of the form `function(query, doc['field'])` were
5670
deprecated in 7.6, and are now removed in 8.x. The form
5771
`function(query, 'field')` should be used instead. For example,
5872
`cosineSimilarity(query, doc['field'])` is replaced by
5973
`cosineSimilarity(query, 'field')`.
74+
====
6075

61-
[float]
62-
==== Object format for `indices_boost`
76+
.The search API's `indices_boost` request body parameter no longer accepts object values.
77+
[%collapsible]
78+
====
79+
*Details* +
6380
The `indices_boost` option in the search request used to accept the boosts
6481
both as an object and as an array. The object format has been deprecated since
6582
5.2 and is now removed in 8.0.
83+
====
6684

67-
[float]
68-
==== Removal of `use_field_mapping` for docvalues fields
85+
.The search API's `use_field_mapping` request body parameter has been removed.
86+
[%collapsible]
87+
====
88+
*Details* +
6989
In 7.0, we began formatting `docvalue_fields` by default using each field's
7090
mapping definition. To ease the transition from 6.x, we added the format
7191
option `use_field_mapping`. This parameter was deprecated in 7.0, and is now
7292
removed in 8.0.
93+
====

docs/reference/migration/migrate_8_0/security.asciidoc

+58-39
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@
66
//Installation and Upgrade Guide
77

88
//tag::notable-breaking-changes[]
9-
[float]
10-
==== The realm `order` setting is required
11-
9+
.The realm `order` setting is now required.
10+
[%collapsible]
11+
====
12+
*Details* +
1213
The `xpack.security.authc.realms.{type}.{name}.order` setting is now required and must be
1314
specified for each explicitly configured realm. Each value must be unique.
1415
The cluster will fail to start if the requirements are not met.
@@ -29,49 +30,58 @@ xpack.security.authc.realms.kerberos.kerb1:
2930
keytab.path: es.keytab
3031
remove_realm_name: false
3132
--------------------------------------------------
32-
33+
====
3334
// end::notable-breaking-changes[]
3435

35-
[float]
3636
[[accept-default-password-removed]]
37-
==== The `accept_default_password` setting has been removed
38-
37+
.The `accept_default_password` setting has been removed.
38+
[%collapsible]
39+
====
40+
*Details* +
3941
The `xpack.security.authc.accept_default_password` setting has not had any affect
4042
since the 6.0 release of {es}. It has been removed and cannot be used.
43+
====
4144

42-
[float]
4345
[[roles-index-cache-removed]]
44-
==== The `roles.index.cache.*` settings have been removed
45-
46+
.The `roles.index.cache.*` settings have been removed.
47+
[%collapsible]
48+
====
49+
*Details* +
4650
The `xpack.security.authz.store.roles.index.cache.max_size` and
4751
`xpack.security.authz.store.roles.index.cache.ttl` settings have
4852
been removed. These settings have been redundant and deprecated
4953
since the 5.2 release of {es}.
54+
====
5055

51-
[float]
5256
[[migrate-tool-removed]]
53-
==== The `elasticsearch-migrate` tool has been removed
54-
57+
.The `elasticsearch-migrate` tool has been removed.
58+
[%collapsible]
59+
====
60+
*Details* +
5561
The `elasticsearch-migrate` tool provided a way to convert file
5662
realm users and roles into the native realm. It has been deprecated
5763
since 7.2.0. Users and roles should now be created in the native
5864
realm directly.
65+
====
5966

60-
[float]
6167
[[separating-node-and-client-traffic]]
62-
==== The `transport.profiles.*.xpack.security.type` setting has been removed
63-
68+
.The `transport.profiles.*.xpack.security.type` setting has been removed.
69+
[%collapsible]
70+
====
71+
*Details* +
6472
The `transport.profiles.*.xpack.security.type` setting has been removed since
6573
the Transport Client has been removed and therefore all client traffic now uses
6674
the HTTP transport. Transport profiles using this setting should be removed.
75+
====
6776

68-
[float]
77+
[discrete]
6978
[[ssl-validation-changes]]
7079
==== SSL/TLS configuration validation
7180

72-
[float]
73-
===== The `xpack.security.transport.ssl.enabled` setting may be required
74-
81+
.The `xpack.security.transport.ssl.enabled` setting is now required to configure `xpack.security.transport.ssl` settings.
82+
[%collapsible]
83+
====
84+
*Details* +
7585
It is now an error to configure any SSL settings for
7686
`xpack.security.transport.ssl` without also configuring
7787
`xpack.security.transport.ssl.enabled`.
@@ -91,10 +101,12 @@ xpack.security.transport.ssl.keystore.path: elastic-certificates.p12
91101
xpack.security.transport.ssl.truststore.path: elastic-certificates.p12
92102
--------------------------------------------------
93103
<1> or `false`.
104+
====
94105

95-
[float]
96-
===== The `xpack.security.http.ssl.enabled` setting may be required
97-
106+
.The `xpack.security.http.ssl.enabled` setting is now required to configure `xpack.security.http.ssl` settings.
107+
[%collapsible]
108+
====
109+
*Details* +
98110
It is now an error to configure any SSL settings for
99111
`xpack.security.http.ssl` without also configuring
100112
`xpack.security.http.ssl.enabled`.
@@ -116,31 +128,36 @@ xpack.security.http.ssl.key: elasticsearch.key
116128
xpack.security.http.ssl.certificate_authorities: [ "corporate-ca.crt" ]
117129
--------------------------------------------------
118130
<1> or `false`.
131+
====
119132

120-
[float]
121-
===== The `xpack.security.transport.ssl` Certificate and Key may be required
122-
133+
.A `xpack.security.transport.ssl` certificate and key are now required to enable SSL for the transport interface.
134+
[%collapsible]
135+
====
136+
*Details* +
123137
It is now an error to enable SSL for the transport interface without also configuring
124138
a certificate and key through use of the `xpack.security.transport.ssl.keystore.path`
125139
setting or the `xpack.security.transport.ssl.certificate` and
126140
`xpack.security.transport.ssl.key` settings.
141+
====
127142

128-
[float]
129-
===== The `xpack.security.http.ssl` Certificate and Key may be required
130-
143+
.A `xpack.security.http.ssl` certificate and key are now required to enable SSL for the HTTP server.
144+
[%collapsible]
145+
====
146+
*Details* +
131147
It is now an error to enable SSL for the HTTP (Rest) server without also configuring
132148
a certificate and key through use of the `xpack.security.http.ssl.keystore.path`
133149
setting or the `xpack.security.http.ssl.certificate` and
134150
`xpack.security.http.ssl.key` settings.
151+
====
135152

136-
137-
[float]
153+
[discrete]
138154
[[builtin-users-changes]]
139155
==== Changes to built-in users
140156

141-
[float]
142-
===== The `kibana` user has been removed in favor of the `kibana_system` user
143-
157+
.The `kibana` user has been renamed `kibana_system`.
158+
[%collapsible]
159+
====
160+
*Details* +
144161
The `kibana` user was historically used to authenticate {kib} to {es}.
145162
The name of this user was confusing, and was often mistakenly used to login to {kib}.
146163
This has been renamed to `kibana_system` in order to reduce confusion, and to better
@@ -157,15 +174,17 @@ then you should update to use the new `kibana_system` user instead:
157174
--------------------------------------------------
158175
elasticsearch.username: kibana_system
159176
--------------------------------------------------
177+
====
160178

161-
162-
[float]
179+
[discrete]
163180
[[builtin-roles-changes]]
164181
==== Changes to built-in roles
165182

166-
[float]
167-
===== The `kibana_user` role has been removed in favor of the `kibana_admin` role
168-
183+
.The `kibana_user` role has been renamed to `kibana_admin`.
184+
[%collapsible]
185+
====
186+
*Details* +
169187
Users who were previously assigned the `kibana_user` role should instead be assigned
170188
the `kibana_admin` role. This role grants the same set of privileges as `kibana_user`, but has been
171189
renamed to better reflect its intended use.
190+
====

0 commit comments

Comments
 (0)