Skip to content

Commit 7f3d5df

Browse files
committed
Add docs for new reindex.ssl settings
Reindex from remote now supports configurable SSL/TLS (node level) settings. This change adds documentation relating to those settings Relates: elastic#37527
1 parent 517aa95 commit 7f3d5df

File tree

1 file changed

+94
-0
lines changed

1 file changed

+94
-0
lines changed

docs/reference/docs/reindex.asciidoc

+94
Original file line numberDiff line numberDiff line change
@@ -427,6 +427,8 @@ The `host` parameter must contain a scheme, host, port (e.g.
427427
The `username` and `password` parameters are optional, and when they are present `_reindex`
428428
will connect to the remote Elasticsearch node using basic auth. Be sure to use `https` when
429429
using basic auth or the password will be sent in plain text.
430+
There are a range of <<reindex-ssl,settings>> available to configure the behaviour of the
431+
`https` connection.
430432

431433
Remote hosts have to be explicitly whitelisted in elasticsearch.yml using the
432434
`reindex.remote.whitelist` property. It can be set to a comma delimited list
@@ -518,6 +520,98 @@ POST _reindex
518520
// TEST[s/^/PUT source\n/]
519521
// TEST[s/otherhost:9200/\${host}/]
520522

523+
[[reindex-ssl]]
524+
==== Configuring SSL parameters
525+
526+
Reindex from remote supports configurable SSL settings. These must be
527+
specified in the `elasticsearch.yml` file (or, for "secure settings",
528+
in the elasticsearch keystore). It is not possible to configure
529+
SSL in the body of the `_reindex` request.
530+
531+
The following settings are supported:
532+
533+
`reindex.ssl.certificate_authorities`::
534+
List of paths to PEM encoded certificate files that should be trusted.
535+
You cannot specify both `reindex.ssl.certificate_authorities` and
536+
`reindex.ssl.truststore.path`.
537+
538+
`reindex.ssl.truststore.path`::
539+
The path to the Java Keystore file that contains the certificates to trust.
540+
This keystore can be in "JKS" or "PKCS#12" format.
541+
You cannot specify both `reindex.ssl.certificate_authorities` and
542+
`reindex.ssl.truststore.path`.
543+
544+
`reindex.ssl.truststore.password`::
545+
The password to the truststore (`reindex.ssl.truststore.path`).
546+
This setting cannot be used with `reindex.ssl.truststore.secure_password`.
547+
548+
`reindex.ssl.truststore.secure_password` (<<secure-settings,Secure>>)::
549+
The password to the truststore (`reindex.ssl.truststore.path`).
550+
This setting cannot be used with `reindex.ssl.truststore.password`.
551+
552+
`reindex.ssl.truststore.type`::
553+
The type of the truststore (`reindex.ssl.truststore.path`).
554+
Must be either `jks` or `PKCS12`. If the truststore path ends in ".p12", ".pfx"
555+
or "pkcs12", this setting defaults to `PKCS12`. Otherwise, it defaults to `jks`.
556+
557+
`reindex.ssl.verification_mode`::
558+
Indicates the type of verification to protect against man in the middle attacks
559+
and certificate forgery.
560+
One of `full` (verify the hostname and the certificate path), `certificate`
561+
(verify the certificate path, but not the hostname) or `none` (perform no
562+
verification - this is strongly discouraged in production environments).
563+
Defaults to `full`.
564+
565+
`reindex.ssl.certificate`::
566+
Specifies the path to the PEM encoded certificate (or certificate chain) to be
567+
used for http client authentication (if required by the remote cluster)
568+
This setting requires that `reindex.ssl.key` also be set.
569+
You cannot specify both `reindex.ssl.certificate` and `reindex.ssl.keystore.path`.
570+
571+
`reindex.ssl.key`::
572+
Specifies the path to the PEM encoded private key associated with the
573+
certificate used for client authentication (`reindex.ssl.certificate`).
574+
You cannot specify both `reindex.ssl.key` and `reindex.ssl.keystore.path`.
575+
576+
`reindex.ssl.key_passphrase`::
577+
Specifies the passphrase to decrypt the PEM encoded private key
578+
(`reindex.ssl.key`) if it is encrypted.
579+
Cannot be used with `reindex.ssl.secure_key_passphrase`.
580+
581+
`reindex.ssl.secure_key_passphrase` (<<secure-settings,Secure>>)::
582+
Specifies the passphrase to decrypt the PEM encoded private key
583+
(`reindex.ssl.key`) if it is encrypted.
584+
Cannot be used with `reindex.ssl.key_passphrase`.
585+
586+
`reindex.ssl.keystore.path`::
587+
Specifies the path to the keystore that contains a private key and certificate
588+
to be used for http client authentication (if required by the remote cluster).
589+
This keystore can be in "JKS" or "PKCS#12" format.
590+
You cannot specify both `reindex.ssl.key` and `reindex.ssl.keystore.path`.
591+
592+
`reindex.ssl.keystore.type`::
593+
The type of the keystore (`reindex.ssl.keystore.path`). Must be either `jks` or `PKCS12`.
594+
If the keystore path ends in ".p12", ".pfx" or "pkcs12", this setting defaults
595+
to `PKCS12`. Otherwise, it defaults to `jks`.
596+
597+
`reindex.ssl.keystore.password`::
598+
The password to the keystore (`reindex.ssl.keystore.path`). This setting cannot be used
599+
with `reindex.ssl.keystore.secure_password`.
600+
601+
`reindex.ssl.keystore.secure_password` (<<secure-settings,Secure>>)::
602+
The password to the keystore (`reindex.ssl.keystore.path`).
603+
This setting cannot be used with `reindex.ssl.keystore.password`.
604+
605+
`reindex.ssl.keystore.key_password`::
606+
The password for the key in the keystore (`reindex.ssl.keystore.path`).
607+
Defaults to the keystore password. This setting cannot be used with
608+
`reindex.ssl.keystore.secure_key_password`.
609+
610+
`reindex.ssl.keystore.secure_key_password` (<<secure-settings,Secure>>)::
611+
The password for the key in the keystore (`reindex.ssl.keystore.path`).
612+
Defaults to the keystore password. This setting cannot be used with
613+
`reindex.ssl.keystore.key_password`.
614+
521615
[float]
522616
=== URL Parameters
523617

0 commit comments

Comments
 (0)