From c87f5d040d7c046194945390479ca4ca2059eedc Mon Sep 17 00:00:00 2001 From: David Turner Date: Thu, 21 Oct 2021 19:09:26 +0100 Subject: [PATCH 1/3] Expand warning about modifying data path contents 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 | 14 ++++++++++++++ .../important-settings/path-settings.asciidoc | 6 ++---- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/docs/reference/modules/node.asciidoc b/docs/reference/modules/node.asciidoc index 50923d3103f6e..2405886279f05 100644 --- a/docs/reference/modules/node.asciidoc +++ b/docs/reference/modules/node.asciidoc @@ -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 +something other than {es} modifies the contents of the data directory then {es} +may fail, reporting corruption or other data inconsistencies, or it may appear +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 +from such a backup. Instead, use <> 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. +// end::modules-node-data-path-warning-tag[] + [discrete] [[other-node-settings]] === Other node settings diff --git a/docs/reference/setup/important-settings/path-settings.asciidoc b/docs/reference/setup/important-settings/path-settings.asciidoc index f66477c25146b..5767ba7dcd52c 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] From 843ce494f8dd039b4ac9969ec585db0eec53cd1b Mon Sep 17 00:00:00 2001 From: David Turner Date: Thu, 21 Oct 2021 21:12:41 +0100 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com> --- docs/reference/modules/node.asciidoc | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/reference/modules/node.asciidoc b/docs/reference/modules/node.asciidoc index 2405886279f05..a7713bd251d03 100644 --- a/docs/reference/modules/node.asciidoc +++ b/docs/reference/modules/node.asciidoc @@ -460,17 +460,14 @@ 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 -something other than {es} modifies the contents of the data directory then {es} -may fail, reporting corruption or other data inconsistencies, or it may appear +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. Do not attempt to -take backups of the data directory because there is no supported way to restore -from such a backup. Instead, use <> 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. +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} // end::modules-node-data-path-warning-tag[] [discrete] From 294b536403bd69ed7eef15a8ddffbde8fc39b819 Mon Sep 17 00:00:00 2001 From: David Turner Date: Thu, 21 Oct 2021 21:15:04 +0100 Subject: [PATCH 3/3] Reformat and reinstate lost sentence --- docs/reference/modules/node.asciidoc | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/reference/modules/node.asciidoc b/docs/reference/modules/node.asciidoc index a7713bd251d03..2626c255baf05 100644 --- a/docs/reference/modules/node.asciidoc +++ b/docs/reference/modules/node.asciidoc @@ -460,14 +460,16 @@ 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. Do not 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} +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]