Skip to content

Commit

Permalink
Update MSI documentation (#31950)
Browse files Browse the repository at this point in the history
Update MSI documentation
  • Loading branch information
Stuart Cam authored Aug 29, 2018
1 parent 30a2302 commit 4736258
Show file tree
Hide file tree
Showing 15 changed files with 31 additions and 33 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/reference/images/msi_installer/msi_installer_help.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/reference/images/msi_installer/msi_installer_installing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/reference/images/msi_installer/msi_installer_locations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/reference/images/msi_installer/msi_installer_no_service.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/reference/images/msi_installer/msi_installer_plugins.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/reference/images/msi_installer/msi_installer_service.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/reference/images/msi_installer/msi_installer_success.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/reference/images/msi_installer/msi_installer_uninstall.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/reference/images/msi_installer/msi_installer_xpack.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
64 changes: 31 additions & 33 deletions docs/reference/setup/install/windows.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -76,14 +76,12 @@ TIP: Ensure the installation machine has access to the internet and that any cor
[[msi-installer-selected-plugins]]
image::images/msi_installer/msi_installer_selected_plugins.png[]

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

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

NOTE: {xpack} includes a choice of a Trial or Basic license for 30 days. After that, you can obtain one of the
https://www.elastic.co/subscriptions[available subscriptions] or {ref}/security-settings.html[disable Security].
The Basic license is free and includes the https://www.elastic.co/products/x-pack/monitoring[Monitoring] extension.
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.

After clicking the install button, the installation will begin:

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

`XPACKLICENSE`::

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

`XPACKSECURITYENABLED`::

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

`BOOTSTRAPPASSWORD`::

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

`SKIPSETTINGPASSWORDS`::

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

`ELASTICUSERPASSWORD`::

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

`KIBANAUSERPASSWORD`::

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

`LOGSTASHSYSTEMUSERPASSWORD`::

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

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

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

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

ifdef::include-xpack[]
[[msi-installer-enable-indices]]
==== Enable automatic creation of {xpack} indices
==== Enable automatic creation of X-Pack indices

{xpack} will try to automatically create a number of indices within {es}.

X-Pack will try to automatically create a number of indices within Elasticsearch.
include::xpack-indices.asciidoc[]

endif::include-xpack[]
Expand All @@ -340,9 +339,9 @@ endif::include-xpack[]
include::msi-windows-start.asciidoc[]

[[msi-installer-command-line-configuration]]
==== Configuring {es} on the command line
==== Configuring Elasticsearch on the command line

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

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

[[msi-installer-windows-service]]
==== Installing {es} as a Service on Windows
==== Installing Elasticsearch as a Service on Windows

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

* `INSTALLASSERVICE=true`
* `STARTAFTERINSTALL=true`
* `STARTWHENWINDOWSSTARTS=true`

Once installed, {es} will appear within the Services control panel:
Once installed, Elasticsearch will appear within the Services control panel:

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

[source,sh]
--------------------------------------------
sc.exe stop {es}
sc.exe start {es}
sc.exe stop Elasticsearch
sc.exe start Elasticsearch
--------------------------------------------

with PowerShell:

[source,powershell]
--------------------------------------------
Get-Service {es} | Stop-Service
Get-Service {es} | Start-Service
Get-Service Elasticsearch | Stop-Service
Get-Service Elasticsearch | Start-Service
--------------------------------------------

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

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

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

The `.msi` can also upgrade {es} using the command line.
The `.msi` can also upgrade Elasticsearch using the command line.

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

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

["source","sh",subs="attributes,callouts"]
Expand All @@ -466,14 +465,13 @@ start /wait msiexec.exe /i elasticsearch-{version}.msi /qn /l upgrade.log

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

WARNING: Uninstallation will remove **all** directories and their contents created as part of
installation, **including data within the data directory**. If you wish to retain your data upon
uninstallation, it is recommended that you make a copy of the data directory beforehand or consider using the snapshot API.
WARNING: Uninstallation will remove **all** contents created as part of
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.

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

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

[[msi-installer-uninstall]]
Expand Down

0 comments on commit 4736258

Please sign in to comment.