Skip to content

[DOCS] Merges duplicate pages for file realms #49200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 18, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Security configuration information resides in two places:
`xpack.security` namespace>> inside the `elasticsearch.yml` and
`elasticsearch.keystore` files. In addition there are several other
<<security-files, extra configuration files>> inside the same `ES_PATH_CONF`
directory. These files define roles and role mappings and
<<configuring-file-realm, configure the file realm>>. Some of the
directory. These files define roles and role mappings and configure the
<<file-realm,file realm>>. Some of the
settings specify file paths to security-sensitive data, such as TLS keys and
certificates for the HTTP client and inter-node communication and private key files for
<<ref-saml-settings, SAML>>, <<ref-oidc-settings, OIDC>> and the
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/redirects.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -971,3 +971,7 @@ See <<ref-saml-encryption-settings>>.

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

[role="exclude",id="configuring-file-realm"]
=== Configuring a file realm

See <<file-realm-configuration>>.
2 changes: 1 addition & 1 deletion docs/reference/upgrade/reindex_upgrade.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ bin/elasticsearch-users userdel <user_name>
----------------------------------------------------------
--

For more information, see <<configuring-file-realm>>.
For more information, see <<file-realm>>.
====
endif::include-xpack[]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
[role="xpack"]
[[configuring-file-realm]]
=== Configuring a file realm

You can manage and authenticate users with the built-in `file` internal realm.
All the data about the users for the `file` realm is stored in two files on each
node in the cluster: `users` and `users_roles`. Both files are located in
`ES_PATH_CONF` and are read on startup.
Expand All @@ -22,8 +17,6 @@ or using a configuration management system such as Puppet or Chef).
The `file` realm is added to the realm chain by default. You don't need to
explicitly configure a `file` realm.

For more information about file realms, see <<file-realm>>.

. (Optional) Add a realm configuration to `elasticsearch.yml` under the
`xpack.security.authc.realms.file` namespace. At a minimum, you must set
the realm's `order` attribute.
Expand Down
6 changes: 4 additions & 2 deletions x-pack/docs/en/security/authentication/file-realm.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,7 @@ To define users, the {security-features} provide the
<<users-command,users>> command-line tool. This tool enables you to add
and remove users, assign user roles, and manage user passwords.

For more information, see
<<configuring-file-realm>>.
[[file-realm-configuration]]
==== Configuring a file realm

include::configuring-file-realm.asciidoc[]
3 changes: 1 addition & 2 deletions x-pack/docs/en/security/configuring-es.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ your subscription. For more information, see https://www.elastic.co/subscription

--
** <<configuring-ad-realm,Active Directory realms>>
** <<configuring-file-realm,File realms>>
** <<file-realm,File realms>>
** <<configuring-kerberos-realm,Kerberos realms>>
** <<configuring-ldap-realm,LDAP realms>>
** <<native-realm,Native realms>>
Expand Down Expand Up @@ -144,7 +144,6 @@ include::securing-communications/configuring-tls-docker.asciidoc[]
include::securing-communications/enabling-cipher-suites.asciidoc[]

include::authentication/configuring-active-directory-realm.asciidoc[]
include::authentication/configuring-file-realm.asciidoc[]
include::authentication/configuring-ldap-realm.asciidoc[]
include::authentication/configuring-pki-realm.asciidoc[]
include::authentication/configuring-kerberos-realm.asciidoc[]
Expand Down
4 changes: 2 additions & 2 deletions x-pack/docs/en/security/reference/files.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ The {es} {security-features} use the following files:
<<defining-roles>>.

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

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

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