Skip to content

Commit b0054ee

Browse files
committed
[DOCS] Merges duplicate pages for file realms (#49200)
1 parent eefe768 commit b0054ee

File tree

7 files changed

+14
-16
lines changed

7 files changed

+14
-16
lines changed

docs/reference/high-availability/backup-and-restore-security-config.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ Security configuration information resides in two places:
1818
`xpack.security` namespace>> inside the `elasticsearch.yml` and
1919
`elasticsearch.keystore` files. In addition there are several other
2020
<<security-files, extra configuration files>> inside the same `ES_PATH_CONF`
21-
directory. These files define roles and role mappings and
22-
<<configuring-file-realm, configure the file realm>>. Some of the
21+
directory. These files define roles and role mappings and configure the
22+
<<file-realm,file realm>>. Some of the
2323
settings specify file paths to security-sensitive data, such as TLS keys and
2424
certificates for the HTTP client and inter-node communication and private key files for
2525
<<ref-saml-settings, SAML>>, <<ref-oidc-settings, OIDC>> and the

docs/reference/redirects.asciidoc

+4
Original file line numberDiff line numberDiff line change
@@ -945,3 +945,7 @@ See <<ref-saml-encryption-settings>>.
945945

946946
See <<ref-saml-ssl-settings>>.
947947

948+
[role="exclude",id="configuring-file-realm"]
949+
=== Configuring a file realm
950+
951+
See <<file-realm-configuration>>.

docs/reference/upgrade/reindex_upgrade.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ bin/elasticsearch-users userdel <user_name>
9494
----------------------------------------------------------
9595
--
9696
97-
For more information, see <<configuring-file-realm>>.
97+
For more information, see <<file-realm>>.
9898
====
9999
endif::include-xpack[]
100100

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

-7
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
[role="xpack"]
2-
[[configuring-file-realm]]
3-
=== Configuring a file realm
4-
5-
You can manage and authenticate users with the built-in `file` internal realm.
61
All the data about the users for the `file` realm is stored in two files on each
72
node in the cluster: `users` and `users_roles`. Both files are located in
83
`ES_PATH_CONF` and are read on startup.
@@ -22,8 +17,6 @@ or using a configuration management system such as Puppet or Chef).
2217
The `file` realm is added to the realm chain by default. You don't need to
2318
explicitly configure a `file` realm.
2419

25-
For more information about file realms, see <<file-realm>>.
26-
2720
. (Optional) Add a realm configuration to `elasticsearch.yml` under the
2821
`xpack.security.authc.realms.file` namespace. At a minimum, you must set
2922
the realm's `order` attribute.

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

+4-2
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,7 @@ To define users, the {security-features} provide the
2323
{ref}/users-command.html[users] command-line tool. This tool enables you to add
2424
and remove users, assign user roles, and manage user passwords.
2525

26-
For more information, see
27-
{ref}/configuring-file-realm.html[Configuring a file realm].
26+
[[file-realm-configuration]]
27+
==== Configuring a file realm
28+
29+
include::configuring-file-realm.asciidoc[]

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

+1-2
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ your subscription. For more information, see https://www.elastic.co/subscription
7373

7474
--
7575
** <<configuring-ad-realm,Active Directory realms>>
76-
** <<configuring-file-realm,File realms>>
76+
** <<file-realm,File realms>>
7777
** <<configuring-kerberos-realm,Kerberos realms>>
7878
** <<configuring-ldap-realm,LDAP realms>>
7979
** <<native-realm,Native 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-file-realm.asciidoc[]
150149
include::authentication/configuring-ldap-realm.asciidoc[]
151150
include::authentication/configuring-pki-realm.asciidoc[]
152151
include::authentication/configuring-kerberos-realm.asciidoc[]

x-pack/docs/en/security/reference/files.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ The {es} {security-features} use the following files:
99
<<defining-roles>>.
1010

1111
* `ES_PATH_CONF/elasticsearch-users` defines the users and their hashed passwords for
12-
the `file` realm. See <<configuring-file-realm>>.
12+
the `file` realm. See <<file-realm>>.
1313

1414
* `ES_PATH_CONF/elasticsearch-users_roles` defines the user roles assignment for the
15-
the `file` realm. See <<configuring-file-realm>>.
15+
the `file` realm. See <<file-realm>>.
1616

1717
* `ES_PATH_CONF/role_mapping.yml` defines the role assignments for a
1818
Distinguished Name (DN) to a role. This allows for LDAP and Active Directory

0 commit comments

Comments
 (0)