You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by st...@apache.org on 2008/02/08 00:48:23 UTC
svn commit: r619689 - in /hadoop/hbase: branches/0.1/CHANGES.txt
branches/0.1/build.xml branches/0.1/src/java/overview.html
trunk/CHANGES.txt trunk/src/java/overview.html
Author: stack
Date: Thu Feb 7 15:48:19 2008
New Revision: 619689
URL: http://svn.apache.org/viewvc?rev=619689&view=rev
Log:
HBASE-425 Fix doc. so it accomodates new hbase untethered context
Modified:
hadoop/hbase/branches/0.1/CHANGES.txt
hadoop/hbase/branches/0.1/build.xml
hadoop/hbase/branches/0.1/src/java/overview.html
hadoop/hbase/trunk/CHANGES.txt
hadoop/hbase/trunk/src/java/overview.html
Modified: hadoop/hbase/branches/0.1/CHANGES.txt
URL: http://svn.apache.org/viewvc/hadoop/hbase/branches/0.1/CHANGES.txt?rev=619689&r1=619688&r2=619689&view=diff
==============================================================================
--- hadoop/hbase/branches/0.1/CHANGES.txt (original)
+++ hadoop/hbase/branches/0.1/CHANGES.txt Thu Feb 7 15:48:19 2008
@@ -1,7 +1,7 @@
HBase Change Log
-Trunk (unreleased changes)
+Release 0.1.0
INCOMPATIBLE CHANGES
HADOOP-2750 Deprecated methods startBatchUpdate, commitBatch, abortBatch,
@@ -22,6 +22,7 @@
(Bryan Duxbury & Stack)
HADOOP-2773 Master marks region offline when it is recovering from a region
server death
+ HBASE-425 Fix doc. so it accomodates new hbase untethered context
IMPROVEMENTS
HADOOP-2555 Refactor the HTable#get and HTable#getRow methods to avoid
Modified: hadoop/hbase/branches/0.1/build.xml
URL: http://svn.apache.org/viewvc/hadoop/hbase/branches/0.1/build.xml?rev=619689&r1=619688&r2=619689&view=diff
==============================================================================
--- hadoop/hbase/branches/0.1/build.xml (original)
+++ hadoop/hbase/branches/0.1/build.xml Thu Feb 7 15:48:19 2008
@@ -48,6 +48,7 @@
<property name="build.classes" location="${build.dir}/classes"/>
<property name="build.test" location="${build.dir}/test"/>
<property name="build.examples" location="${build.dir}/examples"/>
+ <property name="build.src" value="${build.dir}/src"/>
<property name="build.docs" value="${build.dir}/docs"/>
<property name="build.javadoc" value="${build.docs}/api"/>
<property name="build.encoding" value="ISO-8859-1"/>
@@ -136,7 +137,7 @@
<!--Compile whats under src and generated java classes made from jsp-->
<javac
encoding="${build.encoding}"
- srcdir="${src.dir}"
+ srcdir="${src.dir};${build.src}"
includes="**/*.java"
destdir="${build.classes}"
debug="${javac.debug}"
Modified: hadoop/hbase/branches/0.1/src/java/overview.html
URL: http://svn.apache.org/viewvc/hadoop/hbase/branches/0.1/src/java/overview.html?rev=619689&r1=619688&r2=619689&view=diff
==============================================================================
--- hadoop/hbase/branches/0.1/src/java/overview.html (original)
+++ hadoop/hbase/branches/0.1/src/java/overview.html Thu Feb 7 15:48:19 2008
@@ -27,11 +27,6 @@
<h2><a name="requirements">Requirements</a></h2>
<ul>
<li>Java 1.5.x, preferably from <a href="http://www.java.com/en/download/">Sun</a>.</li>
-<li>Hbase runs on top of <a href="http://lucene.apache.org/hadoop">Hadoop</a>. Hadoop has its own set of
-<a href="http://lucene.apache.org/hadoop/api/overview-summary.html#overview_description">
-requirements and instructions</a>. Make sure to set
-<code>JAVA_HOME</code> to the root of your Java installation when configuring Hadoop.
-</li>
</ul>
<h2><a name="getting_started" >Getting Started</a></h2>
@@ -44,32 +39,35 @@
</p>
<p>
<ul>
-<li><code>${HADOOP_HOME}</code>: The root directory of your Hadoop installation.</li>
-<li><code>${HBASE_HOME}</code>: The Hbase root, located at
-<code>${HADOOP_HOME}/src/contrib/hbase</code>.</li>
+<li><code>${HBASE_HOME}</code>: The Hbase root.
+</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.
<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.
</p>
<h2><a name="distributed" >Distributed Operation</a></h2>
-<p>
-Make sure you have followed
-<a href="http://lucene.apache.org/hadoop/api/overview-summary.html#overview_description">
-Hadoop's instructions</a> for running a distributed operation.
-Configuring Hbase for a distributed operation requires modification of the following two
-files: <code>${HBASE_HOME}/conf/hbase-site.xml</code> and
-<code>${HBASE_HOME}/conf/regionservers</code>.
+<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:
+<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.
</p>
<p>
<code>hbase-site.xml</code> allows the user 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> property should be redefined
+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>):
+Hbase master, regionservers, etc</a>) and to point hbase the Hadoop filesystem to use:
</p>
<pre>
<configuration>
@@ -81,6 +79,13 @@
</description>
</property>
+ <property>
+ <name>hbase.rootdir</name>
+ <value>FULLY_QUALIFIED_PATH</value>
+ <description>The directory shared by region servers.
+ </description>
+ </property>
+
</configuration>
</pre>
<p>
@@ -88,12 +93,6 @@
host per line (This file is synonymous to the slaves file at
<code>${HADOOP_HOME}/conf/slaves</code>).
</p>
-<h3><a name="additional" >Additional Notes on Distributed Operation</a></h3>
-<ul>
-<li>Hadoop and Hbase must be set up on each host you plan to use.</li>
-<li>Additional (optional) Hbase-specific variables such as HBASE_HEAPSIZE and HBASE_CLASSPATH
-can be set in <code>${HBASE_HOME}/conf/hbase-env.sh</code>.</li>
-</ul>
<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
@@ -111,8 +110,9 @@
</pre>
<p>
Once Hbase has started, enter <code>${HBASE_HOME}/bin/hbase shell</code> to obtain a
-shell against Hbase from which you can execute Hbase commands. In the Hbase shell, type
-<code>help;</code> to see a list of supported commands. Note that all commands in the Hbase
+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
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
@@ -126,16 +126,16 @@
before stopping the Hadoop daemons.
</p>
<p>
-The default location for logs is <code>${HADOOP_HOME}/logs</code>.
+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>
<h2><a name="upgrading" >Upgrading</a></h2>
-<p>After installing the new hbase, before starting your cluster, run the
+<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.
+the hbase version (It does not change your install unless you explicitly ask it to).
</p>
<h2><a name="related" >Related Documentation</a></h2>
Modified: hadoop/hbase/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/CHANGES.txt?rev=619689&r1=619688&r2=619689&view=diff
==============================================================================
--- hadoop/hbase/trunk/CHANGES.txt (original)
+++ hadoop/hbase/trunk/CHANGES.txt Thu Feb 7 15:48:19 2008
@@ -1,4 +1,4 @@
-HBase Change Log
+Hbase Change Log
INCOMPATIBLE CHANGES
HBASE-288 Add in-memory caching of data. Required update of hadoop to
@@ -26,6 +26,8 @@
HBASE-281 Shell should allow deletions in .META. and -ROOT- tables
(Edward Yoon & Bryan Duxbury via Stack)
HBASE-56 Unnecessary HQLClient Object creation in a shell loop
+ (Edward Yoon via Stack)
+
Branch 0.1
@@ -48,6 +50,7 @@
(Bryan Duxbury & Stack)
HADOOP-2773 Master marks region offline when it is recovering from a region
server death
+ HBASE-425 Fix doc. so it accomodates new hbase untethered context
IMPROVEMENTS
HADOOP-2555 Refactor the HTable#get and HTable#getRow methods to avoid
Modified: hadoop/hbase/trunk/src/java/overview.html
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/overview.html?rev=619689&r1=619688&r2=619689&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/overview.html (original)
+++ hadoop/hbase/trunk/src/java/overview.html Thu Feb 7 15:48:19 2008
@@ -27,11 +27,6 @@
<h2><a name="requirements">Requirements</a></h2>
<ul>
<li>Java 1.5.x, preferably from <a href="http://www.java.com/en/download/">Sun</a>.</li>
-<li>Hbase runs on top of <a href="http://lucene.apache.org/hadoop">Hadoop</a>. Hadoop has its own set of
-<a href="http://lucene.apache.org/hadoop/api/overview-summary.html#overview_description">
-requirements and instructions</a>. Make sure to set
-<code>JAVA_HOME</code> to the root of your Java installation when configuring Hadoop.
-</li>
</ul>
<h2><a name="getting_started" >Getting Started</a></h2>
@@ -44,32 +39,35 @@
</p>
<p>
<ul>
-<li><code>${HADOOP_HOME}</code>: The root directory of your Hadoop installation.</li>
-<li><code>${HBASE_HOME}</code>: The Hbase root, located at
-<code>${HADOOP_HOME}/src/contrib/hbase</code>.</li>
+<li><code>${HBASE_HOME}</code>: The Hbase root.
+</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.
<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.
</p>
<h2><a name="distributed" >Distributed Operation</a></h2>
-<p>
-Make sure you have followed
-<a href="http://lucene.apache.org/hadoop/api/overview-summary.html#overview_description">
-Hadoop's instructions</a> for running a distributed operation.
-Configuring Hbase for a distributed operation requires modification of the following two
-files: <code>${HBASE_HOME}/conf/hbase-site.xml</code> and
-<code>${HBASE_HOME}/conf/regionservers</code>.
+<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:
+<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.
</p>
<p>
<code>hbase-site.xml</code> allows the user 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> property should be redefined
+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>):
+Hbase master, regionservers, etc</a>) and to point hbase the Hadoop filesystem to use:
</p>
<pre>
<configuration>
@@ -81,6 +79,13 @@
</description>
</property>
+ <property>
+ <name>hbase.rootdir</name>
+ <value>FULLY_QUALIFIED_PATH</value>
+ <description>The directory shared by region servers.
+ </description>
+ </property>
+
</configuration>
</pre>
<p>
@@ -88,12 +93,6 @@
host per line (This file is synonymous to the slaves file at
<code>${HADOOP_HOME}/conf/slaves</code>).
</p>
-<h3><a name="additional" >Additional Notes on Distributed Operation</a></h3>
-<ul>
-<li>Hadoop and Hbase must be set up on each host you plan to use.</li>
-<li>Additional (optional) Hbase-specific variables such as HBASE_HEAPSIZE and HBASE_CLASSPATH
-can be set in <code>${HBASE_HOME}/conf/hbase-env.sh</code>.</li>
-</ul>
<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
@@ -111,8 +110,9 @@
</pre>
<p>
Once Hbase has started, enter <code>${HBASE_HOME}/bin/hbase shell</code> to obtain a
-shell against Hbase from which you can execute Hbase commands. In the Hbase shell, type
-<code>help;</code> to see a list of supported commands. Note that all commands in the Hbase
+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
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
@@ -126,16 +126,16 @@
before stopping the Hadoop daemons.
</p>
<p>
-The default location for logs is <code>${HADOOP_HOME}/logs</code>.
+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>
<h2><a name="upgrading" >Upgrading</a></h2>
-<p>After installing the new hbase, before starting your cluster, run the
+<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.
+the hbase version (It does not change your install unless you explicitly ask it to).
</p>
<h2><a name="related" >Related Documentation</a></h2>