From 9fa72c0177683d34ab1187c89902041acc1ac07c Mon Sep 17 00:00:00 2001 From: Michael Stack Date: Tue, 18 Mar 2008 22:32:14 +0000 Subject: [PATCH] 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 --- CHANGES.txt | 1 + README.txt | 2 +- build.xml | 1 - docs/index.html | 7 ++ docs/index.pdf | 67 ++++++++++------- docs/linkmap.html | 9 +++ docs/linkmap.pdf | 24 +++--- .../src/documentation/content/xdocs/index.xml | 1 + .../src/documentation/content/xdocs/site.xml | 2 + .../hadoop/hbase/regionserver/HRegion.java | 1 - src/java/overview.html | 74 ++++++++++--------- 11 files changed, 113 insertions(+), 76 deletions(-) diff --git a/CHANGES.txt b/CHANGES.txt index efeb59e74d1..c7c2d756102 100644 --- a/CHANGES.txt +++ b/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 diff --git a/README.txt b/README.txt index 44e996dd461..c9683121b95 100644 --- a/README.txt +++ b/README.txt @@ -1 +1 @@ -See http://wiki.apache.org/lucene-hadoop/Hbase +See the docs directory or http://hbase.org diff --git a/build.xml b/build.xml index 36ec100b7ba..2078c522fde 100644 --- a/build.xml +++ b/build.xml @@ -285,7 +285,6 @@ - diff --git a/docs/index.html b/docs/index.html index 27d56fc0b08..34c23691ead 100644 --- a/docs/index.html +++ b/docs/index.html @@ -108,6 +108,9 @@ document.write("Last Published: " + document.lastModified);
Overview
+Getting Started +
+
API Docs
@@ -152,6 +155,10 @@ document.write("Last Published: " + document.lastModified);
    +
  • +Getting Started +
    • +
  • API Docs
    • diff --git a/docs/index.pdf b/docs/index.pdf index 8e430dabb22..835d1086af9 100644 --- a/docs/index.pdf +++ b/docs/index.pdf @@ -5,10 +5,10 @@ /Producer (FOP 0.20.5) >> endobj 5 0 obj -<< /Length 740 /Filter [ /ASCII85Decode /FlateDecode ] +<< /Length 810 /Filter [ /ASCII85Decode /FlateDecode ] >> stream -Gat=)a`?,Y(r#;b3$pF574_W&G$DH?WG+3<6dpZ;@7_,83$?n<[kC2YG`g%1n\P3Ts''p\//.L$M?$ZoZ%4,@4\&WOrshJ#5l%/^.]9V#9Rq&l)D9J,3q/"C"'L'brth0Orp-V!?_'+7mnm:@=W#ePa$oW*@C4*U9;JLC'm%e&'W0+D5Glb\PnfN-KAHhRGU,[2Aq>,$+P,s>J0M[,31<*OGS`;AXY+G*apM+M5>%"N+mYL`QE=mLj8t)=?>396HG,XOH$DfT48d3uK+/3t5umBJdA*4<@-3Sh]Hp,9/I(bo[rlb^eb^4fVmQ5JA`^%OlJiq2E-L?m+$)')!NA`V*#,7G6B2jr#u4,)f?/dI;n_@'NE^(I*b!]2,7ZZ4^H,S!OICAc3"`"/Dt +Gat=*c#T:-(qfGS3[QYb.YNK5BX`,QSsl+9*1@osaM7p'#D#$`qo[ng_@@WJ`s6sF^>8`g8FeNV^8sGI#t,oi39^.&3!a&T$]t4p+?Y\["@:?E5dU]EmX?]sam[&YbQ@J$m[Hc$/[(VQ.7A:hrds@3ihXB/*Tr*31'W.p3he%S2"^S$DBm;%*/Z4%6YXjtc-WU/q]`Gj&lBs&B2=AbF>?)>Bj5Xo6BfHL6&20c%E`t,1[&,O#%ZMhP"f1?4RLmo[ceAqL)*uRkt";L%=[*VLun0`C2th>$b`rQ*j_0)Ar;e^ZJptLG3cfMr&o)WSBa"er;[gu+W+*a\b@4Im^I]h[8]+&7nS;>5T)P3[I`H1US59E^_hT1YqjtO7B'5\;#"!Z$+oE,n/92:JYKpoHKs*5`F.>_>)(3e2SE=A-P.9iUt/dJRrn\\iZS%gg>b6D8RCboK]k)>$$RNnbJT7s&fUIIZWC:AdLRaa<6Wr#*IFJYJf*"akl1ZoXLVB%8%XYK@Z^ip62Y6[]mn)oNN+0jUUr%#1C4fA\9tlM,A&2iN-togcn_^ endstream endobj 6 0 obj @@ -26,6 +26,7 @@ endobj 9 0 R 10 0 R 11 0 R +12 0 R ] endobj 8 0 obj @@ -42,10 +43,10 @@ endobj 9 0 obj << /Type /Annot /Subtype /Link -/Rect [ 108.0 555.4 154.992 543.4 ] +/Rect [ 108.0 555.4 180.996 543.4 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] -/A << /URI (api/index.html) +/A << /URI (api/overview-summary.html#overview_description) /S /URI >> /H /I >> @@ -53,10 +54,10 @@ endobj 10 0 obj << /Type /Annot /Subtype /Link -/Rect [ 108.0 542.2 132.0 530.2 ] +/Rect [ 108.0 542.2 154.992 530.2 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] -/A << /URI (http://wiki.apache.org/hadoop/Hbase) +/A << /URI (api/index.html) /S /URI >> /H /I >> @@ -67,33 +68,44 @@ endobj /Rect [ 108.0 529.0 132.0 517.0 ] /C [ 0 0 0 ] /Border [ 0 0 0 ] -/A << /URI (http://wiki.apache.org/hadoop/Hbase/FAQ) +/A << /URI (http://wiki.apache.org/hadoop/Hbase) /S /URI >> /H /I >> endobj 12 0 obj +<< /Type /Annot +/Subtype /Link +/Rect [ 108.0 515.8 132.0 503.8 ] +/C [ 0 0 0 ] +/Border [ 0 0 0 ] +/A << /URI (http://wiki.apache.org/hadoop/Hbase/FAQ) +/S /URI >> +/H /I +>> +endobj +13 0 obj << /Type /Font /Subtype /Type1 /Name /F3 /BaseFont /Helvetica-Bold /Encoding /WinAnsiEncoding >> endobj -13 0 obj +14 0 obj << /Type /Font /Subtype /Type1 /Name /F5 /BaseFont /Times-Roman /Encoding /WinAnsiEncoding >> endobj -14 0 obj +15 0 obj << /Type /Font /Subtype /Type1 /Name /F1 /BaseFont /Helvetica /Encoding /WinAnsiEncoding >> endobj -15 0 obj +16 0 obj << /Type /Font /Subtype /Type1 /Name /F2 @@ -112,33 +124,34 @@ endobj endobj 3 0 obj << -/Font << /F3 12 0 R /F5 13 0 R /F1 14 0 R /F2 15 0 R >> +/Font << /F3 13 0 R /F5 14 0 R /F1 15 0 R /F2 16 0 R >> /ProcSet [ /PDF /ImageC /Text ] >> endobj xref -0 16 +0 17 0000000000 65535 f -0000002239 00000 n -0000002297 00000 n -0000002347 00000 n +0000002510 00000 n +0000002568 00000 n +0000002618 00000 n 0000000015 00000 n 0000000071 00000 n -0000000902 00000 n -0000001022 00000 n -0000001067 00000 n -0000001265 00000 n -0000001426 00000 n -0000001607 00000 n -0000001792 00000 n -0000001905 00000 n -0000002015 00000 n -0000002123 00000 n +0000000972 00000 n +0000001092 00000 n +0000001144 00000 n +0000001342 00000 n +0000001535 00000 n +0000001697 00000 n +0000001878 00000 n +0000002063 00000 n +0000002176 00000 n +0000002286 00000 n +0000002394 00000 n trailer << -/Size 16 +/Size 17 /Root 2 0 R /Info 4 0 R >> startxref -2459 +2730 %%EOF diff --git a/docs/linkmap.html b/docs/linkmap.html index 9506f296e60..de581d85940 100644 --- a/docs/linkmap.html +++ b/docs/linkmap.html @@ -108,6 +108,9 @@ document.write("Last Published: " + document.lastModified); Overview
+Getting Started +
+
API Docs
@@ -162,6 +165,12 @@ document.write("Last Published: " + document.lastModified); + +
  • API Docs  ___________________  api diff --git a/docs/linkmap.pdf b/docs/linkmap.pdf index 249aac4173e..ef3da569aa4 100644 --- a/docs/linkmap.pdf +++ b/docs/linkmap.pdf @@ -5,10 +5,10 @@ /Producer (FOP 0.20.5) >> endobj 5 0 obj -<< /Length 628 /Filter [ /ASCII85Decode /FlateDecode ] +<< /Length 666 /Filter [ /ASCII85Decode /FlateDecode ] >> stream -GatUpd;GF-'Sc(%$=BYHok\+W\4kXGgXN7(MR8;LW]Vtle:ln'^-4(QVZoq/O&DfcN$jdh\T4;],^XCeQgT?r!8lp)]65j#a?RXOZB:Aqn5/BeaS3X]7Q-H@mqq4q"KH]Jf%=KXNM@:(6:QR/XIWsQ0C?T^k,-aAX(DF2;8OqgfSY@@??g:e="q&atp&._T'G%*Z;]bJ1Q?W@citjAeb@qm;-9(j^:o12CDZ-_8MmaX%K..aMY1BnN<5S?C!=d_ogs)$83A"3ii&;FIY&;iX>hK[>ZX@;9lpUW&*d +GatUq?#Q2d'Sc)P'u!?plIj08E1+/X51F;IK%,^$W]VtlfGQtPn+.S#fN-dg:tQn@,k[GRP+kBS)Y2KT8+QGJ_uBn1@bKOOs"RQ(:U;gg546)@duC$k&k:Vf=EZA0_GVE"6/d/1BX$:c3$-D"HXk^gVmAs[h>d5=h%sMLT^i/cs-3RZ^!F>oWHE7EAFqB,>k7sPB![=;sb7)Y9Z68it6GM_'j\BIisEX;_1E*CLJ2KHE?h@8@<>N@Aku2I/>o1ni).G^bCYe:pR9E*.mYqJmq9t!;dDh^A&Y endstream endobj 6 0 obj @@ -72,17 +72,17 @@ endobj xref 0 12 0000000000 65535 f -0000001451 00000 n -0000001509 00000 n -0000001559 00000 n +0000001489 00000 n +0000001547 00000 n +0000001597 00000 n 0000000015 00000 n 0000000071 00000 n -0000000790 00000 n -0000000896 00000 n -0000001008 00000 n -0000001117 00000 n -0000001227 00000 n -0000001335 00000 n +0000000828 00000 n +0000000934 00000 n +0000001046 00000 n +0000001155 00000 n +0000001265 00000 n +0000001373 00000 n trailer << /Size 12 @@ -90,5 +90,5 @@ trailer /Info 4 0 R >> startxref -1679 +1717 %%EOF diff --git a/src/docs/src/documentation/content/xdocs/index.xml b/src/docs/src/documentation/content/xdocs/index.xml index e0d67d8494e..2b25a897a8a 100644 --- a/src/docs/src/documentation/content/xdocs/index.xml +++ b/src/docs/src/documentation/content/xdocs/index.xml @@ -30,6 +30,7 @@ mailing list or browse the archives.

      +
    • Getting Started
    • API Docs
    • Wiki
    • FAQ
      • diff --git a/src/docs/src/documentation/content/xdocs/site.xml b/src/docs/src/documentation/content/xdocs/site.xml index 090583ea11c..471fa1a82a0 100644 --- a/src/docs/src/documentation/content/xdocs/site.xml +++ b/src/docs/src/documentation/content/xdocs/site.xml @@ -33,6 +33,7 @@ See http://forrest.apache.org/docs/linking.html for more info. + @@ -54,6 +55,7 @@ See http://forrest.apache.org/docs/linking.html for more info. + diff --git a/src/java/org/apache/hadoop/hbase/regionserver/HRegion.java b/src/java/org/apache/hadoop/hbase/regionserver/HRegion.java index 9be83252f27..61358db3b48 100644 --- a/src/java/org/apache/hadoop/hbase/regionserver/HRegion.java +++ b/src/java/org/apache/hadoop/hbase/regionserver/HRegion.java @@ -1107,7 +1107,6 @@ public class HRegion implements HConstants { * ts. * * @param row row key - * @param ts * @return map of values * @throws IOException */ diff --git a/src/java/overview.html b/src/java/overview.html index 7f59b8b66ee..c7c33e10eb7 100644 --- a/src/java/overview.html +++ b/src/java/overview.html @@ -22,7 +22,7 @@ HBase -HBase is the Hadoop simple database. +HBase is the Hadoop simple database.

      Requirements

        @@ -31,58 +31,61 @@ HBase is the Hadoop simple databas

        Getting Started

        -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 Operation

        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).

        Running and Confirming Your Installation

        -

        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 migrate migration script. It will make any
-adjustments to the filesystem data under hbase.rootdir necessary 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 migrate migration script.
+It will make any adjustments to the filesystem data under hbase.rootdir necessary to run
+the HBase version. It does not change your install unless you explicitly ask it to.
 
        
 
 
        Related Documentation