Skip to content

Commit d7ac310

Browse files
lcawllcawl
committed
[DOCS] Move settings out of reindex API
1 parent 4735260 commit d7ac310

File tree

2 files changed

+99
-95
lines changed

2 files changed

+99
-95
lines changed

‎docs/reference/docs/reindex.asciidoc‎

Lines changed: 1 addition & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1132,91 +1132,4 @@ Reindex from remote supports configurable SSL settings. These must be
11321132
specified in the `elasticsearch.yml` file, with the exception of the
11331133
secure settings, which you add in the Elasticsearch keystore.
11341134
It is not possible to configure SSL in the body of the `_reindex` request.
1135-
1136-
The following settings are supported:
1137-
1138-
`reindex.ssl.certificate_authorities`::
1139-
List of paths to PEM encoded certificate files that should be trusted.
1140-
You cannot specify both `reindex.ssl.certificate_authorities` and
1141-
`reindex.ssl.truststore.path`.
1142-
1143-
`reindex.ssl.truststore.path`::
1144-
The path to the Java Keystore file that contains the certificates to trust.
1145-
This keystore can be in "JKS" or "PKCS#12" format.
1146-
You cannot specify both `reindex.ssl.certificate_authorities` and
1147-
`reindex.ssl.truststore.path`.
1148-
1149-
`reindex.ssl.truststore.password`::
1150-
The password to the truststore (`reindex.ssl.truststore.path`).
1151-
deprecated:[7.17.0] Prefer `reindex.ssl.truststore.secure_password` instead.
1152-
This setting cannot be used with `reindex.ssl.truststore.secure_password`.
1153-
1154-
`reindex.ssl.truststore.secure_password` (<<secure-settings,Secure>>)::
1155-
The password to the truststore (`reindex.ssl.truststore.path`).
1156-
This setting cannot be used with `reindex.ssl.truststore.password`.
1157-
1158-
`reindex.ssl.truststore.type`::
1159-
The type of the truststore (`reindex.ssl.truststore.path`).
1160-
Must be either `jks` or `PKCS12`. If the truststore path ends in ".p12", ".pfx"
1161-
or "pkcs12", this setting defaults to `PKCS12`. Otherwise, it defaults to `jks`.
1162-
1163-
`reindex.ssl.verification_mode`::
1164-
Indicates the type of verification to protect against man in the middle attacks
1165-
and certificate forgery.
1166-
One of `full` (verify the hostname and the certificate path), `certificate`
1167-
(verify the certificate path, but not the hostname) or `none` (perform no
1168-
verification - this is strongly discouraged in production environments).
1169-
Defaults to `full`.
1170-
1171-
`reindex.ssl.certificate`::
1172-
Specifies the path to the PEM encoded certificate (or certificate chain) to be
1173-
used for HTTP client authentication (if required by the remote cluster)
1174-
This setting requires that `reindex.ssl.key` also be set.
1175-
You cannot specify both `reindex.ssl.certificate` and `reindex.ssl.keystore.path`.
1176-
1177-
`reindex.ssl.key`::
1178-
Specifies the path to the PEM encoded private key associated with the
1179-
certificate used for client authentication (`reindex.ssl.certificate`).
1180-
You cannot specify both `reindex.ssl.key` and `reindex.ssl.keystore.path`.
1181-
1182-
`reindex.ssl.key_passphrase`::
1183-
Specifies the passphrase to decrypt the PEM encoded private key
1184-
(`reindex.ssl.key`) if it is encrypted.
1185-
deprecated:[7.17.0] Prefer `reindex.ssl.secure_key_passphrase` instead.
1186-
Cannot be used with `reindex.ssl.secure_key_passphrase`.
1187-
1188-
`reindex.ssl.secure_key_passphrase` (<<secure-settings,Secure>>)::
1189-
Specifies the passphrase to decrypt the PEM encoded private key
1190-
(`reindex.ssl.key`) if it is encrypted.
1191-
Cannot be used with `reindex.ssl.key_passphrase`.
1192-
1193-
`reindex.ssl.keystore.path`::
1194-
Specifies the path to the keystore that contains a private key and certificate
1195-
to be used for HTTP client authentication (if required by the remote cluster).
1196-
This keystore can be in "JKS" or "PKCS#12" format.
1197-
You cannot specify both `reindex.ssl.key` and `reindex.ssl.keystore.path`.
1198-
1199-
`reindex.ssl.keystore.type`::
1200-
The type of the keystore (`reindex.ssl.keystore.path`). Must be either `jks` or `PKCS12`.
1201-
If the keystore path ends in ".p12", ".pfx" or "pkcs12", this setting defaults
1202-
to `PKCS12`. Otherwise, it defaults to `jks`.
1203-
1204-
`reindex.ssl.keystore.password`::
1205-
The password to the keystore (`reindex.ssl.keystore.path`).
1206-
deprecated:[7.17.0] Prefer `reindex.ssl.keystore.secure_password` instead.
1207-
This setting cannot be used with `reindex.ssl.keystore.secure_password`.
1208-
1209-
`reindex.ssl.keystore.secure_password` (<<secure-settings,Secure>>)::
1210-
The password to the keystore (`reindex.ssl.keystore.path`).
1211-
This setting cannot be used with `reindex.ssl.keystore.password`.
1212-
1213-
`reindex.ssl.keystore.key_password`::
1214-
The password for the key in the keystore (`reindex.ssl.keystore.path`).
1215-
Defaults to the keystore password.
1216-
deprecated:[7.17.0] Prefer `reindex.ssl.keystore.secure_key_password` instead.
1217-
This setting cannot be used with `reindex.ssl.keystore.secure_key_password`.
1218-
1219-
`reindex.ssl.keystore.secure_key_password` (<<secure-settings,Secure>>)::
1220-
The password for the key in the keystore (`reindex.ssl.keystore.path`).
1221-
Defaults to the keystore password. This setting cannot be used with
1222-
`reindex.ssl.keystore.key_password`.
1135+
Refer to <<reindex-settings>>.

‎docs/reference/modules/indices/index_management.asciidoc‎

Lines changed: 98 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,6 @@ cannot close open indices. Defaults to `true`.
2727
+
2828
NOTE: Closed indices still consume a significant amount of disk space.
2929

30-
[[reindex-remote-whitelist]]
31-
// tag::reindex-remote-whitelist[]
32-
`reindex.remote.whitelist` {ess-icon}::
33-
(<<static-cluster-setting,Static>>)
34-
Specifies the hosts that can be <<reindex-from-remote,reindexed from remotely>>. Expects a YAML array of `host:port` strings. Consists of a comma-delimited list of `host:port` entries. Defaults to `["\*.io:*", "\*.com:*"]`.
35-
// end::reindex-remote-whitelist[]
36-
3730
[[stack-templates-enabled]]
3831
`stack.templates.enabled`::
3932
+
@@ -52,3 +45,101 @@ This setting also affects the following built-in component templates:
5245

5346
include::{es-ref-dir}/indices/put-component-template.asciidoc[tag=built-in-component-templates]
5447
--
48+
49+
50+
[discrete]
51+
[[reindex-settings]]
52+
==== Reindex settings
53+
54+
[[reindex-remote-whitelist]]
55+
// tag::reindex-remote-whitelist[]
56+
`reindex.remote.whitelist` {ess-icon}::
57+
(<<static-cluster-setting,Static>>)
58+
Specifies the hosts that can be <<reindex-from-remote,reindexed from remotely>>. Expects a YAML array of `host:port` strings. Consists of a comma-delimited list of `host:port` entries. Defaults to `["\*.io:*", "\*.com:*"]`.
59+
// end::reindex-remote-whitelist[]
60+
61+
`reindex.ssl.certificate`::
62+
Specifies the path to the PEM encoded certificate (or certificate chain) to be
63+
used for HTTP client authentication (if required by the remote cluster)
64+
This setting requires that `reindex.ssl.key` also be set.
65+
You cannot specify both `reindex.ssl.certificate` and `reindex.ssl.keystore.path`.
66+
67+
`reindex.ssl.certificate_authorities`::
68+
List of paths to PEM encoded certificate files that should be trusted.
69+
You cannot specify both `reindex.ssl.certificate_authorities` and
70+
`reindex.ssl.truststore.path`.
71+
72+
`reindex.ssl.key`::
73+
Specifies the path to the PEM encoded private key associated with the
74+
certificate used for client authentication (`reindex.ssl.certificate`).
75+
You cannot specify both `reindex.ssl.key` and `reindex.ssl.keystore.path`.
76+
77+
`reindex.ssl.key_passphrase`::
78+
Specifies the passphrase to decrypt the PEM encoded private key
79+
(`reindex.ssl.key`) if it is encrypted.
80+
deprecated:[7.17.0] Prefer `reindex.ssl.secure_key_passphrase` instead.
81+
Cannot be used with `reindex.ssl.secure_key_passphrase`.
82+
83+
`reindex.ssl.keystore.key_password`::
84+
The password for the key in the keystore (`reindex.ssl.keystore.path`).
85+
Defaults to the keystore password.
86+
deprecated:[7.17.0] Prefer `reindex.ssl.keystore.secure_key_password` instead.
87+
This setting cannot be used with `reindex.ssl.keystore.secure_key_password`.
88+
89+
`reindex.ssl.keystore.password`::
90+
The password to the keystore (`reindex.ssl.keystore.path`).
91+
deprecated:[7.17.0] Prefer `reindex.ssl.keystore.secure_password` instead.
92+
This setting cannot be used with `reindex.ssl.keystore.secure_password`.
93+
94+
`reindex.ssl.keystore.path`::
95+
Specifies the path to the keystore that contains a private key and certificate
96+
to be used for HTTP client authentication (if required by the remote cluster).
97+
This keystore can be in "JKS" or "PKCS#12" format.
98+
You cannot specify both `reindex.ssl.key` and `reindex.ssl.keystore.path`.
99+
100+
`reindex.ssl.keystore.type`::
101+
The type of the keystore (`reindex.ssl.keystore.path`). Must be either `jks` or `PKCS12`.
102+
If the keystore path ends in ".p12", ".pfx" or "pkcs12", this setting defaults
103+
to `PKCS12`. Otherwise, it defaults to `jks`.
104+
105+
`reindex.ssl.secure_key_passphrase` (<<secure-settings,Secure>>)::
106+
Specifies the passphrase to decrypt the PEM encoded private key
107+
(`reindex.ssl.key`) if it is encrypted.
108+
Cannot be used with `reindex.ssl.key_passphrase`.
109+
110+
`reindex.ssl.keystore.secure_key_password` (<<secure-settings,Secure>>)::
111+
The password for the key in the keystore (`reindex.ssl.keystore.path`).
112+
Defaults to the keystore password. This setting cannot be used with
113+
`reindex.ssl.keystore.key_password`.
114+
115+
`reindex.ssl.keystore.secure_password` (<<secure-settings,Secure>>)::
116+
The password to the keystore (`reindex.ssl.keystore.path`).
117+
This setting cannot be used with `reindex.ssl.keystore.password`.
118+
119+
`reindex.ssl.truststore.password`::
120+
The password to the truststore (`reindex.ssl.truststore.path`).
121+
deprecated:[7.17.0] Prefer `reindex.ssl.truststore.secure_password` instead.
122+
This setting cannot be used with `reindex.ssl.truststore.secure_password`.
123+
124+
`reindex.ssl.truststore.path`::
125+
The path to the Java Keystore file that contains the certificates to trust.
126+
This keystore can be in "JKS" or "PKCS#12" format.
127+
You cannot specify both `reindex.ssl.certificate_authorities` and
128+
`reindex.ssl.truststore.path`.
129+
130+
`reindex.ssl.truststore.secure_password` (<<secure-settings,Secure>>)::
131+
The password to the truststore (`reindex.ssl.truststore.path`).
132+
This setting cannot be used with `reindex.ssl.truststore.password`.
133+
134+
`reindex.ssl.truststore.type`::
135+
The type of the truststore (`reindex.ssl.truststore.path`).
136+
Must be either `jks` or `PKCS12`. If the truststore path ends in ".p12", ".pfx"
137+
or "pkcs12", this setting defaults to `PKCS12`. Otherwise, it defaults to `jks`.
138+
139+
`reindex.ssl.verification_mode`::
140+
Indicates the type of verification to protect against man in the middle attacks
141+
and certificate forgery.
142+
One of `full` (verify the hostname and the certificate path), `certificate`
143+
(verify the certificate path, but not the hostname) or `none` (perform no
144+
verification - this is strongly discouraged in production environments).
145+
Defaults to `full`.

0 commit comments

Comments
 (0)