diff --git a/pom.xml b/pom.xml index d7ab45e1e5b..5f6e8729d87 100644 --- a/pom.xml +++ b/pom.xml @@ -282,6 +282,7 @@ true true ${basedir}/target/site/ + css/freebsd_docbook.css diff --git a/src/docbkx/book.xml b/src/docbkx/book.xml index 33c76815dae..5e50f5d2d6f 100644 --- a/src/docbkx/book.xml +++ b/src/docbkx/book.xml @@ -279,6 +279,7 @@ stopping hbase............... Just like Hadoop, HBase requires java 6 from Oracle. Usually you'll want to use the latest version available except the problematic u18 (u22 is the latest version as of this writing). +
<link xlink:href="http://hadoop.apache.org">hadoop</link> This version of HBase will only run on Hadoop 0.20.x. It will not run on hadoop 0.21.x as of this writing. @@ -286,10 +287,10 @@ Usually you'll want to use the latest version available except the problematic u Currently only the branch-0.20-append branch has this attribute. No official releases have been made from this branch as of this writing so you will have to build your own Hadoop from the tip of this branch - (or install Cloudera's CDH3 (as of this writing, it is in beta); it has the - 0.20-append patches needed to add a durable sync). + (or install Cloudera's CDH3 (as of this writing, it is in beta); + CDH has the 0.20-append patches needed to add a durable sync). See CHANGES.txt - in branch-0.20.-append to see list of patches involved. + in branch-0.20-append to see list of patches involved.
ssh ssh must be installed and sshd must be running to use Hadoop's scripts to manage remote Hadoop daemons. @@ -297,8 +298,13 @@ Usually you'll want to use the latest version available except the problematic u
DNS -Basic name resolving must be working correctly on your cluster. - + HBase uses the local hostname to self-report it's IP address. Both forward and reverse DNS resolving should work. + If your machine has multiple interfaces, HBase will use the interface that the primary hostname resolves to. + If this is insufficient, you can set hbase.regionserver.dns.interface to indicate the primary interface. + This only works if your cluster + configuration is consistent and every host has the same network interface configuration. + Another alternative is setting hbase.regionserver.dns.nameserver to choose a different nameserver than the + system wide default.
NTP @@ -306,6 +312,7 @@ Usually you'll want to use the latest version available except the problematic u wild skew could generate odd behaviors. Run NTP on your cluster, or an equivalent. + If you are having problems querying data, or "weird" cluster operations, check system time!
@@ -316,22 +323,47 @@ Usually you'll want to use the latest version available except the problematic u Any significant amount of loading will lead you to FAQ: Why do I see "java.io.IOException...(Too many open files)" in my logs?. You will also notice errors like: - 2010-04-06 03:04:37,542 INFO org.apache.hadoop.hdfs.DFSClient: Exception increateBlockOutputStream java.io.EOFException + + 2010-04-06 03:04:37,542 INFO org.apache.hadoop.hdfs.DFSClient: Exception increateBlockOutputStream java.io.EOFException 2010-04-06 03:04:37,542 INFO org.apache.hadoop.hdfs.DFSClient: Abandoning block blk_-6935524980745310745_1391901 Do yourself a favor and change the upper bound on the number of file descriptors. Set it to north of 10k. See the above referenced FAQ for how. To be clear, upping the file descriptors for the user who is running the HBase process is an operating system configuration, not an - HBase configuration. + HBase configuration. Also, a common mistake is that administrators + will up the file descriptors for a user but for whatever reason, + HBase is running as some other users. HBase prints in its logs + as the first line the ulimit its seeing. Ensure its whats expected. +
+ <varname>ulimit</varname> on Ubuntu + + If you are on Ubuntu you will need to make the following changes: + + In the file /etc/security/limits.conf add a line like: + hadoop - nofile 32768 + + Replace 'hadoop' with whatever user is running hadoop and hbase. If you have + separate users, you will need 2 entries, one for each user. + + + In the file /etc/pam.d/common-session add as the last line in the file: + session required pam_limits.so + + Otherwise the changes in /etc/security/limits.conf won't be applied. + + + Don't forget to log out and back in again for the changes to take place! + +
<varname>dfs.datanode.max.xcievers</varname> - Hadoop HDFS has an upper bound of files that it will serve at one same time, - called xcievers (yes, this is misspelled). Again, before + Hadoop HDFS datanodes have an upper bound on the number of files that it will serve at one same time. + The upper bound parameter is called xcievers (yes, this is misspelled). Again, before doing any loading, make sure you have configured Hadoop's conf/hdfs-site.xml setting the xceivers value to at least the following: @@ -341,6 +373,8 @@ Usually you'll want to use the latest version available except the problematic u </property> + Be sure to restart your HDFS after making the above configuration change so its picked + up by datanodes.
@@ -349,7 +383,7 @@ Usually you'll want to use the latest version available except the problematic u If you are running HBase on Windows, you must install Cygwin to have a *nix-like environment for the shell scripts. The full details -are explained in the Windows Installation +are explained in the Windows Installation guide.
@@ -366,23 +400,29 @@ set the heapsize for HBase, etc. At a minimum, set JAVA_HOME to poi your Java installation.
Standalone HBase - This mode is what Quick Start covered; - all daemons are run in the one JVM and HBase writes the local filesystem. + This is the default mode straight out of the box. Standalone mode is + what is described in the quickstart + section. In standalone mode, HBase does not use HDFS -- it uses the local + filesystem instead -- and it runs all HBase daemons and a local zookeeper + all up in the same JVM. Zookeeper binds to a well known port so clients may + talk to HBase. +
Distributed Distributed mode can be subdivided into distributed but all daemons run on a - single node AND distibuted with daemons spread across all nodes in the cluster. + single node -- i.e. pseudo-distributed mode -- AND + cluster distibuted with daemons spread across all + nodes in the cluster. - Distributed modes require an instance of the Hadoop Distributed File System (HDFS). -See the Hadoop -requirements and instructions for how to set up a HDFS. + Distributed modes require an instance of the + Hadoop Distributed File System (HDFS). See the + Hadoop + requirements and instructions for how to set up a HDFS. - -
Pseudo-distributed A pseudo-distributed mode is simply a distributed mode run on a single host. -Use this configuration testing and prototyping on hbase. Do not use this configuration +Use this configuration testing and prototyping on HBase. Do not use this configuration for production nor for evaluating HBase performance. Once you have confirmed your HDFS setup, configuring HBase for use on one host requires modification of @@ -417,23 +457,31 @@ it should run with one replica only (recommended for pseudo-distributed mode): -Let HBase create the directory. If you don't, you'll get warning saying HBase -needs a migration run because the directory is missing files expected by HBase (it'll +Let HBase create the hbase.rootdir +directory. If you don't, you'll get warning saying HBase +needs a migration run because the directory is missing files +expected by HBase (it'll create them if you let it). -Above we bind to localhost. This means that a remote client cannot -connect. Amend accordingly, if you want to connect from a remote location. +Above we bind to localhost. +This means that a remote client cannot +connect. Amend accordingly, if you want to +connect from a remote location. -
+
+Starting extra masters and regionservers when running pseudo-distributed +See Pseudo-distributed mode extras. +
+
-
Distributed across multiple machines +
Cluster Distributed For running a fully-distributed operation on more than one host, the following configurations must be made in addition to those described in the -pseudo-distributed operation section above. +pseudo-distributed section above. In hbase-site.xml, set hbase.cluster.distributed to true. @@ -503,7 +551,7 @@ to false so that HBase doesn't mess with your ZooKeeper set As an example, to have HBase manage a ZooKeeper quorum on nodes -rs{1,2,3,4,5}.example.com, bound to port 2222 (the default is 2181), use: +rs{1,2,3,4,5}.example.com, bound to port 2222 (the default is 2181), use: ${HBASE_HOME}/conf/hbase-env.sh: @@ -546,7 +594,7 @@ ${HBASE_HOME}/bin/hbase-daemons.sh {start,stop} zookeeper If you do let HBase manage ZooKeeper for you, make sure you configure -where it's data is stored. By default, it will be stored in /tmp which is +where it's data is stored. By default, it will be stored in /tmp which is sometimes cleaned in live systems. Do modify this configuration: <property> @@ -568,7 +616,7 @@ the ZooKeeper + + + + hbase.zookeeper.quorum + example1,example2,example3 + The directory shared by region servers. + + + +]]> + + +
@@ -934,6 +1004,24 @@ index e70ebc6..96f8c27 100644
+ + HBase and MapReduce + See HBase and MapReduce + up in javadocs. + + + + Metrics + See Metrics. + + + + + Cluster Replication + See Cluster Replication. + + + Data Model The HBase data model resembles that a traditional RDBMS. diff --git a/src/site/resources/css/freebsd_docbook.css b/src/site/resources/css/freebsd_docbook.css new file mode 100644 index 00000000000..3d40fa7010c --- /dev/null +++ b/src/site/resources/css/freebsd_docbook.css @@ -0,0 +1,208 @@ +/* + * Copyright (c) 2001, 2003, 2010 The FreeBSD Documentation Project + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * $FreeBSD: doc/share/misc/docbook.css,v 1.15 2010/03/20 04:15:01 hrs Exp $ + */ + +BODY ADDRESS { + line-height: 1.3; + margin: .6em 0; +} + +BODY BLOCKQUOTE { + margin-top: .75em; + line-height: 1.5; + margin-bottom: .75em; +} + +HTML BODY { + margin: 1em 8% 1em 10%; + line-height: 1.2; +} + +.LEGALNOTICE { + font-size: small; + font-variant: small-caps; +} + +BODY DIV { + margin: 0; +} + +DL { + margin: .8em 0; + line-height: 1.2; +} + +BODY FORM { + margin: .6em 0; +} + +H1, H2, H3, H4, H5, H6, +DIV.EXAMPLE P B, +.QUESTION, +DIV.TABLE P B, +DIV.PROCEDURE P B { + color: #990000; +} + +BODY H1, BODY H2, BODY H3, BODY H4, BODY H5, BODY H6 { + line-height: 1.3; + margin-left: 0; +} + +BODY H1, BODY H2 { + margin: .8em 0 0 -4%; +} + +BODY H3, BODY H4 { + margin: .8em 0 0 -3%; +} + +BODY H5 { + margin: .8em 0 0 -2%; +} + +BODY H6 { + margin: .8em 0 0 -1%; +} + +BODY HR { + margin: .6em; + border-width: 0 0 1px 0; + border-style: solid; + border-color: #cecece; +} + +BODY IMG.NAVHEADER { + margin: 0 0 0 -4%; +} + +OL { + margin: 0 0 0 5%; + line-height: 1.2; +} + +BODY PRE { + margin: .75em 0; + line-height: 1.0; + font-family: monospace; +} + +BODY TD, BODY TH { + line-height: 1.2; +} + +UL, BODY DIR, BODY MENU { + margin: 0 0 0 5%; + line-height: 1.2; +} + +HTML { + margin: 0; + padding: 0; +} + +BODY P B.APPLICATION { + color: #000000; +} + +.FILENAME { + color: #007a00; +} + +.GUIMENU, .GUIMENUITEM, .GUISUBMENU, +.GUILABEL, .INTERFACE, +.SHORTCUT, .SHORTCUT .KEYCAP { + font-weight: bold; +} + +.GUIBUTTON { + background-color: #CFCFCF; + padding: 2px; +} + +.ACCEL { + background-color: #F0F0F0; + text-decoration: underline; +} + +.SCREEN { + padding: 1ex; +} + +.PROGRAMLISTING { + padding: 1ex; + background-color: #eee; + border: 1px solid #ccc; +} + +@media screen { /* hide from IE3 */ + a[href]:hover { background: #ffa } +} + +BLOCKQUOTE.NOTE { + color: #222; + background: #eee; + border: 1px solid #ccc; + padding: 0.4em 0.4em; + width: 85%; +} + +BLOCKQUOTE.TIP { + color: #004F00; + background: #d8ecd6; + border: 1px solid green; + padding: 0.2em 2em; + width: 85%; +} + +BLOCKQUOTE.IMPORTANT { + font-style:italic; + border: 1px solid #a00; + border-left: 12px solid #c00; + padding: 0.1em 1em; +} + +BLOCKQUOTE.WARNING { + color: #9F1313; + background: #f8e8e8; + border: 1px solid #e59595; + padding: 0.2em 2em; + width: 85%; +} + +.EXAMPLE { + background: #fefde6; + border: 1px solid #f1bb16; + margin: 1em 0; + padding: 0.2em 2em; + width: 90%; +} + +.INFORMALTABLE TABLE.CALSTABLE TR TD { + padding-left: 1em; + padding-right: 1em; +}