Commit Graph

674 Commits

Author SHA1 Message Date
Abdon Pijpelink 9180bea2f0
[DOCS] Fix small typo in secure-settings.asciidoc (#96040)
The word "in" was missing.
2023-05-11 19:05:25 +02:00
David Turner 3e61112b1e
Reword note on tmpfs (#95974)
There's no need to talk about unwelcome behaviour or power outages here,
and it caused at least one user some concern. This commit clarifies the
message.

Relates #95166
2023-05-10 13:47:01 +01:00
David Turner a8d82d996f
Note renaming a cluster requires a full restart (#95858) 2023-05-05 10:35:58 +01:00
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
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
James Rodewig 78e2e14404
[DOCS] Remove configuration management tools (#81938)
Removes a section covering configuration management tools from the
installation instructions.

After 7.16.2, Elastic will no longer maintain these tools. Previously,
the tools were only supported on a "best effort" basis.
2021-12-20 11:31:03 -05:00
Adam Locke bf60ce68c6
[DOCS] Update Docker Compose installation with simplified configuration (#81835)
* [DOCS] Update Docker Compose installation with simplified configuration

* Change heading to fix link issue
2021-12-16 19:42:41 -05:00
Adam Locke dd47e68ce1
[DOCS] Enroll additional nodes on Docker (#81787)
* [DOCS] Enroll additional nodes on Docker

* Remove -p option for second node

Co-authored-by: Fabio Busatto <52658645+bytebilly@users.noreply.github.com>

* Rename nodes to align with other Docker docs

* Add elastic network to first node docker run command

* Remove hyphen from node names

Co-authored-by: Fabio Busatto <52658645+bytebilly@users.noreply.github.com>
2021-12-16 12:42:16 -05:00
Adam Locke 1bd0561a91
[DOCS] Add docs for verifying CA fingerprint (#81279)
* [DOCS] Add docs for verifying CA fingerprint

* Update openssl command and explanatory text

* Explain copying CA cert if fingerprint validation isn't possible

* Incorporate new section into the main security config page

* Clarify how cert is used

Co-authored-by: Ioannis Kakavas <ikakavas@protonmail.com>

* Split into two, separate sections

* Rename file and update text based on feedback

* Update ref to use new filename

* Remove extra word

Co-authored-by: Ioannis Kakavas <ikakavas@protonmail.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2021-12-15 14:08:20 -05:00
Adam Locke b9ae8fdb13
[DOCS] Fix elasticsearch-reset-password typo (#80919) 2021-11-23 07:42:56 -05:00
Adam Locke 2d83013fe8
[DOCS] Update Docker commands with variables (#80885)
* [DOCS' Update Docker commands with variables

* Modify "VERSION" to lowercase

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Remove errant + icons

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2021-11-19 16:16:09 -05:00
Adam Locke 247d124666
[DOCS] Update ES quick start for security ON by default (#80735)
* [DOCS] Update ES quick start for security ON by default

* Remove code.asciidoc, which is part of the overall doc build now

* Update node names for cleanup

* Add note with links to tools

* Add --net elastic network

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2021-11-17 17:48:07 -05:00
Adam Locke a72a26696c
[DOCS] Update Windows .zip install instructions for security ON by default (#80552)
* [DOCS] Update Windows .zip install instructions for security ON by default

* Rework instructions for running as a service on Windows

* Update wording and add variable for back/forward slashes

* Relocating enroll nodes steps and introducing variables

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2021-11-17 17:35:09 -05:00
James Rodewig 2f4143267e
[DOCS] Un-deprecate transient cluster settings (#80766) (#80780)
#80556 reverted the deprecation of transient cluster settings. This replaces deprecation language in the docs with a warning/recommendation to avoid transient settings.

Closes #80557
# Conflicts:
#	docs/reference/migration/migrate_7_16.asciidoc
2021-11-16 16:00:13 -05:00
James Rodewig 659e0d3fd3
[DOCS] Overhaul snapshot and restore docs (#79081)
Makes several changes to consolidate snapshot and backup-related docs.

Highlights:

* Adds info about supported ESS snapshot repository types
* Adds docs for Kibana's Snapshot and Restore feature
* Combines tutorial pages related to taking and managing snapshots
* Consolidates explanations of the snapshot process
* Incorporates SLM into the snapshot tutorial
* Removes duplicate "back up a cluster" pages
2021-11-15 12:45:07 -05:00
David Turner 57dbefe4fb
Set LIBFFI_TMPDIR at startup (#80651)
Today if `libffi` cannot allocate pages of memory which are both
writeable and executable then it will attempt to write code to a
temporary file. Elasticsearch configures itself a suitable temporary
directory for use by JNA but by default `libffi` won't find this
directory and will try various other places. In certain configurations,
none of the other places that `libffi` tries are suitable. With older
versions of JNA this would result in a `SIGSEGV`; since #80617 the JVM
will exit with an exception.

With this commit we use the `LIBFFI_TMPDIR` environment variable to
configure `libffi` to use the same directory as JNA for its temporary
files if they are needed.

Closes #18272
Closes #73309
Closes #74545
Closes #77014
Closes #77053
Relates #77285

Co-authored-by: Rory Hunter <roryhunter2@gmail.com>
2021-11-15 08:18:58 +00:00
Rory Hunter ba87234f51
Use almalinux as the Docker base image (#80524)
Closes #76681. Our approach to using `scratch` for building Docker
images has caused problems at Docker Hub. Fix this situation by
removing the whole process of using scratch and instead bases the
default distribution on `almalinux:8.4-minimal`. Alma Linux is
binary-compatible with RHEL, and therefore very similar to UBI.
2021-11-10 13:04:56 +00:00
David Turner 8cf4c7b6fb
Remove last few mentions of Zen discovery (#80410)
We have a few leftover mentions of `zen` discovery, mostly for
historical/BwC reasons, which this commit removes.

Prior to this commit the default value for `discovery.type` was `zen`
but this was not written down anywhere or officially supported: the two
options were to set it to `single-node` or to omit it entirely. This
commit changes the default to `multi-node` and documents this.

Co-authored-by: Adam Locke <adam.locke@elastic.co>
2021-11-09 09:52:06 +01:00
James Rodewig a4ab7f9d03
[DOCS] Docker configs should set `network.host` to `0.0.0.0` (#80042)
The `elasticsearch.yml` file that ships with our Docker image includes the
`network.host: 0.0.0.0` setting by default. If a user bind-mounts a custom
config file, it should include this setting to ensure Elasticsearch is reachable.

Closes #77937.
2021-11-05 18:37:46 -04:00
Adam Locke b13df02d83
[DOCS] Update archive install docs for security ON by default (#80375)
* [DOCS] Update archive install docs for security ON by default

* Remove extra attribute references that aren't needed

* Incorporate security info into start page

* Update heading
2021-11-05 13:56:54 -04:00
Ioannis Kakavas 5434ca1b41
[DOCS] Adjust packaged installation docs for security on by default (#80195)
* Adjust packaged installation docs for security on by default

This commit introduces necessary changes to guide users through
the installation of our DEB/RPM packages, now that security is
enabled and configured by default.

* Update security docs and configure includes

* Update wording in check-running.asciidoc

* Adding hidden GET request

* Update heading

* Updated reconfigure heading

Co-authored-by: Adam Locke <adam.locke@elastic.co>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2021-11-04 11:39:37 -04:00
Kyle.K.Zhao 127667c596
[DOCS] Fix HOSTNAME quotes (#80115)
error: export HOSTNAME=“host1,host2"
2021-11-03 14:02:34 -04:00
James Rodewig cb6347b3da
[DOCS] Add transient settings migration guide (#80091) (#80272)
Changes:

* Adds a transient settings migration guide to the 7.16 docs.
* Updates the related deprecation docs to link to the guide.

Closes #80055

Relates to #79167.
2021-11-03 09:23:25 -04:00
Adam Locke 902f0527a4
[DOCS] Update Docker for security ON by default (#80113)
* [DOCS] Update Elasticsearch Docker security instructions

* Adding source files for secure Docker environment

* Updating install instructions and removing security page

* Update instructions for starting a single-node cluster with security

* Add NOTCONSOLE to curl command

* Incorporating reviewer feedback

* Update commands

* Fix link, update structure, other edits

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2021-11-02 14:43:11 -04:00
James Rodewig f758648762
[DOCS] Fix formatting for Docker mem lock example (#79963)
This places the example in a code snippet block rather than just using monospace.
2021-10-27 17:32:50 -04:00
James Rodewig c0487e5471 [DOCS] Minor grammar fix 2021-10-26 12:14:11 -04:00
Adam Locke ca9d8f638d
[DOCS] Add missing system config entry (#79830)
* [DOCS] Add missing system config entry

* Save and commit my actual changes
2021-10-26 12:04:58 -04:00
James Rodewig 8f23448870
[DOCS] Update ESS best practice for dynamic cluster settings (#79579)
Changes:

* Updates a tip in the configuration docs to point Cloud users to the [edit user settings](https://www.elastic.co/guide/en/cloud/current/ec-add-user-settings.html) feature.
* Removes some duplicate content from the cluster update settings API docs.

Relates to https://github.com/elastic/cloud/pull/90394

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
2021-10-26 11:57:42 -04:00
David Turner 6cc0a41af0
Expand warning about modifying data path contents (#79649)
Today we have a short note in one place in the docs saying not to touch
the contents of the data path. This commit expands the warning to
describe more precisely what is forbidden, and to give some more detail
of the consequences, and also duplicates the warning to the other
location that documents the `path.data` setting.
2021-10-21 16:28:43 -04:00
Nikola Grcevski 055c770083
Deprecation of transient cluster settings (#78794)
This PR changes uses of transient cluster settings to
persistent cluster settings. 

The PR also deprecates the transient settings usage.

Relates to #49540
2021-10-15 13:00:52 -04:00
Przemyslaw Gomulka f5e4228bb3
Setting to disable x-opaque-id in logs throttling (#78911)
Introduces a setting cluster.deprecation_indexing.x_opaque_id_used.enabled to disable use of
x-opaque-id in RateLimitingFilter. This will be used for deprecation
logs indexing and will not affect logging to files (it uses different
instance of RateLimitingFilter with this flag enabled by default)

Changes the indices backing a deprecation log data stream to be hidden.

Refactors DeprecationHttpIT to be more reliable

relates #76292
closes #77936
2021-10-12 12:55:28 +02:00
James Rodewig 485e7deaa0
[DOCS] Re-add docs for multiple data paths (MDP) (#78342)
We deprecated support for multiple data paths (MDP) in 7.13. However,
we won't remove support until after 8.0.

Changes:

* Reverts PR #72267, which removed MDP docs
* Removes a related item from the 8.0 breaking changes.
2021-09-28 09:20:45 -04:00
Przemyslaw Gomulka 8c0d7fa2fa
[doc] Improve documentation for deprecation logging (#78326)
adding a section on WARN messages

relates #77030
2021-09-27 16:56:26 +02:00
Adam Locke 6940673e8a
[DOCS] Update remote cluster docs (#77043)
* [DOCS] Update remote cluster docs

* Add files, rename files, write new stuff

* Plethora of changes

* Add test and update snippets

* Redirects, moved files, and test updates

* Moved file to x-pack for tests

* Remove older CCS page and add redirects

* Cleanup, link updates, and some rewrites

* Update image

* Incorporating user feedback and rewriting much of the remote clusters page

* More changes from review feedback

* Numerous updates, including request examples for CCS and Kibana

* More changes from review feedback

* Minor clarifications on security for remote clusters

* Incorporate review feedback

Co-authored-by: Yang Wang <ywangd@gmail.com>

* Some review feedback and some editorial changes

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Co-authored-by: Yang Wang <ywangd@gmail.com>
2021-09-22 16:02:33 -04:00
James Rodewig 5ccb1b4c62
[DOCS] Fix ESS install lead-in (#77887)
Replaces the hard-coded ESS lead-in with the docs attribute.

Previously, this copy omitted Microsoft Azure. This ensures these docs are better maintained.
2021-09-16 12:04:04 -04:00
James Rodewig cd95a2aefb
[DOCS] Re-add `KEYSTORE_PASSWORD` example to Docker install docs (#77588)
PR #77155 updated the keystore instructions for Docker. However, it removed an
example that included the `KEYSTORE_PASSWORD` env variable.

This replaces a docker compose example with the original example from PR #51123.
2021-09-10 17:12:18 -04:00
James Rodewig 63a9a3bddb [DOCS] Remove extraneous key from docker compose example 2021-09-10 10:45:25 -04:00
Stef Nestor 5bc291717b
[DOCS] Fix keystore creation instructions for Docker (#77155)
* [DOC] Update Persist Keystore via Docker

From feedback from ES Devs summarized in [^1], I believe this needs to reflect a directory mount rather than file mount to not error. Also adding in the two common mounting errors, but not sure if this is the right place for them.

[^1] https://discuss.elastic.co/t/persist-elasticsearch-kibana-keystores-with-docker/283099

* feedback

* Reorganize

* reword

* fix formatting

* address review feedback

* remove extra whitespace

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2021-09-10 10:42:10 -04:00