honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update defaults in documentation (#25483) 

Following internal discussion

Relates: https://github.com/elastic/windows-installers/pull/49
This commit is contained in:
Russ Cam 2017-06-30 16:24:53 +10:00 committed by GitHub
parent 7e1a5c68db
commit 099ccd36ee
1 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/reference/setup/install/windows.asciidoc
View File

@ -71,9 +71,6 @@ part of the installation:
[[msi-installer-selected-plugins]] [[msi-installer-selected-plugins]]
image::images/msi_installer/msi_installer_selected_plugins.png[] image::images/msi_installer/msi_installer_selected_plugins.png[]
By default, the {xpack-ref}/index.html[X-Pack] plugin will be selected to be installed, and if
installing with the <<ingest, ingest>> node role, the {plugins}/ingest-attachment.html[Ingest Attachment Processor] and {plugins}/ingest-geoip.html[Ingest GeoIP Processor] plugins will also be selected for installation.
NOTE: X-Pack includes a trial 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 trial 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.
After clicking the install button, Elasticsearch will be installed: After clicking the install button, Elasticsearch will be installed:
@ -104,7 +101,7 @@ start /wait msiexec.exe /i elasticsearch-{version}.msi /qn
As with any MSI installation package, a log file for the installation process can be found As with any MSI installation package, a log file for the installation process can be found
within the `%TEMP%` directory, with a randomly generated name adhering to the format within the `%TEMP%` directory, with a randomly generated name adhering to the format
`MSI*.LOG`. The path to a log file can be supplied using the `/l` command line argument `MSI<random>.LOG`. The path to a log file can be supplied using the `/l` command line argument
["source","sh",subs="attributes,callouts"] ["source","sh",subs="attributes,callouts"]
-------------------------------------------- --------------------------------------------
@ -129,7 +126,7 @@ as _properties_ within Windows Installer documentation) that can be passed to ms
[horizontal] [horizontal]
`INSTALLDIR`:: `INSTALLDIR`::
The installation directory. Defaults to `%PROGRAMFILES%\Elastic\Elasticsearch` The installation directory. Defaults to `%ProgramW6432%\Elastic\Elasticsearch`
`DATADIRECTORY`:: `DATADIRECTORY`::
@ -212,12 +209,13 @@ Defaults to `%ALLUSERSPROFILE%\Elastic\Elasticsearch\data`
`SELECTEDMEMORY`:: `SELECTEDMEMORY`::
The amount of memory to allocate to the JVM heap for Elasticsearch. The amount of memory to allocate to the JVM heap for Elasticsearch.
Defaults to half of the available memory on the target machine, up to a maximum of 30.5GB Defaults to `2048`. If the target machine has less than 4GB in total, defaults
to 50% of total memory.
`LOCKMEMORY`:: `LOCKMEMORY`::
Whether `bootstrap.memory_lock` should be used to try to lock the process Whether `bootstrap.memory_lock` should be used to try to lock the process
address space into RAM. Defaults to `true` address space into RAM. Defaults to `false`
`UNICASTNODES`:: `UNICASTNODES`::
@ -245,8 +243,7 @@ Defaults to `%ALLUSERSPROFILE%\Elastic\Elasticsearch\data`
`PLUGINS`:: `PLUGINS`::
A comma separated list of the plugins to download and install as part of the installation. Defaults to A comma separated list of the plugins to download and install as part of the installation. Defaults `""`
`x-pack, ingest-attachment, ingest-geoip`
To pass a value, simply append the property name and value using the format `<PROPERTYNAME>="<VALUE>"` 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: the installation command. For example, to use a different installation directory to the default one: