honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-07 21:48:39 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/setup/install/windows.asciidoc
Jason Tedor b9df2e2287 Improve the out-of-the-box experience 
Elasticsearch can be run in a few different ways:
 - from the command line on Linux and Windows
 - as a service on Linux and Windows

on both 32-bit client and 64-bit server VMs. We strive for a great
out-of-the-box experience any of these combinations but today it is
lacking on 32-bit client JVMs and on the Windows service. There are two
deficiencies that arise:
 - on any 32-bit client JVM we fail to start out of the box because we
   force the server JVM in jvm.options
 - when installing the Windows service, the thread stack size must be
   specified in jvm.options

This commit attempts to address these deficiencies.

We should continue to force the server JVM because there are systems
where the server JVM is not active by default (e.g., the 32-bit JDK on
Windows). This does mean that if a user tries to run with a client JVM
they will see a failure message at startup but this is the best that we
can do if we want to continue to force the server JVM. Thus, this commit
at least documents this situation.

To improve the situation with installing the Windows service, this
commit adds a default setting for the thread stack size. This default is
chosen based on the default thread stack size across all 64-bit server
JVMs. This means that if a user tries to run with a 32-bit JVM they
could otherwise see significantly higher memory usage (this situation is
complicated, it's really only on Windows where the extra memory usage is
egregious, but cutting into the 32-bit address space on any system is
bad). So this commit makes it so that the out-of-the-box experience is
improved for the Windows service on 64-bit server JVMs and we document
the need to adjust this setting on 32-bit JVMs.

Again, we are focusing on the out-of-the-box experience here and this
means optimizing for the best experience on any 64-bit server JVM as
this covers the vast majority of the user base. The users that are on
32-bit JVMs will suffer a little bit but at least now any user on any
64-bit server JVM can start Elasticsearch out of the box.

Finally, we fix some references to the jvm.options documentation.

Relates #21920
2016-12-01 17:26:29 -05:00

261 lines
9.6 KiB
Plaintext
Raw Blame History

[[windows]]
=== Install Elasticsearch on Windows
Elasticsearch can be installed on Windows using the `.zip` package. This
comes with a `elasticsearch-service.bat` command which will setup Elasticsearch to run as a
service.
The latest stable version of Elasticsearch can be found on the
link:/downloads/elasticsearch[Download Elasticsearch] page.
Other versions can be found on the
link:/downloads/past-releases[Past Releases page].
NOTE: Elasticsearch requires Java 8 or later. Use the
http://www.oracle.com/technetwork/java/javase/downloads/index.html[official Oracle distribution]
or an open-source distribution such as http://openjdk.java.net[OpenJDK].
[[install-windows]]
==== Download and install the `.zip` package
ifeval::["{release-state}"=="unreleased"]
Version {version} of Elasticsearch has not yet been released.
endif::[]
ifeval::["{release-state}"!="unreleased"]
Download the `.zip` archive for Elasticsearch v{version} from: https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{version}.zip
Unzip it with your favourite unzip tool. This will create a folder called
+elasticsearch-{version}+, which we will refer to as `%ES_HOME%`. In a terminal
window, `cd` to the `%ES_HOME%` directory, for instance:
["source","sh",subs="attributes"]
----------------------------
cd c:\elasticsearch-{version}
----------------------------
endif::[]
[[windows-running]]
==== Running Elasticsearch from the command line
Elasticsearch can be started from the command line as follows:
[source,sh]
--------------------------------------------
.\bin\elasticsearch
--------------------------------------------
By default, Elasticsearch runs in the foreground, prints its logs to `STDOUT`,
and can be stopped by pressing `Ctrl-C`.
[[windows-configuring]]
==== Configuring Elasticsearch on the command line
Elasticsearch loads its configuration from the `%ES_HOME%/config/elasticsearch.yml`
file by default. The format of this config file is explained in
<<settings>>.
Any settings that can be specified in the config file can also be specified on
the command line, using the `-E` syntax as follows:
[source,sh]
--------------------------------------------
./bin/elasticsearch -Ecluster.name=my_cluster -Enode.name=node_1
--------------------------------------------
NOTE: Values that contain spaces must be surrounded with quotes. For instance `-Epath.logs="C:\My Logs\logs"`.
TIP: Typically, any cluster-wide settings (like `cluster.name`) should be
added to the `elasticsearch.yml` config file, while any node-specific settings
such as `node.name` could be specified on the command line.
include::check-running.asciidoc[]
[[windows-service]]
==== Installing Elasticsearch as a Service on Windows
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
through the `elasticsearch-service.bat` script in the `bin\` folder which allows one to
install, remove, manage or configure the service and potentially start and
stop the service, all from the command-line.
["source","sh",subs="attributes,callouts"]
--------------------------------------------------
c:\elasticsearch-{version}{backslash}bin>elasticsearch-service
Usage: elasticsearch-service.bat install|remove|start|stop|manager [SERVICE_ID]
--------------------------------------------------
The script requires one parameter (the command to execute) followed by an
optional one indicating the service id (useful when installing multiple
Elasticsearch services).
The commands available are:
[horizontal]
`install`:: Install Elasticsearch as a service
`remove`:: Remove the installed Elasticsearch service (and stop the service if started)
`start`:: Start the Elasticsearch service (if installed)
`stop`:: Stop the Elasticsearch service (if started)
`manager`:: Start a GUI for managing the installed service
Based on the architecture of the available JDK/JRE (set through `JAVA_HOME`),
the appropriate 64-bit(x64) or 32-bit(x86) service will be installed. This
information is made available during install:
["source","sh",subs="attributes"]
--------------------------------------------------
c:\elasticsearch-{version}{backslash}bin>elasticsearch-service install
Installing service : "elasticsearch-service-x64"
Using JAVA_HOME (64-bit): "c:\jvm\jdk1.8"
The service 'elasticsearch-service-x64' has been installed.
--------------------------------------------------
NOTE: While a JRE can be used for the Elasticsearch service, due to its use of a client VM (as opposed to a server JVM which offers better performance for long-running applications) its usage is discouraged and a warning will be issued.
NOTE: Upgrading (or downgrading) JVM versions does not require the service to be reinstalled. However, upgrading across JVM types (e.g. JRE versus SE) is not supported, and does require the service to be reinstalled.
[[windows-service-settings]]
[float]
=== Customizing service settings
The Elasticsearch service can be configured prior to installation by setting the the following environment variables (either using the https://technet.microsoft.com/en-us/library/cc754250(v=ws.10).aspx[set command] from the command line, or through the `System Properties->Environment Variables` GUI).
[horizontal]
`SERVICE_ID`::
A unique identifier for the service. Useful if installing multiple instances on the same machine. Defaults to `elasticsearch-service-x86` (on 32-bit Windows) or `elasticsearch-service-x64` (on 64-bit Windows).
`SERVICE_USERNAME`::
The user to run as, defaults to the local system account.
`SERVICE_PASSWORD`::
The password for the user specified in `%SERVICE_USERNAME%`.
`SERVICE_DISPLAY_NAME`::
The name of the service. Defaults to `Elasticsearch <version> %SERVICE_ID%`.
`SERVICE_DESCRIPTION`::
The description of the service. Defaults to `Elasticsearch <version> Windows Service - https://elastic.co`.
`JAVA_HOME`::
The installation directory of the desired JVM to run the service under.
`LOG_DIR`::
Log directory, defaults to `%ES_HOME%\logs`.
`DATA_DIR`::
Data directory, defaults to `%ES_HOME%\data`.
`CONF_DIR`::
Configuration file directory (which needs to include `elasticsearch.yml`
and `log4j2.properties` files), defaults to `%ES_HOME%\conf`.
`ES_JAVA_OPTS`::
Any additional JVM system properties you may want to apply.
`ES_START_TYPE`::
Startup mode for the service. Can be either `auto` or `manual` (default).
`ES_STOP_TIMEOUT` ::
The timeout in seconds that procrun waits for service to exit gracefully. Defaults to `0`.
NOTE: At its core, `elasticsearch-service.bat` relies on http://commons.apache.org/proper/commons-daemon/[Apache Commons Daemon] project
to install the service. Environment variables set prior to the service installation are copied and will be used during the service lifecycle. This means any changes made to them after the installation will not be picked up unless the service is reinstalled.
NOTE: On Windows, the <<heap-size,heap size>> can be configured as for
any other Elasticsearch installation when running Elasticsearch from the
command line, or when installing Elasticsearch as a service for the
first time. To adjust the heap size for an already installed service,
use the service manager: `bin\elasticsearch-service.bat manager`.
Using the Manager GUI::
It is also possible to configure the service after it's been installed using the manager GUI (`elasticsearch-service-mgr.exe`), which offers insight into the installed service, including its status, startup type, JVM, start and stop settings amongst other things. Simply invoking `elasticsearch-service.bat manager` from the command-line will open up the manager window:
image::images/service-manager-win.png["Windows Service Manager GUI",align="center"]
Most changes (like JVM settings) made through the manager GUI will require a restart of the service in order to take affect.
[[windows-layout]]
==== Directory layout of `.zip` archive
The `.zip` package is entirely self-contained. All files and directories are,
by default, contained within `%ES_HOME%` -- the directory created when
unpacking the archive.
This is very convenient because you don't have to create any directories to
start using Elasticsearch, and uninstalling Elasticsearch is as easy as
removing the `%ES_HOME%` directory. However, it is advisable to change the
default locations of the config directory, the data directory, and the logs
directory so that you do not delete important data later on.
[cols="<h,<,<m,<m",options="header",]
|=======================================================================
| Type | Description | Default Location | Setting
| home
| Elasticsearch home directory or `%ES_HOME%`
d| Directory created by unpacking the archive
|
| bin
| Binary scripts including `elasticsearch` to start a node
and `elasticsearch-plugin` to install plugins
| %ES_HOME%\bin
d|
| conf
| Configuration files including `elasticsearch.yml`
| %ES_HOME%\config
| path.conf
| data
| The location of the data files of each index / shard allocated
on the node. Can hold multiple locations.
| %ES_HOME%\data
| path.data
| logs
| Log files location.
| %ES_HOME%\logs
| path.logs
| plugins
| Plugin files location. Each plugin will be contained in a subdirectory.
| %ES_HOME%\plugins
|
| repo
| Shared file system repository locations. Can hold multiple locations. A file system repository can be placed in to any subdirectory of any directory specified here.
d| Not configured
| path.repo
| script
| Location of script files.
| %ES_HOME%\scripts
| path.scripts
|=======================================================================
include::next-steps.asciidoc[]
Reference in New Issue View Git Blame Copy Permalink