Skip to content

Commit

Permalink
Clarify support for ssl options for modules (elastic#7967)
Browse files Browse the repository at this point in the history
* Clarify support for ssl options for modules

* Change example to show http module
  • Loading branch information
dedemorton authored Sep 24, 2018
1 parent 31f6e33 commit c0ec744
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 2 deletions.
19 changes: 19 additions & 0 deletions libbeat/docs/shared-ssl-config.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ You can specify SSL options when you configure:
ifeval::["{beatname_lc}"=="heartbeat"]
* <<configuration-heartbeat-options,{beatname_uc} monitors>> that support SSL
endif::[]
ifeval::["{beatname_lc}"=="metricbeat"]
* <<metricbeat-modules,modules>> that define the host as an HTTP URL
endif::[]

Example output config with SSL enabled:

Expand Down Expand Up @@ -51,6 +54,22 @@ heartbeat.monitors:
-------------------------------------------------------------------------------
endif::[]

ifeval::["{beatname_lc}"=="metricbeat"]
Example module with SSL enabled:

[source,yaml]
----
- module: http
namespace: "myservice"
enabled: true
period: 10s
hosts: ["https://localhost"]
path: "/stats"
headers:
Authorization: "Bearer test123"
ssl.verification_mode: "none"
----
endif::[]

[float]
=== Configuration options
Expand Down
12 changes: 10 additions & 2 deletions metricbeat/docs/metricbeat-options.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand All @@ -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 <<configuration-ssl>> for more information.

[float]
==== `headers`

Expand Down

0 comments on commit c0ec744

Please sign in to comment.