Skip to content

Commit

Permalink
[DOCS] Add deprecation docs for incompatible builds (#77730) (#77961)
Browse files Browse the repository at this point in the history
We deprecated the `es.unsafely_permit_handshake_from_incompatible_builds` system
property in 7.11 with PR #65601. However, we didn't add a related item to the
7.11 deprecation docs. This adds the missing item.

Relates to #65753.
  • Loading branch information
jrodewig authored Sep 16, 2021
1 parent f668c27 commit 68fa321
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 5 deletions.
26 changes: 24 additions & 2 deletions docs/reference/migration/migrate_7_11.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ See also <<release-highlights>> and <<es-release-notes>>.
* <<breaking_711_rest_changes>>
* <<breaking_711_search_changes>>
* <<breaking_711_transform_changes>>
* <<breaking_711_transport_deprecations>>

//NOTE: The notable-breaking-changes tagged regions are re-used in the
//Installation and Upgrade Guide
Expand Down Expand Up @@ -120,7 +121,6 @@ settings of the transform.
====
//end::notable-breaking-changes[]

////
[discrete]
[[deprecated-7.11]]
=== Deprecations
Expand All @@ -136,4 +136,26 @@ the old behavior is supported until the next major release.
To find out if you are using any deprecated functionality,
enable <<deprecation-logging, deprecation logging>>.

////
[discrete]
[[breaking_711_transport_deprecations]]
==== Transport deprecations

//tag::notable-breaking-changes[]
[[deprecate-unsafely_permit_handshake_from_incompatible_builds]]
.The `es.unsafely_permit_handshake_from_incompatible_builds` system property is deprecated.
[%collapsible]
====
*Details* +
The `es.unsafely_permit_handshake_from_incompatible_builds` system property is
now deprecated.
{es} verifies that communicating pairs of nodes of the same version are running
the same build and using the same wire format. You can bypass this check by
setting `es.unsafely_permit_handshake_from_incompatible_builds` to `true`.
Skipping this check is unsafe and not recommended.
*Impact* +
To avoid deprecation warnings, discontinue use of the system property. Instead
ensure that all nodes of the same version are running the same build.
====
//end::notable-breaking-changes[]
6 changes: 3 additions & 3 deletions docs/reference/migration/migrate_7_12.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -91,14 +91,14 @@ SSL/TLS versions on your JDK].
//end::notable-breaking-changes[]

[discrete]
[[deprecated-7.11]]
[[deprecated-7.12]]
=== Deprecations

The following functionality has been deprecated in {es} 7.10
The following functionality has been deprecated in {es} 7.12
and will be removed in 8.0
While this won't have an immediate impact on your applications,
we strongly encourage you take the described steps to update your code
after upgrading to 7.10.
after upgrading to 7.12.

NOTE: Significant changes in behavior are deprecated in a minor release and
the old behavior is supported until the next major release.
Expand Down

0 comments on commit 68fa321

Please sign in to comment.