Skip to content

Commit ec741bd

Browse files
author
Adam Locke
authored
[7.11] [DOCS] Add deprecation warnings for SSL settings (#79289)
1 parent 17664b1 commit ec741bd

File tree

1 file changed

+103
-0
lines changed

1 file changed

+103
-0
lines changed

docs/reference/migration/migrate_7_11.asciidoc

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,109 @@ the old behavior is supported until the next major release.
136136
To find out if you are using any deprecated functionality,
137137
enable <<deprecation-logging, deprecation logging>>.
138138

139+
[discrete]
140+
[[breaking_711_tls_changes]]
141+
==== Security changes
142+
143+
[[tls-ssl-transport-enabled-required]]
144+
.The `xpack.security.transport.ssl.enabled` setting will be required to configure `xpack.security.transport.ssl` settings.
145+
[%collapsible]
146+
====
147+
*Details* +
148+
Configuring any SSL settings for
149+
`xpack.security.transport.ssl` without also configuring
150+
`xpack.security.transport.ssl.enabled` generates warnings in the deprecation
151+
log. In 8.0, this configuration will result in errors.
152+
153+
*Impact* +
154+
To avoid deprecation warnings, either:
155+
156+
* Explicitly set `xpack.security.transport.ssl.enabled` as `false`
157+
* Discontinue use of other `xpack.security.transport.ssl` settings
158+
159+
If you want to enable SSL, follow the instructions to
160+
{ref}/configuring-tls.html#tls-transport[encrypt communications between nodes]. As part of this configuration, explicitly set
161+
`xpack.security.transport.ssl.enabled` as `true`.
162+
163+
For example:
164+
[source,yaml]
165+
--------------------------------------------------
166+
xpack.security.transport.ssl.enabled: true <1>
167+
xpack.security.transport.ssl.keystore.path: elastic-certificates.p12
168+
xpack.security.transport.ssl.truststore.path: elastic-certificates.p12
169+
--------------------------------------------------
170+
<1> or `false`.
171+
====
172+
173+
[[tls-ssl-http-enabled-required]]
174+
.The `xpack.security.http.ssl.enabled` setting will be required to configure `xpack.security.http.ssl` settings.
175+
[%collapsible]
176+
====
177+
*Details* +
178+
Configuring any SSL settings for `xpack.security.http.ssl` without also
179+
configuring `xpack.security.http.ssl.enabled` generates warnings in the
180+
deprecation log. In 8.0, this configuration will result in errors.
181+
182+
*Impact* +
183+
To avoid deprecation warnings, either:
184+
185+
* Explicitly set `xpack.security.http.ssl.enabled` as `false`
186+
* Discontinue use of other `xpack.security.http.ssl` settings
187+
188+
If you want to enable SSL, follow the instructions to
189+
{ref}/configuring-tls.html#tls-http[encrypt HTTP client communications for {es}]. As part
190+
of this configuration, explicitly set `xpack.security.http.ssl.enabled`
191+
as `true`.
192+
193+
For example:
194+
[source,yaml]
195+
--------------------------------------------------
196+
xpack.security.http.ssl.enabled: true <1>
197+
xpack.security.http.ssl.certificate: elasticsearch.crt
198+
xpack.security.http.ssl.key: elasticsearch.key
199+
xpack.security.http.ssl.certificate_authorities: [ "corporate-ca.crt" ]
200+
--------------------------------------------------
201+
<1> or `false`.
202+
====
203+
204+
[[tls-ssl-transport-cert-required]]
205+
.A `xpack.security.transport.ssl` certificate and key will be required to enable SSL for the transport interface.
206+
[%collapsible]
207+
====
208+
*Details* +
209+
Enabling SSL for the transport interface without also configuring a certificate
210+
and key through use of the `xpack.security.transport.ssl.keystore.path`
211+
setting or the `xpack.security.transport.ssl.certificate` and
212+
`xpack.security.transport.ssl.key` settings generates warnings in the
213+
deprecation log. In 8.0, this configuration will result in errors.
214+
215+
*Impact* +
216+
If `xpack.security.transport.ssl.enabled` is set to `true`, provide a
217+
certificate and key using the `xpack.security.transport.ssl.keystore.path`
218+
setting or the `xpack.security.transport.ssl.certificate` and
219+
`xpack.security.transport.ssl.key` settings. If a certificate and key is not
220+
provided, {es} will generate warnings in the deprecation log.
221+
====
222+
223+
[[tls-ssl-http-cert-required]]
224+
.A `xpack.security.http.ssl` certificate and key will be required to enable SSL for the HTTP layer.
225+
[%collapsible]
226+
====
227+
*Details* +
228+
Enabling SSL for the HTTP layer without also configuring a certificate and key
229+
through use of the `xpack.security.http.ssl.keystore.path` setting or
230+
the `xpack.security.http.ssl.certificate` and `xpack.security.http.ssl.key`
231+
settings generates warnings in the deprecation log. In 8.0, this configuration
232+
will result in errors.
233+
234+
*Impact* +
235+
If `xpack.security.http.ssl.enabled` is set to `true`, provide a
236+
certificate and key using the `xpack.security.http.ssl.keystore.path`
237+
setting or the `xpack.security.http.ssl.certificate` and
238+
`xpack.security.http.ssl.key` settings. If a certificate and key is not
239+
provided, {es} will generate warnings in the deprecation log.
240+
====
241+
139242
[discrete]
140243
[[breaking_711_transport_deprecations]]
141244
==== Transport deprecations

0 commit comments

Comments
 (0)