Skip to content

Commit

Permalink
[DOCS] Cleans up X-Pack references in Kibana User Guide (elastic#19150)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed May 17, 2018
1 parent d0c1855 commit 63e168c
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 22 deletions.
2 changes: 1 addition & 1 deletion docs/management.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/setup/docker.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Some example translations are shown here:
`XPACK_MONITORING_ENABLED`:: `xpack.monitoring.enabled`

In general, any setting listed in <<settings>> 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:
Expand Down Expand Up @@ -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`
Expand Down
7 changes: 4 additions & 3 deletions docs/setup/install.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,10 @@ downloaded from the Elastic Docker Registry.
+
<<docker,Running Kibana on Docker>>

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[]
Expand Down
26 changes: 13 additions & 13 deletions docs/setup/production.asciidoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[[production]]
== Using Kibana in a Production Environment
== Using Kibana in a production environment

* <<configuring-kibana-shield, Using Kibana with X-Pack>>
* <<configuring-kibana-shield, Using Kibana with {xpack}>>
* <<enabling-ssl, Enabling SSL>>
* <<load-balancing, Load Balancing Across Multiple Elasticsearch Nodes>>
* <<load-balancing, Load balancing across multiple {es} nodes>>

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
Expand All @@ -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`:
Expand All @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion x-pack/docs/en/settings/reporting-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]
[[reporting-settings-kb]]
=== X-Pack Reporting Settings in Kibana
=== {reporting} settings in Kibana
++++
<titleabbrev>Reporting Settings</titleabbrev>
++++
Expand Down
2 changes: 1 addition & 1 deletion x-pack/docs/en/setup/setup-xkb.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]
[[setup-xpack-kb]]
= Set Up X-Pack
= Set Up {xpack}

[partintro]
--
Expand Down

0 comments on commit 63e168c

Please sign in to comment.