Skip to content

Commit ab4c5b8

Browse files
committed
[DOCS] Merges duplicate pages for LDAP realms (#49203)
1 parent f088e6a commit ab4c5b8

File tree

7 files changed

+44
-45
lines changed

7 files changed

+44
-45
lines changed

docs/reference/redirects.asciidoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -946,3 +946,23 @@ See <<ref-saml-ssl-settings>>.
946946
=== Configuring a file realm
947947

948948
See <<file-realm-configuration>>.
949+
950+
[role="exclude",id="ldap-user-search"]
951+
=== User search mode and user DN templates mode
952+
953+
See <<ldap-realm-configuration>>.
954+
955+
[role="exclude",id="configuring-ldap-realm"]
956+
=== Configuring an LDAP realm
957+
958+
See <<ldap-realm-configuration>>.
959+
960+
[role="exclude",id="ldap-settings"]
961+
=== LDAP realm settings
962+
963+
See <<ref-ldap-settings>>.
964+
965+
[role="exclude",id="ldap-ssl"]
966+
=== Setting up SSL between Elasticsearch and LDAP
967+
968+
See <<tls-ldap>>.

x-pack/docs/en/security/authentication/configuring-ldap-realm.asciidoc

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
1-
[role="xpack"]
2-
[[configuring-ldap-realm]]
3-
=== Configuring an LDAP realm
4-
5-
You can configure {es} to authenticate users by communicating with a Lightweight
6-
Directory Access Protocol (LDAP) server. To integrate with LDAP, you configure
7-
an `ldap` realm and map LDAP groups to user roles.
8-
9-
For more information about LDAP realms, see
10-
<<ldap-realm>>.
1+
To integrate with LDAP, you configure an `ldap` realm and map LDAP groups to
2+
user roles.
113

124
. Determine which mode you want to use. The `ldap` realm supports two modes of
135
operation, a user search mode and a mode with specific templates for user DNs.
@@ -215,3 +207,5 @@ xpack:
215207
metadata: cn
216208
--------------------------------------------------
217209
--
210+
211+
. Set up SSL to encrypt communications between {es} and LDAP. See <<tls-ldap>>.

x-pack/docs/en/security/authentication/ldap-realm.asciidoc

Lines changed: 16 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,8 @@
33
=== LDAP user authentication
44

55
You can configure the {stack} {security-features} to communicate with a
6-
Lightweight Directory Access Protocol (LDAP) server to authenticate users. To
7-
integrate with LDAP, you configure an `ldap` realm and map LDAP groups to user
8-
roles in the <<mapping-roles, role mapping file>>.
6+
Lightweight Directory Access Protocol (LDAP) server to authenticate users. See
7+
<<ldap-realm-configuration>>.
98

109
LDAP stores users and groups hierarchically, similar to the way folders are
1110
grouped in a file system. An LDAP directory's hierarchy is built from containers
@@ -20,25 +19,6 @@ for example `"cn=admin,dc=example,dc=com"` (white spaces are ignored).
2019
The `ldap` realm supports two modes of operation, a user search mode
2120
and a mode with specific templates for user DNs.
2221

23-
[[ldap-user-search]]
24-
==== User search mode and user DN templates mode
25-
26-
See {ref}/configuring-ldap-realm.html[Configuring an LDAP Realm].
27-
28-
[[ldap-load-balancing]]
29-
==== Load balancing and failover
30-
The `load_balance.type` setting can be used at the realm level to configure how
31-
the {security-features} should interact with multiple LDAP servers. The
32-
{security-features} support both failover and load balancing modes of operation.
33-
34-
See
35-
{ref}/security-settings.html#load-balancing[Load balancing and failover settings].
36-
37-
[[ldap-settings]]
38-
==== LDAP realm settings
39-
40-
See {ref}/security-settings.html#ref-ldap-settings[LDAP realm settings].
41-
4222
[[mapping-roles-ldap]]
4323
==== Mapping LDAP groups to roles
4424

@@ -52,12 +32,16 @@ supports the notion of groups, which often represent user roles for different
5232
systems in the organization.
5333

5434
The `ldap` realm enables you to map LDAP users to roles via their LDAP
55-
groups, or other metadata. This role mapping can be configured via the
56-
{ref}/security-api-put-role-mapping.html[add role mapping API] or by using a
35+
groups or other metadata. This role mapping can be configured via the
36+
<<security-api-put-role-mapping,add role mapping API>> or by using a
5737
file stored on each node. When a user authenticates with LDAP, the privileges
5838
for that user are the union of all privileges defined by the roles to which
59-
the user is mapped. For more information, see
60-
{ref}/configuring-ldap-realm.html[Configuring an LDAP realm].
39+
the user is mapped.
40+
41+
[[ldap-realm-configuration]]
42+
==== Configuring an LDAP realm
43+
44+
include::configuring-ldap-realm.asciidoc[]
6145

6246
[[ldap-user-metadata]]
6347
==== User metadata in LDAP realms
@@ -81,8 +65,10 @@ the `metadata` setting on the LDAP realm. This metadata is available for use
8165
with the <<mapping-roles-api, role mapping API>> or in
8266
<<templating-role-query, templated role queries>>.
8367

84-
[[ldap-ssl]]
85-
==== Setting up SSL between Elasticsearch and LDAP
68+
[[ldap-load-balancing]]
69+
==== Load balancing and failover
70+
The `load_balance.type` setting can be used at the realm level to configure how
71+
the {security-features} should interact with multiple LDAP servers. The
72+
{security-features} support both failover and load balancing modes of operation.
8673

87-
See
88-
{ref}/configuring-tls.html#tls-ldap[Encrypting communications between {es} and LDAP].
74+
See <<load-balancing>>.

x-pack/docs/en/security/authorization/run-as-privilege.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ users, you can use the _run as_ mechanism to restrict data access according to
1111
To "run as" (impersonate) another user, you must be able to retrieve the user from
1212
the realm you use to authenticate. Both the internal `native` and `file` realms
1313
support this out of the box. The LDAP realm must be configured to run in
14-
<<ldap-user-search, _user search_ mode>>. The Active Directory realm must be
14+
<<ldap-realm-configuration,_user search_ mode>>. The Active Directory realm must be
1515
<<ad-settings,configured with a `bind_dn` and `secure_bind_password`>> to support
1616
_run as_. The PKI, Kerberos, and SAML realms do not support _run as_.
1717

x-pack/docs/en/security/configuring-es.asciidoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ your subscription. For more information, see https://www.elastic.co/subscription
7575
** <<configuring-ad-realm,Active Directory realms>>
7676
** <<file-realm,File realms>>
7777
** <<configuring-kerberos-realm,Kerberos realms>>
78-
** <<configuring-ldap-realm,LDAP realms>>
78+
** <<ldap-realm,LDAP realms>>
7979
** <<native-realm,Native realms>>
8080
** <<configuring-pki-realm,PKI realms>>
8181
** <<saml-realm,SAML realms>>
@@ -146,7 +146,6 @@ include::securing-communications/enabling-cipher-suites.asciidoc[]
146146
include::securing-communications/separating-node-client-traffic.asciidoc[]
147147

148148
include::authentication/configuring-active-directory-realm.asciidoc[]
149-
include::authentication/configuring-ldap-realm.asciidoc[]
150149
include::authentication/configuring-pki-realm.asciidoc[]
151150
include::authentication/configuring-kerberos-realm.asciidoc[]
152151

x-pack/docs/en/security/securing-communications/tls-ldap.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ contents of the connection are encrypted. Clients and nodes that connect via
1010
TLS to the LDAP server need to have the LDAP server's certificate or the
1111
server's root CA certificate installed in their keystore or truststore.
1212

13-
For more information, see <<configuring-ldap-realm>>.
13+
For more information, see <<ldap-realm>>.
1414

1515
. Configure the realm's TLS settings on each node to trust certificates signed
1616
by the CA that signed your LDAP server certificates. The following example

x-pack/docs/en/security/troubleshooting.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ this error.
9292

9393
Groups are located by either an LDAP search or by the "memberOf" attribute on
9494
the user. Also, If subtree search is turned off, it will search only one
95-
level deep. See the <<ldap-settings, LDAP Settings>> for all the options.
95+
level deep. For all the options, see <<ref-ldap-settings>>.
9696
There are many options here and sticking to the defaults will not work for all
9797
scenarios.
9898

0 commit comments

Comments
 (0)