Skip to content

Commit 21b4ea2

Browse files
[DOCS] clarify v7 file realm configuration (#94778)
* [DOCS] clarify v7 file realm configuration * Update x-pack/docs/en/security/authentication/configuring-file-realm.asciidoc Co-authored-by: Yang Wang <[email protected]> --------- Co-authored-by: Yang Wang <[email protected]>
1 parent ad68908 commit 21b4ea2

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

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

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
To use the `file` or `native` realms when any other realms are configured and
2+
enabled, you need to explicitly configure them in the `elasticsearch.yml` file.
3+
4+
If no other realms are configured and enabled, you don't need to explicitly
5+
configure a `file` or `native` realm and they are added to the realm
6+
chain by default. Unless configured otherwise, the `file` realm is added
7+
first, followed by the `native` realm.
8+
9+
IMPORTANT: While it is possible to define multiple instances of some other
10+
realms, you can define only _one_ `file` realm per node.
11+
112
All the data about the users for the `file` realm is stored in two files on each
213
node in the cluster: `users` and `users_roles`. Both files are located in
314
`ES_PATH_CONF` and are read on startup.
@@ -14,9 +25,6 @@ files distributed or copied to all other nodes in the cluster (either manually
1425
or using a configuration management system such as Puppet or Chef).
1526
==============================
1627

17-
The `file` realm is added to the realm chain by default. You don't need to
18-
explicitly configure a `file` realm.
19-
2028
. (Optional) Add a realm configuration to `elasticsearch.yml` under the
2129
`xpack.security.authc.realms.file` namespace. At a minimum, you must set
2230
the realm's `order` attribute.

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,6 @@ In this type of scenario, the `file` realm is a convenient way out - you can
1919
define a new `admin` user in the `file` realm and use it to log in and reset the
2020
credentials of all other users.
2121

22-
IMPORTANT: When you configure realms in `elasticsearch.yml`, only the realms you
23-
specify are used for authentication. To use the `file` realm you must explicitly
24-
include it in the realm chain. While it is possible to define multiple instances
25-
of some other realms, you can define only _one_ file realm per node.
26-
2722
To define users, the {security-features} provide the
2823
{ref}/users-command.html[users] command-line tool. This tool enables you to add
2924
and remove users, assign user roles, and manage user passwords.

0 commit comments

Comments
 (0)