WARNING: Version 5.2 of the Elastic Stack has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
The X-Pack security uses the following files:
CONFIG_DIR/x-pack/roles.ymldefines the roles in use on the cluster (read more here).
CONFIG_DIR/x-pack/usersdefines the users and their hashed passwords for the
CONFIG_DIR/x-pack/users_rolesdefines the user roles assignment for the the
CONFIG_DIR/x-pack/role_mapping.ymldefines the role assignments for a Distinguished Name (DN) to a role. This allows for LDAP and Active Directory groups and users and PKI users to be mapped to roles (read more here).
CONFIG_DIR/x-pack/log4j2.propertiescontains audit information (read more here).
CONFIG_DIR/x-pack/system_keyholds a cluster secret key that’s used to authenticate messages during node to node communication. For more information, see Enabling Message Authentication.
Several of these files are in the YAML format. When you edit these files, be aware that YAML is indentation-level sensitive and indentation errors can lead to configuration errors. Avoid the tab character to set indentation levels, or use an editor that automatically expands tabs to spaces.
Be careful to properly escape YAML constructs such as
: or leading exclamation
points within quoted strings. Using the
> characters to define block
literals instead of escaping the problematic characters can help avoid problems.