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

Add an invariants section to the developer docs; added the one about no permanent data in zk 

git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@1381740 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Stack 2012-09-06 20:16:48 +00:00
parent c310653a19
commit e0d8aea624
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/docbkx/developer.xml
View File

@ -626,6 +626,21 @@ mvn compile
<para>This convention comes from our parent project Hadoop.</para>
</section> <!-- code.standards -->
<section xml:id="design.invariants">
<title>Invariants</title>
<para>We don't have many but what we have we list below. All are subject to challenge of
course but until then, please hold to the rules of the road.
</para>
<section xml:id="design.invariants.zk.data">
<title>No permanent state in ZooKeeper</title>
<para>ZooKeeper state should transient (treat it like memory). If deleted, hbase
should be able to recover and essentially be in the same state<footnote><para>There are currently
a few exceptions that we need to fix around whether a table is enabled or disabled</para></footnote>.
</para>
</section>
</section> <!-- design.invariants -->
<section xml:id="run.insitu">
<title>Running In-Situ</title>
<para>If you are developing HBase, frequently it is useful to test your changes against a more-real cluster than what you find in unit tests. In this case, HBase can be run directly from the source in local-mode.