WARNING: Version 6.2 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.

« Heartbeat and X-Pack Security Granting Users Access to Heartbeat Indices »

› › ›

Configuring Authentication Credentials for Heartbeat

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Configuring Authentication Credentials for Heartbeat

edit

When 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 and monitor cluster privileges, and read, write, and create_index privileges for the indices that Heartbeat creates. You can create roles from the Management / Roles UI in Kibana or through the role API. For example, the following request creates a heartbeat_writer role:
```
POST _xpack/security/role/heartbeat_writer
{
  "cluster": ["manage_index_templates", "monitor"],
  "indices": [
    {
      "names": [ "heartbeat-*" ], 
      "privileges": ["write","create_index"]
    }
  ]
}
```
If you use a custom Heartbeat index pattern, specify that pattern instead of the default heartbeat-* pattern.
Assign the writer role to the user that Heartbeat will use to connect to Elasticsearch:
1. 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 a heartbeat_internal user that has the heartbeat_writer role:
```
POST /_xpack/security/user/heartbeat_internal
{
  "password" : "x-pack-test-password",
  "roles" : [ "heartbeat_writer"],
  "full_name" : "Internal Heartbeat User"
}
```
2. 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:
1. To use basic authentication, configure the username and password settings. For example, the following Heartbeat output configuration uses the native heartbeat_internal user to connect to Elasticsearch:
```
output.elasticsearch:
    hosts: ["localhost:9200"]
    index: "heartbeat"
    username: "heartbeat_internal"
    password: "x-pack-test-password"
```
2. To use PKI authentication, configure the certificate and key settings:
```
output.elasticsearch:
    hosts: ["localhost:9200"]
    index: "heartbeat"
    ssl.certificate: "/etc/pki/client/cert.pem" 
    ssl.key: "/etc/pki/client/cert.key"
```
  The distinguished name (DN) in the certificate must be mapped to the writer role in the role_mapping.yml configuration file on each node in the Elasticsearch cluster.

« Heartbeat and X-Pack Security Granting Users Access to Heartbeat Indices »