summaryrefslogtreecommitdiff
path: root/docs/reference/setup
AgeCommit message (Collapse)Author
2016-12-01Fix reference to jvm.options docsJason Tedor
The reference for the jvm.options docs recently changed from es-java-opts to jvm-options. This commit fixes a broken reference that arose as a result of this change.
2016-12-01Improve the out-of-the-box experienceJason Tedor
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-01Add option to skip kernel parameters on installJason Tedor
During package install on systemd-based systems, we try to set vm.max_map_count. On some systems (e.g., containers), users do not have the ability to tune these parameters from within the container. This commit provides an option for these users to skip setting such kernel parameters. Relates #21899
2016-11-30Remove misplaced parenthesis from configuring docsJason Tedor
This commit removes a misplaced parenthesis from the systemd section of the configuring docs.
2016-11-18Remove stale mention of minimum master nodes checkJason Tedor
This commit removes a stale mention of the minimum master nodes boostrap check from the docs. Relates #21653
2016-11-17Mark snippet in docker docs NOTCONSOLENik Everett
That keeps us from failing the build because it is "unconverted". Relates to #21497
2016-11-17[docs] Document Docker installation methodDimitrios Liappis
Initial commit of the Docker installation method for Elasticsearch. Relates #21497
2016-11-15Fix incorrect instructions for disabling deprecation logging (#21569)Lee Hinman
We log deprecation events at "WARN", so setting it to `info` means the events are still logged. It must be set to `error` in order to disable the logging.
2016-11-09Updated install docs to add missing empty cell in directory layoutClinton Gormley
2016-11-09Update zip-targz.asciidocClinton Gormley
Added missing empty cell in directory layout table
2016-11-08Fix markup in sysconfig-file docsJason Tedor
This commit fixes a markup issue in the sysconfig-file docs, adding a missing backtick.
2016-11-08minor grammatical fix (#21384)Joeyn414
2016-11-07Remove double space in bootstrap checks docsJason Tedor
This commit removes a double space in the G1GC check section of the bootstrap check docs.
2016-11-07Migrate G1GC JVM check to bootstrap checkJason Tedor
This commit fixes an assertion in G1GCCheck#jvmVersion that was mistakenly asserting on itself. Relates #21388
2016-11-07Removed left over ID and [float] from the setup docsClinton Gormley
2016-11-03[DOCS] "service" should be "elasticsearch-service" (#21311)Chris Earle
The Windows `service.bat` script was renamed to `elasticsearch-service.bat` in ES 5.0+.
2016-11-03Remove broken docs linkJason Tedor
The important settings docs previously referred to a section regarding the node.max_local_storage_nodes setting. This section was removed, but the link was not. This commit removes that link.
2016-11-03Remove node.max_local_storage_nodes from setup docJason Tedor
Previously node.max_local_storage_nodes defaulted to fifty, and this permitted users to start multiple instances of Elasticsearch sharing the same data folder. This can be dangerous, and usually it does not make sense to run more than one instance of Elasticsearch on a single server. Because of this, we had a note in the important settings docs advising users to set this setting to one. However, we have since changed the default value of this setting to one so this advise is no longer needed. Relates #21305
2016-11-01Add extra note about Java8 requirement to sub-install docs (#21190)Alexander Lin
Closes #20005
2016-10-31Fix transport host settingJason Tedor
This commit fixes a reference to the transport.host setting which was mistakenly identified as transport.tcp.host.
2016-10-31Fix markup for bootstrap checks docsJason Tedor
This commit adds a missing backtick to the bootstrap check docs.
2016-10-31Clarify production mode for bootstrap checksJason Tedor
This commit clarifies that production mode for the bootstrap checks is only tripped if transport is bound to an external interface. Relates #21220
2016-10-13Add note about retention periods to reindex-upgrade docsClinton Gormley
2016-10-11Added upgrade docs explaining how to reindex in place or reindex from remoteClinton Gormley
Closes #20675
2016-10-10Fixed typos (#20843)Pascal Borreli
2016-10-10Reword note about windows and FDsNik Everett
Make it clear why this isn't a thing in windows and remove value judgement about file descriptors. Relates to #20737
2016-10-06Fixed released_state docs switch to build correctly and include missing linksClinton Gormley
2016-10-06Add placeholder to the docs to distinguish released from unreleased from ↵Clinton Gormley
prerelease versions (#20644) Closes https://github.com/elastic/stack/issues/18
2016-10-04File descriptors limit doesn't apply to WindowsNik Everett
On Windows the JDK uses `CreateFileW` which has a stupidly high limit for the number of `Handle`s it can make - `16 * 1024 * 1024`. So this isn't really a problem on Windows at all. Closes #20732
2016-09-24Fix documentation for setting Java I/O temp dirJason Tedor
This commit fixes the documentation for configuring the Java I/O temp dir which incorrectly suggested using the -D flag as a parameter on the command line; these flags have been removed and should now be specified as arguments to the JVM using either the ES_JAVA_OPTS environment variable or using the jvm.options configuration file. Closes #20652
2016-09-21Change APT/YUM urls to point to the prerelease repositoriesClinton Gormley
Closes #20593
2016-09-20Fix JVM heap size docs for 5.0Clinton Gormley
Closes #20587
2016-09-20Remove redundant .x from apt/rpm repo docsClinton Gormley
Relates to #20574
2016-09-19Convert old download links to unified release urls (#20574)Ryan Ernst
With the unified release process across the elastic stack, download links for all products are changing. This change updates docs referring to the old download and packages urls. Note that this change also updates the plugin installation command as the url for downloads is being changed to be consistent with that for packages (both plural).
2016-09-19Add serial collector bootstrap checkJason Tedor
The serial collector is not suitable for running with a server application like Elasticsearch and can decimate performance and lead to cluster instability. This commit adds a bootstrap check to prevent usage of the serial collector when Elasticsearch is running in production mode. Relates #20558
2016-09-19[DOC] Remove obsolete node names from documentationTanguy Leroux
Funny node names have been removed in #19456 and replaced by UUID. This commit removes these obsolete node names and replace them by real UUIDs in the documentation. closes #20065
2016-09-15Add clusterUUID to RestMainAction output (#20503)Luca Cavanna
Add clusterUUID to RestMainAction output GET / now returns the clusterUUID as well as part of its output for monitoring purposes
2016-09-15Rename service.bat to elasticsearch-service.bat (#20496)gfyoung
Closes gh-17528.
2016-09-14Update logger names in docsJason Tedor
In 7560101ec73331acb39a042bde6130e59e4bb630, the Elasticsearch logger names were modified to be their fully-qualified class name (with some exceptions for special loggers like the slow logs and the transport tracer). This commit updates the docs accordingly. Relates #20475
2016-09-13Add quiet option to disable console logging (#20422)Tanguy Leroux
This commit adds a -q/--quiet option to Elasticsearch so that it does not log anything in the console and closes stdout & stderr streams. This is useful for SystemD to avoid duplicate logs in both journalctl and /var/log/elasticsearch/elasticsearch.log while still allows the JVM to print error messages in stdout/stderr if needed. closes #17220
2016-09-06Remove most of the need for `// NOTCONSOLE`Nik Everett
and be much more stingy about what we consider a console candidate. * Add `// CONSOLE` to check-running * Fix version in some snippets * Mark groovy snippets as groovy * Fix versions in plugins * Fix language marker errors * Fix language parsing in snippets This adds support for snippets who's language is written like `[source, txt]` and `["source","js",subs="attributes,callouts"]`. This also makes language required for snippets which is nice because then we can be sure we can grep for snippets in a particular language.
2016-09-01Size limit deprecation logsJason Tedor
This commit configures the deprecation logs to be size-limited to 1 GB, and compress these logs when they roll. The default configuration will preserve up to four rolled logs. Relates #20287
2016-08-31Update docs for Log4j 2Jason Tedor
This commit updates the logging docs for Elasticsearch to reflect the migration to Log4j 2.
2016-08-31Merge branch 'master' into log4j2Jason Tedor
* master: Increase visibility of deprecation logger Skip transport client plugin installed on JDK 9 Explicitly disable Netty key set replacement percolator: Fail indexing percolator queries containing either a has_child or has_parent query. Make it possible for Ingest Processors to access AnalysisRegistry Allow RestClient to send array-based headers Silence rest util tests until the bogusness can be simplified Remove unknown HttpContext-based test as it fails unpredictably on different JVMs Tests: Improve rest suite names and generated test names for docs tests Add support for a RestClient base path
2016-08-31Increase visibility of deprecation loggerJason Tedor
The deprecation logger is an important way to make visible features of Elasticsearch that are deprecated. Yet, the default logging makes the log messages for the deprecation logger invisible. We want these log messages to be visible, so the default logging for the deprecation logger should enable these log messages. This commit changes the log level of deprecation log message to warn, and configures the deprecation logger so that these log messages are visible out of the box. Relates #20254
2016-08-29Mark lots of stuff `// NOTCONSOLE`Nik Everett
2016-08-23Remove minimum master nodes bootstrap docsJason Tedor
The minimum master nodes bootstrap check was removed in 069fc2269664c5b2a4a393c893825f982b55ccc7 but the docs were left behind. This commit removes these stale docs. Relates #20127
2016-07-23Persistent Node Names (#19456)Boaz Leskes
With #19140 we started persisting the node ID across node restarts. Now that we have a "stable" anchor, we can use it to generate a stable default node name and make it easier to track nodes over a restarts. Sadly, this means we will not have those random fun Marvel characters but we feel this is the right tradeoff. On the implementation side, this requires a bit of juggling because we now need to read the node id from disk before we can log as the node node is part of each log message. The PR move the initialization of NodeEnvironment as high up in the starting sequence as possible, with only one logging message before it to indicate we are initializing. Things look now like this: ``` [2016-07-15 19:38:39,742][INFO ][node ] [_unset_] initializing ... [2016-07-15 19:38:39,826][INFO ][node ] [aAmiW40] node name set to [aAmiW40] by default. set the [node.name] settings to change it [2016-07-15 19:38:39,829][INFO ][env ] [aAmiW40] using [1] data paths, mounts [[ /(/dev/disk1)]], net usable_space [5.5gb], net total_space [232.6gb], spins? [unknown], types [hfs] [2016-07-15 19:38:39,830][INFO ][env ] [aAmiW40] heap size [1.9gb], compressed ordinary object pointers [true] [2016-07-15 19:38:39,837][INFO ][node ] [aAmiW40] version[5.0.0-alpha5-SNAPSHOT], pid[46048], build[473d3c0/2016-07-15T17:38:06.771Z], OS[Mac OS X/10.11.5/x86_64], JVM[Oracle Corporation/Java HotSpot(TM) 64-Bit Server VM/1.8.0_51/25.51-b03] [2016-07-15 19:38:40,980][INFO ][plugins ] [aAmiW40] modules [percolator, lang-mustache, lang-painless, reindex, aggs-matrix-stats, lang-expression, ingest-common, lang-groovy, transport-netty], plugins [] [2016-07-15 19:38:43,218][INFO ][node ] [aAmiW40] initialized ``` Needless to say, settings `node.name` explicitly still works as before. The commit also contains some clean ups to the relationship between Environment, Settings and Plugins. The previous code suggested the path related settings could be changed after the initial Environment was changed. This did not have any effect as the security manager already locked things down.
2016-07-08Fix nesting of stopping docsJason Tedor
This commit fixes errant nesting of the stopping docs due to using a section header instead of a chapter header at the top of the stopping docs.
2016-07-07Die with dignityJason Tedor
Today when a thread encounters a fatal unrecoverable error that threatens the stability of the JVM, Elasticsearch marches on. This includes out of memory errors, stack overflow errors and other errors that leave the JVM in a questionable state. Instead, the Elasticsearch JVM should die when these errors are encountered. This commit causes this to be the case. Relates #19272