Add disclaimer about remote fs usage and an example of setting env var (

#1644) (#1646) * Add disclaimer about remote fs usage and an example of setting env var Signed-off-by: JeffH-AWS <[email protected]> * Enhanced wording a little bit Signed-off-by: JeffH-AWS <[email protected]> Signed-off-by: JeffH-AWS <[email protected]> (cherry picked from commit f9d7758) Co-authored-by: Jeff Huss <[email protected]>
opensearch-project · Oct 21, 2022 · fe0a981 · fe0a981
1 parent e391d0b
commit fe0a981
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/_opensearch/install/compatibility.md b/_opensearch/install/compatibility.md
@@ -9,6 +9,9 @@ nav_order: 2
 
 We recommend installing OpenSearch on Red Hat Enterprise Linux (RHEL) or Debian-based Linux distributions that use [systemd](https://en.wikipedia.org/wiki/Systemd), such as CentOS, Amazon Linux 2, and Ubuntu Long-Term Support (LTS). OpenSearch should work on most Linux distributions, but we only test a handful. We recommend RHEL 7 or 8, CentOS 7 or 8, Amazon Linux 2, Ubuntu 16.04, 18.04, or 20.04 for any version of OpenSearch.
 
+Avoid using a network file system for node storage in a production workflow. Using a network file system for node storage can cause performance issues in your cluster due to factors such as network conditions (like latency or limited throughput) or read/write speeds. You should use solid-state drives (SSDs) installed on the host for node storage where possible.
+{: .note}
+
 # Java compatibility
 
 The OpenSearch distribution for Linux ships with a compatible [Adoptium JDK](https://adoptium.net/) version of Java in the `jdk` directory. To find the JDK version, run `./jdk/bin/java -version`. For example, the OpenSearch 1.0.0 tarball ships with Java 15.0.1+9 (non-LTS), OpenSearch 1.3.0 ships with Java 11.0.14.1+1 (LTS), and OpenSearch 2.0.0 ships with Java 17.0.2+8 (LTS). OpenSearch is tested with all compatible Java versions.
@@ -19,4 +22,7 @@ OpenSearch Version | Compatible Java Versions | Bundled Java Version
 1.3.x       | 8, 11, 14 | 11.0.14.1+1
 2.0.0       | 11, 17    | 17.0.2+8
 
-To use a different Java installation, set the `OPENSEARCH_JAVA_HOME` or `JAVA_HOME` environment variable to the Java install location.
+To use a different Java installation, set the `OPENSEARCH_JAVA_HOME` or `JAVA_HOME` environment variable to the Java install location. For example:
+```bash
+export OPENSEARCH_JAVA_HOME=/path/to/opensearch-{{site.opensearch_version}}/jdk
+```