Commit graph

621 commits

Author SHA1 Message Date
David Kilfoyle
2c8e29807e
[DOCS] Add note about /tmp removal (#95166) 2023-04-13 08:39:53 -04:00
Alessandro Stoltenberg
2f274229cc
docs logging configuration: removed dead link and added javadoc reference instead. (#95080)
* docs: removed dead link and added javadoc reference instead.

* Update docs/reference/setup/logging-config.asciidoc

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>

---------

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2023-04-12 10:01:16 +02:00
Rafi Estrada
d0f96a8c0b
Add note about ENV for systemd installs (#91424)
* Add note about ENV for systemd installs

This ES_TMPDIR env variable is not referenced in the /guide/en/elasticsearch/reference/current/setting-system-settings.html#sysconfig section, and when searching for the error mentioned in this page, it might not become too obvious.

* Restructure

---------

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2023-03-28 12:07:34 -05:00
Abdon Pijpelink
f5c9804442
[DOCS] Show how to reset a dynamically-adjusted log level (#94573) 2023-03-23 14:39:59 +01:00
Ryan Ernst
2cad2266d5
Suggest systemd override file instead of unit file for tmpdir (#93211)
The systemd unit file is part of the Elasticsearch package and should
not be edited. Instead, we recommend creating a service override file.
This commit tweaks the docs for setting tmp dir with systemd to use the
override file instead of editing the unit file.

relates #93121
2023-01-24 13:56:14 -08:00
Nikola Grcevski
f117f76460
[DOCS] Forward-port persisting vm.max_map_count for WSL2 (#87276) 2023-01-23 13:02:14 -05:00
David Turner
a4de6bd14a
Document how to set ES_TMPDIR in the service file (#93121)
Today we suggest that users set `ES_TMPDIR` using `export`, which only
works if you're running things directly from the shell. Yet most users
encountering `ES_TMPDIR` problems seem to on RHEL and trying to run
things via `systemd`, for whom the `export` suggestion doesn't work.

This commit adds to the docs a suggestion of how to adjust the `systemd`
service file to set the appropriate environment variable.

Relates #80651
2023-01-23 08:30:54 +00:00
Abdon Pijpelink
648d80e517
[DOCS] Add ssl.verification_mode to secure settings (#93083)
Co-authored-by: Adam Locke <adam.locke@elastic.co>
2023-01-19 17:13:55 +01:00
Daniel Mitterdorfer
8fc2d6af4c
Add log level for JVM logs (#92382)
With this commit we specify `level` in JVM logs. `level` helps to filter
more severe messages from mere debugging messages in logs and with this
change we are able to use it also for JVM logs.

Here are a few example lines:

Before:

```
[2022-12-15T06:19:16.936+0000][15181][gc,start    ] GC(0) Pause Young (Normal) (G1 Evacuation Pause)
```

After:

```
[2022-12-15T06:22:27.932+0000][16320][info][gc,start    ] GC(0) Pause Young (Normal) (G1 Evacuation Pause)
[2022-12-15T06:22:27.932+0000][16320][debug][gc,age      ] GC(0) Desired survivor size 14680064 bytes, new threshold 15 (max threshold 15)
[2022-12-15T06:22:27.935+0000][16320][info ][gc,phases   ] GC(0)   Pre Evacuate Collection Set: 0.1ms
[2022-12-15T06:22:27.935+0000][16320][trace][gc,age      ] GC(0) Age table with threshold 15 (max threshold 15)
```

Notice, that the log level might have trailing spaces.

See also
https://docs.oracle.com/en/java/javase/19/docs/specs/man/java.html#xlog-tags-and-levels
for the available log levels.
2023-01-10 07:58:18 +01:00
Ryan Ernst
0421a21a6e
Use default text for preview warning with tcp readiness port (#92508)
The docs for the TCP readiness port have a preview warning, with custom
text. However, this doesn't render correctly in the docs. Rather than
figure out why the custom text doesn't render, this commit simply
removes the custom text in favor of the default preview text.
2022-12-21 13:49:15 -08:00
Adam Locke
9af1c278f8
[DOCS] Remove extra ports in Docker command (#91118)
The current command to start the first Elasticsearch node includes `-p 9200:9200` and `-p 9300:9300`. This PR removes the extra ports so that they're not open unnecessarily.

Co-authored-by: Adam Locke <adam.locke@elastic.co>
2022-11-22 09:13:36 -08:00
David Turner
9671cabefc
Adjust docs for new systemd startup timeout (#91648)
The docs introduced in #91333 apply to older versions in which the `systemd`
startup timeout was 75s by default, but in #91338 we extended the `systemd`
startup timeout to 900s from 8.7.0 and 7.17.8 onwards. This commit adjusts the
docs to match.
2022-11-17 14:20:01 +00:00
David Turner
d8e7cce08e
Add docs about TimeoutStartSec in systemd (#91333)
Adds a short note about the effects of `TimeoutStartSec` in older
`systemd` versions.
2022-11-17 12:11:21 +00:00
Nikola Grcevski
3fd338ffd1
Bind the readiness service to the wildcard address (#91329)
This change changes the host binding on the readiness service to all from localhost.
2022-11-16 09:46:28 -05:00
Flavio
83694c37a3
Update docker image (#90730) 2022-10-24 15:52:36 -04:00
Nikola Grcevski
f16110da9b
[DOCS] Revert changes for ES_JAVA_OPTS (#89931)
ES_JAVA_OPTS is still the correct way to pass options to
the Elasticsearch process, CLI_JAVA_OPTS affects only the
command line tool. CLI_JAVA_OPTS is the correct way to pass
options for plugin installation or other tools.
2022-09-08 13:37:39 -04:00
Adam Locke
93ad8828a3
[DOCS] Add note about passwords in .env Docker file (#89892) 2022-09-08 08:40:09 -04:00
debadair
ba14aaa004
[DOCS] Add simple dev setup instructions back to the README (#89714)
* [DOCS] Add Docker-based quickstart instructions to README & ES guide

* Removed attributes

* Added basic tutorial

* Fixed headings

* Edit

* [DOCS] Adding basic dev setup instructions to the ES guide

* Incorporated security config from Kibana docs

* Update README.asciidoc

Co-authored-by: Adam Locke <adam.locke@elastic.co>

* Update README.asciidoc

Co-authored-by: Adam Locke <adam.locke@elastic.co>

* Added callouts for version attributes

* Update README.asciidoc

Co-authored-by: Adam Locke <adam.locke@elastic.co>

* Update README.asciidoc

Co-authored-by: Adam Locke <adam.locke@elastic.co>

* Added README content to guide topic

* Snippet test fixes

* Incorporated review feedback

* Remove version

* Update docs/reference/setup/run-elasticsearch-locally.asciidoc

* Added info about security on by default

* Fix xrefs

* Update docs/reference/setup/run-elasticsearch-locally.asciidoc

* Fix headers

* Edits

Co-authored-by: Adam Locke <adam.locke@elastic.co>
2022-09-01 16:49:05 -07:00
Leaf-Lin
78d9d6844f
[DOCS] Add warning on restarting nodes exceeding low disk watermark (#89018)
* Create restart-cluster.asciidoc

As per https://github.com/elastic/elasticsearch/issues/49972 and https://github.com/elastic/elasticsearch/issues/56578, if a node is above low disk threshold when being restarted (rolling restart, network disruption or crash), the disk threshold decider prevents reusing the shard content on the restarted node.

The consequence of the event is the node may take a long time to start.

* Update docs/reference/setup/restart-cluster.asciidoc

LGTM! Thanks!

Co-authored-by: Adam Locke <adam.locke@elastic.co>

Co-authored-by: Adam Locke <adam.locke@elastic.co>
2022-08-29 15:14:44 -04:00
Adam Locke
2fad061394
[DOCS] Update add node section (#89393)
* [DOCS] Update add node section

* Include information for enrolling nodes
2022-08-25 08:51:03 -04:00
Yang Wang
098f5181c4
Double quote the env variable in curl command (#89279)
The env variable can contain special chacacters. Without quoting it
could mis-behave when used in the curl command of the setup docker
container.
2022-08-16 00:40:47 +10:00
Adam Locke
7b8c056494
[DOCS] Replace ES_JAVA_OPTS with CLI_JAVA_OPTS (#89121) 2022-08-04 09:27:40 -04:00
Leaf-Lin
00eefdd9a0 Revert "Add warning on restarting nodes > low watermark"
This reverts commit a3555eca6b.
2022-08-02 16:44:14 +10:00
Leaf-Lin
a3555eca6b
Add warning on restarting nodes > low watermark
As per https://github.com/elastic/elasticsearch/issues/49972 and https://github.com/elastic/elasticsearch/issues/56578, if a node is above low disk threshold when being restarted (rolling restart, network disruption or crash), the disk threshold decider prevents reusing the shard content on the restarted node.

The consequence of the event is the node may take a long time to start.
2022-08-02 16:36:27 +10:00
Ryan Ernst
9016883e1c
Add build_flavor back to info api rest response (#88336)
The build_flavor was previously removed since it is no longer relevant;
only the default distribution now exists. However, the removal of build
flavor included removing it from the version information on the info
response for the root path. This API is supposed to be stable, so
removing that key was a compatibility break. This commit adds the
build_flavor back to that API, hardcoded to `default`. Additionally, a
test is added to ensure the key exists going forward, until it can be
properly deprecated.

closes #88318
2022-07-08 09:54:29 +09:30
debadair
dd7d10844f
[DOCS] Add deployment options to Install topic (#87906) 2022-06-22 17:15:27 -07:00
David Kilfoyle
91175851a2
Update macOS install steps to use curl instead of wget (#87186) 2022-05-31 17:34:24 -04:00
Przemyslaw Gomulka
8bdfd6ea04
[doc] update deprecation logging (#83723)
more details on how to disable deprecation logging
2022-05-17 16:17:54 +02:00
Adam Locke
4bf3f0beca
[DOCS] Fix CA cert directory for client connections (#86613) 2022-05-10 11:10:17 -04:00
Nicole Albee
2af0126949
[doc] Update to include API for checking JVM pointers (#86360)
* [doc] Add information for how to find if compressed ordinary object pointers is in use using the REST APIs.

* Update docs/reference/setup/advanced-configuration.asciidoc

Co-authored-by: Nikola Grcevski <6207777+grcevski@users.noreply.github.com>

Co-authored-by: Nikola Grcevski <6207777+grcevski@users.noreply.github.com>
2022-05-05 13:44:38 -05:00
Adam Locke
6ebe562c5b
[DOCS] Fix config directory for installation (#86390) 2022-05-03 09:06:25 -04:00
Rune Antonsen
ce4c00f898 fix(docker-compose.yml): check correct filepath (#85602)
Add `config/` to the path in the `if`-checks in `docker-compose` documentation.
2022-04-26 11:44:22 +01:00
David Turner
ce004d49e7
More docs re. removing cluster.initial_master_nodes (#85948)
Ensures that on every page of the docs that mentions
`cluster.initial_master_nodes` also mentions that this setting must be
removed after bootstrapping completes.
2022-04-19 07:54:43 +01:00
Nikola Grcevski
88600d156b
Remove references to bootstrap.system_call_filter (#85964) 2022-04-18 19:33:00 -04:00
Ryan Ernst
d60cde6681
Remove flavor from build (#85796)
The default distribution is the only remaining build flavor, and has been for
quite a while now. This commit removes flavor from the internal Build
class. It keeps rest api compat for nodes info for now by hardcoding
`default`.
2022-04-11 16:46:55 -07:00
Nikola Grcevski
0935ca0add
[DOCS] Add readiness listener documentation (#85464)
Add documentation on the experimental TCP
readiness port listener.
2022-03-31 15:16:13 -04:00
Rick Boyd
a476abdc71
Various updates related to minimum Java version 17 (#85545)
Since 8.0.0, we only support Java 17 and up. This change cleans up unsupported Java versions from jvm.options and updates documentation to reference supported Java versions, in case it is confusing to users.
2022-03-31 10:04:50 -04:00
Ioannis Kakavas
7c33a770ad
Update start with security enabled docs (#84936)
In #84340 we adjusted the docs to show instructions on how to
retrieve TLS keystores passwords from the elasticsearch keystore
but the security-files-reference.asciidoc was not referenced in
all places where the instructions should be used. This commit
changes that and also removes references for beta versions.
2022-03-15 10:15:49 +02:00
Ioannis Kakavas
b1eb543c91
Fix check-running docs (#84856)
The way this specific doc was structured meant that the path for
DEB/RPM packages were wrong (an extra `config` was added to the
dir path). This commit changes the structure to be relevant to the
ES_CONF_PATH env variable that should work uniformly for all of
our installation means.
2022-03-10 17:13:27 +02:00
James Rodewig
c672eca54d
[DOCS] Fix intro sentence for Docker install instructions (#83939) (#84822)
Fixes an intro sentence for the Docker install instructions.

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
(cherry picked from commit 472a7d8e91)

Co-authored-by: Alexander Reelsen <alexander@reelsen.net>
2022-03-09 11:29:20 -05:00
er0k
26307bbef3
[DOCS] Update install instructions for Debian/Ubuntu (#84645)
The use of `apt-key` is deprecated and will no longer be available after
Debian 11 and Ubuntu 22.04. This updates the installation instructions
for Debian-based distributions.

Closes #84644
2022-03-07 12:24:50 -05:00
Ioannis Kakavas
121014d73f
Dix docker instructions for elasticsearch (#84604)
We suggest users should run the containers in a specific network
but we didn't include the command to create the network. This commit
addresses that.
2022-03-03 12:10:59 +02:00
Ioannis Kakavas
8cebba5708
Instructions to retrieve keystore pwd (#84340)
In 8.0.0. we introduce TLS autoconfiguration. We store the key and
certificate materials in password protected PKCS#12 keystores and
we store these passwords in the elasticsearch keystore.
This commit adds instructions on how to get hold of the passwords
for users to inspect or alter the PKCS#12 keystores.
2022-02-25 15:27:06 +02:00
DeDe Morton
08c0fcd91e
Clarify docs about CA fingerprints and Fleet (#84056)
Co-authored-by: James Rodewig <james.rodewig@elastic.co>
Co-authored-by: Ioannis Kakavas <ikakavas@protonmail.com>
2022-02-22 15:02:46 -08:00
Ioannis Kakavas
c923bd235b
Package installation docs minor change (#84177)
Make it clearer that security configuration happens on installation
and not on first start of Elasticsearch.
2022-02-22 18:54:26 +02:00
Quentin Pradet
f033f5879e
Fix path to cacert in check-running.asciidoc (#83888)
Co-authored-by: Arbkz <arbkz@users.noreply.github.com>
2022-02-14 16:15:31 +04:00
Adam Locke
6f8db84885
[DOCS] Moving Docker YAML and .env to a separate directory (#83864) 2022-02-11 16:23:17 -05:00
Adam Locke
b2e196fe91
[DOCS] Replace mentions of tls_auto_config directory (#83856)
Updates directory mentions of `config/tls_auto_config_<timestamp>` to `config/certs`.
2022-02-11 15:16:58 -05:00
Fabio Busatto
ba95c87b50
Fix version variable in docker-compose.yml (#83823) 2022-02-11 21:02:45 +01:00
David Turner
4e525d9a1a
Note libffi error message in tmpdir docs (#83662)
In #80617 we upgraded to a version of JNA which would report the message
`Failed to allocate closure` if the temp dir for `libffi` did not permit
executables (rather than crashing with a segfault). This commit extends
the docs to mention this message.
2022-02-08 17:36:17 +00:00