Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand warning about modifying data path contents #79649

Merged
merged 3 commits into from
Oct 21, 2021
Merged

Expand warning about modifying data path contents #79649

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c87f5d0
Expand warning about modifying data path contents
DaveCTurner Oct 21, 2021
843ce49
Apply suggestions from code review
DaveCTurner Oct 21, 2021
294b536
Reformat and reinstate lost sentence
DaveCTurner Oct 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/reference/modules/node.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -459,6 +459,20 @@ 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: You must not modify anything within the data directory and you must
not run any other processes that might interfere with its contents. If
DaveCTurner marked this conversation as resolved.
Show resolved Hide resolved
something other than {es} modifies the contents of the data directory then {es}
DaveCTurner marked this conversation as resolved.
Show resolved Hide resolved
may fail, reporting corruption or other data inconsistencies, or it may appear
DaveCTurner marked this conversation as resolved.
Show resolved Hide resolved
to work correctly having silently lost some of your data. Do not attempt to
take backups of the data directory because there is no supported way to restore
DaveCTurner marked this conversation as resolved.
Show resolved Hide resolved
from such a backup. Instead, use <<snapshot-restore>> to take backups safely.
Do not run virus scanners on the data directory because they can prevent {es}
from working correctly and may modify the directory's contents. The data
directory contains no executables so a virus scan will only find false
positives.
DaveCTurner marked this conversation as resolved.
Show resolved Hide resolved
// end::modules-node-data-path-warning-tag[]

[discrete]
[[other-node-settings]]
=== Other node settings
Expand Down
6 changes: 2 additions & 4 deletions docs/reference/setup/important-settings/path-settings.asciidoc
View file
Open in desktop
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