Skip to content

Commit 0384370

Browse files
authored
Update MSI instructions
1 parent 90355a8 commit 0384370

File tree

1 file changed

+48
-48
lines changed

1 file changed

+48
-48
lines changed

docs/reference/setup/install/windows.asciidoc

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -47,50 +47,50 @@ 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 X-Pack plugin, an additional step allows a choice of the type of X-Pack
79-
license to install, in addition to X-Pack Security configuration and built-in user configuration:
79+
As of version 6.3.0, {xpack} is now https://www.elastic.co/products/x-pack/open[bundled by default]. The final step allows a choice of the type of {xpack} 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: X-Pack includes a choice of a Trial or Basic license for 30 days. After that, you can obtain one of the
84+
NOTE: {xpack} includes a choice of a Trial or Basic license for 30 days. After that, you can obtain one of the
8585
https://www.elastic.co/subscriptions[available subscriptions] or {ref}/security-settings.html[disable Security].
8686
The Basic license is free and includes the https://www.elastic.co/products/x-pack/monitoring[Monitoring] extension.
8787

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

9090
[[msi-installer-installing]]
9191
image::images/msi_installer/msi_installer_installing.png[]
9292

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

9595
[[msi-installer-success]]
9696
image::images/msi_installer/msi_installer_success.png[]
@@ -107,7 +107,7 @@ then running:
107107
msiexec.exe /i elasticsearch-{version}.msi /qn
108108
--------------------------------------------
109109

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

@@ -132,13 +132,13 @@ Supported Windows Installer command line arguments can be viewed using
132132
msiexec.exe /help
133133
--------------------------------------------
134134

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].
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].
136136

137137
[[msi-command-line-options]]
138138
==== Command line options
139139

140140
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:
141+
as _properties_ within Windows Installer documentation) that can be passed to `msiexec.exe`:
142142

143143
[horizontal]
144144
`INSTALLDIR`::
@@ -282,43 +282,42 @@ as _properties_ within Windows Installer documentation) that can be passed to ms
282282

283283
`XPACKLICENSE`::
284284

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

288287
`XPACKSECURITYENABLED`::
289288

290-
When installing X-Pack plugin with a `Trial` license, whether X-Pack Security should be enabled.
289+
When installing with a `Trial` license, whether {xpack} Security should be enabled.
291290
Defaults to `true`
292291

293292
`BOOTSTRAPPASSWORD`::
294293

295-
When installing X-Pack plugin with a `Trial` license and X-Pack Security enabled, the password to
294+
When installing with a `Trial` license and {xpack} Security enabled, the password to
296295
used to bootstrap the cluster and persisted as the `bootstrap.password` setting in the keystore.
297296
Defaults to a randomized value.
298297

299298
`SKIPSETTINGPASSWORDS`::
300299

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

305304
`ELASTICUSERPASSWORD`::
306305

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

310309
`KIBANAUSERPASSWORD`::
311310

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

315314
`LOGSTASHSYSTEMUSERPASSWORD`::
316315

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

320319
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[X-Pack]:
320+
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}]:
322321

323322
["source","sh",subs="attributes,callouts"]
324323
--------------------------------------------
@@ -341,10 +340,10 @@ endif::include-xpack[]
341340
include::msi-windows-start.asciidoc[]
342341

343342
[[msi-installer-command-line-configuration]]
344-
==== Configuring Elasticsearch on the command line
343+
==== Configuring {es} on the command line
345344

346-
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+
{es} loads its configuration from the `%ES_PATH_CONF%\elasticsearch.yml`
346+
file by default. The format of this config file is explained in
348347
<<settings>>.
349348

350349
Any settings that can be specified in the config file can also be specified on
@@ -364,17 +363,17 @@ such as `node.name` could be specified on the command line.
364363
include::check-running.asciidoc[]
365364

366365
[[msi-installer-windows-service]]
367-
==== Installing Elasticsearch as a Service on Windows
366+
==== Installing {es} as a Service on Windows
368367

369-
Elasticsearch can be installed as a service to run in the background or start
368+
{es} can be installed as a service to run in the background or start
370369
automatically at boot time without any user interaction. This can be achieved upon installation
371370
using the following command line options
372371

373372
* `INSTALLASSERVICE=true`
374373
* `STARTAFTERINSTALL=true`
375374
* `STARTWHENWINDOWSSTARTS=true`
376375

377-
Once installed, Elasticsearch will appear within the Services control panel:
376+
Once installed, {es} will appear within the Services control panel:
378377

379378
[[msi-installer-installed-service]]
380379
image::images/msi_installer/msi_installer_installed_service.png[]
@@ -385,35 +384,36 @@ with Command Prompt:
385384

386385
[source,sh]
387386
--------------------------------------------
388-
sc.exe stop Elasticsearch
389-
sc.exe start Elasticsearch
387+
sc.exe stop {es}
388+
sc.exe start {es}
390389
--------------------------------------------
391390

392391
with PowerShell:
393392

394393
[source,powershell]
395394
--------------------------------------------
396-
Get-Service Elasticsearch | Stop-Service | Start-Service
395+
Get-Service {es} | Stop-Service
396+
Get-Service {es} | Start-Service
397397
--------------------------------------------
398398

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

403403
[[upgrade-msi-gui]]
404404
==== Upgrade using the graphical user interface (GUI)
405405

406-
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+
The `.msi` package supports upgrading an installed version of {es} to a newer
407+
version. The upgrade process through the GUI handles upgrading all
408408
installed plugins as well as retaining both your data and configuration.
409409

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:
410+
Downloading and double-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:
412412

413413
[[msi-installer-upgrade-notice]]
414414
image::images/msi_installer/msi_installer_upgrade_notice.png[]
415415

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

418418
[[msi-installer-upgrade-configuration]]
419419
image::images/msi_installer/msi_installer_upgrade_configuration.png[]
@@ -427,25 +427,25 @@ image::images/msi_installer/msi_installer_upgrade_plugins.png[]
427427
[[upgrade-msi-command-line]]
428428
==== Upgrade using the command line
429429

430-
The `.msi` can also upgrade Elasticsearch using the command line.
430+
The `.msi` can also upgrade {es} using the command line.
431431

432432
[IMPORTANT]
433433
===========================================
434434
A command line upgrade requires passing the **same** command line properties as
435435
used at first install time; the Windows Installer does not remember these properties.
436436
437-
For example, if you originally installed with the command line options `PLUGINS="x-pack"` and
437+
For example, if you originally installed with the command line options `PLUGINS="ingest-geoip"` and
438438
`LOCKMEMORY="true"`, then you must pass these same values when performing an
439439
upgrade from the command line.
440440
441-
The **exception** to this is `INSTALLDIR` (if originally specified), which must be a different directory to the
441+
The **exception** to this is the `INSTALLDIR` parameter (if originally specified), which must be a different directory to the
442442
current installation.
443-
If setting `INSTALLDIR`, the final directory in the path **must** be the version of Elasticsearch e.g.
443+
If setting `INSTALLDIR`, the final directory in the path **must** be the version of {es} e.g.
444444
445-
++C:\Program Files\Elastic\Elasticsearch{backslash}{version}++
445+
++C:\Program Files\Elastic\{es}{backslash}{version}++
446446
===========================================
447447

448-
The simplest upgrade, assuming Elasticsearch was installed using all defaults,
448+
The simplest upgrade, assuming {es} was installed using all defaults,
449449
is achieved by first navigating to the download directory, then running:
450450

451451
["source","sh",subs="attributes,callouts"]
@@ -468,12 +468,12 @@ The `.msi` package handles uninstallation of all directories and files added as
468468

469469
WARNING: Uninstallation will remove **all** directories and their contents created as part of
470470
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.
471+
uninstallation, it is recommended that you make a copy of the data directory beforehand or consider using the snapshot API.
472472

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

476-
Once opened, find the Elasticsearch installation within the list of installed applications, click
476+
Once opened, find the {es} installation within the list of installed applications, click
477477
and choose `Uninstall`:
478478

479479
[[msi-installer-uninstall]]

0 commit comments

Comments
 (0)