Skip to content

Commit d6ed147

Browse files
lcawlkcm
authored andcommitted
[DOCS] Synchronize location of Breaking Changes (#33588)
1 parent c37d1fa commit d6ed147

17 files changed

+110
-27
lines changed

docs/reference/index.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,6 @@ include::setup/bootstrap-checks-xes.asciidoc[]
2929
:edit_url:
3030
include::upgrade.asciidoc[]
3131

32-
include::migration/index.asciidoc[]
33-
3432
include::api-conventions.asciidoc[]
3533

3634
include::docs.asciidoc[]
@@ -76,6 +74,8 @@ include::glossary.asciidoc[]
7674

7775
include::release-notes/highlights.asciidoc[]
7876

77+
include::migration/index.asciidoc[]
78+
7979
include::release-notes.asciidoc[]
8080

8181
include::redirects.asciidoc[]

docs/reference/migration/migrate_7_0.asciidoc

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,14 @@
11
[[breaking-changes-7.0]]
22
== Breaking changes in 7.0
3+
++++
4+
<titleabbrev>7.0</titleabbrev>
5+
++++
36

47
This section discusses the changes that you need to be aware of when migrating
58
your application to Elasticsearch 7.0.
69

710
See also <<release-highlights>> and <<es-release-notes>>.
811

9-
[float]
10-
=== Indices created before 7.0
11-
12-
Elasticsearch 7.0 can read indices created in version 6.0 or above. An
13-
Elasticsearch 7.0 node will not start in the presence of indices created in a
14-
version of Elasticsearch before 6.0.
15-
16-
[IMPORTANT]
17-
.Reindex indices from Elasticsearch 5.x or before
18-
=========================================
19-
20-
Indices created in Elasticsearch 5.x or before will need to be reindexed with
21-
Elasticsearch 6.x in order to be readable by Elasticsearch 7.x.
22-
23-
=========================================
24-
25-
[float]
26-
=== Also see:
27-
2812
* <<breaking_70_aggregations_changes>>
2913
* <<breaking_70_cluster_changes>>
3014
* <<breaking_70_indices_changes>>
@@ -41,6 +25,22 @@ Elasticsearch 6.x in order to be readable by Elasticsearch 7.x.
4125
* <<breaking_70_restclient_changes>>
4226
* <<breaking_70_low_level_restclient_changes>>
4327

28+
[float]
29+
=== Indices created before 7.0
30+
31+
Elasticsearch 7.0 can read indices created in version 6.0 or above. An
32+
Elasticsearch 7.0 node will not start in the presence of indices created in a
33+
version of Elasticsearch before 6.0.
34+
35+
[IMPORTANT]
36+
.Reindex indices from Elasticsearch 5.x or before
37+
=========================================
38+
39+
Indices created in Elasticsearch 5.x or before will need to be reindexed with
40+
Elasticsearch 6.x in order to be readable by Elasticsearch 7.x.
41+
42+
=========================================
43+
4444
include::migrate_7_0/aggregations.asciidoc[]
4545
include::migrate_7_0/analysis.asciidoc[]
4646
include::migrate_7_0/cluster.asciidoc[]

docs/reference/migration/migrate_7_0/aggregations.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,26 @@
1+
[float]
12
[[breaking_70_aggregations_changes]]
23
=== Aggregations changes
34

5+
[float]
46
==== Deprecated `global_ordinals_hash` and `global_ordinals_low_cardinality` execution hints for terms aggregations have been removed
57

68
These `execution_hint` are removed and should be replaced by `global_ordinals`.
79

10+
[float]
811
==== `search.max_buckets` in the cluster setting
912

1013
The dynamic cluster setting named `search.max_buckets` now defaults
1114
to 10,000 (instead of unlimited in the previous version).
1215
Requests that try to return more than the limit will fail with an exception.
1316

17+
[float]
1418
==== `missing` option of the `composite` aggregation has been removed
1519

1620
The `missing` option of the `composite` aggregation, deprecated in 6.x,
1721
has been removed. `missing_bucket` should be used instead.
1822

23+
[float]
1924
==== Replaced `params._agg` with `state` context variable in scripted metric aggregations
2025

2126
The object used to share aggregation state between the scripts in a Scripted Metric

docs/reference/migration/migrate_7_0/analysis.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1+
[float]
12
[[breaking_70_analysis_changes]]
23
=== Analysis changes
34

5+
[float]
46
==== Limiting the number of tokens produced by _analyze
57

68
To safeguard against out of memory errors, the number of tokens that can be produced
79
using the `_analyze` endpoint has been limited to 10000. This default limit can be changed
810
for a particular index with the index setting `index.analyze.max_token_count`.
911

12+
[float]
1013
==== Limiting the length of an analyzed text during highlighting
1114

1215
Highlighting a text that was indexed without offsets or term vectors,
@@ -16,13 +19,15 @@ To protect against this, the maximum number of characters that will be analyzed
1619
limited to 1000000. This default limit can be changed
1720
for a particular index with the index setting `index.highlight.max_analyzed_offset`.
1821

22+
[float]
1923
==== `delimited_payload_filter` renaming
2024

2125
The `delimited_payload_filter` was deprecated and renamed to `delimited_payload` in 6.2.
2226
Using it in indices created before 7.0 will issue deprecation warnings. Using the old
2327
name in new indices created in 7.0 will throw an error. Use the new name `delimited_payload`
2428
instead.
2529

30+
[float]
2631
==== `standard` filter has been removed
2732

2833
The `standard` token filter has been removed because it doesn't change anything in the stream.

docs/reference/migration/migrate_7_0/api.asciidoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
[float]
12
[[breaking_70_api_changes]]
23
=== API changes
34

5+
[float]
46
==== Camel case and underscore parameters deprecated in 6.x have been removed
57
A number of duplicate parameters deprecated in 6.x have been removed from
68
Bulk request, Multi Get request, Term Vectors request, and More Like This Query
@@ -22,6 +24,7 @@ The following parameters starting with underscore have been removed:
2224
Instead of these removed parameters, use their non camel case equivalents without
2325
starting underscore, e.g. use `version_type` instead of `_version_type` or `versionType`.
2426

27+
[float]
2528
==== Thread pool info
2629

2730
In previous versions of Elasticsearch, the thread pool info returned in the
@@ -48,10 +51,12 @@ aligns the output of the API with the configuration values for thread
4851
pools. Note that `core` and `max` will be populated for scaling thread pools,
4952
and `size` will be populated for fixed thread pools.
5053

54+
[float]
5155
==== The parameter `fields` deprecated in 6.x has been removed from Bulk request
5256
and Update request. The Update API returns `400 - Bad request` if request contains
5357
unknown parameters (instead of ignored in the previous version).
5458

59+
[float]
5560
[[remove-suggest-metric]]
5661
==== Remove support for `suggest` metric/index metric in indices stats and nodes stats APIs
5762

@@ -66,6 +71,7 @@ In the past, `fields` could be provided either as a parameter, or as part of the
6671
body. Specifying `fields` in the request body as opposed to a parameter was deprecated
6772
in 6.4.0, and is now unsupported in 7.0.0.
6873

74+
[float]
6975
==== `copy_settings` is deprecated on shrink and split APIs
7076

7177
Versions of Elasticsearch prior to 6.4.0 did not copy index settings on shrink
@@ -76,10 +82,12 @@ will be for such settings to be copied on such operations. To enable users in
7682
the only behavior in 8.0.0, this parameter is deprecated in 7.0.0 for removal in
7783
8.0.0.
7884

85+
[float]
7986
==== The deprecated stored script contexts have now been removed
8087
When putting stored scripts, support for storing them with the deprecated `template` context or without a context is
8188
now removed. Scripts must be stored using the `script` context as mentioned in the documentation.
8289

90+
[float]
8391
==== Get Aliases API limitations when {security} is enabled removed
8492

8593
The behavior and response codes of the get aliases API no longer vary
@@ -88,6 +96,7 @@ depending on whether {security} is enabled. Previously a
8896
current user was not authorized for any alias. An empty response with
8997
status 200 - OK is now returned instead at all times.
9098

99+
[float]
91100
==== Put User API response no longer has `user` object
92101

93102
The Put User API response was changed in 6.5.0 to add the `created` field
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
1+
[float]
12
[[breaking_70_cluster_changes]]
23
=== Cluster changes
34

5+
[float]
46
==== `:` is no longer allowed in cluster name
57

68
Due to cross-cluster search using `:` to separate a cluster and index name,
79
cluster names may no longer contain `:`.
810

11+
[float]
912
==== New default for `wait_for_active_shards` parameter of the open index command
1013

1114
The default value for the `wait_for_active_shards` parameter of the open index API
1215
is changed from 0 to 1, which means that the command will now by default wait for all
1316
primary shards of the opened index to be allocated.
1417

18+
[float]
1519
==== Shard preferences `_primary`, `_primary_first`, `_replica`, and `_replica_first` are removed
1620
These shard preferences are removed in favour of the `_prefer_nodes` and `_only_nodes` preferences.

docs/reference/migration/migrate_7_0/indices.asciidoc

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
1+
[float]
12
[[breaking_70_indices_changes]]
23
=== Indices changes
34

5+
[float]
46
==== `:` is no longer allowed in index name
57

68
Due to cross-cluster search using `:` to separate a cluster and index name,
79
index names may no longer contain `:`.
810

11+
[float]
912
==== `index.unassigned.node_left.delayed_timeout` may no longer be negative
1013

1114
Negative values were interpreted as zero in earlier versions but are no
1215
longer accepted.
1316

14-
17+
[float]
1518
==== `_flush` and `_force_merge` will no longer refresh
1619

1720
In previous versions issuing a `_flush` or `_force_merge` (with `flush=true`)
@@ -20,7 +23,7 @@ visible to searches and non-realtime GET operations. From now on these operation
2023
don't have this side-effect anymore. To make documents visible an explicit `_refresh`
2124
call is needed unless the index is refreshed by the internal scheduler.
2225

23-
26+
[float]
2427
==== Limit to the difference between max_size and min_size in NGramTokenFilter and NGramTokenizer
2528

2629
To safeguard against creating too many index terms, the difference between `max_ngram` and
@@ -29,7 +32,7 @@ limit can be changed with the index setting `index.max_ngram_diff`. Note that if
2932
exceeded a error is thrown only for new indices. For existing pre-7.0 indices, a deprecation
3033
warning is logged.
3134

32-
35+
[float]
3336
==== Limit to the difference between max_size and min_size in ShingleTokenFilter
3437

3538
To safeguard against creating too many tokens, the difference between `max_shingle_size` and
@@ -38,6 +41,7 @@ limit can be changed with the index setting `index.max_shingle_diff`. Note that
3841
exceeded a error is thrown only for new indices. For existing pre-7.0 indices, a deprecation
3942
warning is logged.
4043

44+
[float]
4145
==== Document distribution changes
4246

4347
Indices created with version `7.0.0` onwards will have an automatic `index.number_of_routing_shards`
@@ -46,6 +50,7 @@ shards the index has. In order to maintain the exact same distribution as a pre
4650
`index.number_of_routing_shards` must be set to the `index.number_of_shards` at index creation time.
4751
Note: if the number of routing shards equals the number of shards `_split` operations are not supported.
4852

53+
[float]
4954
==== Skipped background refresh on search idle shards
5055

5156
Shards belonging to an index that does not have an explicit
@@ -56,6 +61,7 @@ that access a search idle shard will be "parked" until the next refresh
5661
happens. Indexing requests with `wait_for_refresh` will also trigger
5762
a background refresh.
5863

64+
[float]
5965
==== Remove deprecated url parameters for Clear Indices Cache API
6066

6167
The following previously deprecated url parameter have been removed:
@@ -65,12 +71,14 @@ The following previously deprecated url parameter have been removed:
6571
* `request_cache` - use `request` instead
6672
* `field_data` - use `fielddata` instead
6773

74+
[float]
6875
==== `network.breaker.inflight_requests.overhead` increased to 2
6976

7077
Previously the in flight requests circuit breaker considered only the raw byte representation.
7178
By bumping the value of `network.breaker.inflight_requests.overhead` from 1 to 2, this circuit
7279
breaker considers now also the memory overhead of representing the request as a structured object.
7380

81+
[float]
7482
==== Parent circuit breaker changes
7583

7684
The parent circuit breaker defines a new setting `indices.breaker.total.use_real_memory` which is
@@ -79,6 +87,7 @@ heap memory instead of only considering the reserved memory by child circuit bre
7987
setting is `true`, the default parent breaker limit also changes from 70% to 95% of the JVM heap size.
8088
The previous behavior can be restored by setting `indices.breaker.total.use_real_memory` to `false`.
8189

90+
[float]
8291
==== `fix` value for `index.shard.check_on_startup` is removed
8392

8493
Deprecated option value `fix` for setting `index.shard.check_on_startup` is not supported.

docs/reference/migration/migrate_7_0/java.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,28 @@
1+
[float]
12
[[breaking_70_java_changes]]
23
=== Java API changes
34

5+
[float]
46
==== `isShardsAcked` deprecated in `6.2` has been removed
57

68
`isShardsAcked` has been replaced by `isShardsAcknowledged` in
79
`CreateIndexResponse`, `RolloverResponse` and
810
`CreateIndexClusterStateUpdateResponse`.
911

12+
[float]
1013
==== `prepareExecute` removed from the client api
1114

1215
The `prepareExecute` method which created a request builder has been
1316
removed from the client api. Instead, construct a builder for the
1417
appropriate request directly.
1518

19+
[float]
1620
==== Some Aggregation classes have moved packages
1721

1822
* All classes present in `org.elasticsearch.search.aggregations.metrics.*` packages
1923
were moved to a single `org.elasticsearch.search.aggregations.metrics` package.
2024

25+
[float]
2126
==== `Retry.withBackoff` methods with `Settings` removed
2227

2328
The variants of `Retry.withBackoff` that included `Settings` have been removed

docs/reference/migration/migrate_7_0/low_level_restclient.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
1+
[float]
12
[[breaking_70_low_level_restclient_changes]]
23
=== Low-level REST client changes
34

5+
[float]
46
==== Deprecated flavors of performRequest have been removed
57

68
We deprecated the flavors of `performRequest` and `performRequestAsync` that
79
do not take `Request` objects in 6.4.0 in favor of the flavors that take
810
`Request` objects because those methods can be extended without breaking
911
backwards compatibility.
1012

13+
[float]
1114
==== Removed setHosts
1215

1316
We deprecated `setHosts` in 6.4.0 in favor of `setNodes` because it supports

0 commit comments

Comments
 (0)