Modified TSDR HBase Installation Guide and corrected some formatting issues.

Change-Id: I3c6c22da94b4811d0cca27ea2fc4d6bd96094e34
Signed-off-by: YuLing Chen <yuling_c@dell.com>
(cherry picked from commit f46f9e4843524ad22a9ccfd6c1e55a4023673d51)

diff --git a/manuals/getting-started-guide/src/main/asciidoc/tsdr/tsdr-hbase-install.adoc b/manuals/getting-started-guide/src/main/asciidoc/tsdr/tsdr-hbase-install.adoc
index 608de317607740d7e84b618b6e69151352cf1872..e5fc9fd10441f8e125501bbd5c7f684ff78babdd 100644 (file)
--- a/manuals/getting-started-guide/src/main/asciidoc/tsdr/tsdr-hbase-install.adoc
+++ b/manuals/getting-started-guide/src/main/asciidoc/tsdr/tsdr-hbase-install.adoc
@@ -22,63 +22,89 @@ In Lithium, we implemented Data Collection Service, Data Storage Service, TSDR P
 A future release will contain Data Aggregation service, Data Purging Service, and a full-fledged Data Query Service with Norghbound APIs.
 
 
-=== Pre Requisites for Installing TSDR HBase Data Store 
-* Software Requirements
-  ** The supported operating system for TSDR HBase Data Store is Linux. We do not support TSDR HBase Data Store on Windows.
-  ** Besides the software that ODL requires, we also requires HBase database running on top of Hadoop.
+=== Prerequisites for Installing TSDR HBase Data Store
+The hardware requirements are the same as those for standard ODL controller installation. 
+
+The software requirements for TSDR HBase Data Store are as follows:
+
+* The supported operating system for TSDR HBase Data Store is Linux. We do not support TSDR HBase Data Store on Windows.
+* Besides the software that ODL requires, we also require HBase database running on top of Hadoop single node.
 
 === Preparing for Installation
-* Download HBase (version number to be finalized) from the following website.
+Download HBase (version number to be finalized) from the following website.
+
 http://archive.apache.org/dist/hbase/hbase-0.94.15/
 
 
 === Installing TSDR HBase Data Store 
-* Installing HBase server
-In Lithium, we only support HBase single node running together on the same machine as ODL controller.
-a. create a folder in Linux operating system for the HBase server.
-      For example, create an hbase directory under /usr/lib
+Installing TSDR HBase Data Store contains two steps:
+
+    * Installing HBase server, and
+    * Installing TSDR HBase Data Store features from ODL Karaf console.
+
+This installation guide will only cover the first step. For installing TSDR HBase Data Store features, please refer to TSDR HBase Data Store User Guide.
+
+In Lithium, we only support HBase single node running together on the same machine as ODL controller. Therefore, follow the steps to download and install HBase server onto the same box as where ODL controller is running:
+
+* Create a folder in Linux operating system for the HBase server.
+
+For example, create an hbase directory under /usr/lib:
+
       mkdir /usr/lib/hbase
-b. Unzip the downloaded HBase server tar file.
-      run the following command to unzip the installation package:
-      tar xvf <hbase-installer-name>  /usr/lib/hbase
 
-c. Make proper changes in hbase-site.xml
+* Unzip the downloaded HBase server tar file.
+
+Run the following command to unzip the installation package:
+
+      tar xvf <hbase-installer-name>  /usr/lib/hbase 
+
+* Make proper changes in hbase-site.xml
+
    .. Under <hbase-install-directory>/conf/, there is a hbase-site.xml. Although it is not recommended, an experience user with HBase canmodify the data directory for hbase server to store the data.
+
    .. Modify the value of the property with name "hbase.rootdir" in the file to reflect the desired file directory for storing hbase data.
 
 The following is an example of the file:
 
-<configuration>
-  <property>
-    <name>hbase.rootdir</name>
-    <value>file:///usr/lib/hbase/data</value>
-  </property>
-  <property>
-    <name>hbase.zookeeper.property.dataDir</name>
-    <value>/usr/lib/hbase/zookeeper</value>
-  </property>
-</configuration>
-
+    <configuration>
+      <property>
+        <name>hbase.rootdir</name>
+        <value>file:///usr/lib/hbase/data</value>
+      </property>
+      <property>
+        <name>hbase.zookeeper.property.dataDir</name>
+        <value>/usr/lib/hbase/zookeeper</value>
+      </property>
+    </configuration>
  
 
 === Verifying your Installation
 After the HBase server is properly installed, start hbase server and hbase shell.
-a. start hbase server
+
+.. start hbase server
+
    cd <hbase-installation-directory> 
    ./start-hbase.sh
-b. start hbase shell
+
+.. start hbase shell
+
    cd <hbase-insatllation-directory>
    ./hbase shell
-==== Troubleshooting
 
 === Post Installation Configuration
 Please refer to HBase Data Store User Guide.
+
 === Upgrading From a Previous Release
 Lithium is the first release of TSDR. Upgrading is not applicable for TSDR Lithium release.
+
 === Uninstalling HBase Data Store 
 To uninstall TSDR HBase Data Store, 
-a. stop hbase server
+
+.. stop hbase server
+
    cd <hbase-installation-directory>
    ./stop-hbase.sh
-b. remove the file directory that contains the HBase server installation.
+
+.. remove the file directory that contains the HBase server installation.
+
    rm -r <hbase-installation-directory>