From b17e8e6d91fd853b23f67a0b3ed0c5c95c2d8788 Mon Sep 17 00:00:00 2001 From: Plamen Jeliazkov Date: Fri, 22 Jun 2018 12:28:26 -0700 Subject: [PATCH] [#57] Organize and update documentation --- docs/Getting_Started/How_To_Build.md | 2 +- docs/Getting_Started/How_To_Run.md | 4 +-- .../Supported_Hadoop_Versions.md | 3 ++- .../Supported_Operating_Systems.md | 10 +++++++ docs/index.md | 27 ++++++++++++------- 5 files changed, 32 insertions(+), 14 deletions(-) create mode 100644 docs/Getting_Started/Supported_Operating_Systems.md diff --git a/docs/Getting_Started/How_To_Build.md b/docs/Getting_Started/How_To_Build.md index b4d8b185..ac81c61a 100644 --- a/docs/Getting_Started/How_To_Build.md +++ b/docs/Getting_Started/How_To_Build.md @@ -1,5 +1,5 @@ **How To Build:** -0. Check the [Supported Hadoop Versions](getting_started/Supported_Hadoop_Versions.md) page for what versions you can build for. +0. Check the [Supported Hadoop Versions](Supported_Hadoop_Versions/) page for what versions you can build for. 1. To build the RPM: `./gradlew clean buildRpm -PhadoopVersion=X.X.X` 2. Find the RPM in: `cd build/distributions/` \ No newline at end of file diff --git a/docs/Getting_Started/How_To_Run.md b/docs/Getting_Started/How_To_Run.md index 0e9dd05d..836ad4f8 100644 --- a/docs/Getting_Started/How_To_Run.md +++ b/docs/Getting_Started/How_To_Run.md @@ -1,10 +1,10 @@ **How To Run:** 0. (Optional) Check out `/usr/local/nn-analytics/bin/nn_loader` and observe that the JVM set-up is adequate for your needs. Modify the shell scripts as necessary for your environment. It is possible to change the classpath here and point to your own HDFS installations. -1. As root, run: `service nn-analytics start` +1. Run: `sudo service nn-analytics start` 2. (Optional) On your browser hit: `http(s)://HOSTNAME:8080/namespace.html` and fetch the latest image and then `service nn-analytics restart` if this is your first run. 3. If any issues occur check `/var/log/nn-analytics` for logs. -** As root you can run: `service nn-analytics stop` to shutdown or just `kill -9` the process. +** Run: `sudo service nn-analytics stop` to shutdown or just `kill -9` the process. ** It is advised that, in production, you hit `http(s)://HOSTNAME:8080/namespace.html` and "Save Namespace" prior shutting down your NNA instance. \ No newline at end of file diff --git a/docs/Getting_Started/Supported_Hadoop_Versions.md b/docs/Getting_Started/Supported_Hadoop_Versions.md index 2209c467..a2552fef 100644 --- a/docs/Getting_Started/Supported_Hadoop_Versions.md +++ b/docs/Getting_Started/Supported_Hadoop_Versions.md @@ -8,4 +8,5 @@ 6. 3.0.x (run with -PhadoopVersion=3.0.0) ** If you are building for 2.5.x you can re-use the 2.4.x build. -** Check [How To Build](getting_started/How_To_Build.md) for how to set these versions in your build. + +** Check [How To Build](How_To_Build/) for how to set these versions in your build. \ No newline at end of file diff --git a/docs/Getting_Started/Supported_Operating_Systems.md b/docs/Getting_Started/Supported_Operating_Systems.md new file mode 100644 index 00000000..a7dd6463 --- /dev/null +++ b/docs/Getting_Started/Supported_Operating_Systems.md @@ -0,0 +1,10 @@ +**Supported Operating Systems:** + +For running / production we recommend the following flavors of Linux: + +1. CentOS +2. RedHat +3. Ubuntu +4. Debian + +** For development / testing we also support Mac OSX. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index f5abb0bf..05890764 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,22 +1,29 @@ -# +NameNodeAnalytics +================= "A Standby read-only HDFS NameNode, with no RPC server, that services clients over a REST API, utilizes Java 8 Stream API, all for the purpose of performing large and complicated scans of the entire file system metadata for end users." + + Contents ================= - * [Supported Hadoop Versions](Getting_Started/Supported_Hadoop_Versions.md) - * [How To Test](Getting_Started/How_To_Test.md) * [How To Build](Getting_Started/How_To_Build.md) - * [How To Install](Getting_Started/How_To_Install.md) * [How To Configure](Getting_Started/How_To_Configure.md) - * [How To Run](Getting_Started/How_To_Run.md) + * [How To Install](Getting_Started/How_To_Install.md) * [How To Query](Getting_Started/How_To_Query.md) - * [Sets](Query_Parameters/1_Sets.md) - * [Filters](Query_Parameters/2_Filters.md) - * [FilterOps](Query_Parameters/3_FilterOps.md) - * [Sums](Query_Parameters/4_Sums.md) - * [Histograms](Query_Parameters/5_Histograms.md) + * [How To Run](Getting_Started/How_To_Run.md) + * [How To Test](Getting_Started/How_To_Test.md) + * [Supported Hadoop Versions](Getting_Started/Supported_Hadoop_Versions.md) + * [Supported Operating Systems](Getting_Started/Supported_Operating_Systems.md) + +**Query Parameters:** + + 1. [Sets](Query_Parameters/1_Sets.md) + 2. [Filters](Query_Parameters/2_Filters.md) + 3. [FilterOps](Query_Parameters/3_FilterOps.md) + 4. [Sums](Query_Parameters/4_Sums.md) + 5. [Histograms](Query_Parameters/5_Histograms.md) External =================