From 7468aa0a1d3f7186d84b7bb6d17c1fd5ee030185 Mon Sep 17 00:00:00 2001 From: David Turner Date: Thu, 21 Oct 2021 21:39:24 +0100 Subject: [PATCH] Expand warning about modifying data path contents (#79649) (#79655) 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. --- docs/reference/modules/node.asciidoc | 13 +++++++++++++ .../setup/important-settings/path-settings.asciidoc | 6 ++---- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/docs/reference/modules/node.asciidoc b/docs/reference/modules/node.asciidoc index cbd09b50cfa6a..b51a75578a1e4 100644 --- a/docs/reference/modules/node.asciidoc +++ b/docs/reference/modules/node.asciidoc @@ -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 +<> 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` diff --git a/docs/reference/setup/important-settings/path-settings.asciidoc b/docs/reference/setup/important-settings/path-settings.asciidoc index e68dd04372378..eadbe4b4c8874 100644 --- a/docs/reference/setup/important-settings/path-settings.asciidoc +++ b/docs/reference/setup/important-settings/path-settings.asciidoc @@ -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]