Skip to content

Commit 2dc4a5b

Browse files
Stuart Camcodebrain
authored andcommitted
Update MSI documentation (#31950)
1 parent 1be3dd5 commit 2dc4a5b

15 files changed

+40
-42
lines changed
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

docs/reference/setup/install/windows.asciidoc

Lines changed: 40 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -47,50 +47,48 @@ aside panel with additional information for each input:
4747
image::images/msi_installer/msi_installer_help.png[]
4848

4949
Within the first screen, select the directory for the installation. In addition, select directories for where
50-
data, logs and configuration will reside or <<msi-command-line-options,roll with the default locations>>:
50+
data, logs and configuration will be placed or <<msi-command-line-options,use the default locations>>:
5151

5252
[[msi-installer-locations]]
5353
image::images/msi_installer/msi_installer_locations.png[]
5454

5555
Then select whether to install as a service or start Elasticsearch manually as needed. When
56-
installing as a service, you can also decide which account to run the service under as well
57-
as whether the service should be started after installation and when Windows is started or
58-
restarted:
56+
installing as a service, you can also configure the Windows account to run the service with,
57+
whether the service should be started after installation and the Windows startup behaviour:
5958

6059
[[msi-installer-service]]
6160
image::images/msi_installer/msi_installer_service.png[]
6261

63-
IMPORTANT: When selecting an account to run the service with, be sure that the chosen account
64-
has sufficient privileges to access the installation and other deployment directories chosen.
62+
IMPORTANT: When selecting a Windows account to run the service with, be sure that the chosen account
63+
has sufficient privileges to access the installation and other deployment directories chosen. Also
64+
ensure the account is able to run Windows services.
6565

6666
Common configuration settings are exposed within the Configuration section, allowing the cluster
6767
name, node name and roles to be set, in addition to memory and network settings:
6868

6969
[[msi-installer-configuration]]
7070
image::images/msi_installer/msi_installer_configuration.png[]
7171

72-
A list of common plugins that can be downloaded and installed as
73-
part of the installation, with the option to configure a HTTPS proxy through which to download:
72+
A list of common plugins that can be downloaded and installed as part of the installation, with the option to configure a HTTPS proxy through which to download these plugins.
73+
74+
TIP: Ensure the installation machine has access to the internet and that any corporate firewalls in place are configured to allow downloads from `artifacts.elastic.co`:
7475

7576
[[msi-installer-selected-plugins]]
7677
image::images/msi_installer/msi_installer_selected_plugins.png[]
7778

78-
Upon choosing to install {xpack} plugin, an additional step allows a choice of the type of {xpack}
79-
license to install, in addition to {security} configuration and built-in user configuration:
79+
As of version 6.3.0, X-Pack is now https://www.elastic.co/products/x-pack/open[bundled by default]. The final step allows a choice of the type of X-Pack license to install, in addition to security configuration and built-in user configuration:
8080

8181
[[msi-installer-xpack]]
8282
image::images/msi_installer/msi_installer_xpack.png[]
8383

84-
NOTE: {xpack} includes a choice of a Trial or Basic license for 30 days. After that, you can obtain one of the
85-
https://www.elastic.co/subscriptions[available subscriptions] or {ref}/security-settings.html[disable Security].
86-
The Basic license is free and includes the https://www.elastic.co/products/x-pack/monitoring[Monitoring] extension.
84+
NOTE: X-Pack includes a choice of a Trial or Basic license. A Trial license is valid for 30 days, after which you can obtain one of the available subscriptions. The Basic license is free and perpetual. Consult the https://www.elastic.co/subscriptions[available subscriptions] for further details on which features are available under which license.
8785

88-
After clicking the install button, the installer will begin installation:
86+
After clicking the install button, the installation will begin:
8987

9088
[[msi-installer-installing]]
9189
image::images/msi_installer/msi_installer_installing.png[]
9290

93-
and will indicate when it has been successfully installed:
91+
...and will indicate when it has been successfully installed:
9492

9593
[[msi-installer-success]]
9694
image::images/msi_installer/msi_installer_success.png[]
@@ -107,7 +105,7 @@ then running:
107105
msiexec.exe /i elasticsearch-{version}.msi /qn
108106
--------------------------------------------
109107

110-
By default, msiexec does not wait for the installation process to complete, since it runs in the
108+
By default, `msiexec.exe` does not wait for the installation process to complete, since it runs in the
111109
Windows subsystem. To wait on the process to finish and ensure that `%ERRORLEVEL%` is set
112110
accordingly, it is recommended to use `start /wait` to create a process and wait for it to exit
113111

@@ -132,13 +130,13 @@ Supported Windows Installer command line arguments can be viewed using
132130
msiexec.exe /help
133131
--------------------------------------------
134132

135-
or by consulting the https://msdn.microsoft.com/en-us/library/windows/desktop/aa367988(v=vs.85).aspx[Windows Installer SDK Command-Line Options].
133+
...or by consulting the https://msdn.microsoft.com/en-us/library/windows/desktop/aa367988(v=vs.85).aspx[Windows Installer SDK Command-Line Options].
136134

137135
[[msi-command-line-options]]
138136
==== Command line options
139137

140138
All settings exposed within the GUI are also available as command line arguments (referred to
141-
as _properties_ within Windows Installer documentation) that can be passed to msiexec:
139+
as _properties_ within Windows Installer documentation) that can be passed to `msiexec.exe`:
142140

143141
[horizontal]
144142
`INSTALLDIR`::
@@ -282,57 +280,57 @@ as _properties_ within Windows Installer documentation) that can be passed to ms
282280

283281
`XPACKLICENSE`::
284282

285-
When installing {xpack} plugin, the type of license to install,
286-
either `Basic` or `Trial`. Defaults to `Basic`
283+
The type of X-Pack license to install, either `Basic` or `Trial`. Defaults to `Basic`
287284

288285
`XPACKSECURITYENABLED`::
289286

290-
When installing {xpack} plugin with a `Trial` license, whether {security} should be enabled.
287+
When installing with a `Trial` license, whether X-Pack Security should be enabled.
291288
Defaults to `true`
292289

293290
`BOOTSTRAPPASSWORD`::
294291

295-
When installing {xpack} plugin with a `Trial` license and {security} enabled, the password to
292+
When installing with a `Trial` license and X-Pack Security enabled, the password to
296293
used to bootstrap the cluster and persisted as the `bootstrap.password` setting in the keystore.
297294
Defaults to a randomized value.
298295

299296
`SKIPSETTINGPASSWORDS`::
300297

301-
When installing {xpack} plugin with a `Trial` license and {security} enabled, whether the
298+
When installing with a `Trial` license and X-Pack Security enabled, whether the
302299
installation should skip setting up the built-in users `elastic`, `kibana` and `logstash_system`.
303300
Defaults to `false`
304301

305302
`ELASTICUSERPASSWORD`::
306303

307-
When installing {xpack} plugin with a `Trial` license and {security} enabled, the password
304+
When installing with a `Trial` license and X-Pack Security enabled, the password
308305
to use for the built-in user `elastic`. Defaults to `""`
309306

310307
`KIBANAUSERPASSWORD`::
311308

312-
When installing {xpack} plugin with a `Trial` license and {security} enabled, the password
309+
When installing with a `Trial` license and X-Pack Security enabled, the password
313310
to use for the built-in user `kibana`. Defaults to `""`
314311

315312
`LOGSTASHSYSTEMUSERPASSWORD`::
316313

317-
When installing {xpack} plugin with a `Trial` license and {security} enabled, the password
314+
When installing with a `Trial` license and X-Pack Security enabled, the password
318315
to use for the built-in user `logstash_system`. Defaults to `""`
319316

320317
To pass a value, simply append the property name and value using the format `<PROPERTYNAME>="<VALUE>"` to
321-
the installation command. For example, to use a different installation directory to the default one and to install https://www.elastic.co/products/x-pack[{xpack}]:
318+
the installation command. For example, to use a different installation directory to the default one and to install https://www.elastic.co/products/x-pack[X-Pack]:
322319

323320
["source","sh",subs="attributes,callouts"]
324321
--------------------------------------------
325-
start /wait msiexec.exe /i elasticsearch-{version}.msi /qn INSTALLDIR="C:\Custom Install Directory" PLUGINS="x-pack"
322+
start /wait msiexec.exe /i elasticsearch-{version}.msi /qn INSTALLDIR="C:\Custom Install Directory\{version}" PLUGINS="x-pack"
326323
--------------------------------------------
327324

328325
Consult the https://msdn.microsoft.com/en-us/library/windows/desktop/aa367988(v=vs.85).aspx[Windows Installer SDK Command-Line Options]
329326
for additional rules related to values containing quotation marks.
330327

331328
ifdef::include-xpack[]
332329
[[msi-installer-enable-indices]]
333-
==== Enable automatic creation of {xpack} indices
330+
==== Enable automatic creation of X-Pack indices
331+
334332

335-
{xpack} will try to automatically create a number of indices within {es}.
333+
X-Pack will try to automatically create a number of indices within Elasticsearch.
336334
include::xpack-indices.asciidoc[]
337335

338336
endif::include-xpack[]
@@ -344,7 +342,7 @@ include::msi-windows-start.asciidoc[]
344342
==== Configuring Elasticsearch on the command line
345343

346344
Elasticsearch loads its configuration from the `%ES_PATH_CONF%\elasticsearch.yml`
347-
file by default. The format of this config file is explained in
345+
file by default. The format of this config file is explained in
348346
<<settings>>.
349347

350348
Any settings that can be specified in the config file can also be specified on
@@ -393,27 +391,28 @@ with PowerShell:
393391

394392
[source,powershell]
395393
--------------------------------------------
396-
Get-Service Elasticsearch | Stop-Service | Start-Service
394+
Get-Service Elasticsearch | Stop-Service
395+
Get-Service Elasticsearch | Start-Service
397396
--------------------------------------------
398397

399-
Changes can be made to jvm.options and elasticsearch.yml configuration files to configure the
398+
Changes can be made to `jvm.options` and `elasticsearch.yml` configuration files to configure the
400399
service after installation. Most changes (like JVM settings) will require a restart of the
401400
service in order to take effect.
402401

403402
[[upgrade-msi-gui]]
404403
==== Upgrade using the graphical user interface (GUI)
405404

406405
The `.msi` package supports upgrading an installed version of Elasticsearch to a newer
407-
version of Elasticsearch. The upgrade process through the GUI handles upgrading all
406+
version. The upgrade process through the GUI handles upgrading all
408407
installed plugins as well as retaining both your data and configuration.
409408

410-
Downloading and clicking on a newer version of the `.msi` package will launch the GUI wizard.
411-
The first step will list the read only properties from the previous installation:
409+
Downloading and double-clicking on a newer version of the `.msi` package will launch the GUI wizard.
410+
The first step will list the read-only properties from the previous installation:
412411

413412
[[msi-installer-upgrade-notice]]
414413
image::images/msi_installer/msi_installer_upgrade_notice.png[]
415414

416-
The following configuration step allows certain configuration options to be changed:
415+
The next step allows certain configuration options to be changed:
417416

418417
[[msi-installer-upgrade-configuration]]
419418
image::images/msi_installer/msi_installer_upgrade_configuration.png[]
@@ -434,11 +433,11 @@ The `.msi` can also upgrade Elasticsearch using the command line.
434433
A command line upgrade requires passing the **same** command line properties as
435434
used at first install time; the Windows Installer does not remember these properties.
436435
437-
For example, if you originally installed with the command line options `PLUGINS="x-pack"` and
436+
For example, if you originally installed with the command line options `PLUGINS="ingest-geoip"` and
438437
`LOCKMEMORY="true"`, then you must pass these same values when performing an
439438
upgrade from the command line.
440439
441-
The **exception** to this is `INSTALLDIR` (if originally specified), which must be a different directory to the
440+
The **exception** to this is the `INSTALLDIR` parameter (if originally specified), which must be a different directory to the
442441
current installation.
443442
If setting `INSTALLDIR`, the final directory in the path **must** be the version of Elasticsearch e.g.
444443
@@ -466,9 +465,8 @@ start /wait msiexec.exe /i elasticsearch-{version}.msi /qn /l upgrade.log
466465

467466
The `.msi` package handles uninstallation of all directories and files added as part of installation.
468467

469-
WARNING: Uninstallation will remove **all** directories and their contents created as part of
470-
installation, **including data within the data directory**. If you wish to retain your data upon
471-
uninstallation, it is recommended that you make a copy of the data directory before uninstallation.
468+
WARNING: Uninstallation will remove **all** contents created as part of
469+
installation, **except for data, config or logs directories**. It is recommended that you make a copy of your data directory before upgrading or consider using the snapshot API.
472470

473471
MSI installer packages do not provide a GUI for uninstallation. An installed program can be uninstalled
474472
by pressing the Windows key and typing `add or remove programs` to open the system settings.

0 commit comments

Comments
 (0)