Skip to content

Commit 93e1058

Browse files
author
Adam Locke
authored
[7.9] [DOCS] Add deprecation warnings for SSL settings (#79291)
1 parent b2936fe commit 93e1058

File tree

1 file changed

+103
-0
lines changed

1 file changed

+103
-0
lines changed

docs/reference/migration/migrate_7_9.asciidoc

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,109 @@ not recreate the built-in templates after deletion.
5151
//end::notable-breaking-changes[]
5252

5353
//tag::notable-breaking-changes[]
54+
[discrete]
55+
[[breaking_79_tls_changes]]
56+
=== Security changes
57+
58+
[[tls-ssl-transport-enabled-required]]
59+
.The `xpack.security.transport.ssl.enabled` setting will be required to configure `xpack.security.transport.ssl` settings.
60+
[%collapsible]
61+
====
62+
*Details* +
63+
Configuring any SSL settings for
64+
`xpack.security.transport.ssl` without also configuring
65+
`xpack.security.transport.ssl.enabled` generates warnings in the deprecation
66+
log. In 8.0, this configuration will result in errors.
67+
68+
*Impact* +
69+
To avoid deprecation warnings, either:
70+
71+
* Explicitly set `xpack.security.transport.ssl.enabled` as `false`
72+
* Discontinue use of other `xpack.security.transport.ssl` settings
73+
74+
If you want to enable SSL, follow the instructions to
75+
{ref}/configuring-tls.html#tls-transport[encrypt communications between nodes]. As part of this configuration, explicitly set
76+
`xpack.security.transport.ssl.enabled` as `true`.
77+
78+
For example:
79+
[source,yaml]
80+
--------------------------------------------------
81+
xpack.security.transport.ssl.enabled: true <1>
82+
xpack.security.transport.ssl.keystore.path: elastic-certificates.p12
83+
xpack.security.transport.ssl.truststore.path: elastic-certificates.p12
84+
--------------------------------------------------
85+
<1> or `false`.
86+
====
87+
88+
[[tls-ssl-http-enabled-required]]
89+
.The `xpack.security.http.ssl.enabled` setting will be required to configure `xpack.security.http.ssl` settings.
90+
[%collapsible]
91+
====
92+
*Details* +
93+
Configuring any SSL settings for `xpack.security.http.ssl` without also
94+
configuring `xpack.security.http.ssl.enabled` generates warnings in the
95+
deprecation log. In 8.0, this configuration will result in errors.
96+
97+
*Impact* +
98+
To avoid deprecation warnings, either:
99+
100+
* Explicitly set `xpack.security.http.ssl.enabled` as `false`
101+
* Discontinue use of other `xpack.security.http.ssl` settings
102+
103+
If you want to enable SSL, follow the instructions to
104+
{ref}/configuring-tls.html#tls-http[encrypt HTTP client communications for {es}]. As part
105+
of this configuration, explicitly set `xpack.security.http.ssl.enabled`
106+
as `true`.
107+
108+
For example:
109+
[source,yaml]
110+
--------------------------------------------------
111+
xpack.security.http.ssl.enabled: true <1>
112+
xpack.security.http.ssl.certificate: elasticsearch.crt
113+
xpack.security.http.ssl.key: elasticsearch.key
114+
xpack.security.http.ssl.certificate_authorities: [ "corporate-ca.crt" ]
115+
--------------------------------------------------
116+
<1> or `false`.
117+
====
118+
119+
[[tls-ssl-transport-cert-required]]
120+
.A `xpack.security.transport.ssl` certificate and key will be required to enable SSL for the transport interface.
121+
[%collapsible]
122+
====
123+
*Details* +
124+
Enabling SSL for the transport interface without also configuring a certificate
125+
and key through use of the `xpack.security.transport.ssl.keystore.path`
126+
setting or the `xpack.security.transport.ssl.certificate` and
127+
`xpack.security.transport.ssl.key` settings generates warnings in the
128+
deprecation log. In 8.0, this configuration will result in errors.
129+
130+
*Impact* +
131+
If `xpack.security.transport.ssl.enabled` is set to `true`, provide a
132+
certificate and key using the `xpack.security.transport.ssl.keystore.path`
133+
setting or the `xpack.security.transport.ssl.certificate` and
134+
`xpack.security.transport.ssl.key` settings. If a certificate and key is not
135+
provided, {es} will generate warnings in the deprecation log.
136+
====
137+
138+
[[tls-ssl-http-cert-required]]
139+
.A `xpack.security.http.ssl` certificate and key will be required to enable SSL for the HTTP layer.
140+
[%collapsible]
141+
====
142+
*Details* +
143+
Enabling SSL for the HTTP layer without also configuring a certificate and key
144+
through use of the `xpack.security.http.ssl.keystore.path` setting or
145+
the `xpack.security.http.ssl.certificate` and `xpack.security.http.ssl.key`
146+
settings generates warnings in the deprecation log. In 8.0, this configuration
147+
will result in errors.
148+
149+
*Impact* +
150+
If `xpack.security.http.ssl.enabled` is set to `true`, provide a
151+
certificate and key using the `xpack.security.http.ssl.keystore.path`
152+
setting or the `xpack.security.http.ssl.certificate` and
153+
`xpack.security.http.ssl.key` settings. If a certificate and key is not
154+
provided, {es} will generate warnings in the deprecation log.
155+
====
156+
54157
[discrete]
55158
[[breaking_79_script_cache_changes]]
56159
=== Script cache changes

0 commit comments

Comments
 (0)