Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cherry-pick to 7.14: [DOCS] Remove PKI mentions (#27422) #27457

Merged
merged 1 commit into from
Aug 19, 2021
Merged

Cherry-pick to 7.14: [DOCS] Remove PKI mentions (#27422) #27457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions libbeat/docs/shared-kibana-config.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@
//////////////////////////////////////////////////////////////////////////

[[setup-kibana-endpoint]]
== Configure the Kibana endpoint
== Configure the {kib} endpoint

++++
<titleabbrev>Kibana endpoint</titleabbrev>
<titleabbrev>{kib} endpoint</titleabbrev>
++++

Starting with {beatname_uc} 6.0.0, the Kibana dashboards are loaded into Kibana
via the Kibana API. This requires a Kibana endpoint configuration.
{kib} dashboards are loaded into {kib}
via the {kib} API. This requires a {kib} endpoint configuration. For details on
authenticating to the {kib} API, see {kibana-ref}/api.html#api-authentication[Authentication].

You configure the endpoint in the `setup.kibana` section of the
+{beatname_lc}.yml+ config file.
Expand All @@ -38,7 +39,7 @@ You can specify the following options in the `setup.kibana` section of the
[float]
==== `setup.kibana.host`

The Kibana host where the dashboards will be loaded. The default is
The {kib} host where the dashboards will be loaded. The default is
`127.0.0.1:5601`. The value of `host` can be a `URL` or `IP:PORT`. For example: `http://192.15.3.2`, `192:15.3.2:5601` or `http://192.15.3.2:6701/path`. If no
port is specified, `5601` is used.

Expand All @@ -53,7 +54,7 @@ IPv6 addresses must be defined using the following format:
[[kibana-protocol-option]]
==== `setup.kibana.protocol`

The name of the protocol Kibana is reachable on. The options are: `http` or
The name of the protocol {kib} is reachable on. The options are: `http` or
`https`. The default is `http`. However, if you specify a URL for host, the
value of `protocol` is overridden by whatever scheme you specify in the URL.

Expand All @@ -70,37 +71,37 @@ setup.kibana.path: /kibana
[float]
==== `setup.kibana.username`

The basic authentication username for connecting to Kibana. If you don't
The basic authentication username for connecting to {kib}. If you don't
specify a value for this setting, {beatname_uc} uses the `username` specified
for the Elasticsearch output.
for the {es} output.

[float]
==== `setup.kibana.password`

The basic authentication password for connecting to Kibana. If you don't
The basic authentication password for connecting to {kib}. If you don't
specify a value for this setting, {beatname_uc} uses the `password` specified
for the Elasticsearch output.
for the {es} output.

[float]
[[kibana-path-option]]
==== `setup.kibana.path`

An HTTP path prefix that is prepended to the HTTP API calls. This is useful for
the cases where Kibana listens behind an HTTP reverse proxy that exports the API
the cases where {kib} listens behind an HTTP reverse proxy that exports the API
under a custom prefix.

[float]
[[kibana-space-id-option]]
==== `setup.kibana.space.id`

The {kibana-ref}/xpack-spaces.html[Kibana space] ID to use. If specified,
{beatname_uc} loads Kibana assets into this Kibana space. Omit this option to
{beatname_uc} loads {kib} assets into this {kib} space. Omit this option to
use the default space.

[float]
===== `setup.kibana.headers`

Custom HTTP headers to add to each request sent to Kibana.
Custom HTTP headers to add to each request sent to {kib}.
Example:

[source,yaml]
Expand All @@ -112,7 +113,7 @@ setup.kibana.headers:
[float]
==== `setup.kibana.ssl.enabled`

Enables {beatname_uc} to use SSL settings when connecting to Kibana via HTTPS.
Enables {beatname_uc} to use SSL settings when connecting to {kib} via HTTPS.
If you configure {beatname_uc} to connect over HTTPS, this setting defaults to
`true` and {beatname_uc} uses the default SSL settings.

Expand All @@ -122,9 +123,9 @@ Example configuration:
----
setup.kibana.host: "https://192.0.2.255:5601"
setup.kibana.ssl.enabled: true
setup.kibana.ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
setup.kibana.ssl.certificate: "/etc/pki/client/cert.pem"
setup.kibana.ssl.key: "/etc/pki/client/cert.key
setup.kibana.ssl.certificate_authorities: ["/etc/client/ca.pem"]
setup.kibana.ssl.certificate: "/etc/client/cert.pem"
setup.kibana.ssl.key: "/etc/client/cert.key
----

See <<configuration-ssl>> for more information.
20 changes: 10 additions & 10 deletions libbeat/docs/shared-ssl-config.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ Example output config with SSL enabled:
[source,yaml]
----
output.elasticsearch.hosts: ["https://192.168.1.42:9200"]
output.elasticsearch.ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
output.elasticsearch.ssl.certificate: "/etc/pki/client/cert.pem"
output.elasticsearch.ssl.key: "/etc/pki/client/cert.key"
output.elasticsearch.ssl.certificate_authorities: ["/etc/client/ca.pem"]
output.elasticsearch.ssl.certificate: "/etc/client/cert.pem"
output.elasticsearch.ssl.key: "/etc/client/cert.key"
----

ifndef::no-output-logstash[]
Expand All @@ -48,9 +48,9 @@ Example Kibana endpoint config with SSL enabled:
----
setup.kibana.host: "https://192.0.2.255:5601"
setup.kibana.ssl.enabled: true
setup.kibana.ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
setup.kibana.ssl.certificate: "/etc/pki/client/cert.pem"
setup.kibana.ssl.key: "/etc/pki/client/cert.key"
setup.kibana.ssl.certificate_authorities: ["/etc/client/ca.pem"]
setup.kibana.ssl.certificate: "/etc/client/cert.pem"
setup.kibana.ssl.key: "/etc/client/cert.key"
----
endif::no_kibana[]

Expand Down Expand Up @@ -264,7 +264,7 @@ certificate_authorities:

[float]
[[client-certificate]]
==== `certificate: "/etc/pki/client/cert.pem"`
==== `certificate: "/etc/client/cert.pem"`

The path to the certificate for SSL client authentication is only required if
`client_authentication` is specified. If the certificate
Expand Down Expand Up @@ -302,7 +302,7 @@ certificate: |

[float]
[[client-key]]
==== `key: "/etc/pki/client/cert.key"`
==== `key: "/etc/client/cert.key"`

The client certificate key used for client authentication and is only required
if `client_authentication` is configured. The key option support embedding of the private key:
Expand Down Expand Up @@ -423,7 +423,7 @@ certificate_authorities:

[float]
[[server-certificate]]
==== `certificate: "/etc/pki/server/cert.pem"`
==== `certificate: "/etc/server/cert.pem"`

For server authentication, the path to the SSL authentication certificate must
be specified for TLS. If the certificate is not specified, startup will fail.
Expand Down Expand Up @@ -457,7 +457,7 @@ certificate: |

[float]
[[server-key]]
==== `key: "/etc/pki/server/cert.key"`
==== `key: "/etc/server/cert.key"`

The server certificate key used for authentication is required.
The key option support embedding of the private key:
Expand Down