From afb6fe8dd6f4f87681ea22a516b6ee9e985c60fb Mon Sep 17 00:00:00 2001 From: dedemorton Date: Tue, 14 Aug 2018 14:48:34 -0700 Subject: [PATCH 1/2] Clarify support for ssl options for modules --- libbeat/docs/shared-ssl-config.asciidoc | 19 +++++++++++++++++++ metricbeat/docs/metricbeat-options.asciidoc | 12 ++++++++++-- 2 files changed, 29 insertions(+), 2 deletions(-) diff --git a/libbeat/docs/shared-ssl-config.asciidoc b/libbeat/docs/shared-ssl-config.asciidoc index 6034a924826..c70d7884387 100644 --- a/libbeat/docs/shared-ssl-config.asciidoc +++ b/libbeat/docs/shared-ssl-config.asciidoc @@ -8,6 +8,9 @@ You can specify SSL options when you configure: ifeval::["{beatname_lc}"=="heartbeat"] * <> that support SSL endif::[] +ifeval::["{beatname_lc}"=="metricbeat"] +* <> that define the host as an HTTP URL +endif::[] Example output config with SSL enabled: @@ -52,6 +55,22 @@ heartbeat.monitors: ------------------------------------------------------------------------------- endif::[] +ifeval::["{beatname_lc}"=="metricbeat"] +Example module with SSL enabled: + +[source,yaml] +---- +- module: prometheus + namespace: "kube-apiserver" + metricsets: ["collector"] + enabled: true + period: 10s + headers: + Authorization: "Bearer test123" + hosts: ["https://apiserver"] + ssl.verification_mode: "none" +---- +endif::[] [float] === Configuration options diff --git a/metricbeat/docs/metricbeat-options.asciidoc b/metricbeat/docs/metricbeat-options.asciidoc index 9eb64ebc0f1..09f62cd1cfd 100644 --- a/metricbeat/docs/metricbeat-options.asciidoc +++ b/metricbeat/docs/metricbeat-options.asciidoc @@ -204,8 +204,8 @@ processors in your config. [[module-http-config-options]] === Standard HTTP config options -The modules and metricsets for which the host is defined as a HTTP URL, also -support the following options: +The following options are available for modules and metricsets that define the +host as an HTTP URL: [float] ==== `username` @@ -217,6 +217,14 @@ The username to use for basic authentication. The password to use for basic authentication. +[float] +==== `ssl` + +Configuration options for SSL parameters like the certificate authority to use +for HTTPS-based connections. + +See <> for more information. + [float] ==== `headers` From ee8642a0321268fa2ede1f0118d832b7258d1cf0 Mon Sep 17 00:00:00 2001 From: dedemorton Date: Tue, 4 Sep 2018 16:13:34 -0700 Subject: [PATCH 2/2] Change example to show http module --- libbeat/docs/shared-ssl-config.asciidoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/libbeat/docs/shared-ssl-config.asciidoc b/libbeat/docs/shared-ssl-config.asciidoc index c70d7884387..51d272a77af 100644 --- a/libbeat/docs/shared-ssl-config.asciidoc +++ b/libbeat/docs/shared-ssl-config.asciidoc @@ -60,14 +60,14 @@ Example module with SSL enabled: [source,yaml] ---- -- module: prometheus - namespace: "kube-apiserver" - metricsets: ["collector"] +- module: http + namespace: "myservice" enabled: true period: 10s + hosts: ["https://localhost"] + path: "/stats" headers: Authorization: "Bearer test123" - hosts: ["https://apiserver"] ssl.verification_mode: "none" ---- endif::[]