Skip to content

Commit 25fce29

Browse files
author
Adam Locke
authored
[7.7] [DOCS] Add deprecation warnings for SSL settings (#79294)
1 parent 202a501 commit 25fce29

File tree

1 file changed

+103
-0
lines changed

1 file changed

+103
-0
lines changed

docs/reference/migration/migrate_7_7.asciidoc

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,109 @@ See also <<release-highlights>> and <<es-release-notes>>.
1313
//Installation and Upgrade Guide
1414

1515
//tag::notable-breaking-changes[]
16+
[discrete]
17+
[[breaking_77_tls_changes]]
18+
=== Security changes
19+
20+
[[tls-ssl-transport-enabled-required]]
21+
.The `xpack.security.transport.ssl.enabled` setting will be required to configure `xpack.security.transport.ssl` settings.
22+
[%collapsible]
23+
====
24+
*Details* +
25+
Configuring any SSL settings for
26+
`xpack.security.transport.ssl` without also configuring
27+
`xpack.security.transport.ssl.enabled` generates warnings in the deprecation
28+
log. In 8.0, this configuration will result in errors.
29+
30+
*Impact* +
31+
To avoid deprecation warnings, either:
32+
33+
* Explicitly set `xpack.security.transport.ssl.enabled` as `false`
34+
* Discontinue use of other `xpack.security.transport.ssl` settings
35+
36+
If you want to enable SSL, follow the instructions to
37+
{ref}/configuring-tls.html#tls-transport[encrypt communications between nodes]. As part of this configuration, explicitly set
38+
`xpack.security.transport.ssl.enabled` as `true`.
39+
40+
For example:
41+
[source,yaml]
42+
--------------------------------------------------
43+
xpack.security.transport.ssl.enabled: true <1>
44+
xpack.security.transport.ssl.keystore.path: elastic-certificates.p12
45+
xpack.security.transport.ssl.truststore.path: elastic-certificates.p12
46+
--------------------------------------------------
47+
<1> or `false`.
48+
====
49+
50+
[[tls-ssl-http-enabled-required]]
51+
.The `xpack.security.http.ssl.enabled` setting will be required to configure `xpack.security.http.ssl` settings.
52+
[%collapsible]
53+
====
54+
*Details* +
55+
Configuring any SSL settings for `xpack.security.http.ssl` without also
56+
configuring `xpack.security.http.ssl.enabled` generates warnings in the
57+
deprecation log. In 8.0, this configuration will result in errors.
58+
59+
*Impact* +
60+
To avoid deprecation warnings, either:
61+
62+
* Explicitly set `xpack.security.http.ssl.enabled` as `false`
63+
* Discontinue use of other `xpack.security.http.ssl` settings
64+
65+
If you want to enable SSL, follow the instructions to
66+
{ref}/configuring-tls.html#tls-http[encrypt HTTP client communications for {es}]. As part
67+
of this configuration, explicitly set `xpack.security.http.ssl.enabled`
68+
as `true`.
69+
70+
For example:
71+
[source,yaml]
72+
--------------------------------------------------
73+
xpack.security.http.ssl.enabled: true <1>
74+
xpack.security.http.ssl.certificate: elasticsearch.crt
75+
xpack.security.http.ssl.key: elasticsearch.key
76+
xpack.security.http.ssl.certificate_authorities: [ "corporate-ca.crt" ]
77+
--------------------------------------------------
78+
<1> or `false`.
79+
====
80+
81+
[[tls-ssl-transport-cert-required]]
82+
.A `xpack.security.transport.ssl` certificate and key will be required to enable SSL for the transport interface.
83+
[%collapsible]
84+
====
85+
*Details* +
86+
Enabling SSL for the transport interface without also configuring a certificate
87+
and key through use of the `xpack.security.transport.ssl.keystore.path`
88+
setting or the `xpack.security.transport.ssl.certificate` and
89+
`xpack.security.transport.ssl.key` settings generates warnings in the
90+
deprecation log. In 8.0, this configuration will result in errors.
91+
92+
*Impact* +
93+
If `xpack.security.transport.ssl.enabled` is set to `true`, provide a
94+
certificate and key using the `xpack.security.transport.ssl.keystore.path`
95+
setting or the `xpack.security.transport.ssl.certificate` and
96+
`xpack.security.transport.ssl.key` settings. If a certificate and key is not
97+
provided, {es} will generate warnings in the deprecation log.
98+
====
99+
100+
[[tls-ssl-http-cert-required]]
101+
.A `xpack.security.http.ssl` certificate and key will be required to enable SSL for the HTTP layer.
102+
[%collapsible]
103+
====
104+
*Details* +
105+
Enabling SSL for the HTTP layer without also configuring a certificate and key
106+
through use of the `xpack.security.http.ssl.keystore.path` setting or
107+
the `xpack.security.http.ssl.certificate` and `xpack.security.http.ssl.key`
108+
settings generates warnings in the deprecation log. In 8.0, this configuration
109+
will result in errors.
110+
111+
*Impact* +
112+
If `xpack.security.http.ssl.enabled` is set to `true`, provide a
113+
certificate and key using the `xpack.security.http.ssl.keystore.path`
114+
setting or the `xpack.security.http.ssl.certificate` and
115+
`xpack.security.http.ssl.key` settings. If a certificate and key is not
116+
provided, {es} will generate warnings in the deprecation log.
117+
====
118+
16119
[discrete]
17120
[[breaking_77_indices_deprecations]]
18121
=== Indices deprecations

0 commit comments

Comments
 (0)