Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update MSI documentation #31950

Merged
merged 3 commits into from
Aug 29, 2018
Merged

Update MSI documentation #31950

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dead816
Update MSI documentation
codebrain Jul 11, 2018
7a90d15
Address PR comments
codebrain Aug 28, 2018
1277d5e
Address PR comments
codebrain Aug 28, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/reference/images/msi_installer/msi_installer_xpack.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 27 additions & 26 deletions docs/reference/setup/install/windows.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +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
NOTE: X-Pack includes a choice of a Trial license (valid for 30 days) or Basic license (valid perpetually). After that, you can obtain one of the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be a bit clearer to separate out the license types from their validity e.g.

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 on the other hand is free and perpetual. Consult the https://www.elastic.co/subscriptions[available subscriptions] for further details on which features are available under which license.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect

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.

Expand Down Expand Up @@ -282,56 +282,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 +341,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 +364,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 Down Expand Up @@ -403,7 +404,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 +428,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 +441,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 @@ -467,13 +468,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.
installation, **except for data, config or logs directories**. If you wish to retain your data upon
uninstallation, it is recommended that you make a copy of your data directory beforehand or consider using the snapshot API.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you wish to retain your data upon uninstallation, it is recommended that you make a copy of your data directory

This doesn't align with the previous sentence, since data directory is not removed on uninstall

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. I think asking the user to backup their data on an upgrade is probably good advice anyway, so will rephrase.


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