From 6c249c45bf0c760c0b196ce7dd5b493ec3cadec7 Mon Sep 17 00:00:00 2001 From: Shaunak Kashyap Date: Thu, 27 Feb 2020 09:05:46 -0800 Subject: [PATCH] Document Kibana Space ID setting (#16622) * Document Kibana Space ID setting * Update reference YML files * Update libbeat/docs/shared-kibana-config.asciidoc Co-Authored-By: DeDe Morton * Updating reference YML files * Adding link to doc Co-authored-by: DeDe Morton --- auditbeat/auditbeat.reference.yml | 3 +++ filebeat/filebeat.reference.yml | 3 +++ heartbeat/heartbeat.reference.yml | 3 +++ journalbeat/journalbeat.reference.yml | 3 +++ libbeat/_meta/config.reference.yml.tmpl | 3 +++ libbeat/docs/shared-kibana-config.asciidoc | 9 ++++++++- metricbeat/metricbeat.reference.yml | 3 +++ packetbeat/packetbeat.reference.yml | 3 +++ winlogbeat/winlogbeat.reference.yml | 3 +++ x-pack/auditbeat/auditbeat.reference.yml | 3 +++ x-pack/filebeat/filebeat.reference.yml | 3 +++ x-pack/functionbeat/functionbeat.reference.yml | 3 +++ x-pack/metricbeat/metricbeat.reference.yml | 3 +++ x-pack/winlogbeat/winlogbeat.reference.yml | 3 +++ 14 files changed, 47 insertions(+), 1 deletion(-) diff --git a/auditbeat/auditbeat.reference.yml b/auditbeat/auditbeat.reference.yml index 276dc9baa877..64587f6d2581 100644 --- a/auditbeat/auditbeat.reference.yml +++ b/auditbeat/auditbeat.reference.yml @@ -1122,6 +1122,9 @@ setup.kibana: # Optional HTTP path #path: "" + # Optional Kibana space ID. + #space.id: "" + # Use SSL settings for HTTPS. Default is true. #ssl.enabled: true diff --git a/filebeat/filebeat.reference.yml b/filebeat/filebeat.reference.yml index f4c3cd63f0c9..f3047c61ef3e 100644 --- a/filebeat/filebeat.reference.yml +++ b/filebeat/filebeat.reference.yml @@ -1819,6 +1819,9 @@ setup.kibana: # Optional HTTP path #path: "" + # Optional Kibana space ID. + #space.id: "" + # Use SSL settings for HTTPS. Default is true. #ssl.enabled: true diff --git a/heartbeat/heartbeat.reference.yml b/heartbeat/heartbeat.reference.yml index a83154078ff7..0abaeeb3439c 100644 --- a/heartbeat/heartbeat.reference.yml +++ b/heartbeat/heartbeat.reference.yml @@ -1266,6 +1266,9 @@ setup.kibana: # Optional HTTP path #path: "" + # Optional Kibana space ID. + #space.id: "" + # Use SSL settings for HTTPS. Default is true. #ssl.enabled: true diff --git a/journalbeat/journalbeat.reference.yml b/journalbeat/journalbeat.reference.yml index c0d5dfc30429..27f7a1b0bde7 100644 --- a/journalbeat/journalbeat.reference.yml +++ b/journalbeat/journalbeat.reference.yml @@ -1060,6 +1060,9 @@ setup.kibana: # Optional HTTP path #path: "" + # Optional Kibana space ID. + #space.id: "" + # Use SSL settings for HTTPS. Default is true. #ssl.enabled: true diff --git a/libbeat/_meta/config.reference.yml.tmpl b/libbeat/_meta/config.reference.yml.tmpl index e46100f4d4b4..7b6238f645a0 100644 --- a/libbeat/_meta/config.reference.yml.tmpl +++ b/libbeat/_meta/config.reference.yml.tmpl @@ -1003,6 +1003,9 @@ setup.kibana: # Optional HTTP path #path: "" + # Optional Kibana space ID. + #space.id: "" + # Use SSL settings for HTTPS. Default is true. #ssl.enabled: true diff --git a/libbeat/docs/shared-kibana-config.asciidoc b/libbeat/docs/shared-kibana-config.asciidoc index 0e1e8e743711..aed3ae352147 100644 --- a/libbeat/docs/shared-kibana-config.asciidoc +++ b/libbeat/docs/shared-kibana-config.asciidoc @@ -85,6 +85,14 @@ 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 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 +use the default space. + [float] ==== `setup.kibana.ssl.enabled` @@ -104,4 +112,3 @@ setup.kibana.ssl.key: "/etc/pki/client/cert.key ---- See <> for more information. - diff --git a/metricbeat/metricbeat.reference.yml b/metricbeat/metricbeat.reference.yml index b9ecad9f5c56..20005b8069f0 100644 --- a/metricbeat/metricbeat.reference.yml +++ b/metricbeat/metricbeat.reference.yml @@ -1809,6 +1809,9 @@ setup.kibana: # Optional HTTP path #path: "" + # Optional Kibana space ID. + #space.id: "" + # Use SSL settings for HTTPS. Default is true. #ssl.enabled: true diff --git a/packetbeat/packetbeat.reference.yml b/packetbeat/packetbeat.reference.yml index 67e78fa01cc2..4f05b4276b6c 100644 --- a/packetbeat/packetbeat.reference.yml +++ b/packetbeat/packetbeat.reference.yml @@ -1537,6 +1537,9 @@ setup.kibana: # Optional HTTP path #path: "" + # Optional Kibana space ID. + #space.id: "" + # Use SSL settings for HTTPS. Default is true. #ssl.enabled: true diff --git a/winlogbeat/winlogbeat.reference.yml b/winlogbeat/winlogbeat.reference.yml index 4e89df38f0a1..9a8db2483b5b 100644 --- a/winlogbeat/winlogbeat.reference.yml +++ b/winlogbeat/winlogbeat.reference.yml @@ -1045,6 +1045,9 @@ setup.kibana: # Optional HTTP path #path: "" + # Optional Kibana space ID. + #space.id: "" + # Use SSL settings for HTTPS. Default is true. #ssl.enabled: true diff --git a/x-pack/auditbeat/auditbeat.reference.yml b/x-pack/auditbeat/auditbeat.reference.yml index 7f8d0d64b0d6..0afef1982190 100644 --- a/x-pack/auditbeat/auditbeat.reference.yml +++ b/x-pack/auditbeat/auditbeat.reference.yml @@ -1173,6 +1173,9 @@ setup.kibana: # Optional HTTP path #path: "" + # Optional Kibana space ID. + #space.id: "" + # Use SSL settings for HTTPS. Default is true. #ssl.enabled: true diff --git a/x-pack/filebeat/filebeat.reference.yml b/x-pack/filebeat/filebeat.reference.yml index d40a5bb5e0a1..22c999de8264 100644 --- a/x-pack/filebeat/filebeat.reference.yml +++ b/x-pack/filebeat/filebeat.reference.yml @@ -2347,6 +2347,9 @@ setup.kibana: # Optional HTTP path #path: "" + # Optional Kibana space ID. + #space.id: "" + # Use SSL settings for HTTPS. Default is true. #ssl.enabled: true diff --git a/x-pack/functionbeat/functionbeat.reference.yml b/x-pack/functionbeat/functionbeat.reference.yml index dbf5aca396c4..90395be09fbe 100644 --- a/x-pack/functionbeat/functionbeat.reference.yml +++ b/x-pack/functionbeat/functionbeat.reference.yml @@ -1071,6 +1071,9 @@ setup.kibana: # Optional HTTP path #path: "" + # Optional Kibana space ID. + #space.id: "" + # Use SSL settings for HTTPS. Default is true. #ssl.enabled: true diff --git a/x-pack/metricbeat/metricbeat.reference.yml b/x-pack/metricbeat/metricbeat.reference.yml index b6ab6dd2dce6..9e5493db4097 100644 --- a/x-pack/metricbeat/metricbeat.reference.yml +++ b/x-pack/metricbeat/metricbeat.reference.yml @@ -2026,6 +2026,9 @@ setup.kibana: # Optional HTTP path #path: "" + # Optional Kibana space ID. + #space.id: "" + # Use SSL settings for HTTPS. Default is true. #ssl.enabled: true diff --git a/x-pack/winlogbeat/winlogbeat.reference.yml b/x-pack/winlogbeat/winlogbeat.reference.yml index 5f72557f2cdf..76e206c34da2 100644 --- a/x-pack/winlogbeat/winlogbeat.reference.yml +++ b/x-pack/winlogbeat/winlogbeat.reference.yml @@ -1048,6 +1048,9 @@ setup.kibana: # Optional HTTP path #path: "" + # Optional Kibana space ID. + #space.id: "" + # Use SSL settings for HTTPS. Default is true. #ssl.enabled: true