WARNING: Version 6.1 of Heartbeat 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.
Configuring Authentication Credentials for Heartbeat
editConfiguring Authentication Credentials for Heartbeat
editWhen sending data to a secured cluster through the elasticsearch
output, Heartbeat must either provide basic authentication credentials
or present a client certificate.
To configure authentication credentials for Heartbeat:
-
Create a role that has the
manage_index_templates
andmonitor
cluster privileges, andread
,write
, andcreate_index
privileges for the indices that Heartbeat creates. You can create roles from the Management / Roles UI in Kibana or through therole
API. For example, the following request creates aheartbeat_writer
role: -
Assign the writer role to the user that Heartbeat will use to connect to Elasticsearch:
-
To authenticate as a native user, create a user for the Heartbeat to use internally and assign it the writer role. You can create users from the Management / Users UI in Kibana or through the
user
API. For example, the following request creates aheartbeat_internal
user that has theheartbeat_writer
role:POST /_xpack/security/user/heartbeat_internal { "password" : "x-pack-test-password", "roles" : [ "heartbeat_writer"], "full_name" : "Internal Heartbeat User" }
-
To authenticate using PKI authentication, assign the writer role to the internal Heartbeat user in the
role_mapping.yml
configuration file. Specify the user by the distinguished name that appears in its certificate.heartbeat_writer: - "cn=Internal Heartbeat User,ou=example,o=com"
For more information, see Using Role Mapping Files.
-
-
Configure authentication credentials for the
elasticsearch
output in the Heartbeat configuration file:-
To use basic authentication, configure the
username
andpassword
settings. For example, the following Heartbeat output configuration uses the nativeheartbeat_internal
user to connect to Elasticsearch:output.elasticsearch: hosts: ["localhost:9200"] index: "heartbeat" username: "heartbeat_internal" password: "x-pack-test-password"
-
To use PKI authentication, configure the
certificate
andkey
settings:
-