Skip to content

Commit 34f9366

Browse files
Landon Lengyellandon-lengyel
authored andcommitted
Updating deprecated options
Signed-off-by: Landon Lengyel <landon@almonde.org> Signed-off-by: Landon Lengyel <landon.lengyel@slcschools.org> Signed-off-by: Landon Lengyel <landon@almonde.org>
1 parent 79cfdbf commit 34f9366

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

_install-and-configure/configuring-opensearch/security-settings.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,9 +233,9 @@ The Security plugin supports the following audit log settings:
233233

234234
The Security plugin supports the following hostname verification and DNS lookup settings:
235235

236-
- `plugins.security.ssl.transport.enforce_hostname_verification` (Static): Whether to verify hostnames on the transport layer. Optional. Default is `true`.
236+
- `transport.ssl.enforce_hostname_verification` (Static): Whether to verify hostnames on the transport layer. Optional. Default is `true`.
237237

238-
- `plugins.security.ssl.transport.resolve_hostname` (Static): Whether to resolve hostnames against DNS on the transport layer. Optional. Default is `true`. Only works if hostname verification is enabled.
238+
- `transport.ssl.resolve_hostname` (Static): Whether to resolve hostnames against DNS on the transport layer. Optional. Default is `true`. Only works if hostname verification is enabled.
239239

240240
For more information, see [Hostname verification and DNS lookup]({{site.url}}{{site.baseurl}}/security/configuration/tls/#advanced-hostname-verification-and-dns-lookup).
241241

@@ -389,7 +389,7 @@ plugins.security.roles_mapping_resolution: MAPPING_ONLY
389389
plugins.security.ssl.transport.pemcert_filepath: esnode.pem
390390
plugins.security.ssl.transport.pemkey_filepath: esnode-key.pem
391391
plugins.security.ssl.transport.pemtrustedcas_filepath: root-ca.pem
392-
plugins.security.ssl.transport.enforce_hostname_verification: false
392+
transport.ssl.enforce_hostname_verification: false
393393
plugins.security.ssl.http.enabled: true
394394
plugins.security.ssl.http.pemcert_filepath: esnode.pem
395395
plugins.security.ssl.http.pemkey_filepath: esnode-key.pem

_install-and-configure/install-opensearch/docker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -473,7 +473,7 @@ After configuring security settings, your custom `opensearch.yml` file might loo
473473
plugins.security.ssl.transport.pemcert_filepath: node1.pem
474474
plugins.security.ssl.transport.pemkey_filepath: node1-key.pem
475475
plugins.security.ssl.transport.pemtrustedcas_filepath: root-ca.pem
476-
plugins.security.ssl.transport.enforce_hostname_verification: false
476+
transport.ssl.enforce_hostname_verification: false
477477
plugins.security.ssl.http.enabled: true
478478
plugins.security.ssl.http.pemcert_filepath: node1.pem
479479
plugins.security.ssl.http.pemkey_filepath: node1-key.pem

_security/configuration/generate-certificates.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ openssl req -new -key admin-key.pem -out admin.csr
7777

7878
Follow the prompts to fill in the details. You don't need to specify a challenge password. As noted in the [OpenSSL Cookbook](https://www.feistyduck.com/books/openssl-cookbook/){:target='\_blank'}, "Having a challenge password does not increase the security of the CSR in any way."
7979

80-
If you generate TLS certificates and have enabled hostname verification by setting `plugins.security.ssl.transport.enforce_hostname_verification` to `true` (default), be sure to specify a common name (CN) for each certificate signing request (CSR) that matches the corresponding DNS A record of the intended node.
80+
If you generate TLS certificates and have enabled hostname verification by setting `transport.ssl.enforce_hostname_verification` to `true` (default), be sure to specify a common name (CN) for each certificate signing request (CSR) that matches the corresponding DNS A record of the intended node.
8181

8282
If you want to use the same node certificate on all nodes (not recommended), set hostname verification to `false`. For more information, see [Configure TLS certificates]({{site.url}}{{site.baseurl}}/security/configuration/tls/#advanced-hostname-verification-and-dns-lookup).
8383

@@ -256,7 +256,7 @@ On one node, the security configuration portion of `opensearch.yml` might look l
256256
plugins.security.ssl.transport.pemcert_filepath: node1.pem
257257
plugins.security.ssl.transport.pemkey_filepath: node1-key.pem
258258
plugins.security.ssl.transport.pemtrustedcas_filepath: root-ca.pem
259-
plugins.security.ssl.transport.enforce_hostname_verification: false
259+
transport.ssl.enforce_hostname_verification: false
260260
plugins.security.ssl.http.enabled: true
261261
plugins.security.ssl.http.pemcert_filepath: node1.pem
262262
plugins.security.ssl.http.pemkey_filepath: node1-key.pem

_security/configuration/tls.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,8 @@ In addition, when `resolve_hostname` is enabled, the Security plugin resolves th
156156

157157
Name | Description
158158
:--- | :---
159-
`plugins.security.ssl.transport.enforce_hostname_verification` | Whether to verify hostnames on the transport layer. Optional. Default is `true`.
160-
`plugins.security.ssl.transport.resolve_hostname` | Whether to resolve hostnames against DNS on the transport layer. Optional. Default is `true`. Only works if hostname verification is also enabled.
159+
`transport.ssl.enforce_hostname_verification` | Whether to verify hostnames on the transport layer. Optional. Default is `true`.
160+
`transport.ssl.resolve_hostname` | Whether to resolve hostnames against DNS on the transport layer. Optional. Default is `true`. Only works if hostname verification is also enabled.
161161

162162

163163
## (Advanced) Client authentication

_security/configuration/yaml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ In addition to many OpenSearch settings, the `opensearch.yml` file contains path
321321
plugins.security.ssl.transport.pemcert_filepath: esnode.pem
322322
plugins.security.ssl.transport.pemkey_filepath: esnode-key.pem
323323
plugins.security.ssl.transport.pemtrustedcas_filepath: root-ca.pem
324-
plugins.security.ssl.transport.enforce_hostname_verification: false
324+
transport.ssl.enforce_hostname_verification: false
325325
plugins.security.ssl.http.enabled: true
326326
plugins.security.ssl.http.pemcert_filepath: esnode.pem
327327
plugins.security.ssl.http.pemkey_filepath: esnode-key.pem

0 commit comments

Comments
 (0)