add some html docs for each kind of broker to help folks grok the dif…

…ference
hawtio · Oct 9, 2013 · 3535136 · 3535136
1 parent 633cf7f
commit 3535136
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 1 deletion.
diff --git a/hawtio-web/src/main/webapp/app/fabric/html/createBroker.html b/hawtio-web/src/main/webapp/app/fabric/html/createBroker.html
@@ -15,11 +15,14 @@
 
 
   <div class="create-broker-body row-fluid">
-    <div class="span10 offset1">
+    <div class="span6 offset1">
       <div id="create-form">
         <div simple-form name="create_broker" data="schema" entity="entity"></div>
       </div>
     </div>
+    <div class="span4">
+      <div ng-include="'app/fabric/html/help/kind' + entity.kind + '.html'"></div>
+    </div>
   </div>
 
 </div>
diff --git a/hawtio-web/src/main/webapp/app/fabric/html/help/kind.html b/hawtio-web/src/main/webapp/app/fabric/html/help/kind.html
@@ -0,0 +1,3 @@
+<h3>Broker Kind</h3>
+
+<p>Please pick a kind of broker to create using the <b>kind</b> field on the left.</p>
diff --git a/hawtio-web/src/main/webapp/app/fabric/html/help/kindMasterSlave.html b/hawtio-web/src/main/webapp/app/fabric/html/help/kindMasterSlave.html
@@ -0,0 +1,3 @@
+<h3>Master Slave Broker</h3>
+
+<p>Master Slave uses 2 or more containers running the same broker; one becomes the master and the other broker(s) the slave(s). If the master dies then a slave takes over being the master.</p>
diff --git a/hawtio-web/src/main/webapp/app/fabric/html/help/kindNPlusOne.html b/hawtio-web/src/main/webapp/app/fabric/html/help/kindNPlusOne.html
@@ -0,0 +1,5 @@
+<h3>N + 1 Brokers</h3>
+
+<p>N + 1 refers to where you create N logical brokers inside a Fabric Profile, then run N + 1 containers of the Profile.</p>
+
+<p>For example if N is 2, you'd run 3 containers; one container would be the master of broker1, another container the master of broker2 then the other container would be a slave of broker 1 and 2. This way you can share a smaller pool of slaves across more brokers; so you have a small number of hot stand by slaves to save hardware.</p>
diff --git a/hawtio-web/src/main/webapp/app/fabric/html/help/kindReplicated.html b/hawtio-web/src/main/webapp/app/fabric/html/help/kindReplicated.html
@@ -0,0 +1,3 @@
+<h3>Replicated Broker</h3>
+
+<p>Replicated broker defaults to using 3 containers each running a replicated view of the broker using a share nothing architecture. You then have 3 copies of all the data so you can lose 2 broker machines and file systems without losing your data.</p>
diff --git a/hawtio-web/src/main/webapp/app/fabric/html/help/kindStandAlone.html b/hawtio-web/src/main/webapp/app/fabric/html/help/kindStandAlone.html
@@ -0,0 +1,5 @@
+<h3>Stand Alone Broker</h3>
+
+<p>A stand alone broker requires a single container to run. If you stop and start the container any non-persistent messages are lost, but any persistent messages are preserved.</p>
+
+<p><b>Note</b> that with stand alone brokers; if you lose the machine's files or file system - then all persistent messages will be lost!</p>