From 47d9ad7b85a8f95b6552477d2f37c539f917d77d Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Wed, 24 Apr 2019 12:18:52 -0400 Subject: [PATCH] [DOCS] Standardize docs for `url` setting (#41117) --- .../settings/security-settings.asciidoc | 28 +++++++++++++------ 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/docs/reference/settings/security-settings.asciidoc b/docs/reference/settings/security-settings.asciidoc index 81ed2d6890853..14d22d728e669 100644 --- a/docs/reference/settings/security-settings.asciidoc +++ b/docs/reference/settings/security-settings.asciidoc @@ -255,10 +255,13 @@ Defaults to `true`. The `type` setting must be set to `ldap`. In addition to the <>, you can specify the following settings: -`url`:: Specifies one or more LDAP URLs in the format -`ldap[s]://:`. Multiple URLs can be defined using a comma -separated value or array syntax: `[ "ldaps://server1:636", "ldaps://server2:636" ]`. -`ldaps` and `ldap` URL protocols cannot be mixed in the same realm. Required. +`url`:: +One or more LDAP URLs in the `ldap[s]://:` format. Required. ++ +To provide multiple URLs, use a YAML array (`["ldap://server1:636", "ldap://server2:636"]`) +or comma-separated string (`"ldap://server1:636, ldap://server2:636"`). ++ +While both are supported, you can't mix the `ldap` and `ldaps` protocols. `load_balance.type`:: The behavior to use when there are multiple LDAP URLs defined. For supported @@ -525,11 +528,18 @@ The `type` setting must be set to `active_directory`. In addition to the the following settings: `url`:: -An LDAP URL of the form `ldap[s]://:`. {es} attempts to -authenticate against this URL. If the URL is not specified, it is derived from -the `domain_name` setting and assumes an unencrypted connection to port 389. -Defaults to `ldap://:389`. This setting is required when connecting -using SSL/TLS or when using a custom port. +One or more LDAP URLs in the `ldap[s]://:` format. Defaults to +`ldap://:389`. This setting is required when connecting using +SSL/TLS or when using a custom port. ++ +To provide multiple URLs, use a YAML array (`["ldap://server1:636", "ldap://server2:636"]`) +or comma-separated string (`"ldap://server1:636, ldap://server2:636"`). ++ +While both are supported, you can't mix the `ldap` and `ldaps` protocols. ++ +If no URL is provided, {es} uses a default of `ldap://:389`. This +default uses the `domain_name` setting value and assumes an unencrypted +connection to port 389. `load_balance.type`:: The behavior to use when there are multiple LDAP URLs defined. For supported