-
Notifications
You must be signed in to change notification settings - Fork 24.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add docs for new reindex.ssl settings #38486
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -427,6 +427,8 @@ The `host` parameter must contain a scheme, host, port (e.g. | |||||
The `username` and `password` parameters are optional, and when they are present `_reindex` | ||||||
will connect to the remote Elasticsearch node using basic auth. Be sure to use `https` when | ||||||
using basic auth or the password will be sent in plain text. | ||||||
There are a range of <<reindex-ssl,settings>> available to configure the behaviour of the | ||||||
`https` connection. | ||||||
|
||||||
Remote hosts have to be explicitly whitelisted in elasticsearch.yml using the | ||||||
`reindex.remote.whitelist` property. It can be set to a comma delimited list | ||||||
|
@@ -518,6 +520,99 @@ POST _reindex | |||||
// TEST[s/^/PUT source\n/] | ||||||
// TEST[s/otherhost:9200/\${host}/] | ||||||
|
||||||
[float] | ||||||
[[reindex-ssl]] | ||||||
==== Configuring SSL parameters | ||||||
|
||||||
Reindex from remote supports configurable SSL settings. These must be | ||||||
specified in the `elasticsearch.yml` file (or, for "secure settings", | ||||||
in the elasticsearch keystore). It is not possible to configure | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
SSL in the body of the `_reindex` request. | ||||||
|
||||||
The following settings are supported: | ||||||
|
||||||
`reindex.ssl.certificate_authorities`:: | ||||||
List of paths to PEM encoded certificate files that should be trusted. | ||||||
You cannot specify both `reindex.ssl.certificate_authorities` and | ||||||
`reindex.ssl.truststore.path`. | ||||||
|
||||||
`reindex.ssl.truststore.path`:: | ||||||
The path to the Java Keystore file that contains the certificates to trust. | ||||||
This keystore can be in "JKS" or "PKCS#12" format. | ||||||
You cannot specify both `reindex.ssl.certificate_authorities` and | ||||||
`reindex.ssl.truststore.path`. | ||||||
|
||||||
`reindex.ssl.truststore.password`:: | ||||||
The password to the truststore (`reindex.ssl.truststore.path`). | ||||||
This setting cannot be used with `reindex.ssl.truststore.secure_password`. | ||||||
|
||||||
`reindex.ssl.truststore.secure_password` (<<secure-settings,Secure>>):: | ||||||
The password to the truststore (`reindex.ssl.truststore.path`). | ||||||
This setting cannot be used with `reindex.ssl.truststore.password`. | ||||||
|
||||||
`reindex.ssl.truststore.type`:: | ||||||
The type of the truststore (`reindex.ssl.truststore.path`). | ||||||
Must be either `jks` or `PKCS12`. If the truststore path ends in ".p12", ".pfx" | ||||||
or "pkcs12", this setting defaults to `PKCS12`. Otherwise, it defaults to `jks`. | ||||||
|
||||||
`reindex.ssl.verification_mode`:: | ||||||
Indicates the type of verification to protect against man in the middle attacks | ||||||
and certificate forgery. | ||||||
One of `full` (verify the hostname and the certificate path), `certificate` | ||||||
(verify the certificate path, but not the hostname) or `none` (perform no | ||||||
verification - this is strongly discouraged in production environments). | ||||||
Defaults to `full`. | ||||||
|
||||||
`reindex.ssl.certificate`:: | ||||||
Specifies the path to the PEM encoded certificate (or certificate chain) to be | ||||||
used for http client authentication (if required by the remote cluster) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
This setting requires that `reindex.ssl.key` also be set. | ||||||
You cannot specify both `reindex.ssl.certificate` and `reindex.ssl.keystore.path`. | ||||||
|
||||||
`reindex.ssl.key`:: | ||||||
Specifies the path to the PEM encoded private key associated with the | ||||||
certificate used for client authentication (`reindex.ssl.certificate`). | ||||||
You cannot specify both `reindex.ssl.key` and `reindex.ssl.keystore.path`. | ||||||
|
||||||
`reindex.ssl.key_passphrase`:: | ||||||
Specifies the passphrase to decrypt the PEM encoded private key | ||||||
(`reindex.ssl.key`) if it is encrypted. | ||||||
Cannot be used with `reindex.ssl.secure_key_passphrase`. | ||||||
|
||||||
`reindex.ssl.secure_key_passphrase` (<<secure-settings,Secure>>):: | ||||||
Specifies the passphrase to decrypt the PEM encoded private key | ||||||
(`reindex.ssl.key`) if it is encrypted. | ||||||
Cannot be used with `reindex.ssl.key_passphrase`. | ||||||
|
||||||
`reindex.ssl.keystore.path`:: | ||||||
Specifies the path to the keystore that contains a private key and certificate | ||||||
to be used for http client authentication (if required by the remote cluster). | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
This keystore can be in "JKS" or "PKCS#12" format. | ||||||
You cannot specify both `reindex.ssl.key` and `reindex.ssl.keystore.path`. | ||||||
|
||||||
`reindex.ssl.keystore.type`:: | ||||||
The type of the keystore (`reindex.ssl.keystore.path`). Must be either `jks` or `PKCS12`. | ||||||
If the keystore path ends in ".p12", ".pfx" or "pkcs12", this setting defaults | ||||||
to `PKCS12`. Otherwise, it defaults to `jks`. | ||||||
|
||||||
`reindex.ssl.keystore.password`:: | ||||||
The password to the keystore (`reindex.ssl.keystore.path`). This setting cannot be used | ||||||
with `reindex.ssl.keystore.secure_password`. | ||||||
|
||||||
`reindex.ssl.keystore.secure_password` (<<secure-settings,Secure>>):: | ||||||
The password to the keystore (`reindex.ssl.keystore.path`). | ||||||
This setting cannot be used with `reindex.ssl.keystore.password`. | ||||||
|
||||||
`reindex.ssl.keystore.key_password`:: | ||||||
The password for the key in the keystore (`reindex.ssl.keystore.path`). | ||||||
Defaults to the keystore password. This setting cannot be used with | ||||||
`reindex.ssl.keystore.secure_key_password`. | ||||||
|
||||||
`reindex.ssl.keystore.secure_key_password` (<<secure-settings,Secure>>):: | ||||||
The password for the key in the keystore (`reindex.ssl.keystore.path`). | ||||||
Defaults to the keystore password. This setting cannot be used with | ||||||
`reindex.ssl.keystore.key_password`. | ||||||
|
||||||
[float] | ||||||
=== URL Parameters | ||||||
|
||||||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.