Configuring an esusers Realm
editConfiguring an esusers Realm
editThe esusers realm is the default Shield realm. The esusers realm enables the registration of users, passwords for
those users, and associates those users with roles. The esusers
command-line tool assists with the registration and
administration of users.
esusers
Realm Settings
editLike all other realms, the esusers
realm is configured under the shield.authc.realms
settings namespace in the
elasticsearch.yml
file. The following snippet shows an example of such configuration:
Example esusers
Realm Configuration.
shield: authc: realms: default: type: esusers order: 0
Table 1. esusers
Realm Settings
Setting |
Required |
Description |
|
yes |
Indicates the realm type and must be set to |
|
no |
Indicates the priority of this realm within the realm chain. Realms with lower order will be consulted first. Although not required, it is highly recommended to explicitly set this value when multiple realms are configured. Defaults to |
|
no |
Indicates whether this realm is enabled/disabled. Provides an easy way to disable realms in the chain without removing their configuration. Defaults to |
|
no |
Points to the location of the |
|
no |
Points to the location of the |
|
no |
Specified the time-to-live for cached user entries (a user and its credentials will be cached for this configured period of time). Defaults to |
|
no |
Specified the maximum number of user entries that can live in the cache at a given time. Defaults to 100,000. |
|
no |
(Expert Setting) Specifies the hashing algorithm that will be used for the in-memory cached user credentials (see here for possible values). |
When no realms are explicitly configured in elasticsearch.yml
, a default realm chain will be created that holds
a single esusers
realm. If you wish to only work with esusers
realm and you’re satisfied with the default
files paths, there is no real need to add the above configuration.