Skip to content

Commit cfa5319

Browse files
authored
Mark notable breaking changes for 7.0 (#40478)
This commit adds a tag for each breaking change that could be considered notable.
1 parent f63766d commit cfa5319

File tree

10 files changed

+42
-8
lines changed

10 files changed

+42
-8
lines changed

docs/reference/migration/migrate_7_0/aggregations.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,14 @@
77

88
These `execution_hint` are removed and should be replaced by `global_ordinals`.
99

10+
//tag::notable-breaking-changes[]
1011
[float]
1112
==== `search.max_buckets` in the cluster setting
1213

1314
The dynamic cluster setting named `search.max_buckets` now defaults
1415
to 10,000 (instead of unlimited in the previous version).
1516
Requests that try to return more than the limit will fail with an exception.
17+
//end::notable-breaking-changes[]
1618

1719
[float]
1820
==== `missing` option of the `composite` aggregation has been removed

docs/reference/migration/migrate_7_0/api.asciidoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
[[breaking_70_api_changes]]
33
=== API changes
44

5+
//tag::notable-breaking-changes[]
56
[float]
67
==== Internal Versioning is no longer supported for optimistic concurrency control
78

@@ -14,9 +15,12 @@ while handling a write operation, it may expose a version that will then be reus
1415
new primary.
1516

1617
Due to that issue, internal versioning can no longer be used and is replaced by a new
17-
method based on sequence numbers. See <<optimistic-concurrency-control>> for more details.
18+
method based on sequence numbers. See
19+
{ref}/optimistic-concurrency-control.html[Optimistic concurrency control] for
20+
more details.
1821

1922
Note that the `external` versioning type is still fully supported.
23+
//end::notable-breaking-changes[]
2024

2125
[float]
2226
==== Camel case and underscore parameters deprecated in 6.x have been removed

docs/reference/migration/migrate_7_0/cluster.asciidoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,18 @@ The default value for the `wait_for_active_shards` parameter of the open index A
1515
is changed from 0 to 1, which means that the command will now by default wait for all
1616
primary shards of the opened index to be allocated.
1717

18+
//tag::notable-breaking-changes[]
1819
[float]
1920
==== Shard preferences `_primary`, `_primary_first`, `_replica`, and `_replica_first` are removed
2021
These shard preferences are removed in favour of the `_prefer_nodes` and `_only_nodes` preferences.
22+
//end::notable-breaking-changes[]
2123

24+
//tag::notable-breaking-changes[]
2225
[float]
2326
==== Cluster-wide shard soft limit
2427
Clusters now have soft limits on the total number of open shards in the cluster
2528
based on the number of nodes and the `cluster.max_shards_per_node` cluster
2629
setting, to prevent accidental operations that would destabilize the cluster.
27-
More information can be found in the <<misc-cluster,documentation for that setting>>.
30+
More information can be found in the
31+
{ref}/misc-cluster.html[documentation for that setting].
32+
//end::notable-breaking-changes[]

docs/reference/migration/migrate_7_0/discovery.asciidoc

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,21 @@
22
[[breaking_70_discovery_changes]]
33
=== Discovery changes
44

5+
//tag::notable-breaking-changes[]
56
[float]
67
==== Cluster bootstrapping is required if discovery is configured
78

89
The first time a cluster is started, `cluster.initial_master_nodes` must be set
910
to perform cluster bootstrapping. It should contain the names of the
1011
master-eligible nodes in the initial cluster and be defined on every
11-
master-eligible node in the cluster. See <<discovery-settings,the discovery
12-
settings summary>> for an example, and the
13-
<<modules-discovery-bootstrap-cluster,cluster bootstrapping reference
14-
documentation>> describes this setting in more detail.
12+
master-eligible node in the cluster. See
13+
{ref}/discovery-settings.html[the discovery settings summary] for an example, and the
14+
{ref}/modules-discovery-bootstrap-cluster.html[cluster bootstrapping reference
15+
documentation] describes this setting in more detail.
1516

1617
The `discovery.zen.minimum_master_nodes` setting is permitted, but ignored, on
1718
7.x nodes.
19+
//end::notable-breaking-changes[]
1820

1921
[float]
2022
==== Removing master-eligible nodes sometimes requires voting exclusions
@@ -28,6 +30,7 @@ such as data-only nodes or coordinating-only nodes, voting exclusions are not
2830
required. Likewise, if you add nodes to the cluster, voting exclusions are not
2931
required.
3032

33+
//tag::notable-breaking-changes[]
3134
[float]
3235
==== Discovery configuration is required in production
3336

@@ -44,6 +47,7 @@ file:
4447
The first three settings in this list are only available in versions 7.0 and
4548
above. If you are preparing to upgrade from an earlier version, you must set
4649
`discovery.zen.ping.unicast.hosts` or `discovery.zen.hosts_provider`.
50+
//end::notable-breaking-changes[]
4751

4852
[float]
4953
==== New name for `no_master_block` setting

docs/reference/migration/migrate_7_0/indices.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22
[[breaking_70_indices_changes]]
33
=== Indices changes
44

5+
//tag::notable-breaking-changes[]
56
[float]
67
==== Index creation no longer defaults to five shards
78
Previous versions of Elasticsearch defaulted to creating five shards per index.
89
Starting with 7.0.0, the default is now one shard per index.
10+
//end::notable-breaking-changes[]
911

1012
[float]
1113
==== `:` is no longer allowed in index name

docs/reference/migration/migrate_7_0/java_time.asciidoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
2+
//tag::notable-breaking-changes[]
13
[float]
24
[[breaking_70_java_time_changes]]
3-
=== Replacing Joda-Time with java time
5+
==== Replacing Joda-Time with java time
46

57
Since Java 8 there is a dedicated `java.time` package, which is superior to
68
the Joda-Time library, that has been used so far in Elasticsearch. One of
@@ -10,6 +12,7 @@ to remove the Joda-Time dependency in the future.
1012

1113
The mappings, aggregations and search code switched from Joda-Time to
1214
java time.
15+
//end::notable-breaking-changes[]
1316

1417
[float]
1518
==== Joda based date formatters are replaced with java ones

docs/reference/migration/migrate_7_0/mappings.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,14 @@ This field used to index a composite key formed of the `_type` and the `_id`.
1414
Now that indices cannot have multiple types, this has been removed in favour
1515
of `_id`.
1616

17+
//tag::notable-breaking-changes[]
1718
[float]
1819
==== The `_default_` mapping is no longer allowed
1920

2021
The `_default_` mapping has been deprecated in 6.0 and is now no longer allowed
2122
in 7.0. Trying to configure a `_default_` mapping on 7.x indices will result in
2223
an error.
24+
//end::notable-breaking-changes[]
2325

2426
[float]
2527
==== `index_options` for numeric fields has been removed

docs/reference/migration/migrate_7_0/plugins.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,13 @@ Setting.AffixSetting<String> MY_SETTING = Setting.affixKeySetting(
6464

6565
The `RealmSettings.simpleString` method can be used as a convenience for the above.
6666

67+
//tag::notable-breaking-changes[]
6768
[float]
6869
==== Tribe node removed
6970

7071
Tribe node functionality has been removed in favor of
71-
<<modules-cross-cluster-search,Cross Cluster Search>>.
72+
{ref}/modules-cross-cluster-search.html[{ccs}].
73+
//end::notable-breaking-changes[]
7274

7375
[float]
7476
==== Discovery implementations are no longer pluggable

docs/reference/migration/migrate_7_0/search.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,7 @@ on whether queries need to access score or not. As a result `bool` queries with
205205
`minimum_should_match` to 1. This behavior has been deprecated in the previous
206206
major version.
207207

208+
//tag::notable-breaking-changes[]
208209
[float]
209210
==== `hits.total` is now an object in the search response
210211

@@ -232,6 +233,7 @@ You can also retrieve `hits.total` as a number in the rest response by adding
232233
`rest_total_hits_as_int=true` in the request parameter of the search request.
233234
This parameter has been added to ease the transition to the new format and
234235
will be removed in the next major version (8.0).
236+
//end::notable-breaking-changes[]
235237

236238
[float]
237239
==== `hits.total` is omitted in the response if `track_total_hits` is disabled (false)
@@ -241,6 +243,7 @@ will set `hits.total` to null and the object will not be displayed in the rest
241243
layer. You can add `rest_total_hits_as_int=true` in the search request parameters
242244
to get the old format back (`"total": -1`).
243245

246+
//tag::notable-breaking-changes[]
244247
[float]
245248
==== `track_total_hits` defaults to 10,000
246249

@@ -271,3 +274,4 @@ documents. If the total number of hits that match the query is greater than this
271274

272275
You can force the count to always be accurate by setting `"track_total_hits`
273276
to true explicitly in the search request.
277+
//end::notable-breaking-changes[]

docs/reference/migration/migrate_7_0/settings.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22
[[breaking_70_settings_changes]]
33
=== Settings changes
44

5+
//tag::notable-breaking-changes[]
56
[float]
67
==== The default for `node.name` is now the hostname
78

89
`node.name` now defaults to the hostname at the time when Elasticsearch
910
is started. Previously the default node name was the first eight characters
1011
of the node id. It can still be configured explicitly in `elasticsearch.yml`.
12+
//end::notable-breaking-changes[]
1113

1214
[float]
1315
==== Percolator
@@ -94,6 +96,7 @@ default value of `false`.
9496

9597
[float]
9698
[[include-realm-type-in-setting]]
99+
//tag::notable-breaking-changes-7.0
97100
==== Security realms settings
98101

99102
The settings for all security realms must now include the realm type as part
@@ -121,6 +124,7 @@ xpack.security.authc.realms:
121124
Any realm specific secure settings that have been stored in the elasticsearch
122125
keystore (such as ldap bind passwords, or passwords for ssl keys) must be updated
123126
in a similar way.
127+
//end::notable-breaking-changes-7.0
124128

125129
[float]
126130
[[tls-setting-fallback]]
@@ -132,6 +136,7 @@ fallback to a default configuration when using TLS. Each component (realm, trans
132136
http client, etc) must now be configured with their own settings for TLS if it is being
133137
used.
134138

139+
//tag::notable-breaking-changes[]
135140
[float]
136141
[[tls-v1-removed]]
137142
==== TLS v1.0 disabled
@@ -144,6 +149,7 @@ You can enable TLS v1.0 by configuring the relevant `ssl.supported_protocols` se
144149
--------------------------------------------------
145150
xpack.security.http.ssl.supported_protocols: [ "TLSv1.3", "TLSv1.2", "TLSv1.1", "TLSv1" ]
146151
--------------------------------------------------
152+
//end::notable-breaking-changes[]
147153

148154
[float]
149155
[[trial-explicit-security]]

0 commit comments

Comments
 (0)