From 4c78ede9c1f257284af9700515fa32af34ac0b2b Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Fri, 16 Mar 2018 09:06:21 -0700 Subject: [PATCH] [DOCS] Update X-Pack installation instructions (elastic/x-pack-elasticsearch#4110) Original commit: elastic/x-pack-elasticsearch@b3c21b82f3c6baa66d12067b0621c64de6d5d1d2 --- docs/en/setup/installing-xes.asciidoc | 168 +------------------------- 1 file changed, 2 insertions(+), 166 deletions(-) diff --git a/docs/en/setup/installing-xes.asciidoc b/docs/en/setup/installing-xes.asciidoc index 4b8b655902b..165bb9d6102 100644 --- a/docs/en/setup/installing-xes.asciidoc +++ b/docs/en/setup/installing-xes.asciidoc @@ -5,169 +5,5 @@ Installing {xpack} ++++ -After you install {es}, you can optionally obtain and install {xpack}. -For more information about how to obtain {xpack}, -see https://www.elastic.co/products/x-pack. - -You must run the version of {xpack} that matches the version of {es} you are -running. See the -https://www.elastic.co/support/matrix#matrix_compatibility[Elastic Support Matrix] -for more information about product compatibility. - -IMPORTANT: If you are installing {xpack} for the first time on an existing -cluster, you must perform a full cluster restart. Installing {xpack} enables -security and security must be enabled on ALL nodes in a cluster for the cluster -to operate correctly. When upgrading you can usually perform -a {ref}/rolling-upgrades.html[rolling upgrade]. - -The following diagram provides an overview of the steps that are required to -set up {xpack} on {es}: - -image::setup/images/ElasticsearchFlow.jpg[Installation overview on {es}] - -To install {xpack} in {es}: - -. Optional: If you want to install {xpack} on a machine that doesn't have -internet access: - -.. Manually download the {xpack} zip file: -https://artifacts.elastic.co/downloads/packs/x-pack/x-pack-{version}.zip[ -+https://artifacts.elastic.co/downloads/packs/x-pack/x-pack-{version}.zip+] -(https://artifacts.elastic.co/downloads/packs/x-pack/x-pack-{version}.zip.sha512[sha512]) -+ --- -NOTE: The plugins for {es}, {kib}, and Logstash are included in the same zip -file. If you have already downloaded this file to install {xpack} on one of -those other products, you can reuse the same file. - --- - -.. Transfer the zip file to a temporary directory on the offline machine. (Do -NOT put the file in the {es} plugins directory.) - -. Run `bin/elasticsearch-plugin install` from `ES_HOME` on each node in your -cluster: -+ --- -[source,shell] ----------------------------------------------------------- -bin/elasticsearch-plugin install x-pack ----------------------------------------------------------- - -NOTE: If you are using a <> - of {es}, run the installation with superuser permissions. - -The plugin install scripts require direct internet access to download and -install {xpack}. If your server doesn’t have internet access, specify the -location of the {xpack} zip file that you downloaded to a temporary directory. - -["source","sh",subs="attributes"] ----------------------------------------------------------- -bin/elasticsearch-plugin install file:///path/to/file/x-pack-{version}.zip ----------------------------------------------------------- - -NOTE: You must specify an absolute path to the zip file after the `file://` protocol. - --- - -. Confirm that you want to grant {xpack} additional permissions. -+ --- -TIP: Specify the `--batch` option when running the install command to - automatically grant these permissions and bypass these install prompts. - --- -+ - .. {xpack} needs these permissions to set the threat context loader during - install so {watcher} can send email notifications. -+ --- -[source,shell] ----------------------------------------------------------- -@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ -@ WARNING: plugin requires additional permissions @ -@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ -* java.lang.RuntimePermission accessClassInPackage.com.sun.activation.registries -* java.lang.RuntimePermission getClassLoader -* java.lang.RuntimePermission setContextClassLoader -* java.lang.RuntimePermission setFactory -* java.security.SecurityPermission createPolicy.JavaPolicy -* java.security.SecurityPermission getPolicy -* java.security.SecurityPermission putProviderProperty.BC -* java.security.SecurityPermission setPolicy -* java.util.PropertyPermission * read,write -* java.util.PropertyPermission sun.nio.ch.bugLevel write -* javax.net.ssl.SSLPermission setHostnameVerifier -See http://docs.oracle.com/javase/8/docs/technotes/guides/security/permissions.html -for descriptions of what these permissions allow and the associated risks. - -Continue with installation? [y/N]y ----------------------------------------------------------- --- - .. {xpack} requires permissions to enable {es} to launch the {ml} analytical - engine. The native controller ensures that the launched process is a valid - {ml} component. Once launched, communications between the {ml} processes and - {es} are limited to the operating system user that {es} runs as. -+ --- -[source,shell] ----------------------------------------------------------- -@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ -@ WARNING: plugin forks a native controller @ -@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ -This plugin launches a native controller that is not subject to -the Java security manager nor to system call filters. - -Continue with installation? [y/N]y ----------------------------------------------------------- --- - -. {xpack} will try to automatically create a number of indices within {es}. -+ --- -include::xpack-indices.asciidoc[] --- - -include::xpack-tls.asciidoc[] - -. Start {es}. -+ --- -[source,shell] ----------------------------------------------------------- -bin/elasticsearch ----------------------------------------------------------- --- - -include::xpack-passwords.asciidoc[] - -. Optional: <>. - -. {kibana-ref}/installing-xpack-kb.html[Install {xpack} on {kib}]. - -. {logstash-ref}/installing-xpack-log.html[Install {xpack} on Logstash]. - - -[float] -[[xpack-package-installation]] -=== Installing {xpack} on a DEB/RPM Package Installation - -If you use the DEB/RPM packages to install {es}, by default {es} is installed -in `/usr/share/elasticsearch` and the configuration files are stored -in `/etc/elasticsearch`. (For the complete list of default paths, see -{ref}/deb.html#deb-layout[Debian Directory Layout] and -{ref}/rpm.html#rpm-layout[RPM Directory Layout] in the {es} Reference.) - -To install {xpack} on a DEB/RPM package installation, you need to run -`bin/plugin install` from the `/usr/share/elasticsearch` directory with superuser -permissions: - -[source,shell] ----------------------------------------------------------- -cd /usr/share/elasticsearch -sudo bin/elasticsearch-plugin install x-pack ----------------------------------------------------------- - -NOTE: If the configuration files are not in `/etc/elasticsearch` you need to - specify the location of the configuration files by setting the environment - variable `ES_PATH_CONF` via `ES_PATH_CONF=`. +By default, when you install {es}, {xpack} is installed. See +<>.