Skip to content

[DOCS] Fix realm setting names #30499

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.

Sign up for GitHub

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 1 commit into from
May 14, 2018
Merged

[DOCS] Fix realm setting names #30499

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 6 additions & 9 deletions x-pack/docs/en/security/authorization/mapping-roles.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,14 @@ To use file based role-mappings, you must configure the mappings in a YAML file
and copy it to each node in the cluster. Tools like Puppet or Chef can help with
this.

By default, role mappings are stored in `ES_PATH_CONF/x-pack/role_mapping.yml`,
By default, role mappings are stored in `ES_PATH_CONF/role_mapping.yml`,
Copy link
Member

@jaymode jaymode May 14, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because of this change, this commit will need to be manually edited for versions pre 6.3

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change was back-ported to 5.6, 6.0, 6.1, and 6.2 in x-pack-elasticsearch via commit 84e0ddc84357d5cb80cef3f57362c5de4572dab6

where `ES_PATH_CONF` is `ES_HOME/config` (zip/tar installations) or
`/etc/elasticsearch` (package installations). To specify a different location,
you configure the `files.role_mapping` realm settings in `elasticsearch.yml`.
This setting enables you to use a different set of mappings for each realm type:

|=====
| `xpack.security.authc.ldap.files.role_mapping` | | | The location of the role mappings for LDAP realms.
| `xpack.security.authc.active_directory.files.role_mapping` | | | The location of the role mappings for Active Directory realms.
| `xpack.security.authc.pki.files.role_mapping` | | | The location of the role mappings for PKI realms.
|=====
you configure the `files.role_mapping` setting in the
{ref}/security-settings.html#ref-ad-settings[Active Directory],
{ref}/security-settings.html#ref-ldap-settings[LDAP], and
{ref}/security-settings.html#ref-pki-settings[PKI] realm settings in
`elasticsearch.yml`.

Within the role mapping file, the security roles are keys and groups and users
are values. The mappings can have a many-to-many relationship. When you map roles
Expand Down