Preface

This is the official reference guide for the HBase version it ships with. Herein you will find either the definitive documentation on an HBase topic as of its standing when the referenced HBase version shipped, or it will point to the location in javadoc, JIRA or wiki where the pertinent information can be found.

About This Guide. This reference guide is a work in progress. The source for this guide can be found in the src/main/docbkx directory of the HBase source. This reference guide is marked up using DocBook from which the the finished guide is generated as part of the 'site' build target. Run

mvn site

to generate this documentation. Amendments and improvements to the documentation are welcomed. Click this link to file a new documentation bug against Apache HBase with some values pre-selected.

Contributing to the Documentation. For an overview of Docbook and suggestions to get started contributing to the documentation, see ???.

Providing Feedback. This guide allows you to leave comments or questions on any page, using Disqus. Look for the Comments area at the bottom of the page. Answering these questions is a volunteer effort, and may be delayed.

Heads-up if this is your first foray into the world of distributed computing...

If this is your first foray into the wonderful world of Distributed Computing, then you are in for some interesting times. First off, distributed systems are hard; making a distributed system hum requires a disparate skillset that spans systems (hardware and software) and networking. Your cluster' operation can hiccup because of any of a myriad set of reasons from bugs in HBase itself through misconfigurations -- misconfiguration of HBase but also operating system misconfigurations -- through to hardware problems whether it be a bug in your network card drivers or an underprovisioned RAM bus (to mention two recent examples of hardware issues that manifested as "HBase is slow"). You will also need to do a recalibration if up to this your computing has been bound to a single box. Here is one good starting point: Fallacies of Distributed Computing. That said, you are welcome. Its a fun place to be. Yours, the HBase Community.

comments powered by Disqus