-What follows presumes you are installing hbase for the first time. If upgrading your -hbase instance, see Upgrading. +What follows presumes you are installing HBase for the first time. If upgrading your +HBase instance, see Upgrading.
-Start by defining the following directory variables for your convenience: +Start by defining the following environment variables for your convenience:
${HBASE_HOME}: The HBase root.
+${HBASE_HOME}: Set HBASE_HOME to the location of the HBase root: e.g. /user/local/hbase.
Edit ${HBASE_HOME}/conf/hbase-env.sh. In this file you can
-set the heapsize for HBase, etc. At a minimum, set
-JAVA_HOME to the root of your Java installation.
+set the heapsize for HBase, etc. At a minimum, set JAVA_HOME to point at the root of
+your Java installation.
-If you are running a standalone operation, proceed to Running -and Confirming Your Installation. If you are running a distributed operation, continue below. +If you are running a standalone operation, there should be nothing further to configure; proceed to +Running and Confirming Your Installation. If you are running a distributed +operation, continue reading.
Distributed mode requires an instance of the Hadoop Distributed File System (DFS). See the Hadoop -requirements and instructions for running a distributed operation. Configuring HBase for a -distributed operation requires modification of the following two files: +requirements and instructions for how to set up a DFS.
+Once you have confirmed your DFS setup, configuring HBase requires modification of the following two files:
${HBASE_HOME}/conf/hbase-site.xml and ${HBASE_HOME}/conf/regionservers.
The former needs to be pointed at the running Hadoop DFS instance. The latter file lists
-all members of the HBase cluster.
+all the members of the HBase cluster.
-hbase-site.xml allows the user to override the properties defined in
+Use hbase-site.xml to override the properties defined in
${HBASE_HOME}/conf/hbase-default.xml (hbase-default.xml itself
should never be modified). At a minimum the hbase.master and the
hbase.rootdir properties should be redefined
-in hbase-site.xml to define the host:port pair on which to run the
-HMaster (read about the
-Hbase master, regionservers, etc) and to point hbase at the Hadoop filesystem to use. For
-example:
+in hbase-site.xml to configure the host:port pair on which the
+HMaster runs (read about the
+HBase master, regionservers, etc) and to point HBase at the Hadoop filesystem to use. For
+example, adding the below to your hbase-site.xml says the master is up on port 60000 on the host
+example.org and that HBase should use the /hbase directory in the HDFS whose namenode
+is at port 9000, again on example.org:
<configuration>
<property>
<name>hbase.master</name>
- <value>localhost:60000</value>
+ <value>example.org:60000</value>
<description>The host and port that the HBase master runs at.
</description>
</property>
<property>
<name>hbase.rootdir</name>
- <value>hdfs://localhost:9000/hbase</value>
+ <value>hdfs://example.org:9000/hbase</value>
<description>The directory shared by region servers.
</description>
</property>
@@ -91,18 +94,19 @@ example:
The regionserver file lists all the hosts running HRegionServers, one
-host per line (This file is synonymous to the slaves file at
+host per line (This file is HBase synonym of the hadoop slaves file at
${HADOOP_HOME}/conf/slaves).
If you are running in standalone, non-distributed mode, hbase by default uses +
If you are running in standalone, non-distributed mode, HBase by default uses the local filesystem.
+If you are running a distributed cluster you will need to start the Hadoop DFS daemons before starting HBase and stop the daemons after HBase has shut down. Start and -stop the Hadoop DFS daemons as per the Hadoop -instructions. HBase -does not normally use the mapreduce daemons. These do not need to be started.
+stop the Hadoop DFS daemons by running${HADOOP_HOME}/bin/start-dfs.sh.
+Ensure it started properly by testing the put and get of files into the Hadoop filesystem.
+HBase does not normally use the mapreduce daemons. These do not need to be started.
Start HBase with the following command:
@@ -112,11 +116,11 @@ ${HBASE_HOME}/bin/start-hbase.sh
Once HBase has started, enter ${HBASE_HOME}/bin/hbase shell to obtain a
shell against HBase from which you can execute HQL commands (HQL is a severe subset of SQL).
-In the HBase shell, type
-help; to see a list of supported HQL commands. Note that all commands in the HBase
+In the HBase shell, type help; to see a list of supported HQL commands. Note
+that all commands in the HBase
shell must end with ;. Test your installation by creating, viewing, and dropping
a table, as per the help instructions. Be patient with the create and
-drop operations as they may each take 10 seconds or more. To stop hbase, exit the
+drop operations as they may each take 10 seconds or more. To stop HBase, exit the
HBase shell and enter:
@@ -130,19 +134,21 @@ before stopping the Hadoop daemons. The default location for logs is${HBASE_HOME}/logs.HBase also puts up a UI listing vital attributes. By default its deployed on the master host -at port 60010.
+at port 60010 (HBase regionservers listen on port 60020 by default and put up an informational +http server at 60030).Upgrading
-After installing the new HBase, before starting your cluster, run the -
${HBASE_DIR}/bin/hbase migratemigration script. It will make any -adjustments to the filesystem data underhbase.rootdirnecessary to run -the hbase version (It does not change your install unless you explicitly ask it to). +After installing a new HBase on top of data written by a previous HBase version, before +starting your cluster, run the
${HBASE_DIR}/bin/hbase migratemigration script. +It will make any adjustments to the filesystem data underhbase.rootdirnecessary to run +the HBase version. It does not change your install unless you explicitly ask it to.Related Documentation