Skip to content

Commit 4c78ede

Browse files
authored
[DOCS] Update X-Pack installation instructions (elastic/x-pack-elasticsearch#4110)
Original commit: elastic/x-pack-elasticsearch@b3c21b8
1 parent 485a42d commit 4c78ede

File tree

1 file changed

+2
-166
lines changed

1 file changed

+2
-166
lines changed

docs/en/setup/installing-xes.asciidoc

Lines changed: 2 additions & 166 deletions
Original file line numberDiff line numberDiff line change
@@ -5,169 +5,5 @@
55
<titleabbrev>Installing {xpack}</titleabbrev>
66
++++
77

8-
After you install {es}, you can optionally obtain and install {xpack}.
9-
For more information about how to obtain {xpack},
10-
see https://www.elastic.co/products/x-pack.
11-
12-
You must run the version of {xpack} that matches the version of {es} you are
13-
running. See the
14-
https://www.elastic.co/support/matrix#matrix_compatibility[Elastic Support Matrix]
15-
for more information about product compatibility.
16-
17-
IMPORTANT: If you are installing {xpack} for the first time on an existing
18-
cluster, you must perform a full cluster restart. Installing {xpack} enables
19-
security and security must be enabled on ALL nodes in a cluster for the cluster
20-
to operate correctly. When upgrading you can usually perform
21-
a {ref}/rolling-upgrades.html[rolling upgrade].
22-
23-
The following diagram provides an overview of the steps that are required to
24-
set up {xpack} on {es}:
25-
26-
image::setup/images/ElasticsearchFlow.jpg[Installation overview on {es}]
27-
28-
To install {xpack} in {es}:
29-
30-
. Optional: If you want to install {xpack} on a machine that doesn't have
31-
internet access:
32-
33-
.. Manually download the {xpack} zip file:
34-
https://artifacts.elastic.co/downloads/packs/x-pack/x-pack-{version}.zip[
35-
+https://artifacts.elastic.co/downloads/packs/x-pack/x-pack-{version}.zip+]
36-
(https://artifacts.elastic.co/downloads/packs/x-pack/x-pack-{version}.zip.sha512[sha512])
37-
+
38-
--
39-
NOTE: The plugins for {es}, {kib}, and Logstash are included in the same zip
40-
file. If you have already downloaded this file to install {xpack} on one of
41-
those other products, you can reuse the same file.
42-
43-
--
44-
45-
.. Transfer the zip file to a temporary directory on the offline machine. (Do
46-
NOT put the file in the {es} plugins directory.)
47-
48-
. Run `bin/elasticsearch-plugin install` from `ES_HOME` on each node in your
49-
cluster:
50-
+
51-
--
52-
[source,shell]
53-
----------------------------------------------------------
54-
bin/elasticsearch-plugin install x-pack
55-
----------------------------------------------------------
56-
57-
NOTE: If you are using a <<xpack-package-installation, DEB/RPM distribution>>
58-
of {es}, run the installation with superuser permissions.
59-
60-
The plugin install scripts require direct internet access to download and
61-
install {xpack}. If your server doesn’t have internet access, specify the
62-
location of the {xpack} zip file that you downloaded to a temporary directory.
63-
64-
["source","sh",subs="attributes"]
65-
----------------------------------------------------------
66-
bin/elasticsearch-plugin install file:///path/to/file/x-pack-{version}.zip
67-
----------------------------------------------------------
68-
69-
NOTE: You must specify an absolute path to the zip file after the `file://` protocol.
70-
71-
--
72-
73-
. Confirm that you want to grant {xpack} additional permissions.
74-
+
75-
--
76-
TIP: Specify the `--batch` option when running the install command to
77-
automatically grant these permissions and bypass these install prompts.
78-
79-
--
80-
+
81-
.. {xpack} needs these permissions to set the threat context loader during
82-
install so {watcher} can send email notifications.
83-
+
84-
--
85-
[source,shell]
86-
----------------------------------------------------------
87-
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
88-
@ WARNING: plugin requires additional permissions @
89-
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
90-
* java.lang.RuntimePermission accessClassInPackage.com.sun.activation.registries
91-
* java.lang.RuntimePermission getClassLoader
92-
* java.lang.RuntimePermission setContextClassLoader
93-
* java.lang.RuntimePermission setFactory
94-
* java.security.SecurityPermission createPolicy.JavaPolicy
95-
* java.security.SecurityPermission getPolicy
96-
* java.security.SecurityPermission putProviderProperty.BC
97-
* java.security.SecurityPermission setPolicy
98-
* java.util.PropertyPermission * read,write
99-
* java.util.PropertyPermission sun.nio.ch.bugLevel write
100-
* javax.net.ssl.SSLPermission setHostnameVerifier
101-
See http://docs.oracle.com/javase/8/docs/technotes/guides/security/permissions.html
102-
for descriptions of what these permissions allow and the associated risks.
103-
104-
Continue with installation? [y/N]y
105-
----------------------------------------------------------
106-
--
107-
.. {xpack} requires permissions to enable {es} to launch the {ml} analytical
108-
engine. The native controller ensures that the launched process is a valid
109-
{ml} component. Once launched, communications between the {ml} processes and
110-
{es} are limited to the operating system user that {es} runs as.
111-
+
112-
--
113-
[source,shell]
114-
----------------------------------------------------------
115-
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
116-
@ WARNING: plugin forks a native controller @
117-
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
118-
This plugin launches a native controller that is not subject to
119-
the Java security manager nor to system call filters.
120-
121-
Continue with installation? [y/N]y
122-
----------------------------------------------------------
123-
--
124-
125-
. {xpack} will try to automatically create a number of indices within {es}.
126-
+
127-
--
128-
include::xpack-indices.asciidoc[]
129-
--
130-
131-
include::xpack-tls.asciidoc[]
132-
133-
. Start {es}.
134-
+
135-
--
136-
[source,shell]
137-
----------------------------------------------------------
138-
bin/elasticsearch
139-
----------------------------------------------------------
140-
--
141-
142-
include::xpack-passwords.asciidoc[]
143-
144-
. Optional: <<setup-xpack-client, Configure the Java Client>>.
145-
146-
. {kibana-ref}/installing-xpack-kb.html[Install {xpack} on {kib}].
147-
148-
. {logstash-ref}/installing-xpack-log.html[Install {xpack} on Logstash].
149-
150-
151-
[float]
152-
[[xpack-package-installation]]
153-
=== Installing {xpack} on a DEB/RPM Package Installation
154-
155-
If you use the DEB/RPM packages to install {es}, by default {es} is installed
156-
in `/usr/share/elasticsearch` and the configuration files are stored
157-
in `/etc/elasticsearch`. (For the complete list of default paths, see
158-
{ref}/deb.html#deb-layout[Debian Directory Layout] and
159-
{ref}/rpm.html#rpm-layout[RPM Directory Layout] in the {es} Reference.)
160-
161-
To install {xpack} on a DEB/RPM package installation, you need to run
162-
`bin/plugin install` from the `/usr/share/elasticsearch` directory with superuser
163-
permissions:
164-
165-
[source,shell]
166-
----------------------------------------------------------
167-
cd /usr/share/elasticsearch
168-
sudo bin/elasticsearch-plugin install x-pack
169-
----------------------------------------------------------
170-
171-
NOTE: If the configuration files are not in `/etc/elasticsearch` you need to
172-
specify the location of the configuration files by setting the environment
173-
variable `ES_PATH_CONF` via `ES_PATH_CONF=<path>`.
8+
By default, when you install {es}, {xpack} is installed. See
9+
<<install-elasticsearch>>.

0 commit comments

Comments
 (0)