Apache
/
hbase
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

DOC: Cleaned up TM, linked in the coprocessor blog 

git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@1484955 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
jxiang 2013-05-21 20:59:24 +00:00
parent f8a79db129
commit 76c35afd09
13 changed files with 23 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/main/docbkx/book.xml
View File

@ -45,7 +45,7 @@
</copyright>
<abstract>
<para>This is the official reference guide of
<link xlink:href="http://www.hbase.org">Apache HBase (TM)</link>,
<link xlink:href="http://www.hbase.org">Apache HBase&#153;</link>,
a distributed, versioned, column-oriented database built on top of
<link xlink:href="http://hadoop.apache.org/">Apache Hadoop</link> and
<link xlink:href="http://zookeeper.apache.org/">Apache ZooKeeper</link>.
@ -2150,6 +2150,7 @@ myHtd.setValue(HTableDescriptor.SPLIT_POLICY, MyCustomSplitPolicy.class.getName(
</chapter> <!-- architecture -->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="external_apis.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="cp.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="performance.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="troubleshooting.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="case_studies.xml" />

4
src/main/docbkx/case_studies.xml
View File

@ -26,11 +26,11 @@
* limitations under the License.
*/
-->
<title>Apache HBase (TM) Case Studies</title>
<title>Apache HBase Case Studies</title>
<section xml:id="casestudies.overview">
<title>Overview</title>
<para>This chapter will describe a variety of performance and troubleshooting case studies that can
provide a useful blueprint on diagnosing Apache HBase (TM) cluster issues.</para>
provide a useful blueprint on diagnosing Apache HBase cluster issues.</para>
<para>For more information on Performance and Troubleshooting, see <xref linkend="performance"/> and <xref linkend="trouble"/>.
</para>
</section>

2
src/main/docbkx/community.xml
View File

@ -32,7 +32,7 @@
<section xml:id="feature_branches">
<title>Feature Branches</title>
<para>Feature Branches are easy to make. You do not have to be a committer to make one. Just request the name of your branch be added to JIRA up on the
developer's mailing list and a committer will add it for you. Thereafter you can file issues against your feature branch in Apache HBase (TM) JIRA. Your code you
developer's mailing list and a committer will add it for you. Thereafter you can file issues against your feature branch in Apache HBase JIRA. Your code you
keep elsewhere -- it should be public so it can be observed -- and you can update dev mailing list on progress. When the feature is ready for commit,
3 +1s from committers will get your feature merged<footnote><para>See <link xlink:href="http://search-hadoop.com/m/asM982C5FkS1">HBase, mail # dev - Thoughts about large feature dev branches</link></para></footnote>
</para>

4
src/main/docbkx/configuration.xml
View File

@ -26,8 +26,8 @@
* limitations under the License.
*/
-->
<title>Apache HBase (TM) Configuration</title>
<para>This chapter is the Not-So-Quick start guide to Apache HBase (TM) configuration. It goes
<title>Apache HBase Configuration</title>
<para>This chapter is the Not-So-Quick start guide to Apache HBase configuration. It goes
over system requirements, Hadoop setup, the different Apache HBase run modes, and the
various configurations in HBase. Please read this chapter carefully. At a mimimum
ensure that all <xref linkend="basic.prerequisites" /> have

6
src/main/docbkx/cp.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter version="5.0" xml:id="preface" xmlns="http://docbook.org/ns/docbook"
<chapter version="5.0" xml:id="cp" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:svg="http://www.w3.org/2000/svg"
@ -26,6 +26,8 @@
*/
-->
<title>Coprocessors</title>
<para></para>
<para>HBase coprocessors was inspired by Google's BigTable coprocessors. The <link xlink:href="https://blogs.apache.org/hbase/entry/coprocessor_introduction">Apache HBase Blog on Coprocessor</link> is a very good documentation on that. It has detailed information about the coprocessor framework, terminology, management, and so on.
</para>
</chapter>

4
src/main/docbkx/developer.xml
View File

@ -26,8 +26,8 @@
* limitations under the License.
*/
-->
<title>Building and Developing Apache HBase (TM)</title>
<para>This chapter will be of interest only to those building and developing Apache HBase (TM) (i.e., as opposed to
<title>Building and Developing Apache HBase</title>
<para>This chapter will be of interest only to those building and developing Apache HBase (i.e., as opposed to
just downloading the latest distribution).
</para>
<section xml:id="repos">

4
src/main/docbkx/external_apis.xml
View File

@ -26,8 +26,8 @@
* limitations under the License.
*/
-->
<title>Apache HBase (TM) External APIs</title>
This chapter will cover access to Apache HBase (TM) either through non-Java languages, or through custom protocols.
<title>Apache HBase External APIs</title>
This chapter will cover access to Apache HBase either through non-Java languages, or through custom protocols.
<section xml:id="nonjava.jvm">
<title>Non-Java Languages Talking to the JVM</title>

2
src/main/docbkx/ops_mgt.xml
View File

@ -26,7 +26,7 @@
* limitations under the License.
*/
-->
<title>Apache HBase (TM) Operational Management</title>
<title>Apache HBase Operational Management</title>
This chapter will cover operational tools and practices required of a running Apache HBase cluster.
The subject of operations is related to the topics of <xref linkend="trouble" />, <xref linkend="performance"/>,
and <xref linkend="configuration" /> but is a distinct topic in itself.

2
src/main/docbkx/performance.xml
View File

@ -26,7 +26,7 @@
* limitations under the License.
*/
-->
<title>Apache HBase (TM) Performance Tuning</title>
<title>Apache HBase Performance Tuning</title>
<section xml:id="perf.os">
<title>Operating System</title>

4
src/main/docbkx/security.xml
View File

@ -26,10 +26,10 @@
* limitations under the License.
*/
-->
<title>Secure Apache HBase (TM)</title>
<title>Secure Apache HBase</title>
<section xml:id="hbase.secure.configuration">
<title>Secure Client Access to Apache HBase</title>
<para>Newer releases of Apache HBase (TM) (&gt;= 0.92) support optional SASL authentication of clients<footnote><para>See
<para>Newer releases of Apache HBase (&gt;= 0.92) support optional SASL authentication of clients<footnote><para>See
also Matteo Bertozzi's article on <link xlink:href="http://www.cloudera.com/blog/2012/09/understanding-user-authentication-and-authorization-in-apache-hbase/">Understanding User Authentication and Authorization in Apache HBase</link>.</para></footnote>.</para>
<para>This describes how to set up Apache HBase and clients for connection to secure HBase resources.</para>

2
src/main/docbkx/shell.xml
View File

@ -29,7 +29,7 @@
<title>The Apache HBase Shell</title>
<para>
The Apache HBase (TM) Shell is <link xlink:href="http://jruby.org">(J)Ruby</link>'s
The Apache HBase Shell is <link xlink:href="http://jruby.org">(J)Ruby</link>'s
IRB with some HBase particular commands added. Anything you can do in
IRB, you should be able to do in the HBase Shell.</para>
<para>To run the HBase shell,

4
src/main/docbkx/troubleshooting.xml
View File

@ -26,7 +26,7 @@
* limitations under the License.
*/
-->
<title>Troubleshooting and Debugging Apache HBase (TM)</title>
<title>Troubleshooting and Debugging Apache HBase</title>
<section xml:id="trouble.general">
<title>General Guidelines</title>
<para>
@ -37,7 +37,7 @@
should return some hits for those exceptions you’re seeing.
</para>
<para>
An error rarely comes alone in Apache HBase (TM), usually when something gets screwed up what will
An error rarely comes alone in Apache HBase, usually when something gets screwed up what will
follow may be hundreds of exceptions and stack traces coming from all over the place.
The best way to approach this type of problem is to walk the log up to where it all
began, for example one trick with RegionServers is that they will print some

2
src/main/docbkx/zookeeper.xml
View File

@ -31,7 +31,7 @@
<primary>ZooKeeper</primary>
</indexterm></title>
<para>A distributed Apache HBase (TM) installation depends on a running ZooKeeper cluster.
<para>A distributed Apache HBase installation depends on a running ZooKeeper cluster.
All participating nodes and clients need to be able to access the
running ZooKeeper ensemble. Apache HBase by default manages a ZooKeeper
"cluster" for you. It will start and stop the ZooKeeper ensemble