From 63e168c1dab69326f89b0d9a7402bab57cfda7d6 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Thu, 17 May 2018 09:31:23 -0700 Subject: [PATCH] [DOCS] Cleans up X-Pack references in Kibana User Guide (#19150) --- docs/management.asciidoc | 2 +- docs/plugins.asciidoc | 2 +- docs/setup/docker.asciidoc | 4 +-- docs/setup/install.asciidoc | 7 ++--- docs/setup/production.asciidoc | 26 +++++++++---------- .../en/settings/reporting-settings.asciidoc | 2 +- x-pack/docs/en/setup/setup-xkb.asciidoc | 2 +- 7 files changed, 23 insertions(+), 22 deletions(-) diff --git a/docs/management.asciidoc b/docs/management.asciidoc index dac5ed8b32cfb..8360f001d9758 100644 --- a/docs/management.asciidoc +++ b/docs/management.asciidoc @@ -10,7 +10,7 @@ the various "objects" that you can save throughout Kibana such as searches, visualizations, and dashboards. This section is pluginable, so in addition to the out of the box capabitilies, -packs such as X-Pack can add additional management capabilities to Kibana. +packs such as {xpack} can add additional management capabilities to Kibana. -- include::management/index-patterns.asciidoc[] diff --git a/docs/plugins.asciidoc b/docs/plugins.asciidoc index 454b6c2e32958..f088b7243c6ec 100644 --- a/docs/plugins.asciidoc +++ b/docs/plugins.asciidoc @@ -52,7 +52,7 @@ $ bin/kibana-plugin install file:///some/local/path/my-plugin.zip -d path/to/dir NOTE: This command creates the specified directory if it does not already exist. -WARNING: This option is deprecated and will be removed in Kibana 7. It is known to not work with some plugins, including X-Pack. +WARNING: This option is deprecated and will be removed in Kibana 7. It is known to not work with some plugins, including {xpack}. [float] === Installing Plugins with Linux packages diff --git a/docs/setup/docker.asciidoc b/docs/setup/docker.asciidoc index 933180715eaa0..463f4b9d752f9 100644 --- a/docs/setup/docker.asciidoc +++ b/docs/setup/docker.asciidoc @@ -87,7 +87,7 @@ Some example translations are shown here: `XPACK_MONITORING_ENABLED`:: `xpack.monitoring.enabled` In general, any setting listed in <> or -{xpack-ref}/xpack-settings.html[X-Pack Settings] can be configured +{xpack-ref}/xpack-settings.html[{xpack} Settings] can be configured with this technique. These variables can be set with +docker-compose+ like this: @@ -115,7 +115,7 @@ images: `server.host`:: `"0"` `elasticsearch.url`:: `http://elasticsearch:9200` -In the `x-pack` image, the following additional defaults are also set: +In the {xpack} image, the following additional defaults are also set: [horizontal] `elasticsearch.username`:: `elastic` diff --git a/docs/setup/install.asciidoc b/docs/setup/install.asciidoc index f596e59d09df8..ace96b8859963 100644 --- a/docs/setup/install.asciidoc +++ b/docs/setup/install.asciidoc @@ -38,9 +38,10 @@ downloaded from the Elastic Docker Registry. + <> -IMPORTANT: If your Elasticsearch installation is protected by {xpack-ref}/xpack-security.html[X-Pack Security] -see {kibana-ref}/using-kibana-with-security.html[Configuring Security in Kibana] -for additional setup instructions. +IMPORTANT: If your Elasticsearch installation is protected by +{xpack-ref}/xpack-security.html[{security}] see +{kibana-ref}/using-kibana-with-security.html[Configuring Security in Kibana] for +additional setup instructions. include::install/targz.asciidoc[] diff --git a/docs/setup/production.asciidoc b/docs/setup/production.asciidoc index 042b0ff98768e..149c658187762 100644 --- a/docs/setup/production.asciidoc +++ b/docs/setup/production.asciidoc @@ -1,9 +1,9 @@ [[production]] -== Using Kibana in a Production Environment +== Using Kibana in a production environment -* <> +* <> * <> -* <> +* <> How you deploy Kibana largely depends on your use case. If you are the only user, you can run Kibana on your local machine and configure it to point to whatever @@ -19,29 +19,29 @@ and an Elasticsearch client node on the same machine. For more information, see [float] [[configuring-kibana-shield]] -=== Using Kibana with X-Pack +=== Using Kibana with {security} -You can use {xpack-ref}/xpack-security.html[X-Pack Security] to control what +You can use {stack-ov}/xpack-security.html[{security}] to control what Elasticsearch data users can access through Kibana. -When you install X-Pack, Kibana users have to log in. They need to +When {security} is enabled, Kibana users have to log in. They need to have the `kibana_user` role as well as access to the indices they will be working with in Kibana. If a user loads a Kibana dashboard that accesses data in an index that they are not authorized to view, they get an error that indicates the index does -not exist. X-Pack Security does not currently provide a way to control which +not exist. {security} does not currently provide a way to control which users can load which dashboards. -For information about setting up Kibana users and how to configure Kibana -to work with X-Pack, see -{kibana-ref}/using-kibana-with-security.html[Configuring Security in Kibana]. +For information about setting up Kibana users, see +{kibana-ref}/using-kibana-with-security.html[Configuring security in Kibana]. [float] [[enabling-ssl]] === Enabling SSL -Kibana supports SSL encryption for both client requests and the requests the Kibana server -sends to Elasticsearch. + +Kibana supports TLS/SSL encryption for both client requests and the requests the +Kibana server sends to Elasticsearch. To encrypt communications between the browser and the Kibana server, you configure the `server.ssl.enabled`, `server.ssl.certificate` and `server.ssl.key` properties in `kibana.yml`: @@ -54,7 +54,7 @@ server.ssl.key: /path/to/your/server.key server.ssl.certificate: /path/to/your/server.crt ---- -If you are using X-Pack Security or a proxy that provides an HTTPS endpoint for Elasticsearch, +If you are using {security} or a proxy that provides an HTTPS endpoint for Elasticsearch, you can configure Kibana to access Elasticsearch via HTTPS so communications between the Kibana server and Elasticsearch are encrypted. diff --git a/x-pack/docs/en/settings/reporting-settings.asciidoc b/x-pack/docs/en/settings/reporting-settings.asciidoc index c17f0283c109f..5d36a7e19cfe1 100644 --- a/x-pack/docs/en/settings/reporting-settings.asciidoc +++ b/x-pack/docs/en/settings/reporting-settings.asciidoc @@ -1,6 +1,6 @@ [role="xpack"] [[reporting-settings-kb]] -=== X-Pack Reporting Settings in Kibana +=== {reporting} settings in Kibana ++++ Reporting Settings ++++ diff --git a/x-pack/docs/en/setup/setup-xkb.asciidoc b/x-pack/docs/en/setup/setup-xkb.asciidoc index 772331379d825..79f3bd9654360 100644 --- a/x-pack/docs/en/setup/setup-xkb.asciidoc +++ b/x-pack/docs/en/setup/setup-xkb.asciidoc @@ -1,6 +1,6 @@ [role="xpack"] [[setup-xpack-kb]] -= Set Up X-Pack += Set Up {xpack} [partintro] --