Skip to content

Commit

Permalink
Expand warning about modifying data path contents (#79649)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
DaveCTurner authored Oct 21, 2021
1 parent 3724fea commit 6cc0a41
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
13 changes: 13 additions & 0 deletions docs/reference/modules/node.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -459,6 +459,19 @@ should be configured to locate the data directory outside the {es} home
directory, so that the home directory can be deleted without deleting your data!
The RPM and Debian distributions do this for you already.

// tag::modules-node-data-path-warning-tag[]
WARNING: Don't modify anything within the data directory or run processes that
might interfere with its contents. If something other than {es} modifies the
contents of the data directory, then {es} may fail, reporting corruption or
other data inconsistencies, or may appear to work correctly having silently
lost some of your data. Don't attempt to take filesystem backups of the data
directory; there is no supported way to restore such a backup. Instead, use
<<snapshot-restore>> to take backups safely. Don't run virus scanners on the
data directory. A virus scanner can prevent {es} from working correctly and may
modify the contents of the data directory. The data directory contains no
executables so a virus scan will only find false positives.
// end::modules-node-data-path-warning-tag[]

[discrete]
[[other-node-settings]]
=== Other node settings
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,14 @@ In production, we strongly recommend you set the `path.data` and `path.logs` in
`.msi`>> installations write data and log to locations outside of `$ES_HOME` by
default.

IMPORTANT: To avoid errors, only {es} should open files in the `path.data`
directory. Exclude the `path.data` directory from other services that may open
and lock its files, such as antivirus or backup programs.

Supported `path.data` and `path.logs` values vary by platform:

include::{es-repo-dir}/tab-widgets/code.asciidoc[]

include::{es-repo-dir}/tab-widgets/customize-data-log-path-widget.asciidoc[]

include::{es-repo-dir}/modules/node.asciidoc[tag=modules-node-data-path-warning-tag]

[discrete]
==== Multiple data paths
deprecated::[7.13.0]
Expand Down

0 comments on commit 6cc0a41

Please sign in to comment.