[DOCS] Added deprecation info for xpack.security.authc.token.passphrase (elastic/x-pack-elasticsearch#4301)
Original commit: elastic/x-pack-elasticsearch@1b5d2b0b0d78622c4479f891814dc6e49d7c616a
@@ -47,8 +47,8 @@ In `elasticsearch.yml`, set this to `false` to disable support for the default "
[float]
[[anonymous-access-settings]]
==== Anonymous Access Settings
-You can configure the following anonymous access settings in
-`elasticsearch.yml`. For more information, see {xpack-ref}/anonymous-access.html[
+
+For more information, see {xpack-ref}/anonymous-access.html[
Enabling Anonymous Access].
`xpack.security.authc.anonymous.username`::
@@ -82,16 +82,13 @@ from being configured. Defaults to `true`.
[[token-service-settings]]
==== Token Service Settings
-You can set the following token service settings in
-`elasticsearch.yml`.
-
`xpack.security.authc.token.enabled`::
Set to `false` to disable the built-in token service. Defaults to `true` unless
`xpack.security.http.ssl.enabled` is `false` and `http.enabled` is `true`.
This prevents sniffing the token from a connection over plain http.
-`xpack.security.authc.token.passphrase`::
-A secure passphrase that must be the same on each node and greater than
+`xpack.security.authc.token.passphrase`(<<secure-settings,Secure>>)::
+deprecated[6.0.0] A secure passphrase that must be the same on each node and greater than
8 characters in length. This passphrase is used to derive a cryptographic key
with which the tokens will be encrypted and authenticated. If this setting is
not used, the cluster automatically generates a key, which is the recommended
@@ -104,6 +101,7 @@ The length of time that a token is valid for. By default this value is `20m` or
[float]
[[realm-settings]]
==== Realm Settings
+
You configure realm settings in the `xpack.security.authc.realms`
namespace in `elasticsearch.yml`. For example:
@@ -169,6 +167,7 @@ all possible values. Defaults to `ssha256`.
[[ref-ldap-settings]]
[float]
===== LDAP Realm Settings
+
`url`::
An LDAP URL in the format `ldap[s]://<server>:<port>`. Required.
@@ -642,6 +641,7 @@ Defaults to `CONFIG_DIR/x-pack/role_mapping.yml`.
[[ref-saml-settings]]
[float]
===== SAML Realm Settings
+
`idp.entity_id`::
The Entity ID of the SAML Identity Provider
@@ -899,6 +899,7 @@ cipher suites that should be supported.
[float]
[[ssl-tls-settings]]
==== Default TLS/SSL Settings
+
You can configure the following TLS/SSL settings in
`elasticsearch.yml`. For more information, see
{xpack-ref}/encrypting-communications.html[Encrypting Communications]. These settings will be used
@@ -1055,6 +1056,7 @@ include::ssl-settings.asciidoc[]
[[ssl-tls-profile-settings]]
[float]
===== Transport Profile TLS/SSL Settings
+
The same settings that are available for the <<transport-tls-ssl-settings, default transport>>
are also available for each transport profile. By default, the settings for a
transport profile will be the same as the default transport unless they
@@ -1069,7 +1071,8 @@ setting, this would be `transport.profiles.$PROFILE.xpack.security.ssl.key`.
[float]
[[ip-filtering-settings]]
==== IP Filtering Settings
-You can configure the following settings for {xpack-ref}/ip-filtering.html[IP filtering].
+
+You can configure the following settings for {xpack-ref}/ip-filtering.html[IP filtering]:
`xpack.security.transport.filter.allow`::
List of IP addresses to allow.
