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/09/06 22:16:48 UTC
svn commit: r1381740 - /hbase/trunk/src/docbkx/developer.xml
Author: stack
Date: Thu Sep 6 20:16:48 2012
New Revision: 1381740
URL: http://svn.apache.org/viewvc?rev=1381740&view=rev
Log:
Add an invariants section to the developer docs; added the one about no permanent data in zk
Modified:
hbase/trunk/src/docbkx/developer.xml
Modified: hbase/trunk/src/docbkx/developer.xml
URL: http://svn.apache.org/viewvc/hbase/trunk/src/docbkx/developer.xml?rev=1381740&r1=1381739&r2=1381740&view=diff
==============================================================================
--- hbase/trunk/src/docbkx/developer.xml (original)
+++ hbase/trunk/src/docbkx/developer.xml Thu Sep 6 20:16:48 2012
@@ -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.