[DOCS] Adds native realm configuration details (#30215)

This commit is contained in:
Lisa Cawley 2018-05-02 10:56:31 -07:00 committed by GitHub
parent 13917162ad
commit 5064ff6ad4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 48 additions and 38 deletions

View File

@ -0,0 +1,43 @@
[role="xpack"]
[[configuring-native-realm]]
=== Configuring a Native Realm
The easiest way to manage and authenticate users is with the internal `native`
realm.
The native realm is available by default when no other realms are
configured. If other realm settings have been configured in `elasticsearch.yml`,
you must add the native realm to the realm chain.
You can configure options for the `native` realm in the
`xpack.security.authc.realms` namespace in `elasticsearch.yml`. Explicitly
configuring a native realm enables you to set the order in which it appears in
the realm chain, temporarily disable the realm, and control its cache options.
. Add a realm configuration of type `native` to `elasticsearch.yml` under the
`xpack.security.authc.realms` namespace. At a minimum, you must set the realm
`type` to `native`. If you are configuring multiple realms, you should also
explicitly set the `order` attribute.
+
--
See <<ref-native-settings>> for all of the options you can set for the `native` realm.
For example, the following snippet shows a `native` realm configuration that
sets the `order` to zero so the realm is checked first:
[source, yaml]
------------------------------------------------------------
xpack:
security:
authc:
realms:
native1:
type: native
order: 0
------------------------------------------------------------
--
. Restart {es}.
. Manage your users in {kib} on the *Management / Security / Users* page.
Alternatively, use the <<security-api-users,User Management APIs>>.

View File

@ -9,47 +9,12 @@ manage user passwords.
[float] [float]
==== Configuring a native realm ==== Configuring a native realm
The native realm is added to the realm chain by default. You don't need to See {ref}/[Configuring a native realm].
explicitly configure a native realm to manage users through the REST APIs.
IMPORTANT: When you configure realms in `elasticsearch.yml`, only the
realms you specify are used for authentication. To use the
`native` realm as a fallback, you must include it in the realm chain.
You can, however, configure options for the `native` realm in the
`xpack.security.authc.realms` namespace in `elasticsearch.yml`. Explicitly
configuring a native realm enables you to set the order in which it appears in
the realm chain, temporary disable the realm, and control its cache options.
To configure a native realm:
. Add a realm configuration of type `native` to `elasticsearch.yml` under the
`xpack.security.authc.realms` namespace. At a minimum, you must set the realm
`type` to `native`. If you are configuring multiple realms, you should also
explicitly set the `order` attribute. See <<native-settings, Native Realm Settings>>
for all of the options you can set for the `native` realm.
+
For example, the following snippet shows a `native` realm configuration that
sets the `order` to zero so the realm is checked first:
+
[source, yaml]
------------------------------------------------------------
xpack:
security:
authc:
realms:
native1:
type: native
order: 0
------------------------------------------------------------
. Restart Elasticsearch.
[[native-settings]] [[native-settings]]
==== Native realm settings ==== Native realm settings
See {ref}/security-settings.html#ref-native-settings[Native Realm Settings]. See {ref}/security-settings.html#ref-native-settings[Native realm settings].
[[managing-native-users]] [[managing-native-users]]
==== Managing native users ==== Managing native users
@ -58,7 +23,7 @@ See {ref}/security-settings.html#ref-native-settings[Native Realm Settings].
*Management / Security / Users* page. *Management / Security / Users* page.
Alternatively, you can manage users through the `user` API. For more Alternatively, you can manage users through the `user` API. For more
information and examples, see {ref}/security-api-users.html[User Management APIs]. information and examples, see {ref}/security-api-users.html[User management APIs].
[[migrating-from-file]] [[migrating-from-file]]
NOTE: To migrate file-based users to the `native` realm, use the NOTE: To migrate file-based users to the `native` realm, use the

View File

@ -73,6 +73,7 @@ user API.
. Choose which types of realms you want to use to authenticate users. . Choose which types of realms you want to use to authenticate users.
** <<configuring-ad-realm,Configure an Active Directory realm>>. ** <<configuring-ad-realm,Configure an Active Directory realm>>.
** <<configuring-file-realm,Configure a file realm>>. ** <<configuring-file-realm,Configure a file realm>>.
** <<configuring-native-realm,Configure a native realm>>.
** <<configuring-pki-realm,Configure a PKI realm>>. ** <<configuring-pki-realm,Configure a PKI realm>>.
. Set up roles and users to control access to {es}. . Set up roles and users to control access to {es}.
@ -135,6 +136,7 @@ include::securing-communications/enabling-cipher-suites.asciidoc[]
include::securing-communications/separating-node-client-traffic.asciidoc[] include::securing-communications/separating-node-client-traffic.asciidoc[]
include::authentication/configuring-active-directory-realm.asciidoc[] include::authentication/configuring-active-directory-realm.asciidoc[]
include::authentication/configuring-file-realm.asciidoc[] include::authentication/configuring-file-realm.asciidoc[]
include::authentication/configuring-native-realm.asciidoc[]
include::authentication/configuring-pki-realm.asciidoc[] include::authentication/configuring-pki-realm.asciidoc[]
include::{xes-repo-dir}/settings/security-settings.asciidoc[] include::{xes-repo-dir}/settings/security-settings.asciidoc[]
include::{xes-repo-dir}/settings/audit-settings.asciidoc[] include::{xes-repo-dir}/settings/audit-settings.asciidoc[]