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 2012/06/03 23:59:52 UTC
svn commit: r1345788 [9/10] - in /hbase/trunk: ./ hbase-assembly/
hbase-common/ hbase-server/ hbase-site/ src/ src/assembly/ src/docbkx/
src/site/ src/site/resources/ src/site/resources/css/
src/site/resources/images/ src/site/xdoc/ src/xslt/
Added: hbase/trunk/src/site/resources/css/freebsd_docbook.css
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/resources/css/freebsd_docbook.css?rev=1345788&view=auto
==============================================================================
--- hbase/trunk/src/site/resources/css/freebsd_docbook.css (added)
+++ hbase/trunk/src/site/resources/css/freebsd_docbook.css Sun Jun 3 21:59:50 2012
@@ -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;
+}
Added: hbase/trunk/src/site/resources/css/site.css
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/resources/css/site.css?rev=1345788&view=auto
==============================================================================
--- hbase/trunk/src/site/resources/css/site.css (added)
+++ hbase/trunk/src/site/resources/css/site.css Sun Jun 3 21:59:50 2012
@@ -0,0 +1,127 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+a.externalLink, a.externalLink:link, a.externalLink:visited, a.externalLink:active, a.externalLink:hover {
+ background: none;
+ padding-right: 0;
+}
+
+/*
+body ul {
+ list-style-type: square;
+}
+*/
+
+#downloadbox {
+ float: right;
+ margin: 0 10px 20px 20px;
+ padding: 5px;
+ border: 1px solid #999;
+ background-color: #eee;
+}
+
+#downloadbox h5 {
+ color: #000;
+ margin: 0;
+ border-bottom: 1px solid #aaaaaa;
+ font-size: smaller;
+ padding: 0;
+}
+
+#downloadbox p {
+ margin-top: 1em;
+ margin-bottom: 0;
+}
+
+#downloadbox ul {
+ margin-top: 0;
+ margin-bottom: 1em;
+ list-style-type: disc;
+}
+
+#downloadbox li {
+ font-size: smaller;
+}
+
+/*
+h4 {
+ padding: 0;
+ border: none;
+ color: #000;
+ margin: 0;
+ font-size: larger;
+ font-weight: bold;
+}
+*/
+
+#banner {
+ background: none;
+}
+
+#banner img {
+ padding: 10px;
+ margin: auto;
+ display: block;
+ background: none;
+ float: center;
+ height:;
+}
+
+#breadcrumbs {
+ background-image: url();
+}
+
+#footer {
+ border-top: 0px;
+}
+
+.frontpagebox {
+ float: left;
+ text-align: center;
+ width: 15em;
+ margin-left: 0.5em;
+ margin-right: 0.5em;
+ margin-top: 2em;
+}
+
+.headline {
+ font-size: 120%;
+ font-weight: bold;
+ padding-top: 1px;
+ padding-bottom: 5px;
+ background-image: url(../images/breadcrumbs.jpg);
+ background-repeat: repeat-x;
+}
+
+.section {
+ padding-bottom: 0;
+ padding-top: 0;
+}
+
+/*
+#leftColumn {
+ display: none !important
+}
+
+#bodyColumn {
+ margin-left: 1.5em;
+}
+*/
+
+
Added: hbase/trunk/src/site/resources/doap_Hbase.rdf
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/resources/doap_Hbase.rdf?rev=1345788&view=auto
==============================================================================
--- hbase/trunk/src/site/resources/doap_Hbase.rdf (added)
+++ hbase/trunk/src/site/resources/doap_Hbase.rdf Sun Jun 3 21:59:50 2012
@@ -0,0 +1,57 @@
+<?xml version="1.0"?>
+<?xml-stylesheet type="text/xsl"?>
+<rdf:RDF xml:lang="en"
+ xmlns="http://usefulinc.com/ns/doap#"
+ xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+ xmlns:asfext="http://projects.apache.org/ns/asfext#"
+ xmlns:foaf="http://xmlns.com/foaf/0.1/">
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+ <Project rdf:about="http://hbase.apache.org">
+ <created>2012-04-14</created>
+ <license rdf:resource="http://usefulinc.com/doap/licenses/asl20" />
+ <name>Apache HBase</name>
+ <homepage rdf:resource="http://hbase.apache.org" />
+ <asfext:pmc rdf:resource="http://hbase.apache.org" />
+ <shortdesc>Apache HBase software is the Hadoop database. Think of it as a distributed, scalable, big data store.</shortdesc>
+ <description>Use Apache HBase software when you need random, realtime read/write access to your Big Data. This project's goal is the hosting of very large tables -- billions of rows X millions of columns -- atop clusters of commodity hardware. HBase is an open-source, distributed, versioned, column-oriented store modeled after Google's Bigtable: A Distributed Storage System for Structured Data by Chang et al. Just as Bigtable leverages the distributed data storage provided by the Google File System, HBase provides Bigtable-like capabilities on top of Hadoop and HDFS. </description>
+ <bug-database rdf:resource="http://issues.apache.org/jira/browse/HBASE" />
+ <mailing-list rdf:resource="http://hbase.apache.org/mail-lists.html" />
+ <download-page rdf:resource="http://www.apache.org/dyn/closer.cgi/hbase/" />
+ <programming-language>Java</programming-language>
+ <category rdf:resource="http://projects.apache.org/category/database" />
+ <release>
+ <Version>
+ <name>Apache hbase 0.92.1</name>
+ <created>2012-03-19</created>
+ <revision>0.92.1</revision>
+ </Version>
+ </release>
+ <repository>
+ <SVNRepository>
+ <location rdf:resource="http://svn.apache.org/repos/asf/hbase"/>
+ <browse rdf:resource="http://svn.apache.org/viewvc/hbase"/>
+ </SVNRepository>
+ </repository>
+ <maintainer>
+ <foaf:Person>
+ <foaf:name>Apache HBase PMC</foaf:name>
+ <foaf:mbox rdf:resource="mailto:dev@hbase.apache.org"/>
+ </foaf:Person>
+ </maintainer>
+ </Project>
+</rdf:RDF>
Added: hbase/trunk/src/site/resources/images/architecture.gif
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/resources/images/architecture.gif?rev=1345788&view=auto
==============================================================================
Binary file - no diff available.
Propchange: hbase/trunk/src/site/resources/images/architecture.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: hbase/trunk/src/site/resources/images/favicon.ico
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/resources/images/favicon.ico?rev=1345788&view=auto
==============================================================================
Binary file - no diff available.
Propchange: hbase/trunk/src/site/resources/images/favicon.ico
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: hbase/trunk/src/site/resources/images/hadoop-logo.jpg
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/resources/images/hadoop-logo.jpg?rev=1345788&view=auto
==============================================================================
Binary file - no diff available.
Propchange: hbase/trunk/src/site/resources/images/hadoop-logo.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: hbase/trunk/src/site/resources/images/hbase_logo.png
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/resources/images/hbase_logo.png?rev=1345788&view=auto
==============================================================================
Binary file - no diff available.
Propchange: hbase/trunk/src/site/resources/images/hbase_logo.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: hbase/trunk/src/site/resources/images/hbase_logo.svg
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/resources/images/hbase_logo.svg?rev=1345788&view=auto
==============================================================================
--- hbase/trunk/src/site/resources/images/hbase_logo.svg (added)
+++ hbase/trunk/src/site/resources/images/hbase_logo.svg Sun Jun 3 21:59:50 2012
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 15.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+ width="792px" height="612px" viewBox="0 0 792 612" enable-background="new 0 0 792 612" xml:space="preserve">
+<path fill="#BA160C" d="M233.586,371.672h-9.895v-51.583h9.895V371.672L233.586,371.672z M223.691,307.6v-19.465h9.895V307.6
+ H223.691z M223.691,371.672h-9.896v-32.117h-63.584v32.117h-19.466v-83.537h19.466v31.954h55.128h8.457h9.896V371.672
+ L223.691,371.672z M223.691,288.135h-9.896V307.6h9.896V288.135z"/>
+<path fill="#BA160C" d="M335.939,329.334c6.812,4.218,10.219,10.652,10.219,19.303c0,6.272-2,11.571-6.002,15.897
+ c-4.325,4.758-10.165,7.137-17.519,7.137h-28.629v-19.465h28.629c2.812,0,4.218-2.109,4.218-6.327c0-4.216-1.406-6.325-4.218-6.325
+ h-28.629v-19.303h27.17c2.811,0,4.217-2.109,4.217-6.327c0-4.216-1.406-6.326-4.217-6.326h-27.17v-19.464h27.17
+ c7.353,0,13.192,2.379,17.519,7.137c3.892,4.325,5.839,9.625,5.839,15.896C344.536,318.954,341.67,325.009,335.939,329.334z
+ M294.008,371.672h-52.312v-51.42h19.466h5.259h27.588v19.303h-32.847v12.652h32.847V371.672L294.008,371.672z M294.008,307.599
+ h-32.847v0h-19.466v-19.465h52.312V307.599z"/>
+<path fill="#878888" d="M355.123,266.419v-8.92h14.532v-5.353c0-1.932-0.644-2.899-1.933-2.899h-12.6v-8.919h12.6
+ c3.223,0,5.836,1.164,7.842,3.494c2.007,2.33,3.011,5.104,3.011,8.325v26.463h-8.921v-12.19H355.123L355.123,266.419z
+ M473.726,278.61h-29.587c-3.469,0-6.417-1.152-8.845-3.458c-2.429-2.304-3.642-5.191-3.642-8.659v-14.049
+ c0-3.47,1.213-6.356,3.642-8.662c2.428-2.304,5.376-3.455,8.845-3.455h29.587v8.919h-29.587c-2.378,0-3.567,1.066-3.567,3.197
+ v14.049c0,2.131,1.189,3.196,3.567,3.196h29.587V278.61L473.726,278.61z M567.609,278.61h-8.996v-14.718h-22.895v14.718h-8.92
+ v-38.282h8.92v14.644h22.895v-14.644h8.996V278.61L567.609,278.61z M661.494,249.247h-31.889v5.725h29.807v8.92h-29.807v5.797
+ h31.814v8.92h-40.735v-38.282h40.809V249.247z M355.123,240.328v8.919h-12.674c-1.239,0-1.858,0.967-1.858,2.899v5.353h5.575h2.435
+ h6.522v8.92h-6.522h-2.435h-5.575v12.19h-8.92v-26.463c0-3.221,1.004-5.996,3.011-8.325c2.006-2.33,4.596-3.494,7.768-3.494H355.123
+ L355.123,240.328z M254.661,266.122v-8.92h13.083c1.288,0,1.933-1.313,1.933-3.939c0-2.676-0.645-4.015-1.933-4.015h-13.083v-8.919
+ h13.083c3.32,0,5.995,1.363,8.028,4.088c1.883,2.478,2.825,5.425,2.825,8.846c0,3.419-0.942,6.342-2.825,8.771
+ c-2.033,2.725-4.708,4.088-8.028,4.088H254.661z M177.649,278.61h-8.92v-12.19h-14.532v-8.92h14.532v-5.353
+ c0-1.932-0.644-2.899-1.932-2.899h-12.6v-8.919h12.6c3.222,0,5.835,1.164,7.842,3.494c2.007,2.33,3.01,5.104,3.01,8.325V278.61
+ L177.649,278.61z M254.661,240.328v8.919h-15.016v7.954h15.016v8.92h-15.016v12.488h-8.92v-38.282H254.661z M154.198,266.419h-7.604
+ h-1.354h-5.575v12.19h-8.92v-26.463c0-3.221,1.004-5.996,3.01-8.325c2.007-2.33,4.597-3.494,7.768-3.494h12.674v8.919h-12.674
+ c-1.239,0-1.858,0.967-1.858,2.899v5.353h5.575h1.354h7.604V266.419z"/>
+<path fill="#BA160C" d="M456.325,371.672H436.86V345.07h-31.094h-0.618v-19.466h0.618h31.094v-11.68
+ c0-4.216-1.406-6.324-4.218-6.324h-27.494v-19.465h27.494c7.03,0,12.733,2.541,17.114,7.623c4.379,5.083,6.569,11.139,6.569,18.167
+ V371.672z M405.148,345.07h-19.547h-12.165v26.602h-19.466v-57.748c0-7.028,2.19-13.083,6.569-18.167
+ c4.379-5.083,10.03-7.623,16.952-7.623h27.656V307.6h-27.656c-2.704,0-4.055,2.108-4.055,6.324v11.68h12.165h19.547V345.07z"/>
+<path fill="#BA160C" d="M564.329,345.88c0,7.03-2.109,13.031-6.327,18.006c-4.541,5.19-10.273,7.786-17.193,7.786h-72.02v-19.465
+ h72.02c2.704,0,4.055-2.109,4.055-6.327c0-4.216-1.352-6.325-4.055-6.325h-52.394c-6.92,0-12.652-2.596-17.193-7.787
+ c-4.327-4.865-6.49-10.813-6.49-17.843c0-7.028,2.218-13.083,6.651-18.167c4.434-5.083,10.112-7.623,17.032-7.623h72.021v19.464
+ h-72.021c-2.703,0-4.055,2.109-4.055,6.326c0,4.109,1.352,6.164,4.055,6.164h52.394c6.92,0,12.652,2.596,17.193,7.787
+ C562.22,332.85,564.329,338.852,564.329,345.88z"/>
+<polygon fill="#BA160C" points="661.494,307.599 591.906,307.599 591.906,320.089 656.952,320.089 656.952,339.555 591.906,339.555
+ 591.906,352.207 661.331,352.207 661.331,371.672 572.44,371.672 572.44,288.135 661.494,288.135 "/>
+</svg>
Added: hbase/trunk/src/site/resources/images/hfile.png
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/resources/images/hfile.png?rev=1345788&view=auto
==============================================================================
Binary file - no diff available.
Propchange: hbase/trunk/src/site/resources/images/hfile.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: hbase/trunk/src/site/resources/images/hfilev2.png
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/resources/images/hfilev2.png?rev=1345788&view=auto
==============================================================================
Binary file - no diff available.
Propchange: hbase/trunk/src/site/resources/images/hfilev2.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: hbase/trunk/src/site/resources/images/replication_overview.png
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/resources/images/replication_overview.png?rev=1345788&view=auto
==============================================================================
Binary file - no diff available.
Propchange: hbase/trunk/src/site/resources/images/replication_overview.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: hbase/trunk/src/site/site.vm
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/site.vm?rev=1345788&view=auto
==============================================================================
--- hbase/trunk/src/site/site.vm (added)
+++ hbase/trunk/src/site/site.vm Sun Jun 3 21:59:50 2012
@@ -0,0 +1,544 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+#*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+*#
+<!-- Generated by Apache Maven Doxia at $dateFormat.format( $currentDate ) -->
+#macro ( link $href $name $target $img $position $alt $border $width $height )
+ #set ( $linkTitle = ' title="' + $name + '"' )
+ #if( $target )
+ #set ( $linkTarget = ' target="' + $target + '"' )
+ #else
+ #set ( $linkTarget = "" )
+ #end
+ #if ( ( $href.toLowerCase().startsWith("http") || $href.toLowerCase().startsWith("https") ) )
+ #set ( $linkClass = ' class="externalLink"' )
+ #else
+ #set ( $linkClass = "" )
+ #end
+ #if ( $img )
+ #if ( $position == "left" )
+ <a href="$href"$linkClass$linkTarget$linkTitle>#image($img $alt $border $width $height)$name</a>
+ #else
+ <a href="$href"$linkClass$linkTarget$linkTitle>$name #image($img $alt $border $width $height)</a>
+ #end
+ #else
+ <a href="$href"$linkClass$linkTarget$linkTitle>$name</a>
+ #end
+#end
+##
+#macro ( image $img $alt $border $width $height )
+ #if( $img )
+ #if ( ! ( $img.toLowerCase().startsWith("http") || $img.toLowerCase().startsWith("https") ) )
+ #set ( $imgSrc = $PathTool.calculateLink( $img, $relativePath ) )
+ #set ( $imgSrc = $imgSrc.replaceAll( "\\", "/" ) )
+ #set ( $imgSrc = ' src="' + $imgSrc + '"' )
+ #else
+ #set ( $imgSrc = ' src="' + $img + '"' )
+ #end
+ #if( $alt )
+ #set ( $imgAlt = ' alt="' + $alt + '"' )
+ #else
+ #set ( $imgAlt = ' alt=""' )
+ #end
+ #if( $border )
+ #set ( $imgBorder = ' border="' + $border + '"' )
+ #else
+ #set ( $imgBorder = "" )
+ #end
+ #if( $width )
+ #set ( $imgWidth = ' width="' + $width + '"' )
+ #else
+ #set ( $imgWidth = "" )
+ #end
+ #if( $height )
+ #set ( $imgHeight = ' height="' + $height + '"' )
+ #else
+ #set ( $imgHeight = "" )
+ #end
+ <img class="imageLink"$imgSrc$imgAlt$imgBorder$imgWidth$imgHeight/>
+ #end
+#end
+#macro ( banner $banner $id )
+ #if ( $banner )
+ #if( $banner.href )
+ <a href="$banner.href" id="$id"#if( $banner.alt ) title="$banner.alt"#end>
+ #else
+ <div id="$id">
+ #end
+##
+ #if( $banner.src )
+ #set ( $src = $banner.src )
+ #if ( ! ( $src.toLowerCase().startsWith("http") || $src.toLowerCase().startsWith("https") ) )
+ #set ( $src = $PathTool.calculateLink( $src, $relativePath ) )
+ #set ( $src = $src.replaceAll( "\\", "/" ) )
+ #end
+ #if ( $banner.alt )
+ #set ( $alt = $banner.alt )
+ #else
+ #set ( $alt = $banner.name )
+ #end
+ <img src="$src" alt="$alt" />
+ #else
+ $banner.name
+ #end
+##
+ #if( $banner.href )
+ </a>
+ #else
+ </div>
+ #end
+ #end
+#end
+##
+#macro ( links $links )
+ #set ( $counter = 0 )
+ #foreach( $item in $links )
+ #set ( $counter = $counter + 1 )
+ #set ( $currentItemHref = $PathTool.calculateLink( $item.href, $relativePath ) )
+ #set ( $currentItemHref = $currentItemHref.replaceAll( "\\", "/" ) )
+ #link( $currentItemHref $item.name $item.target $item.img $item.position $item.alt $item.border $item.width $item.height )
+ #if ( $links.size() > $counter )
+ |
+ #end
+ #end
+#end
+##
+#macro ( breadcrumbs $breadcrumbs )
+ #set ( $counter = 0 )
+ #foreach( $item in $breadcrumbs )
+ #set ( $counter = $counter + 1 )
+ #set ( $currentItemHref = $PathTool.calculateLink( $item.href, $relativePath ) )
+ #set ( $currentItemHref = $currentItemHref.replaceAll( "\\", "/" ) )
+##
+ #if ( $currentItemHref == $alignedFileName || $currentItemHref == "" )
+ $item.name
+ #else
+ #link( $currentItemHref $item.name $item.target $item.img $item.position $item.alt $item.border $item.width $item.height )
+ #end
+ #if ( $breadcrumbs.size() > $counter )
+ >
+ #end
+ #end
+#end
+##
+#macro ( displayTree $display $item )
+ #if ( $item && $item.items && $item.items.size() > 0 )
+ #foreach( $subitem in $item.items )
+ #set ( $subitemHref = $PathTool.calculateLink( $subitem.href, $relativePath ) )
+ #set ( $subitemHref = $subitemHref.replaceAll( "\\", "/" ) )
+ #if ( $alignedFileName == $subitemHref )
+ #set ( $display = true )
+ #end
+##
+ #displayTree( $display $subitem )
+ #end
+ #end
+#end
+##
+#macro ( menuItem $item )
+ #set ( $collapse = "none" )
+ #set ( $currentItemHref = $PathTool.calculateLink( $item.href, $relativePath ) )
+ #set ( $currentItemHref = $currentItemHref.replaceAll( "\\", "/" ) )
+##
+ #if ( $item && $item.items && $item.items.size() > 0 )
+ #if ( $item.collapse == false )
+ #set ( $collapse = "expanded" )
+ #else
+ ## By default collapsed
+ #set ( $collapse = "collapsed" )
+ #end
+##
+ #set ( $display = false )
+ #displayTree( $display $item )
+##
+ #if ( $alignedFileName == $currentItemHref || $display )
+ #set ( $collapse = "expanded" )
+ #end
+ #end
+ <li class="$collapse">
+ #if ( $item.img )
+ #if ( $item.position == "left" )
+ #if ( $alignedFileName == $currentItemHref )
+ <strong>#image($item.img $item.alt $item.border $item.width $item.height) $item.name</strong>
+ #else
+ #link($currentItemHref $item.name $item.target $item.img $item.position $item.alt $item.border $item.width $item.height)
+ #end
+ #else
+ #if ( $alignedFileName == $currentItemHref )
+ <strong>$item.name #image($item.img $item.alt $item.border $item.width $item.height)</strong>
+ #else
+ #link($currentItemHref $item.name $item.target $item.img $item.position $item.alt $item.border $item.width $item.height)
+ #end
+ #end
+ #else
+ #if ( $alignedFileName == $currentItemHref )
+ <strong>$item.name</strong>
+ #else
+ #link( $currentItemHref $item.name $item.target $item.img $item.position $item.alt $item.border $item.width $item.height )
+ #end
+ #end
+ #if ( $item && $item.items && $item.items.size() > 0 )
+ #if ( $collapse == "expanded" )
+ <ul>
+ #foreach( $subitem in $item.items )
+ #menuItem( $subitem )
+ #end
+ </ul>
+ #end
+ #end
+ </li>
+#end
+##
+#macro ( mainMenu $menus )
+ #foreach( $menu in $menus )
+ #if ( $menu.name )
+ #if ( $menu.img )
+ #if( $menu.position )
+ #set ( $position = $menu.position )
+ #else
+ #set ( $position = "left" )
+ #end
+##
+ #if ( ! ( $menu.img.toLowerCase().startsWith("http") || $menu.img.toLowerCase().startsWith("https") ) )
+ #set ( $src = $PathTool.calculateLink( $menu.img, $relativePath ) )
+ #set ( $src = $src.replaceAll( "\\", "/" ) )
+ #set ( $src = ' src="' + $src + '"' )
+ #else
+ #set ( $src = ' src="' + $menu.img + '"' )
+ #end
+##
+ #if( $menu.alt )
+ #set ( $alt = ' alt="' + $menu.alt + '"' )
+ #else
+ #set ( $alt = ' alt="' + $menu.name + '"' )
+ #end
+##
+ #if( $menu.border )
+ #set ( $border = ' border="' + $menu.border + '"' )
+ #else
+ #set ( $border = ' border="0"' )
+ #end
+##
+ #if( $menu.width )
+ #set ( $width = ' width="' + $menu.width + '"' )
+ #else
+ #set ( $width = "" )
+ #end
+ #if( $menu.height )
+ #set ( $height = ' height="' + $menu.height + '"' )
+ #else
+ #set ( $height = "" )
+ #end
+##
+ #set ( $img = '<img class="imageLink"' + $src + $alt + $border + $width + $height + "/>" )
+##
+ #if ( $position == "left" )
+ <h5>$img $menu.name</h5>
+ #else
+ <h5>$menu.name $img</h5>
+ #end
+ #else
+ <h5>$menu.name</h5>
+ #end
+ #end
+ #if ( $menu.items && $menu.items.size() > 0 )
+ <ul>
+ #foreach( $item in $menu.items )
+ #menuItem( $item )
+ #end
+ </ul>
+ #end
+ #end
+#end
+##
+#macro ( copyright )
+ #if ( $project )
+ #if ( ${project.organization} && ${project.organization.name} )
+ #set ( $period = "" )
+ #else
+ #set ( $period = "." )
+ #end
+##
+ #set ( $currentYear = ${currentDate.year} + 1900 )
+##
+ #if ( ${project.inceptionYear} && ( ${project.inceptionYear} != ${currentYear.toString()} ) )
+ ${project.inceptionYear}-${currentYear}${period}
+ #else
+ ${currentYear}${period}
+ #end
+##
+ #if ( ${project.organization} )
+ #if ( ${project.organization.name} && ${project.organization.url} )
+ <a href="$project.organization.url">${project.organization.name}</a>.
+ #elseif ( ${project.organization.name} )
+ ${project.organization.name}.
+ #end
+ #end
+ #end
+#end
+##
+#macro ( publishDate $position $publishDate $version )
+ #if ( $publishDate && $publishDate.format )
+ #set ( $format = $publishDate.format )
+ #else
+ #set ( $format = "yyyy-MM-dd" )
+ #end
+##
+ $dateFormat.applyPattern( $format )
+##
+ #set ( $dateToday = $dateFormat.format( $currentDate ) )
+##
+ #if ( $publishDate && $publishDate.position )
+ #set ( $datePosition = $publishDate.position )
+ #else
+ #set ( $datePosition = "left" )
+ #end
+##
+ #if ( $version )
+ #if ( $version.position )
+ #set ( $versionPosition = $version.position )
+ #else
+ #set ( $versionPosition = "left" )
+ #end
+ #else
+ #set ( $version = "" )
+ #set ( $versionPosition = "left" )
+ #end
+##
+ #set ( $breadcrumbs = $decoration.body.breadcrumbs )
+ #set ( $links = $decoration.body.links )
+
+ #if ( $datePosition.equalsIgnoreCase( "right" ) && $links && $links.size() > 0 )
+ #set ( $prefix = " |" )
+ #else
+ #set ( $prefix = "" )
+ #end
+##
+ #if ( $datePosition.equalsIgnoreCase( $position ) )
+ #if ( ( $datePosition.equalsIgnoreCase( "right" ) ) || ( $datePosition.equalsIgnoreCase( "bottom" ) ) )
+ $prefix <span id="publishDate">$i18n.getString( "site-renderer", $locale, "template.lastpublished" ): $dateToday</span>
+ #if ( $versionPosition.equalsIgnoreCase( $position ) )
+ | <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span>
+ #end
+ #elseif ( ( $datePosition.equalsIgnoreCase( "navigation-bottom" ) ) || ( $datePosition.equalsIgnoreCase( "navigation-top" ) ) )
+ <div id="lastPublished">
+ <span id="publishDate">$i18n.getString( "site-renderer", $locale, "template.lastpublished" ): $dateToday</span>
+ #if ( $versionPosition.equalsIgnoreCase( $position ) )
+ | <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span>
+ #end
+ </div>
+ #elseif ( $datePosition.equalsIgnoreCase("left") )
+ <div class="xleft">
+ <span id="publishDate">$i18n.getString( "site-renderer", $locale, "template.lastpublished" ): $dateToday</span>
+ #if ( $versionPosition.equalsIgnoreCase( $position ) )
+ | <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span>
+ #end
+ #if ( $breadcrumbs && $breadcrumbs.size() > 0 )
+ | #breadcrumbs( $breadcrumbs )
+ #end
+ </div>
+ #end
+ #elseif ( $versionPosition.equalsIgnoreCase( $position ) )
+ #if ( ( $versionPosition.equalsIgnoreCase( "right" ) ) || ( $versionPosition.equalsIgnoreCase( "bottom" ) ) )
+ $prefix <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span>
+ #elseif ( ( $versionPosition.equalsIgnoreCase( "navigation-bottom" ) ) || ( $versionPosition.equalsIgnoreCase( "navigation-top" ) ) )
+ <div id="lastPublished">
+ <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span>
+ </div>
+ #elseif ( $versionPosition.equalsIgnoreCase("left") )
+ <div class="xleft">
+ <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span>
+ #if ( $breadcrumbs && $breadcrumbs.size() > 0 )
+ | #breadcrumbs( $breadcrumbs )
+ #end
+ </div>
+ #end
+ #elseif ( $position.equalsIgnoreCase( "left" ) )
+ #if ( $breadcrumbs && $breadcrumbs.size() > 0 )
+ <div class="xleft">
+ #breadcrumbs( $breadcrumbs )
+ </div>
+ #end
+ #end
+#end
+##
+#macro ( poweredByLogo $poweredBy )
+ #if( $poweredBy )
+ #foreach ($item in $poweredBy)
+ #if( $item.href )
+ #set ( $href = $PathTool.calculateLink( $item.href, $relativePath ) )
+ #set ( $href = $href.replaceAll( "\\", "/" ) )
+ #else
+ #set ( $href="http://maven.apache.org/" )
+ #end
+##
+ #if( $item.name )
+ #set ( $name = $item.name )
+ #else
+ #set ( $name = $i18n.getString( "site-renderer", $locale, "template.builtby" ) )
+ #set ( $name = "${name} Maven" )
+ #end
+##
+ #if( $item.img )
+ #set ( $img = $item.img )
+ #else
+ #set ( $img = "images/logos/maven-feather.png" )
+ #end
+##
+ #if ( ! ( $img.toLowerCase().startsWith("http") || $img.toLowerCase().startsWith("https") ) )
+ #set ( $img = $PathTool.calculateLink( $img, $relativePath ) )
+ #set ( $img = $src.replaceAll( "\\", "/" ) )
+ #end
+##
+ #if( $item.alt )
+ #set ( $alt = ' alt="' + $item.alt + '"' )
+ #else
+ #set ( $alt = ' alt="' + $name + '"' )
+ #end
+##
+ #if( $item.border )
+ #set ( $border = ' border="' + $item.border + '"' )
+ #else
+ #set ( $border = "" )
+ #end
+##
+ #if( $item.width )
+ #set ( $width = ' width="' + $item.width + '"' )
+ #else
+ #set ( $width = "" )
+ #end
+ #if( $item.height )
+ #set ( $height = ' height="' + $item.height + '"' )
+ #else
+ #set ( $height = "" )
+ #end
+##
+ <a href="$href" title="$name" class="poweredBy">
+ <img class="poweredBy" $alt src="$img" $border $width $height />
+ </a>
+ #end
+ #if( $poweredBy.isEmpty() )
+ <a href="http://maven.apache.org/" title="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" class="poweredBy">
+ <img class="poweredBy" alt="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" src="$relativePath/images/logos/maven-feather.png" />
+ </a>
+ #end
+ #else
+ <a href="http://maven.apache.org/" title="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" class="poweredBy">
+ <img class="poweredBy" alt="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" src="$relativePath/images/logos/maven-feather.png" />
+ </a>
+ #end
+#end
+##
+<html xmlns="http://www.w3.org/1999/xhtml"#if ( $locale ) xml:lang="$locale.language" lang="$locale.language"#end>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=${outputEncoding}" />
+ <title>$title</title>
+ <style type="text/css" media="all">
+ @import url("$relativePath/css/maven-base.css");
+ @import url("$relativePath/css/maven-theme.css");
+ @import url("$relativePath/css/site.css");
+ </style>
+ <link rel="stylesheet" href="$relativePath/css/print.css" type="text/css" media="print" />
+ <link rel="shortcut icon" href="/images/favicon.ico" />
+#foreach( $author in $authors )
+ <meta name="author" content="$author" />
+#end
+#if ( $dateCreation )
+ <meta name="Date-Creation-yyyymmdd" content="$dateCreation" />
+#end
+#if ( $dateRevision )
+ <meta name="Date-Revision-yyyymmdd" content="$dateRevision" />
+#end
+#if ( $locale )
+ <meta http-equiv="Content-Language" content="$locale.language" />
+#end
+ #if ( $decoration.body.head )
+ #foreach( $item in $decoration.body.head.getChildren() )
+ ## Workaround for DOXIA-150 due to a non-desired behaviour in p-u
+ ## @see org.codehaus.plexus.util.xml.Xpp3Dom#toString()
+ ## @see org.codehaus.plexus.util.xml.Xpp3Dom#toUnescapedString()
+ #set ( $documentHeader = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" )
+ #set ( $documentHeader = $documentHeader.replaceAll( "\\", "" ) )
+ #if ( $item.name == "script" )
+ $StringUtils.replace( $item.toUnescapedString(), $documentHeader, "" )
+ #else
+ $StringUtils.replace( $item.toString(), $documentHeader, "" )
+ #end
+ #end
+ #end
+ ## $headContent
+<!--Google Analytics-->
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-30210968-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ #banner( $decoration.bannerLeft "bannerLeft" )
+ <!-- Commented out since we do not use it. St.Ack 20110906
+ -->
+ ## #banner( $decoration.bannerRight "bannerRight" )
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+ <div class="xright" style="padding-left: 8px; margin-top: -4px;">
+ <form method="GET" action="http://search-hadoop.com/">
+ <input type="text" style="width: 192px; height: 15px; font-size: inherit; border: 1px solid darkgray" name="q" value="Search wiki, mailing lists & more" onfocus="this.value=''"/>
+ <input type="hidden" name="fc_project" value="HBase"/>
+ <button style="height: 20px; width: 60px;">Search</button>
+ </form>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+ #publishDate( "navigation-top" $decoration.publishDate $decoration.version )
+ #mainMenu( $decoration.body.menus )
+ #poweredByLogo( $decoration.poweredBy )
+ #publishDate( "navigation-bottom" $decoration.publishDate $decoration.version )
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ $bodyContent
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright"> #publishDate( "right" $decoration.publishDate $decoration.version ) | Copyright ©#copyright()All Rights Reserved. </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: hbase/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/site.xml?rev=1345788&view=auto
==============================================================================
--- hbase/trunk/src/site/site.xml (added)
+++ hbase/trunk/src/site/site.xml Sun Jun 3 21:59:50 2012
@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+-->
+
+
+<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
+ <bannerLeft>
+ <name>HBase</name>
+ <src>images/hbase_logo.png</src>
+ <href>http://hbase.apache.org/</href>
+ </bannerLeft>
+ <bannerRight />
+ <version position="right" />
+ <publishDate position="right" />
+ <body>
+ <menu name="HBase Project">
+ <item name="Overview" href="index.html"/>
+ <item name="License" href="license.html" />
+ <item name="Downloads" href="http://www.apache.org/dyn/closer.cgi/hbase/" />
+ <item name="Release Notes" href="https://issues.apache.org/jira/browse/HBASE?report=com.atlassian.jira.plugin.system.project:changelog-panel#selectedTab=com.atlassian.jira.plugin.system.project%3Achangelog-panel" />
+ <item name="Issue Tracking" href="issue-tracking.html" />
+ <item name="Mailing Lists" href="mail-lists.html" />
+ <item name="Source Repository" href="source-repository.html" />
+ <item name="ReviewBoard" href="https://reviews.apache.org"/>
+ <item name="Team" href="team-list.html" />
+ <item name="Sponsors" href="sponsors.html" />
+ <item name="Blog" href="http://blogs.apache.org/hbase/" />
+ </menu>
+ <menu name="Documentation">
+ <item name="Getting Started" href="book/quickstart.html" />
+ <item name="API" href="apidocs/index.html" />
+ <item name="X-Ref" href="xref/index.html" />
+ <item name="Ref Guide (multi-page)" href="book/book.html" />
+ <item name="Ref Guide (single-page)" href="book.html" />
+ <item name="FAQ" href="book/faq.html" />
+ <item name="Videos/Presentations" href="book.html#other.info" />
+ <item name="Wiki" href="http://wiki.apache.org/hadoop/Hbase" />
+ <item name="ACID Semantics" href="acid-semantics.html" />
+ <item name="Bulk Loads" href="book.html#arch.bulk.load" />
+ <item name="Metrics" href="metrics.html" />
+ <item name="HBase on Windows" href="cygwin.html" />
+ <item name="Cluster replication" href="replication.html" />
+ </menu>
+ </body>
+ <skin>
+ <groupId>org.apache.maven.skins</groupId>
+ <artifactId>maven-stylus-skin</artifactId>
+ </skin>
+</project>
Added: hbase/trunk/src/site/xdoc/acid-semantics.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/xdoc/acid-semantics.xml?rev=1345788&view=auto
==============================================================================
--- hbase/trunk/src/site/xdoc/acid-semantics.xml (added)
+++ hbase/trunk/src/site/xdoc/acid-semantics.xml Sun Jun 3 21:59:50 2012
@@ -0,0 +1,232 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2010 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
+ "http://forrest.apache.org/dtd/document-v20.dtd">
+
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
+ <properties>
+ <title>
+ HBase ACID Properties
+ </title>
+ </properties>
+
+ <body>
+ <section name="About this Document">
+ <p>HBase is not an ACID compliant database. However, it does guarantee certain specific
+ properties.</p>
+ <p>This specification enumerates the ACID properties of HBase.</p>
+ </section>
+ <section name="Definitions">
+ <p>For the sake of common vocabulary, we define the following terms:</p>
+ <dl>
+ <dt>Atomicity</dt>
+ <dd>an operation is atomic if it either completes entirely or not at all</dd>
+
+ <dt>Consistency</dt>
+ <dd>
+ all actions cause the table to transition from one valid state directly to another
+ (eg a row will not disappear during an update, etc)
+ </dd>
+
+ <dt>Isolation</dt>
+ <dd>
+ an operation is isolated if it appears to complete independently of any other concurrent transaction
+ </dd>
+
+ <dt>Durability</dt>
+ <dd>any update that reports "successful" to the client will not be lost</dd>
+
+ <dt>Visibility</dt>
+ <dd>an update is considered visible if any subsequent read will see the update as having been committed</dd>
+ </dl>
+ <p>
+ The terms <em>must</em> and <em>may</em> are used as specified by RFC 2119.
+ In short, the word "must" implies that, if some case exists where the statement
+ is not true, it is a bug. The word "may" implies that, even if the guarantee
+ is provided in a current release, users should not rely on it.
+ </p>
+ </section>
+ <section name="APIs to consider">
+ <ul>
+ <li>Read APIs
+ <ul>
+ <li>get</li>
+ <li>scan</li>
+ </ul>
+ </li>
+ <li>Write APIs</li>
+ <ul>
+ <li>put</li>
+ <li>batch put</li>
+ <li>delete</li>
+ </ul>
+ <li>Combination (read-modify-write) APIs</li>
+ <ul>
+ <li>incrementColumnValue</li>
+ <li>checkAndPut</li>
+ </ul>
+ </ul>
+ </section>
+
+ <section name="Guarantees Provided">
+
+ <section name="Atomicity">
+
+ <ol>
+ <li>All mutations are atomic within a row. Any put will either wholely succeed or wholely fail.[3]</li>
+ <ol>
+ <li>An operation that returns a "success" code has completely succeeded.</li>
+ <li>An operation that returns a "failure" code has completely failed.</li>
+ <li>An operation that times out may have succeeded and may have failed. However,
+ it will not have partially succeeded or failed.</li>
+ </ol>
+ <li> This is true even if the mutation crosses multiple column families within a row.</li>
+ <li> APIs that mutate several rows will _not_ be atomic across the multiple rows.
+ For example, a multiput that operates on rows 'a','b', and 'c' may return having
+ mutated some but not all of the rows. In such cases, these APIs will return a list
+ of success codes, each of which may be succeeded, failed, or timed out as described above.</li>
+ <li> The checkAndPut API happens atomically like the typical compareAndSet (CAS) operation
+ found in many hardware architectures.</li>
+ <li> The order of mutations is seen to happen in a well-defined order for each row, with no
+ interleaving. For example, if one writer issues the mutation "a=1,b=1,c=1" and
+ another writer issues the mutation "a=2,b=2,c=2", the row must either
+ be "a=1,b=1,c=1" or "a=2,b=2,c=2" and must <em>not</em> be something
+ like "a=1,b=2,c=1".</li>
+ <ol>
+ <li>Please note that this is not true _across rows_ for multirow batch mutations.</li>
+ </ol>
+ </ol>
+ </section>
+ <section name="Consistency and Isolation">
+ <ol>
+ <li>All rows returned via any access API will consist of a complete row that existed at
+ some point in the table's history.</li>
+ <li>This is true across column families - i.e a get of a full row that occurs concurrent
+ with some mutations 1,2,3,4,5 will return a complete row that existed at some point in time
+ between mutation i and i+1 for some i between 1 and 5.</li>
+ <li>The state of a row will only move forward through the history of edits to it.</li>
+ </ol>
+
+ <section name="Consistency of Scans">
+ <p>
+ A scan is <strong>not</strong> a consistent view of a table. Scans do
+ <strong>not</strong> exhibit <em>snapshot isolation</em>.
+ </p>
+ <p>
+ Rather, scans have the following properties:
+ </p>
+
+ <ol>
+ <li>
+ Any row returned by the scan will be a consistent view (i.e. that version
+ of the complete row existed at some point in time) [1]
+ </li>
+ <li>
+ A scan will always reflect a view of the data <em>at least as new as</em>
+ the beginning of the scan. This satisfies the visibility guarantees
+ enumerated below.</li>
+ <ol>
+ <li>For example, if client A writes data X and then communicates via a side
+ channel to client B, any scans started by client B will contain data at least
+ as new as X.</li>
+ <li>A scan _must_ reflect all mutations committed prior to the construction
+ of the scanner, and _may_ reflect some mutations committed subsequent to the
+ construction of the scanner.</li>
+ <li>Scans must include <em>all</em> data written prior to the scan (except in
+ the case where data is subsequently mutated, in which case it _may_ reflect
+ the mutation)</li>
+ </ol>
+ </ol>
+ <p>
+ Those familiar with relational databases will recognize this isolation level as "read committed".
+ </p>
+ <p>
+ Please note that the guarantees listed above regarding scanner consistency
+ are referring to "transaction commit time", not the "timestamp"
+ field of each cell. That is to say, a scanner started at time <em>t</em> may see edits
+ with a timestamp value greater than <em>t</em>, if those edits were committed with a
+ "forward dated" timestamp before the scanner was constructed.
+ </p>
+ </section>
+ </section>
+ <section name="Visibility">
+ <ol>
+ <li> When a client receives a "success" response for any mutation, that
+ mutation is immediately visible to both that client and any client with whom it
+ later communicates through side channels. [3]</li>
+ <li> A row must never exhibit so-called "time-travel" properties. That
+ is to say, if a series of mutations moves a row sequentially through a series of
+ states, any sequence of concurrent reads will return a subsequence of those states.</li>
+ <ol>
+ <li>For example, if a row's cells are mutated using the "incrementColumnValue"
+ API, a client must never see the value of any cell decrease.</li>
+ <li>This is true regardless of which read API is used to read back the mutation.</li>
+ </ol>
+ <li> Any version of a cell that has been returned to a read operation is guaranteed to
+ be durably stored.</li>
+ </ol>
+
+ </section>
+ <section name="Durability">
+ <ol>
+ <li> All visible data is also durable data. That is to say, a read will never return
+ data that has not been made durable on disk[2]</li>
+ <li> Any operation that returns a "success" code (eg does not throw an exception)
+ will be made durable.[3]</li>
+ <li> Any operation that returns a "failure" code will not be made durable
+ (subject to the Atomicity guarantees above)</li>
+ <li> All reasonable failure scenarios will not affect any of the guarantees of this document.</li>
+
+ </ol>
+ </section>
+ <section name="Tunability">
+ <p>All of the above guarantees must be possible within HBase. For users who would like to trade
+ off some guarantees for performance, HBase may offer several tuning options. For example:</p>
+ <ul>
+ <li>Visibility may be tuned on a per-read basis to allow stale reads or time travel.</li>
+ <li>Durability may be tuned to only flush data to disk on a periodic basis</li>
+ </ul>
+ </section>
+ </section>
+ <section name="More Information">
+ <p>
+ For more information, see the <a href="book.html#client">client architecture</a> or <a href="book.html#datamodel">data model</a> sections in the HBase Reference Guide.
+ </p>
+ </section>
+
+ <section name="Footnotes">
+ <p>[1] A consistent view is not guaranteed intra-row scanning -- i.e. fetching a portion of
+ a row in one RPC then going back to fetch another portion of the row in a subsequent RPC.
+ Intra-row scanning happens when you set a limit on how many values to return per Scan#next
+ (See <a href="http://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Scan.html#setBatch(int)">Scan#setBatch(int)</a>).
+ </p>
+
+ <p>[2] In the context of HBase, "durably on disk" implies an hflush() call on the transaction
+ log. This does not actually imply an fsync() to magnetic media, but rather just that the data has been
+ written to the OS cache on all replicas of the log. In the case of a full datacenter power loss, it is
+ possible that the edits are not truly durable.</p>
+ <p>[3] Puts will either wholely succeed or wholely fail, provided that they are actually sent
+ to the RegionServer. If the writebuffer is used, Puts will not be sent until the writebuffer is filled
+ or it is explicitly flushed.</p>
+
+ </section>
+
+ </body>
+</document>
Added: hbase/trunk/src/site/xdoc/bulk-loads.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/xdoc/bulk-loads.xml?rev=1345788&view=auto
==============================================================================
--- hbase/trunk/src/site/xdoc/bulk-loads.xml (added)
+++ hbase/trunk/src/site/xdoc/bulk-loads.xml Sun Jun 3 21:59:50 2012
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2010 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
+ <properties>
+ <title>
+ Bulk Loads in HBase
+ </title>
+ </properties>
+ <body>
+ <p>This page has been retired. The contents have been moved to the
+ <a href="http://hbase.apache.org/book.html#arch.bulk.load">Bulk Loading</a> section
+ in the Reference Guide.
+ </p>
+ </body>
+</document>
Added: hbase/trunk/src/site/xdoc/cygwin.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/xdoc/cygwin.xml?rev=1345788&view=auto
==============================================================================
--- hbase/trunk/src/site/xdoc/cygwin.xml (added)
+++ hbase/trunk/src/site/xdoc/cygwin.xml Sun Jun 3 21:59:50 2012
@@ -0,0 +1,242 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2010 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
+ <properties>
+ <title>Installing HBase on Windows using Cygwin</title>
+ </properties>
+
+<body>
+<section name="Introduction">
+<p><a title="HBase project" href="http://hbase.apache.org" target="_blank">HBase</a> is a distributed, column-oriented store, modeled after Google's <a title="Google's BigTable" href="http://research.google.com/archive/bigtable.html" target="_blank">BigTable</a>. HBase is built on top of <a title="Hadoop project" href="http://hadoop.apache.org">Hadoop</a> for its <a title="Hadoop MapReduce project" href="http://hadoop.apache.org/mapreduce" target="_blank">MapReduce </a>and <a title="Hadoop DFS project" href="http://hadoop.apache.org/hdfs">distributed file system</a> implementation. All these projects are open-source and part of the <a title="The Apache Software Foundation" href="http://www.apache.org/" target="_blank">Apache Software Foundation</a>.</p>
+
+<p style="text-align: justify; ">As being distributed, large scale platforms, the Hadoop and HBase projects mainly focus on <em><strong>*nix</strong></em><strong> environments</strong> for production installations. However, being developed in <strong>Java</strong>, both projects are fully <strong>portable</strong> across platforms and, hence, also to the <strong>Windows operating system</strong>. For ease of development the projects rely on <a title="Cygwin site" href="http://www.cygwin.com/" target="_blank">Cygwin</a> to have a *nix-like environment on Windows to run the shell scripts.</p>
+</section>
+<section name="Purpose">
+<p style="text-align: justify; ">This document explains the <strong>intricacies of running HBase on Windows using Cygwin</strong> as an all-in-one single-node installation for testing and development. The HBase <a title="HBase Overview" href="http://hbase.apache.org/apidocs/overview-summary.html#overview_description" target="_blank">Overview</a> and <a title="HBase QuickStart" href="http://hbase.apache.org/book/quickstart.html" target="_blank">QuickStart</a> guides on the other hand go a long way in explaning how to setup <a title="HBase project" href="http://hadoop.apache.org/hbase" target="_blank">HBase</a> in more complex deployment scenario's.</p>
+</section>
+
+<section name="Installation">
+<p style="text-align: justify; ">For running HBase on Windows, 3 technologies are required: <strong>Java, Cygwin and SSH</strong>. The following paragraphs detail the installation of each of the aforementioned technologies.</p>
+<section name="Java">
+<p style="text-align: justify; ">HBase depends on the <a title="Java Platform, Standard Edition, 6 Release" href="http://java.sun.com/javase/6/" target="_blank">Java Platform, Standard Edition, 6 Release</a>. So the target system has to be provided with at least the Java Runtime Environment (JRE); however if the system will also be used for development, the Jave Development Kit (JDK) is preferred. You can download the latest versions for both from <a title="Java SE Downloads" href="http://java.sun.com/javase/downloads/index.jsp" target="_blank">Sun's download page</a>. Installation is a simple GUI wizard that guides you through the process.</p>
+</section>
+<section name="Cygwin">
+<p style="text-align: justify; ">Cygwin is probably the oddest technology in this solution stack. It provides a dynamic link library that emulates most of a *nix environment on Windows. On top of that a whole bunch of the most common *nix tools are supplied. Combined, the DLL with the tools form a very *nix-alike environment on Windows.</p>
+
+<p style="text-align: justify; ">For installation, Cygwin provides the <a title="Cygwin Setup Utility" href="http://cygwin.com/setup.exe" target="_blank"><strong><code>setup.exe</code> utility</strong></a> that tracks the versions of all installed components on the target system and provides the mechanism for <strong>installing</strong> or <strong>updating </strong>everything from the mirror sites of Cygwin.</p>
+
+<p style="text-align: justify; ">To support installation, the <code>setup.exe</code> utility uses 2 directories on the target system. The <strong>Root</strong> directory for Cygwin (defaults to <code>C:\cygwin)</code> which will become <code>/</code> within the eventual Cygwin installation; and the <strong>Local Package </strong>directory (e.g. <code>C:\cygsetup</code> that is the cache where <code>setup.exe</code> stores the packages before they are installed. The cache must not be the same folder as the Cygwin root.</p>
+
+<p style="text-align: justify; ">Perform following steps to install Cygwin, which are elaboratly detailed in the <a title="Setting Up Cygwin" href="http://cygwin.com/cygwin-ug-net/setup-net.html" target="_self">2nd chapter</a> of the <a title="Cygwin User's Guide" href="http://cygwin.com/cygwin-ug-net/cygwin-ug-net.html" target="_blank">Cygwin User's Guide</a>:</p>
+
+<ol style="text-align: justify; ">
+ <li>Make sure you have <code>Administrator</code> privileges on the target system.</li>
+ <li>Choose and create you <strong>Root</strong> and <strong>Local Package</strong> directories. A good suggestion is to use <code>C:\cygwin\root</code> and <code>C:\cygwin\setup</code> folders.</li>
+ <li>Download the <code>setup.exe</code> utility and save it to the <strong>Local Package</strong> directory.</li>
+ <li>Run the <code>setup.exe</code> utility,
+<ol>
+ <li>Choose the <code>Install from Internet</code> option,</li>
+ <li>Choose your <strong>Root</strong> and <strong>Local Package</strong> folders</li>
+ <li>and select an appropriate mirror.</li>
+ <li>Don't select any additional packages yet, as we only want to install Cygwin for now.</li>
+ <li>Wait for download and install</li>
+ <li>Finish the installation</li>
+</ol>
+</li>
+ <li>Optionally, you can now also add a shortcut to your Start menu pointing to the <code>setup.exe</code> utility in the <strong>Local Package </strong>folder.</li>
+ <li>Add <code>CYGWIN_HOME</code> system-wide environment variable that points to your <strong>Root </strong>directory.</li>
+ <li>Add <code>%CYGWIN_HOME%\bin</code> to the end of your <code>PATH</code> environment variable.</li>
+ <li>Reboot the sytem after making changes to the environment variables otherwise the OS will not be able to find the Cygwin utilities.</li>
+ <li>Test your installation by running your freshly created shortcuts or the <code>Cygwin.bat</code> command in the <strong>Root</strong> folder. You should end up in a terminal window that is running a <a title="Bash Reference Manual" href="http://www.gnu.org/software/bash/manual/bashref.html" target="_blank">Bash shell</a>. Test the shell by issuing following commands:
+<ol>
+ <li><code>cd /</code> should take you to thr <strong>Root</strong> directory in Cygwin;</li>
+ <li>the <code>LS</code> commands that should list all files and folders in the current directory.</li>
+ <li>Use the <code>exit</code> command to end the terminal.</li>
+</ol>
+</li>
+ <li>When needed, to <strong>uninstall</strong> Cygwin you can simply delete the <strong>Root</strong> and <strong>Local Package</strong> directory, and the <strong>shortcuts</strong> that were created during installation.</li>
+</ol>
+</section>
+<section name="SSH">
+<p style="text-align: justify; ">HBase (and Hadoop) rely on <a title="Secure Shell" href="http://nl.wikipedia.org/wiki/Secure_Shell" target="_blank"><strong>SSH</strong></a> for interprocess/-node <strong>communication</strong> and launching<strong> remote commands</strong>. SSH will be provisioned on the target system via Cygwin, which supports running Cygwin programs as <strong>Windows services</strong>!</p>
+
+<ol style="text-align: justify; ">
+ <li>Rerun the <code><strong>setup.exe</strong></code><strong> utility</strong>.</li>
+ <li>Leave all parameters as is, skipping through the wizard using the <code>Next</code> button until the <code>Select Packages</code> panel is shown.</li>
+ <li>Maximize the window and click the <code>View</code> button to toggle to the list view, which is ordered alfabetically on <code>Package</code>, making it easier to find the packages we'll need.</li>
+ <li>Select the following packages by clicking the status word (normally <code>Skip</code>) so it's marked for installation. Use the <code>Next </code>button to download and install the packages.
+<ol>
+ <li>OpenSSH</li>
+ <li>tcp_wrappers</li>
+ <li>diffutils</li>
+ <li>zlib</li>
+</ol>
+</li>
+ <li>Wait for the install to complete and finish the installation.</li>
+</ol>
+</section>
+<section name="HBase">
+<p style="text-align: justify; ">Download the <strong>latest release </strong>of HBase from the <a title="HBase Releases" href="http://www.apache.org/dyn/closer.cgi/hbase/" target="_blank">website</a>. As the HBase distributable is just a zipped archive, installation is as simple as unpacking the archive so it ends up in its final <strong>installation</strong> directory. Notice that HBase has to be installed in Cygwin and a good directory suggestion is to use <code>/usr/local/</code> (or [<code><strong>Root</strong> directory]\usr\local</code> in Windows slang). You should end up with a <code>/usr/local/hbase-<em><version></em></code> installation in Cygwin.</p>
+
+This finishes installation. We go on with the configuration.
+</section>
+</section>
+<section name="Configuration">
+<p style="text-align: justify; ">There are 3 parts left to configure: <strong>Java, SSH and HBase</strong> itself. Following paragraphs explain eacht topic in detail.</p>
+<section name="Java">
+<p style="text-align: justify; ">One important thing to remember in shell scripting in general (i.e. *nix and Windows) is that managing, manipulating and assembling path names that contains spaces can be very hard, due to the need to escape and quote those characters and strings. So we try to stay away from spaces in path names. *nix environments can help us out here very easily by using <strong>symbolic links</strong>.</p>
+
+<ol style="text-align: justify; ">
+ <li style="text-align: justify; ">Create a link in <code>/usr/local</code> to the Java home directory by using the following command and substituting the name of your chosen Java environment:
+<pre>LN -s /cygdrive/c/Program\ Files/Java/<em><jre name> </em>/usr/local/<em><jre name></em></pre>
+</li>
+ <li>Test your java installation by changing directories to your Java folder <code>CD /usr/local/<em><jre name></em></code> and issueing the command <code>./bin/java -version</code>. This should output your version of the chosen JRE.</li>
+</ol>
+</section>
+<section>
+<title>SSH</title>
+<p style="text-align: justify; ">Configuring <strong>SSH </strong>is quite elaborate, but primarily a question of launching it by default as a<strong> Windows service</strong>.</p>
+
+<ol style="text-align: justify; ">
+ <li style="text-align: justify; ">On Windows Vista and above make sure you run the Cygwin shell with <strong>elevated privileges</strong>, by right-clicking on the shortcut an using <code>Run as Administrator</code>.</li>
+ <li style="text-align: justify; ">First of all, we have to make sure the <strong>rights on some crucial files</strong> are correct. Use the commands underneath. You can verify all rights by using the <code>LS -L</code> command on the different files. Also, notice the auto-completion feature in the shell using <code><TAB></code> is extremely handy in these situations.
+<ol>
+ <li><code>chmod +r /etc/passwd</code> to make the passwords file readable for all</li>
+ <li><code>chmod u+w /etc/passwd</code> to make the passwords file writable for the owner</li>
+ <li><code>chmod +r /etc/group</code> to make the groups file readable for all</li>
+</ol>
+<ol>
+ <li><code>chmod u+w /etc/group</code> to make the groups file writable for the owner</li>
+</ol>
+<ol>
+ <li><code>chmod 755 /var</code> to make the var folder writable to owner and readable and executable to all</li>
+</ol>
+</li>
+ <li>Edit the <strong>/etc/hosts.allow</strong> file using your favorite editor (why not VI in the shell!) and make sure the following two lines are in there before the <code>PARANOID</code> line:
+<ol>
+ <li><code>ALL : localhost 127.0.0.1/32 : allow</code></li>
+ <li><code>ALL : [::1]/128 : allow</code></li>
+</ol>
+</li>
+ <li>Next we have to <strong>configure SSH</strong> by using the script <code>ssh-host-config</code>
+<ol>
+ <li>If this script asks to overwrite an existing <code>/etc/ssh_config</code>, answer <code>yes</code>.</li>
+ <li>If this script asks to overwrite an existing <code>/etc/sshd_config</code>, answer <code>yes</code>.</li>
+ <li>If this script asks to use privilege separation, answer <code>yes</code>.</li>
+ <li>If this script asks to install <code>sshd</code> as a service, answer <code>yes</code>. Make sure you started your shell as Adminstrator!</li>
+ <li>If this script asks for the CYGWIN value, just <code><enter></code> as the default is <code>ntsec</code>.</li>
+ <li>If this script asks to create the <code>sshd</code> account, answer <code>yes</code>.</li>
+ <li>If this script asks to use a different user name as service account, answer <code>no</code> as the default will suffice.</li>
+ <li>If this script asks to create the <code>cyg_server</code> account, answer <code>yes</code>. Enter a password for the account.</li>
+</ol>
+</li>
+ <li><strong>Start the SSH service</strong> using <code>net start sshd</code> or <code>cygrunsrv --start sshd</code>. Notice that <code>cygrunsrv</code> is the utility that make the process run as a Windows service. Confirm that you see a message stating that <code>the CYGWIN sshd service was started succesfully.</code></li>
+ <li>Harmonize Windows and Cygwin<strong> user account</strong> by using the commands:
+<ol>
+ <li><code>mkpasswd -cl > /etc/passwd</code></li>
+ <li><code>mkgroup --local > /etc/group</code></li>
+</ol>
+</li>
+ <li><strong>Test </strong>the installation of SSH:
+<ol>
+ <li>Open a new Cygwin terminal</li>
+ <li>Use the command <code>whoami</code> to verify your userID</li>
+ <li>Issue an <code>ssh localhost</code> to connect to the system itself
+<ol>
+ <li>Answer <code>yes</code> when presented with the server's fingerprint</li>
+ <li>Issue your password when prompted</li>
+ <li>test a few commands in the remote session</li>
+ <li>The <code>exit</code> command should take you back to your first shell in Cygwin</li>
+</ol>
+</li>
+ <li><code>Exit</code> should terminate the Cygwin shell.</li>
+</ol>
+</li>
+</ol>
+</section>
+<section name="HBase">
+If all previous configurations are working properly, we just need some tinkering at the <strong>HBase config</strong> files to properly resolve on Windows/Cygwin. All files and paths referenced here start from the HBase <code>[<strong>installation</strong> directory]</code> as working directory.
+<ol>
+ <li>HBase uses the <code>./conf/<strong>hbase-env.sh</strong></code> to configure its dependencies on the runtime environment. Copy and uncomment following lines just underneath their original, change them to fit your environemnt. They should read something like:
+<ol>
+ <li><code>export JAVA_HOME=/usr/local/<em><jre name></em></code></li>
+ <li><code>export HBASE_IDENT_STRING=$HOSTNAME</code> as this most likely does not inlcude spaces.</li>
+</ol>
+</li>
+ <li>HBase uses the ./conf/<code><strong>hbase-default.xml</strong></code> file for configuration. Some properties do not resolve to existing directories because the JVM runs on Windows. This is the major issue to keep in mind when working with Cygwin: within the shell all paths are *nix-alike, hence relative to the root <code>/</code>. However, every parameter that is to be consumed within the windows processes themself, need to be Windows settings, hence <code>C:\</code>-alike. Change following propeties in the configuration file, adjusting paths where necessary to conform with your own installation:
+<ol>
+ <li><code>hbase.rootdir</code> must read e.g. <code>file:///C:/cygwin/root/tmp/hbase/data</code></li>
+ <li><code>hbase.tmp.dir</code> must read <code>C:/cygwin/root/tmp/hbase/tmp</code></li>
+ <li><code>hbase.zookeeper.quorum</code> must read <code>127.0.0.1</code> because for some reason <code>localhost</code> doesn't seem to resolve properly on Cygwin.</li>
+</ol>
+</li>
+ <li>Make sure the configured <code>hbase.rootdir</code> and <code>hbase.tmp.dir</code> <strong>directories exist</strong> and have the proper<strong> rights</strong> set up e.g. by issuing a <code>chmod 777</code> on them.</li>
+</ol>
+</section>
+</section>
+<section>
+<title>Testing</title>
+<p>
+This should conclude the installation and configuration of HBase on Windows using Cygwin. So it's time <strong>to test it</strong>.
+<ol>
+ <li>Start a Cygwin<strong> terminal</strong>, if you haven't already.</li>
+ <li>Change directory to HBase <strong>installation</strong> using <code>CD /usr/local/hbase-<em><version></em></code>, preferably using auto-completion.</li>
+ <li><strong>Start HBase</strong> using the command <code>./bin/start-hbase.sh</code>
+<ol>
+ <li>When prompted to accept the SSH fingerprint, answer <code>yes</code>.</li>
+ <li>When prompted, provide your password. Maybe multiple times.</li>
+ <li>When the command completes, the HBase server should have started.</li>
+ <li>However, to be absolutely certain, check the logs in the <code>./logs</code> directory for any exceptions.</li>
+</ol>
+</li>
+ <li>Next we <strong>start the HBase shell</strong> using the command <code>./bin/hbase shell</code></li>
+ <li>We run some simple <strong>test commands</strong>
+<ol>
+ <li>Create a simple table using command <code>create 'test', 'data'</code></li>
+ <li>Verify the table exists using the command <code>list</code></li>
+ <li>Insert data into the table using e.g.
+<pre>put 'test', 'row1', 'data:1', 'value1'
+put 'test', 'row2', 'data:2', 'value2'
+put 'test', 'row3', 'data:3', 'value3'</pre>
+</li>
+ <li>List all rows in the table using the command <code>scan 'test'</code> that should list all the rows previously inserted. Notice how 3 new columns where added without changing the schema!</li>
+ <li>Finally we get rid of the table by issuing <code>disable 'test'</code> followed by <code>drop 'test'</code> and verified by <code>list</code> which should give an empty listing.</li>
+</ol>
+</li>
+ <li><strong>Leave the shell</strong> by <code>exit</code></li>
+ <li>To <strong>stop the HBase server</strong> issue the <code>./bin/stop-hbase.sh</code> command. And wait for it to complete!!! Killing the process might corrupt your data on disk.</li>
+ <li>In case of <strong>problems</strong>,
+<ol>
+ <li>verify the HBase logs in the <code>./logs</code> directory.</li>
+ <li>Try to fix the problem</li>
+ <li>Get help on the forums or IRC (<code>#hbase@freenode.net</code>). People are very active and keen to help out!</li>
+ <li>Stopr, restart and retest the server.</li>
+</ol>
+</li>
+</ol>
+</p>
+</section>
+
+<section name="Conclusion">
+<p>
+Now your <strong>HBase </strong>server is running, <strong>start coding</strong> and build that next killer app on this particular, but scalable datastore!
+</p>
+</section>
+</body>
+</document>
Added: hbase/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/xdoc/index.xml?rev=1345788&view=auto
==============================================================================
--- hbase/trunk/src/site/xdoc/index.xml (added)
+++ hbase/trunk/src/site/xdoc/index.xml Sun Jun 3 21:59:50 2012
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2010 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
+ <properties>
+ <title>HBase Home</title>
+ <link rel="shortcut icon" href="/images/favicon.ico" />
+ </properties>
+
+ <body>
+ <section name="Welcome to Apache HBase!">
+ <p>HBase is the <a href="http://hadoop.apache.org">Hadoop</a> database. Think of it as a distributed, scalable, big data store.
+ </p>
+ <h4>When Would I Use HBase?</h4>
+ <p>
+ Use HBase when you need random, realtime read/write access to your Big Data.
+ This project's goal is the hosting of very large tables -- billions of rows X millions of columns -- atop clusters of commodity hardware.
+HBase is an open-source, distributed, versioned, column-oriented store modeled after Google's <a href="http://research.google.com/archive/bigtable.html">Bigtable: A Distributed Storage System for Structured Data</a> by Chang et al.
+ Just as Bigtable leverages the distributed data storage provided by the Google File System, HBase provides Bigtable-like capabilities on top of Hadoop and HDFS.
+ </p>
+ <h4>Features</h4>
+ <p>
+<ul>
+ <li>Linear and modular scalability.
+</li>
+ <li>Strictly consistent reads and writes.
+</li>
+ <li>Automatic and configurable sharding of tables
+</li>
+ <li>Automatic failover support between RegionServers.
+</li>
+ <li>Convenient base classes for backing Hadoop MapReduce jobs with HBase tables.
+</li>
+ <li>Easy to use Java API for client access.
+</li>
+ <li>Block cache and Bloom Filters for real-time queries.
+</li>
+ <li>Query predicate push down via server side Filters
+</li>
+ <li>Thrift gateway and a REST-ful Web service that supports XML, Protobuf, and binary data encoding options
+</li>
+ <li>Extensible jruby-based (JIRB) shell
+</li>
+ <li>Support for exporting metrics via the Hadoop metrics subsystem to files or Ganglia; or via JMX
+</li>
+</ul>
+</p>
+ <h4>Where Can I Get More Information?</h4>
+ <p>See the <a href="http://hbase.apache.org/book/architecture.html#arch.overview">Architecture Overview</a>, the <a href="http://hbase.apache.org/book/faq.html">Apache HBase Reference Guide FAQ</a>,
+ and the other documentation links on the left!
+ </p>
+ </section>
+ <section name="News">
+ <p>June 15th, 2012 <a href="http://www.meetup.com/hbaseusergroup/events/59829652/">Birds-of-a-feather</a> in San Jose, day after <a href="http://hadoopsummit.org">Hadoop Summit</a></p>
+ <p>May 23rd, 2012 <a href="http://www.meetup.com/hackathon/events/58953522/">HackConAthon</a> in Palo Alto</p>
+ <p>May 22nd, 2012 <a href="http://www.hbasecon.com">HBaseCon2012</a> in San Francisco</p>
+
+ <p><small><a href="old_news.html">Old News</a></small></p>
+ </section>
+ </body>
+
+</document>
Added: hbase/trunk/src/site/xdoc/metrics.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/src/site/xdoc/metrics.xml?rev=1345788&view=auto
==============================================================================
--- hbase/trunk/src/site/xdoc/metrics.xml (added)
+++ hbase/trunk/src/site/xdoc/metrics.xml Sun Jun 3 21:59:50 2012
@@ -0,0 +1,147 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2010 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
+ <properties>
+ <title>
+ HBase Metrics
+ </title>
+ </properties>
+
+ <body>
+ <section name="Introduction">
+ <p>
+ HBase emits Hadoop <a href="http://hadoop.apache.org/core/docs/current/api/org/apache/hadoop/metrics/package-summary.html">metrics</a>.
+ </p>
+ </section>
+ <section name="Setup">
+ <p>First read up on Hadoop <a href="http://hadoop.apache.org/core/docs/current/api/org/apache/hadoop/metrics/package-summary.html">metrics</a>.
+ If you are using ganglia, the <a href="http://wiki.apache.org/hadoop/GangliaMetrics">GangliaMetrics</a>
+ wiki page is useful read.</p>
+ <p>To have HBase emit metrics, edit <code>$HBASE_HOME/conf/hadoop-metrics.properties</code>
+ and enable metric 'contexts' per plugin. As of this writing, hadoop supports
+ <strong>file</strong> and <strong>ganglia</strong> plugins.
+ Yes, the hbase metrics files is named hadoop-metrics rather than
+ <em>hbase-metrics</em> because currently at least the hadoop metrics system has the
+ properties filename hardcoded. Per metrics <em>context</em>,
+ comment out the NullContext and enable one or more plugins instead.
+ </p>
+ <p>
+ If you enable the <em>hbase</em> context, on regionservers you'll see total requests since last
+ metric emission, count of regions and storefiles as well as a count of memstore size.
+ On the master, you'll see a count of the cluster's requests.
+ </p>
+ <p>
+ Enabling the <em>rpc</em> context is good if you are interested in seeing
+ metrics on each hbase rpc method invocation (counts and time taken).
+ </p>
+ <p>
+ The <em>jvm</em> context is
+ useful for long-term stats on running hbase jvms -- memory used, thread counts, etc.
+ As of this writing, if more than one jvm is running emitting metrics, at least
+ in ganglia, the stats are aggregated rather than reported per instance.
+ </p>
+ </section>
+
+ <section name="Using with JMX">
+ <p>
+ In addition to the standard output contexts supported by the Hadoop
+ metrics package, you can also export HBase metrics via Java Management
+ Extensions (JMX). This will allow viewing HBase stats in JConsole or
+ any other JMX client.
+ </p>
+ <section name="Enable HBase stats collection">
+ <p>
+ To enable JMX support in HBase, first edit
+ <code>$HBASE_HOME/conf/hadoop-metrics.properties</code> to support
+ metrics refreshing. (If you've running 0.94.1 and above, or have already configured
+ <code>hadoop-metrics.properties</code> for another output context,
+ you can skip this step).
+ </p>
+ <source>
+# Configuration of the "hbase" context for null
+hbase.class=org.apache.hadoop.metrics.spi.NullContextWithUpdateThread
+hbase.period=60
+
+# Configuration of the "jvm" context for null
+jvm.class=org.apache.hadoop.metrics.spi.NullContextWithUpdateThread
+jvm.period=60
+
+# Configuration of the "rpc" context for null
+rpc.class=org.apache.hadoop.metrics.spi.NullContextWithUpdateThread
+rpc.period=60
+ </source>
+ </section>
+ <section name="Setup JMX remote access">
+ <p>
+ For remote access, you will need to configure JMX remote passwords
+ and access profiles. Create the files:
+ </p>
+ <dl>
+ <dt><code>$HBASE_HOME/conf/jmxremote.passwd</code> (set permissions
+ to 600)</dt>
+ <dd>
+ <source>
+monitorRole monitorpass
+controlRole controlpass
+ </source>
+ </dd>
+
+ <dt><code>$HBASE_HOME/conf/jmxremote.access</code></dt>
+ <dd>
+ <source>
+monitorRole readonly
+controlRole readwrite
+ </source>
+ </dd>
+ </dl>
+ </section>
+ <section name="Configure JMX in HBase startup">
+ <p>
+ Finally, edit the <code>$HBASE_HOME/conf/hbase-env.sh</code>
+ script to add JMX support:
+ </p>
+ <dl>
+ <dt><code>$HBASE_HOME/conf/hbase-env.sh</code></dt>
+ <dd>
+ <p>Add the lines:</p>
+ <source>
+HBASE_JMX_OPTS="-Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.ssl=false"
+HBASE_JMX_OPTS="$HBASE_JMX_OPTS -Dcom.sun.management.jmxremote.password.file=$HBASE_HOME/conf/jmxremote.passwd"
+HBASE_JMX_OPTS="$HBASE_JMX_OPTS -Dcom.sun.management.jmxremote.access.file=$HBASE_HOME/conf/jmxremote.access"
+
+export HBASE_MASTER_OPTS="$HBASE_JMX_OPTS -Dcom.sun.management.jmxremote.port=10101"
+export HBASE_REGIONSERVER_OPTS="$HBASE_JMX_OPTS -Dcom.sun.management.jmxremote.port=10102"
+ </source>
+ </dd>
+ </dl>
+ <p>
+ After restarting the processes you want to monitor, you should now be
+ able to run JConsole (included with the JDK since JDK 5.0) to view
+ the statistics via JMX. HBase MBeans are exported under the
+ <strong><code>hadoop</code></strong> domain in JMX.
+ </p>
+ </section>
+ <section name="Understanding HBase Metrics">
+ <p>
+ For more information on understanding HBase metrics, see the <a href="book.html#hbase_metrics">metrics section</a> in the HBase Reference Guide.
+ </p>
+ </section>
+ </section>
+ </body>
+</document>