Commit Graph

607 Commits

Author SHA1 Message Date
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
Fabio Busatto 54cfbabe42
[Docs] Delete Elasticsearch Homebrew 8.x docs (#83446)
* Delete Elasticsearch brew install page

* Remove brew references

* Remove brew mentions

* Remove brew references

* Remove brew references

* Remove trailing newline

* Removing trailing newline
2022-02-03 13:05:22 -08:00
Adam Locke e182067f1f
Clarify commands shown for "permanently" setting max_map_count (#82345) (#83227)
* Clarify commands shown for "permanently" setting max_map_count

The current text shows a grep, which of course does not set the value at all.  I've clarified why it's offered (to CHECK the value).

I've also moved the command for setting the value temporarily to above that discussion, to make it more clear to readers that that's what it does.

* Reorder commands, add headings, and fix typos

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

Co-authored-by: Charlie Arehart <charlie@carehart.org>
2022-01-27 13:45:30 -05:00
Toby Sutor 30b8cdc184
[DOCS] Add note to that log4j customization is outside the support scope (#82668)
* [docs] Add note to Elasticsearch logging that log4j customization is out of support scope

* Update language for default logging recommendation

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

Co-authored-by: Quin Hoxie <qhoxie@gmail.com>
Co-authored-by: Adam Locke <adam.locke@elastic.co>
2022-01-25 17:03:16 -05:00
Adam Locke 2684b97c73
[DOCS] Remove unused tag from rolling restart docs (#82967) 2022-01-24 12:54:23 -05:00
Rory Hunter 997880f518
Mention bind-mounting plugins dir in Docker docs (#82622)
Closes #69533.

The Docker docs mention bind-mounting the `config`, `data` and
`logs` directories when using an arbitrary UID / GID, but they fail
to mention that the `plugins` dir must also be mounted in order to
install plugins.
2022-01-24 17:10:29 +00:00
Alex Perrin db9fb02267
Rolling restart instructions (#82387)
* Rolling restart instructions

In a rolling restart scenario, indexing do not need to be stopped. This step is optional. I have updated Rolling restart/ step 2.

Note: I am not sure how to check if the doc, once generated, will keep the numbering as section 1 and 3 are references to the full restart, can you check this detail?

* Clarify that shard recovery can be faster

Co-authored-by: Adam Locke <adam.locke@elastic.co>
2022-01-24 11:56:13 -05:00
Adam Locke c098af1172
[DOCS] Update enrollment token docs for multi-node configuration (#82829)
* [DOCS] Update enrollment token docs for multi-node configuration

* Update transport.host guidance based on review feedback

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2022-01-20 13:00:57 -05:00
James Rodewig b32476c22b
[DOCS] Remove duplicated text (#82637) (#82880)
(cherry picked from commit 376e500e9c)

Co-authored-by: Daeho Ro <lamanus@outlook.kr>
2022-01-20 12:48:46 -05:00
Adam Locke 943a12e4fb
[DOCS] Fix typo (extra +) (#82823) 2022-01-19 16:28:20 -05:00
Adam Locke 12d47983e4
[DOCS] Remove extraneous Elasticsearch Docker image information (#82821)
* [DOCS] Remove extraneous Elasticsearch Docker image information

In the step for starting Elasticsearch with the generated enrollment token, `docker.elastic.co/elasticsearch/elasticsearch:` was included in conjunction with the `{docker-image}` variable. This include led to a duplicate Docker image that displayed as `ocker.elastic.co/elasticsearch/elasticsearch:docker.elastic.co/elasticsearch/elasticsearch:8.0.0-rc1`. This PR removes the duplicate image information.

* Update ifeval statements and add sub-heading for setting JVM heap size
2022-01-19 14:59:31 -05:00
James Rodewig e21a9a0711
[DOCS] Re-add cluster settings precedence (#82738)
Adds some tags and an include statement to re-add cluster settings precedence information to the cluster update settings API page. This should aid with discoverability.

Closes https://github.com/elastic/elasticsearch/issues/82634

Relates to https://github.com/elastic/elasticsearch/pull/79579
2022-01-18 12:32:43 -05:00
Rory Hunter d2dbef5063
Convert repository plugins to modules (#81870)
Closes #81652.

Convert the `repository-azure`, `repository-gcs` and `repository-s3`
plugins into modules, so that they are always included in the
Elasticsearch distribution. Also change plugin installation, removal
and syncing so that attempting to add or remove these plugins still
succeeds but is now a no-op.
2022-01-10 10:45:42 +00:00
Albert Zaharovits 9e9a8cc7d0
Auto-generated TLS files under fixed config path (#81547)
We (mostly I) were initially advocating for the auto-generated files to
use unique names (the name containing a timestamp particle), in order to
avoid that subsequent invocations of the config step conflict with
itself. Moreover, I was wishing that these files will not have to be
handled directly by admins (that the enrollment process was to be used).
However, experience proved us otherwise, admins have to manipulate these
files, and unique configuration names are hard to deal with in scripts
and docs, so this PR is all about using a fixed name for all the
generated files. _Labeling as a bug fix because the feedback is that it
very negatively impacts usabilty._ Closes
https://github.com/elastic/elasticsearch/issues/81057
2021-12-29 12:56:29 -05:00
James Rodewig ff89ee0beb
[DOCS] Remove Windows MSI installer package (#81952) (#81957)
After 7.16.2, we'll no longer produce Windows MSI installer packages for Elasticsearch. These packages were previously released in beta and didn't receive widespread adoption.

### Changes:

* Adds a related 7.17 breaking change.
* Adds a related 7.16 deprecation.
* Removes the MSI installation instructions.
* Removes references to the MSI installer.

I plan to port the applicable changes to 8.1 (main), 8.0, 7.17, and 7.16. In the 7.16 ports, I'll leave in the MSI install docs and add related deprecation notes to them instead.
2021-12-20 13:49:32 -05:00