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

[7.16] Expand warning about modifying data path contents (#79649) #79656

Merged
merged 1 commit into from
Oct 21, 2021
Merged

[7.16] Expand warning about modifying data path contents (#79649) #79656

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 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,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]
[[max-local-storage-nodes]]
=== `node.max_local_storage_nodes`
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