Skip to content

Commit 4736258

Browse files
author
Stuart Cam
authored
Update MSI documentation (#31950)
Update MSI documentation
1 parent 30a2302 commit 4736258

15 files changed

+31
-33
lines changed
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

docs/reference/setup/install/windows.asciidoc

Lines changed: 31 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -76,14 +76,12 @@ TIP: Ensure the installation machine has access to the internet and that any cor
7676
[[msi-installer-selected-plugins]]
7777
image::images/msi_installer/msi_installer_selected_plugins.png[]
7878

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:
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

8886
After clicking the install button, the installation will begin:
8987

@@ -282,56 +280,57 @@ as _properties_ within Windows Installer documentation) that can be passed to `m
282280

283281
`XPACKLICENSE`::
284282

285-
The type of {xpack} license to install, either `Basic` or `Trial`. Defaults to `Basic`
283+
The type of X-Pack license to install, either `Basic` or `Trial`. Defaults to `Basic`
286284

287285
`XPACKSECURITYENABLED`::
288286

289-
When installing with a `Trial` license, whether {xpack} Security should be enabled.
287+
When installing with a `Trial` license, whether X-Pack Security should be enabled.
290288
Defaults to `true`
291289

292290
`BOOTSTRAPPASSWORD`::
293291

294-
When installing with a `Trial` license and {xpack} Security enabled, the password to
292+
When installing with a `Trial` license and X-Pack Security enabled, the password to
295293
used to bootstrap the cluster and persisted as the `bootstrap.password` setting in the keystore.
296294
Defaults to a randomized value.
297295

298296
`SKIPSETTINGPASSWORDS`::
299297

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

304302
`ELASTICUSERPASSWORD`::
305303

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

309307
`KIBANAUSERPASSWORD`::
310308

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

314312
`LOGSTASHSYSTEMUSERPASSWORD`::
315313

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

319317
To pass a value, simply append the property name and value using the format `<PROPERTYNAME>="<VALUE>"` to
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}]:
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]:
321319

322320
["source","sh",subs="attributes,callouts"]
323321
--------------------------------------------
324-
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"
325323
--------------------------------------------
326324

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

330328
ifdef::include-xpack[]
331329
[[msi-installer-enable-indices]]
332-
==== Enable automatic creation of {xpack} indices
330+
==== Enable automatic creation of X-Pack indices
333331

334-
{xpack} will try to automatically create a number of indices within {es}.
332+
333+
X-Pack will try to automatically create a number of indices within Elasticsearch.
335334
include::xpack-indices.asciidoc[]
336335

337336
endif::include-xpack[]
@@ -340,9 +339,9 @@ endif::include-xpack[]
340339
include::msi-windows-start.asciidoc[]
341340

342341
[[msi-installer-command-line-configuration]]
343-
==== Configuring {es} on the command line
342+
==== Configuring Elasticsearch on the command line
344343

345-
{es} loads its configuration from the `%ES_PATH_CONF%\elasticsearch.yml`
344+
Elasticsearch loads its configuration from the `%ES_PATH_CONF%\elasticsearch.yml`
346345
file by default. The format of this config file is explained in
347346
<<settings>>.
348347

@@ -363,17 +362,17 @@ such as `node.name` could be specified on the command line.
363362
include::check-running.asciidoc[]
364363

365364
[[msi-installer-windows-service]]
366-
==== Installing {es} as a Service on Windows
365+
==== Installing Elasticsearch as a Service on Windows
367366

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

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

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

378377
[[msi-installer-installed-service]]
379378
image::images/msi_installer/msi_installer_installed_service.png[]
@@ -384,16 +383,16 @@ with Command Prompt:
384383

385384
[source,sh]
386385
--------------------------------------------
387-
sc.exe stop {es}
388-
sc.exe start {es}
386+
sc.exe stop Elasticsearch
387+
sc.exe start Elasticsearch
389388
--------------------------------------------
390389

391390
with PowerShell:
392391

393392
[source,powershell]
394393
--------------------------------------------
395-
Get-Service {es} | Stop-Service
396-
Get-Service {es} | Start-Service
394+
Get-Service Elasticsearch | Stop-Service
395+
Get-Service Elasticsearch | Start-Service
397396
--------------------------------------------
398397

399398
Changes can be made to `jvm.options` and `elasticsearch.yml` configuration files to configure the
@@ -403,7 +402,7 @@ service in order to take effect.
403402
[[upgrade-msi-gui]]
404403
==== Upgrade using the graphical user interface (GUI)
405404

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

@@ -427,7 +426,7 @@ image::images/msi_installer/msi_installer_upgrade_plugins.png[]
427426
[[upgrade-msi-command-line]]
428427
==== Upgrade using the command line
429428

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

432431
[IMPORTANT]
433432
===========================================
@@ -440,12 +439,12 @@ upgrade from the command line.
440439
441440
The **exception** to this is the `INSTALLDIR` parameter (if originally specified), which must be a different directory to the
442441
current installation.
443-
If setting `INSTALLDIR`, the final directory in the path **must** be the version of {es} e.g.
442+
If setting `INSTALLDIR`, the final directory in the path **must** be the version of Elasticsearch e.g.
444443
445-
++C:\Program Files\Elastic\{es}{backslash}{version}++
444+
++C:\Program Files\Elastic\Elasticsearch{backslash}{version}++
446445
===========================================
447446

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

451450
["source","sh",subs="attributes,callouts"]
@@ -466,14 +465,13 @@ 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 beforehand or consider using the snapshot API.
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.
475473

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

479477
[[msi-installer-uninstall]]

0 commit comments

Comments
 (0)