Browse files

HBASE-526 Add documentation src and build to the 0.1 branch

Second part of documentation commit.


git-svn-id: https://svn.apache.org/repos/asf/hadoop/hbase/trunk@638612 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information...
1 parent 04a1531 commit 413ca237ed14196453531ca494450f482b83329f Michael Stack committed Mar 18, 2008
View
1 CHANGES.txt
@@ -95,6 +95,7 @@ Hbase Change Log
HBASE-443 Move internal classes out of HStore
HBASE-515 At least double default timeouts between regionserver and master
HBASE-529 RegionServer needs to recover if datanode goes down
+ HBASE-456 Clearly state which ports need to be opened in order to run HBase
Branch 0.1
View
2 README.txt
@@ -1 +1 @@
-See http://wiki.apache.org/lucene-hadoop/Hbase
+See the docs directory or http://hbase.org
View
1 build.xml
@@ -285,7 +285,6 @@
<path refid="classpath" />
<pathelement path="${java.class.path}"/>
</classpath>
- <group title="${Name}" packages="org.apache.hadoop.hbase.*"/>
</javadoc>
</target>
View
7 docs/index.html
@@ -108,6 +108,9 @@
<div class="menupagetitle">Overview</div>
</div>
<div class="menuitem">
+<a href="api/overview-summary.html#overview_description">Getting Started</a>
+</div>
+<div class="menuitem">
<a href="api/index.html">API Docs</a>
</div>
<div class="menuitem">
@@ -153,6 +156,10 @@
<ul>
<li>
+<a href="api/overview-summary.html#overview_description">Getting Started</a>
+</li>
+
+<li>
<a href="api/index.html">API Docs</a>
</li>
View
BIN docs/index.pdf
Binary file not shown.
View
9 docs/linkmap.html
@@ -108,6 +108,9 @@
<a href="index.html">Overview</a>
</div>
<div class="menuitem">
+<a href="api/overview-summary.html#overview_description">Getting Started</a>
+</div>
+<div class="menuitem">
<a href="api/index.html">API Docs</a>
</div>
<div class="menuitem">
@@ -164,6 +167,12 @@
<ul>
<li>
+<a href="api/overview-summary.html#overview_description">Getting Started</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>started</em>
+</li>
+</ul>
+
+<ul>
+<li>
<a href="api/index.html">API Docs</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>api</em>
</li>
</ul>
View
BIN docs/linkmap.pdf
Binary file not shown.
View
1 src/docs/src/documentation/content/xdocs/index.xml
@@ -30,6 +30,7 @@
<a href="ext:lists">mailing list</a> or browse the archives.
</p>
<ul>
+ <li><a href="ext:api/started">Getting Started</a></li>
<li><a href="ext:api/index">API Docs</a></li>
<li><a href="ext:wiki">Wiki</a></li>
<li><a href="ext:faq">FAQ</a></li>
View
2 src/docs/src/documentation/content/xdocs/site.xml
@@ -33,6 +33,7 @@ See http://forrest.apache.org/docs/linking.html for more info.
<docs label="Documentation">
<overview label="Overview" href="index.html" />
+ <started label="Getting Started" href="ext:api/started" />
<api label="API Docs" href="ext:api/index" />
<wiki label="Wiki" href="ext:wiki" />
<faq label="FAQ" href="ext:faq" />
@@ -54,6 +55,7 @@ See http://forrest.apache.org/docs/linking.html for more info.
<cygwin href="http://www.cygwin.com/" />
<osx href="http://www.apple.com/macosx" />
<api href="api/">
+ <started href="overview-summary.html#overview_description" />
<index href="index.html" />
<org href="org/">
<apache href="apache/">
View
1 src/java/org/apache/hadoop/hbase/regionserver/HRegion.java
@@ -1107,7 +1107,6 @@ public Cell get(Text row, Text column) throws IOException {
* <i>ts</i>.
*
* @param row row key
- * @param ts
* @return map of values
* @throws IOException
*/
View
74 src/java/overview.html
@@ -22,7 +22,7 @@
<title>HBase</title>
</head>
<body bgcolor="white">
-HBase is the <a href="http://lucene.apache.org/hadoop">Hadoop</a> simple database.
+<a href="http://hbase.org">HBase</a> is the <a href="http://lucene.apache.org/hadoop">Hadoop</a> simple database.
<h2><a name="requirements">Requirements</a></h2>
<ul>
@@ -31,58 +31,61 @@
<h2><a name="getting_started" >Getting Started</a></h2>
<p>
-What follows presumes you are installing hbase for the first time. If upgrading your
-hbase instance, see <a href="#upgrading">Upgrading</a>.
+What follows presumes you are installing HBase for the first time. If upgrading your
+HBase instance, see <a href="#upgrading">Upgrading</a>.
</p>
<p>
-Start by defining the following directory variables for your convenience:
+Start by defining the following environment variables for your convenience:
</p>
<p>
<ul>
-<li><code>${HBASE_HOME}</code>: The HBase root.
+<li><code>${HBASE_HOME}</code>: Set HBASE_HOME to the location of the HBase root: e.g. <code>/user/local/hbase</code>.
</li>
</ul>
</p>
<p>Edit <code>${HBASE_HOME}/conf/hbase-env.sh</code>. In this file you can
-set the heapsize for HBase, etc. At a minimum, set
-<code>JAVA_HOME</code> to the root of your Java installation.
+set the heapsize for HBase, etc. At a minimum, set <code>JAVA_HOME</code> to point at the root of
+your Java installation.
<p>
-If you are running a standalone operation, proceed to <a href=#runandconfirm>Running
-and Confirming Your Installation</a>. 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
+<a href=#runandconfirm>Running and Confirming Your Installation</a>. If you are running a distributed
+operation, continue reading.
</p>
<h2><a name="distributed" >Distributed Operation</a></h2>
<p>Distributed mode requires an instance of the Hadoop Distributed File System (DFS).
See the Hadoop <a href="http://lucene.apache.org/hadoop/api/overview-summary.html#overview_description">
-requirements and instructions</a> for running a distributed operation. Configuring HBase for a
-distributed operation requires modification of the following two files:
+requirements and instructions</a> for how to set up a DFS.</p>
+<p>Once you have confirmed your DFS setup, configuring HBase requires modification of the following two files:
<code>${HBASE_HOME}/conf/hbase-site.xml</code> and <code>${HBASE_HOME}/conf/regionservers</code>.
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.
</p>
<p>
-<code>hbase-site.xml</code> allows the user to override the properties defined in
+Use <code>hbase-site.xml</code> to override the properties defined in
<code>${HBASE_HOME}/conf/hbase-default.xml</code> (<code>hbase-default.xml</code> itself
should never be modified). At a minimum the <code>hbase.master</code> and the
<code>hbase.rootdir</code> properties should be redefined
-in <code>hbase-site.xml</code> to define the <code>host:port</code> pair on which to run the
-HMaster (<a href="http://wiki.apache.org/lucene-hadoop/Hbase/HbaseArchitecture">read about the
-Hbase master, regionservers, etc</a>) and to point hbase at the Hadoop filesystem to use. For
-example:
+in <code>hbase-site.xml</code> to configure the <code>host:port</code> pair on which the
+HMaster runs (<a href="http://wiki.apache.org/lucene-hadoop/Hbase/HbaseArchitecture">read about the
+HBase master, regionservers, etc</a>) 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 <code>/hbase</code> directory in the HDFS whose namenode
+is at port 9000, again on example.org:
</p>
<pre>
&lt;configuration&gt;
&lt;property&gt;
&lt;name&gt;hbase.master&lt;/name&gt;
- &lt;value&gt;localhost:60000&lt;/value&gt;
+ &lt;value&gt;example.org:60000&lt;/value&gt;
&lt;description&gt;The host and port that the HBase master runs at.
&lt;/description&gt;
&lt;/property&gt;
&lt;property&gt;
&lt;name&gt;hbase.rootdir&lt;/name&gt;
- &lt;value&gt;hdfs://localhost:9000/hbase&lt;/value&gt;
+ &lt;value&gt;hdfs://example.org:9000/hbase&lt;/value&gt;
&lt;description&gt;The directory shared by region servers.
&lt;/description&gt;
&lt;/property&gt;
@@ -91,18 +94,19 @@
</pre>
<p>
The <code>regionserver</code> 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
<code>${HADOOP_HOME}/conf/slaves</code>).
</p>
<h2><a name="runandconfirm">Running and Confirming Your Installation</a></h2>
-<p>If you are running in standalone, non-distributed mode, hbase by default uses
+<p>If you are running in standalone, non-distributed mode, HBase by default uses
the local filesystem.</p>
+
<p>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
-<a href="http://lucene.apache.org/hadoop/api/overview-summary.html">instructions</a>. HBase
-does not normally use the mapreduce daemons. These do not need to be started.</p>
+stop the Hadoop DFS daemons by running <code>${HADOOP_HOME}/bin/start-dfs.sh</code>.
+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.</p>
<p>Start HBase with the following command:
</p>
@@ -112,11 +116,11 @@
<p>
Once HBase has started, enter <code>${HBASE_HOME}/bin/hbase shell</code> 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
-<code>help;</code> to see a list of supported HQL commands. Note that all commands in the HBase
+In the HBase shell, type <code>help;</code> to see a list of supported HQL commands. Note
+that all commands in the HBase
shell must end with <code>;</code>. Test your installation by creating, viewing, and dropping
a table, as per the help instructions. Be patient with the <code>create</code> and
-<code>drop</code> operations as they may each take 10 seconds or more. To stop hbase, exit the
+<code>drop</code> operations as they may each take 10 seconds or more. To stop HBase, exit the
HBase shell and enter:
</p>
<pre>
@@ -130,19 +134,21 @@
The default location for logs is <code>${HBASE_HOME}/logs</code>.
</p>
<p>HBase also puts up a UI listing vital attributes. By default its deployed on the master host
-at port 60010.</p>
+at port 60010 (HBase regionservers listen on port 60020 by default and put up an informational
+http server at 60030).</p>
<h2><a name="upgrading" >Upgrading</a></h2>
-<p>After installing the new HBase, before starting your cluster, run the
-<code>${HBASE_DIR}/bin/hbase migrate</code> migration script. It will make any
-adjustments to the filesystem data under <code>hbase.rootdir</code> necessary to run
-the hbase version (It does not change your install unless you explicitly ask it to).
+<p>After installing a new HBase on top of data written by a previous HBase version, before
+starting your cluster, run the <code>${HBASE_DIR}/bin/hbase migrate</code> migration script.
+It will make any adjustments to the filesystem data under <code>hbase.rootdir</code> necessary to run
+the HBase version. It does not change your install unless you explicitly ask it to.
</p>
<h2><a name="related" >Related Documentation</a></h2>
<ul>
- <li><a href="http://wiki.apache.org/lucene-hadoop/Hbase">HBase Home Page</a>
- <li><a href="http://wiki.apache.org/lucene-hadoop/Hbase/HbaseArchitecture">HBase Architecture</a>
+ <li><a href="http://hbase.org">HBase Home Page</a>
+ <li><a href="http://wiki.apache.org/hadoop/Hbase">HBase Wiki</a>
+ <li><a href="http://hadoop.apache.org/">Hadoop Home Page</a>
</ul>
</body>

0 comments on commit 413ca23

Please sign in to comment.