docs/reference/metricbeat/securing-communication-elasticsearch.md
When sending data to a secured cluster through the elasticsearch output, Metricbeat can use any of the following authentication methods:
Authentication is specified in the Metricbeat configuration file:
To use basic authentication, specify the username and password settings under output.elasticsearch. For example:
output.elasticsearch:
hosts: ["https://myEShost:9200"]
username: "metricbeat_writer" <1>
password: "YOUR_PASSWORD" <2>
To use token-based API key authentication, specify the api_key under output.elasticsearch. For example:
output.elasticsearch:
hosts: ["https://myEShost:9200"]
api_key: "ZCV7VnwBgnX0T19fN8Qe:KnR6yE41RrSowb0kQ0HWoA" <1>
To use Public Key Infrastructure (PKI) certificates to authenticate users, specify the certificate and key settings under output.elasticsearch. For example:
output.elasticsearch:
hosts: ["https://myEShost:9200"]
ssl.certificate: "/etc/pki/client/cert.pem" <1>
ssl.key: "/etc/pki/client/cert.key" <2>
These settings assume that the distinguished name (DN) in the certificate is mapped to the appropriate roles in the role_mapping.yml file on each node in the {{es}} cluster. For more information, see Using role mapping files.
By default, Metricbeat uses the list of trusted certificate authorities (CA) from the operating system where Metricbeat is running. If the certificate authority that signed your node certificates is not in the host system’s trusted certificate authorities list, you need to add the path to the .pem file that contains your CA’s certificate to the Metricbeat configuration. This will configure Metricbeat to use a specific list of CA certificates instead of the default list from the OS.
Here is an example configuration:
output.elasticsearch:
hosts: ["https://myEShost:9200"]
ssl.certificate_authorities: <1>
- /etc/pki/my_root_ca.pem
- /etc/pki/my_other_ca.pem
ssl.certificate: "/etc/pki/client.pem" <2>
ssl.key: "/etc/pki/key.pem" <3>
.pem file that contains your Certificate Authority’s certificate. This is needed if you use your own CA to sign your node certificates.::::{note}
For any given connection, the SSL/TLS certificates must have a subject that matches the value specified for hosts, or the SSL handshake fails. For example, if you specify hosts: ["foobar:9200"], the certificate MUST include foobar in the subject (CN=foobar) or as a subject alternative name (SAN). Make sure the hostname resolves to the correct IP address. If no DNS is available, then you can associate the IP address with your hostname in /etc/hosts (on Unix) or C:\Windows\System32\drivers\etc\hosts (on Windows).
::::
If you’ve configured the {{kib}} endpoint, you can also specify credentials for authenticating with {{kib}} under kibana.setup. If no credentials are specified, Kibana will use the configured authentication method in the Elasticsearch output.
For example, specify a unique username and password to connect to Kibana like this:
setup.kibana:
host: "mykibanahost:5601"
username: "metricbeat_kib_setup" <1>
password: "YOUR_PASSWORD" <2>
More information on sending data to a secured cluster is available in the configuration reference: