Skip to content

Commit 785ce7e

Browse files
author
Adam Locke
authored
[DOCS] Add missing SSL settings for Metricbeat (#72987)
1 parent 0937c3f commit 785ce7e

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

x-pack/docs/en/security/securing-communications/security-basic-setup-https.asciidoc

+21-10
Original file line numberDiff line numberDiff line change
@@ -470,15 +470,15 @@ management.
470470
===== Configure {metricbeat} to use TLS
471471

472472
Before starting {metricbeat}, you configure the connections to {es} and
473-
Kibana. You can configure authentication to send data to your secured cluster
473+
{kib}. You can configure authentication to send data to your secured cluster
474474
using basic authentication, API key authentication, or Public Key
475475
Infrastructure (PKI) certificates.
476476

477477
The following instructions use the credentials for the `metricbeat_writer`
478478
and `metricbeat_setup` users that you created. If you need a greater level of
479479
security, we recommend using PKI certificates.
480480

481-
After configuring connections to Elasticsearch and Kibana, you'll enable the
481+
After configuring connections to {es} and {kib}, you'll enable the
482482
`elasticsearch-xpack` module and configure that module to use HTTPS.
483483

484484
WARNING: In production environments, we strongly recommend using a separate
@@ -491,10 +491,10 @@ activities from impacting the performance of your production cluster.
491491
`/kibana` directory that you created when <<encrypt-http-communication,encrypting HTTP client communications for {es}>>.
492492

493493
. Copy the `elasticsearch-ca.pem` certificate to the directory where you
494-
installed Metricbeat.
494+
installed {metricbeat}.
495495

496496
. Open the `metricbeat.yml` configuration file and configure the connection
497-
to Elasticsearch.
497+
to {es}.
498498
+
499499
Under `output.elasticsearch`, specify the following fields:
500500
+
@@ -521,9 +521,10 @@ output.elasticsearch:
521521

522522
`password`:: Password for the indicated `username`.
523523

524-
`certificate_authorities`:: Indicates the path to your trusted CA.
524+
`certificate_authorities`:: Indicates the path to the local `.pem` file that
525+
contains your CA's certificate.
525526

526-
. Configure the connection to Kibana.
527+
. Configure the connection to {kib}.
527528
+
528529
Under `setup.kibana`, specify the following fields:
529530
+
@@ -536,10 +537,10 @@ setup.kibana
536537
password: "p@ssw0rd"
537538
----
538539

539-
`hosts`:: The URLs of the Elasticsearch instances to use for all your
540+
`hosts`:: The URLs of the {es} instances to use for all your
540541
queries. Ensure that you include `https` in the URL.
541542

542-
`username`:: Name of the user with privileges required to set up dashboards in Kibana. The `metricbeat_setup` user that you created has these privileges.
543+
`username`:: Name of the user with privileges required to set up dashboards in {kib}. The `metricbeat_setup` user that you created has these privileges.
543544

544545
`password`:: Password for the indicated `username`.
545546

@@ -550,7 +551,8 @@ setup.kibana
550551
./metricbeat modules enable elasticsearch-xpack
551552
----
552553

553-
. Modify the `elasticsearch-xpack` module to use HTTPS.
554+
. Modify the `elasticsearch-xpack` module to use HTTPS. This module collects
555+
metrics about {es}.
554556
+
555557
Open `/modules.d/elasticsearch-xpack.yml` and specify the following fields:
556558
+
@@ -562,9 +564,15 @@ Open `/modules.d/elasticsearch-xpack.yml` and specify the following fields:
562564
hosts: ["https://<your_elasticsearch_host>:9200"]
563565
username: "remote_monitoring_user"
564566
password: "<password>"
567+
ssl: <1>
568+
enabled: true
569+
certificate_authorities: ["elasticsearch-ca.pem"]
570+
verification_mode: "certificate"
565571
----
572+
<1> Configuring SSL is required when monitoring a node with encrypted traffic.
573+
See {metricbeat-ref}/configuration-ssl.html[Configure SSL for {metricbeat}].
566574

567-
`hosts`:: Specifies the host where your Elasticsearch cluster is running.
575+
`hosts`:: Specifies the host where your {es} cluster is running.
568576
Ensure that you include `https` in the URL.
569577

570578
`username`:: Name of the user with privileges to collect metric data. The
@@ -573,6 +581,9 @@ Open `/modules.d/elasticsearch-xpack.yml` and specify the following fields:
573581

574582
`password`:: Password for the indicated `username`.
575583

584+
`certificate_authorities`:: Indicates the path to the local `.pem` file that
585+
contains your CA's certificate.
586+
576587
. If you want to use the predefined assets for parsing, indexing, and
577588
visualizing your data, run the following command to load these assets:
578589
+

0 commit comments

Comments
 (0)