NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.
Configure authentication credentials
editConfigure authentication credentials
editWhen sending data to a secured cluster through the elasticsearch
output, Metricbeat must either provide basic authentication credentials
or present a client certificate.
To configure authentication credentials for Metricbeat:
-
Create a writer role that has the following privileges:
-
Cluster:
manage_index_templates
andmonitor
-
Index:
write
andcreate_index
on the Metricbeat indices
You can create roles from the Management / Roles UI in Kibana or through the
role
API. For example, the following request creates a role namedmetricbeat_writer
: -
Cluster:
-
If you plan to use index lifecycle management, create a role that has the following privileges. These privileges are required to load index lifecycle policies and create and manage rollover indices:
-
Cluster:
manage_ilm
-
Index:
write
,create_index
,manage
, andmanage_ilm
on the Metricbeat indicesPOST _xpack/security/role/metricbeat_ilm { "cluster": ["manage_ilm"], "indices": [ { "names": [ "metricbeat-*","shrink-metricbeat-*"], "privileges": ["write","create_index","manage","manage_ilm"] } ] }
-
Cluster:
-
Assign the writer role to the user that Metricbeat will use to connect to Elasticsearch. Make sure you also assign any roles that are required for specific features. For the list of features and required roles, see Metricbeat features that require authorization.
-
To authenticate as a native user, create a user for Metricbeat to use internally and assign it the writer role, plus any other roles that are needed.
You can create users from the Management / Users UI in Kibana or through the
user
API. For example, following request creates a user namedmetricbeat_internal
that has themetricbeat_writer
andkibana_user
roles:POST /_xpack/security/user/metricbeat_internal { "password" : "YOUR_PASSWORD", "roles" : [ "metricbeat_writer","kibana_user"], "full_name" : "Internal Metricbeat User" }
-
To use PKI authentication, assign the writer role, plus any other roles that are needed, in the
role_mapping.yml
configuration file. Specify the user by the distinguished name that appears in its certificate:metricbeat_writer: - "cn=Internal Metricbeat User,ou=example,o=com" kibana_user: - "cn=Internal Metricbeat User,ou=example,o=com"
For more information, see Using Role Mapping Files.
-
-
In the Metricbeat configuration file, specify authentication credentials for the
elasticsearch
output:-
To use basic authentication, configure the
username
andpassword
settings. For example, the following Metricbeat output configuration uses the nativemetricbeat_internal
user to connect to Elasticsearch:output.elasticsearch: hosts: ["localhost:9200"] username: "metricbeat_internal" password: "YOUR_PASSWORD"
You created this user earlier.
The example shows a hard-coded password, but you should store sensitive values in the secrets keystore.
-
To use PKI authentication, configure the
certificate
andkey
settings:
-