summaryrefslogtreecommitdiff
path: root/docs/reference/setup
AgeCommit message (Collapse)Author
2017-06-30Update defaults in documentation (#25483)Russ Cam
Following internal discussion Relates: https://github.com/elastic/windows-installers/pull/49
2017-06-28Remove implicit 32-bit supportJason Tedor
We previously tried to maintain (while not formally supporting) 32-bit support, although we never tested this anywhere in CI. Since we do not formally support this, and 32-bit usage is very low, we have elected to no longer maintain 32-bit support. This commit removes any implication of 32-bit support. Relates #25435
2017-06-28Update MSI installer images (#25414)Russ Cam
Slight updating to styling
2017-06-26Remove default path settingsJason Tedor
This commit removes the default path settings for data and logs. With this change, we now ship the packages with these settings set in the elasticsearch.yml configuration file rather than going through the default.path.data and default.path.logs dance that we went through in the past. Relates #25408
2017-06-26[DOCS] Fixed broken cross doc links to security settings.Deb Adair
2017-06-26Remove path.conf settingJason Tedor
This commit removes path.conf as a valid setting and replaces it with a command-line flag for specifying a non-default path for configuration. Relates #25392
2017-06-19Add MSI installation to documentation (#25213)Russ Cam
* Add MSI installation to documentation Move installation documentation for Windows with the .zip archive into the zip and tar installation documentation, and clearly indicate any differences for installing on macOS/Linux and Windows. * Separate out installation with .zip on Windows
2017-06-13Docs: Add note about which secure settings are valid (#25212)Ryan Ernst
This commit adds a note to the docs to clarify that only some settings can be used with the keystore.
2017-06-12[DOC] Add X-Pack links to Elasticsearch Reference (#25164)Lisa Cawley
* [DOC] Add X-Pack links to Elasticsearch Reference * [DOCS] Address alignment of attributes in Versions.asciidoc
2017-06-06Honor masking of systemd-sysctl.serviceChristian Hofstaedtler
During package install on systemd-based systems, some sysctl settings should be set (e.g. vm.max_map_count). In some environments, changing sysctl settings plainly does not work; previously a global environment variable named ES_SKIP_SET_KERNEL_PARAMETERS was introduced to skip calling sysctl, but this causes trouble for: - configuration management systems, which usually cannot apply an env var when running a package manager - package upgrades, which will not have the env var set any more, and thus leaving the package management system in a bad state (possibly half-way upgraded, can be very hard to recover) This removes the env var again and instead of calling systemd-sysctl manually, tells systemd to restart the wrapper unit - which itself can be masked by system administrators or management tools if it is known that sysctl does not work in a given environment. The restart is not silent on systems in their default configuration, but is ignored if the unit is masked. Relates #24234
2017-05-31Docs: Fix typo in docker docs (#24988)Sergey Novikov
`boostrap.memory_lock` -> `bootstrap.memory_lock`
2017-05-19Typo in setup/configuration.asciidoc (#24797)Oleksandr Chychkan
2017-05-17Scripting: Remove file scripts (#24627)Ryan Ernst
This commit removes file scripts, which were deprecated in 5.5. closes #21798
2017-05-16Use correct script name in docs for WindowsDaniel Mitterdorfer
With this commit we correct the name of the ES batch script to `elasticsearch.bat` in the docs and use backslashes in path names.
2017-05-12Clarify disabling swap in docsJason Tedor
Our strong recommendation is disabling swap over any other alternative to avoid the JVM from landing on disk. This commit clarifies the docs in this regard.
2017-05-09Fixed prerelease URLs for RPM and Deb repos in docsClinton Gormley
2017-05-03Docs: Update production notes for DockerDimitrios Liappis
Add info about the base image used and the github repo of elasticsearch-docker. Clarify that setting `memlock=-1:-1` is only a requirement when `bootstrap_memory_lock=true` and the alternatives we document elsewhere in docs for disabling swap are valid for Docker as well. Additionally, with latest versions of docker-ce shipping with unlimited (or high enough) defaults for `nofile` and `nproc`, clarify that explicitly setting those per ES container is not required, unless they are not defined in the Docker daemon. Finally simplify production `docker-compose.yml` example by removing unneeded options. Relates #24389
2017-04-21Add note to docs regarding JAVA_HOME on WindowsJason Tedor
For the Windows service, JAVA_HOME should be set to the path to the JDK. We should make this clear in the docs to help users avoid frustrating startup problems. Relates #24260
2017-04-20Reword note on whitespace in Log4j settingsJason Tedor
This commit rewords the note on whitespace in Log4j settings to not refer to only of the examples on the page, but instead be clear that the note applies to all the examples on the page.
2017-04-20Add note to docs on whitespace in Log4j settingsJason Tedor
A confusing thing that can happen when configuring Log4j is that extraneous whitespace throws off its configuration parsing yet the error messages that arise give no indication that this is the problem. This commit adds a note to the docs. Relates #24198
2017-04-19Clarify elasticsearch user uid:gid mapping in Docker docsDimitrios Liappis
Elasticsearch runs as user elasticsearch with uid:gid 1000:1000 inside the Docker container. Clarify that bind mounted local directories need to be accessible by this user. Relates #24092
2017-04-14Remove customization of ES_USER and ES_GROUPLee Hinman
This removes the ability to configure Elasticsearch to use custom username and/or group when it is run. Resolves #23848
2017-04-13Remove support for default settingsJason Tedor
Today Elasticsearch allows default settings to be used only if the actual setting is not set. These settings are trappy, and the complexity invites bugs. This commit removes support for default settings with the exception of default.path.data, default.path.conf, and default.path.logs which are maintainted to support packaging. A follow-up will remove support for these as well. Relates #24093
2017-04-05Update secure-settings.asciidoc (#23891)Jayant Ameta
2017-04-04Disable bootstrap checks for single-node discoveryJason Tedor
While there are use-cases where a single-node is in production, there are also use-cases for starting a single-node that binds transport to an external interface where the node is not in production (for example, for testing the transport client against a node started in a Docker container). It's tricky to balance the desire to always enforce the bootstrap checks when a node might be in production with the need for the community to perform testing in situations that would trip the bootstrap checks. This commit enables some flexibility for these users. By setting the discovery type to "single-node", we disable the bootstrap checks independently of how transport is bound. While this sounds like a hole in the bootstrap checks, the bootstrap checks can already be avoided in the single-node use-case by binding only HTTP but not transport. For users that are genuinely in production on a single-node use-case with transport bound to an external use-case, they can set the system property "es.enable.bootstrap.checks" to force running the bootstrap checks. It would be a mistake for them not to do this. Relates #23598
2017-03-24Add early-access checkJason Tedor
The OpenJDK project provides early-access builds of upcoming releases. These early-access builds are not suitable for production. These builds sometimes end up on systems due to aggressive packaging (e.g., Ubuntu). This commit adds a bootstrap check to ensure these early-access builds are not being used in production. Relates #23743
2017-03-22Docs: Fix language on a few snippetsNik Everett
They aren't `js`, they are their own thing. Relates to #18160
2017-03-20Fix typo 'Elastisearch' -> 'Elasticsearch' (#23633)Max Goodridge
Corrects `Elastisearch` to `Elasticsearch` in some docs and a packaging test utility.
2017-03-15Enable explicitly enforcing bootstrap checksJason Tedor
This commit adds a system property that enables end-users to explicitly enforce the bootstrap checks, independently of the binding of the transport protocol. This can be useful for single-node production systems that do not bind the transport protocol (and thus the bootstrap checks would not be enforced). Relates #23585
2017-03-06Fix link to Debian install instructionsShashank Singh
The link for the Debian install instructions was mistakenly pointing to the RPM instructions. This commit fixes the reference. Relates #23485
2017-03-02Add documentation for Bash requirementJason Tedor
This commit adds a note to the docs regarding the requirements for Bash. Relates #23464
2017-02-16Fix more missing markup in configuration docsJason Tedor
This commit fixes some missing markup in the configuration docs in the logging configuration section.
2017-02-16Replace HTTP link with HTTPS linkJason Tedor
This commit replaces an HTTP link in the configuration docs with an HTTPS link.
2017-02-16Fix missing markup in configuration docsJason Tedor
This commit adds a missing backtick in the configuration docs.
2017-02-09Adding `ansible-elasticsearch` to list of CM tools (#23058)Jonathan D Strootman
2017-02-07Small typo fix in Windows service documentationJordan Robinson
This commit removes a duplicate definite article in the Windows service documentation. Relates #23028
2017-02-04Replaced absolute URLs in docs with attributesClinton Gormley
2017-02-04Centralised doc versions in docs/Versions.asciidocClinton Gormley
2017-01-30Docs: Add setup section for the keystore tool and secure settings (#22838)Ryan Ernst
2017-01-23Add note regarding custom jvm.optionsJason Tedor
When users need to specify a custom location for configuration files, they also need to specify a custom location for the jvm.options file yet our docs are absent in this regard. This commit adds a note to the rolling upgrade docs explaining this situation. Relates #22747
2017-01-16Expose logs base pathJason Tedor
For certain situations, end-users need the base path for Elasticsearch logs. Exposing this as a property is better than hard-coding the path into the logging configuration file as otherwise the logging configuration file could easily diverge from the Elasticsearch configuration file. Additionally, Elasticsearch will only have permissions to write to the log directory configured in the Elasticsearch configuration file. This commit adds a property that exposes this base path. One use-case for this is configuring a rollover strategy to retain logs for a certain period of time. As such, we add an example of this to the documentation. Additionally, we expose the property es.logs.cluster_name as this is used as the name of the log files in the default configuration. Finally, we expose es.logs.node_name in cases where node.name is explicitly set in case users want to include the node name as part of the name of the log files. Relates #22625
2017-01-11Fix default port for unicast zen ping hostsJason Tedor
Today when you do not specify a port for an entry in discovery.zen.ping.unicast.hosts, the default port is the value of the setting transport.profiles.default.port and falls back to the value of transport.tcp.port if this is not set. For a node that is explicitly bound to a different port than the default port, this means that the default port will be equal to this explicitly bound port. Yet, the docs say that we fall back to 9300 here. This commit corrects the docs. Relates #22568
2017-01-11[docs] Add missing RUN command from custom docker configDimitrios Liappis
Fix the `Dockerfile` example in the `Customizing image` third configuration method by adding the missing RUN instruction. Originally reported by Shankar Vasudevan (@vshank77). Relates #21973
2017-01-10Update Debian package installation documentation (#22405)Chris Adams
#9261 added a warning about the use of `add-apt-repository` which is becoming obsolete over time as new distribution releases include later versions of `add-apt-repository` which don't automatically add the `deb-src` line. This change updates the documentation to make the block a note rather than a warning and adds two other reasons for avoiding `add-apt-repository` which are still relevant: avoiding edits to a system shared file and not requiring a large number of non-default packages to add one line of text to a file.
2016-12-28Fixing a second "second" reference in docs (#22345)Itamar Syn-Hershko
2016-12-16Rename bootstrap.seccomp to bootstrap.system_call_filterJason Tedor
We try to install a system call filter on various operating systems (Linux, macOS, BSD, Solaris, and Windows) but the setting (bootstrap.seccomp) to control this is named after the Linux implementation (seccomp). This commit replaces this setting with bootstrap.system_call_filter. For backwards compatibility reasons, we fallback to bootstrap.seccomp and log a deprecation message if bootstrap.seccomp is set. We intend to remove this fallback in 6.0.0. Note that now is the time to make this change it's likely that most users are not making this setting anyway as prior to version 5.2.0 (currently unreleased) it was not necessary to configure anything to enable a node to start up if the system call filter failed to install (we marched on anyway) but starting in 5.2.0 it will be necessary in this case. Relates #22226
2016-12-09Fixed typo (#22066)Juan Paulo Gutierrez
2016-12-07Fix systemd override example in configuring docsJared Carey
When overriding a systemd configuration via a drop-in file, the [Service] header is required. This commit adds this to an example drop-in override in the configuring docs. Relates #22038
2016-12-07Fix typos in threads docsNikhil Patel
This commit fixes a typo in the threads docs where the past tense form of a verb was used when current tense is needed. Relates #22016
2016-12-02Add system call filter bootstrap checkJason Tedor
Today if system call filters fail to install on startup, we log a message but otherwise march on. This might leave users without system call filters installed not knowing that they have implicitly accepted the additional risk. We should not be lenient like this, instead clearly informing the user that they have to either fix their configuration or accept the risk of not having system call filters installed. This commit adds a bootstrap check that if system call filters are enabled, they must successfully install. Relates #21940