X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=ext%2Factivemq%2Fexamples%2Fmulti-broker%2Fbroker1-activemq.xml;fp=ext%2Factivemq%2Fexamples%2Fmulti-broker%2Fbroker1-activemq.xml;h=bc7fe078bde7e6a399b1ddd52a0986e5a93ce2bc;hb=8fd0f35facc21b89b378ecfb253e06a66af1e422;hp=a910b3d1439a3cb0c1179c601a82a4ca75ee759a;hpb=327162e6e319ff38447992668e0753363b870b6e;p=packages%2Fprecise%2Fmcollective.git

diff --git a/ext/activemq/examples/multi-broker/broker1-activemq.xml b/ext/activemq/examples/multi-broker/broker1-activemq.xml
index a910b3d..bc7fe07 100755
--- a/ext/activemq/examples/multi-broker/broker1-activemq.xml
+++ b/ext/activemq/examples/multi-broker/broker1-activemq.xml
@@ -12,7 +12,29 @@
         </property>
     </bean>
 
+    <!--
+      For more information about what MCollective requires in this file,
+      see http://docs.puppetlabs.com/mcollective/deploy/middleware/activemq.html
+    -->
+
+    <!--
+      WARNING: The elements that are direct children of <broker> MUST BE IN
+      ALPHABETICAL ORDER. This is fixed in ActiveMQ 5.6.0, but affects
+      previous versions back to 5.4.
+      https://issues.apache.org/jira/browse/AMQ-3570
+    -->
+
+    <!-- In a network of brokers, the brokerName attribute must be unique. -->
     <broker xmlns="http://activemq.apache.org/schema/core" brokerName="broker1" useJmx="true" schedulePeriodForDestinationPurge="60000">
+        <!--
+          MCollective generally expects producer flow control to be turned off.
+          It will also generate a limitless number of single-use reply queues,
+          which should be garbage-collected after about five minutes to conserve
+          memory.
+
+          For more information, see:
+          http://activemq.apache.org/producer-flow-control.html
+        -->
         <destinationPolicy>
           <policyMap>
             <policyEntries>
@@ -26,11 +48,20 @@
             <managementContext createConnector="false"/>
         </managementContext>
 
+        <!--
+          Configure network connectors for a network of brokers. The
+          MCollective ActiveMQ connector uses TWO bi-directional
+          connectors per link, because the short-lived reply queues
+          require conduitSubscriptions be set to false.
+
+          In this config, broker1 connects to both other brokers; neither
+          of the other two have a <networkConnectors> element.
+        -->
         <networkConnectors>
           <!-- broker1 -> broker2 -->
           <networkConnector
                 name="broker1-broker2-topics"
-                uri="static:(tcp://broker2:6166)"
+                uri="static:(tcp://broker2:61616)"
                 userName="amq"
                 password="secret"
                 duplex="true"
@@ -43,7 +74,7 @@
           </networkConnector>
           <networkConnector
                 name="broker1-broker2-queues"
-                uri="static:(tcp://broker2:6166)"
+                uri="static:(tcp://broker2:61616)"
                 userName="amq"
                 password="secret"
                 duplex="true"
@@ -59,7 +90,7 @@
           <!-- broker1 -> broker3 -->
           <networkConnector
                 name="broker1-broker3-topics"
-                uri="static:(tcp://broker3:6166)"
+                uri="static:(tcp://broker3:61616)"
                 userName="amq"
                 password="secret"
                 duplex="true"
@@ -72,7 +103,7 @@
           </networkConnector>
           <networkConnector
                 name="broker1-broker3-queues"
-                uri="static:(tcp://broker3:6166)"
+                uri="static:(tcp://broker3:61616)"
                 userName="amq"
                 password="secret"
                 duplex="true"
@@ -86,15 +117,47 @@
           </networkConnector>
         </networkConnectors>
 
+        <!--
+          Configure message persistence for the broker. MCollective only
+          requires this in a network of brokers, where it's used to prevent
+          duplicate messages.
+
+          The default persistence mechanism is the KahaDB store (identified by
+          the kahaDB tag). For more information, see:
+
+          http://activemq.apache.org/persistence.html
+        -->
+        <persistenceAdapter>
+            <kahaDB directory="${activemq.base}/data/kahadb"/>
+        </persistenceAdapter>
+
         <plugins>
           <statisticsBrokerPlugin/>
+
+          <!--
+            This configures the users and groups used by this broker. Groups
+            are referenced below, in the write/read/admin attributes
+            of each authorizationEntry element.
+          -->
           <simpleAuthenticationPlugin>
             <users>
               <authenticationUser username="amq" password="secret" groups="admins,everyone"/>
               <authenticationUser username="mcollective" password="marionette" groups="mcollective,everyone"/>
-              <authenticationUser username="admin" password="secret" groups="mcollective,admin,everyone"/>
+              <authenticationUser username="admin" password="secret" groups="mcollective,admins,everyone"/>
             </users>
           </simpleAuthenticationPlugin>
+
+          <!--
+            Configure which users are allowed to read and write where. Permissions
+            are organized by group; groups are configured above, in the
+            authentication plugin.
+
+            With the rules below, both servers and admin users belong to group
+            mcollective, which can both issue and respond to commands. For an
+            example that splits permissions and doesn't allow servers to issue
+            commands, see:
+            http://docs.puppetlabs.com/mcollective/deploy/middleware/activemq.html#detailed-restrictions
+          -->
           <authorizationPlugin>
             <map>
               <authorizationMap>
@@ -103,6 +166,10 @@
                   <authorizationEntry topic=">" write="admins" read="admins" admin="admins" />
                   <authorizationEntry topic="mcollective.>" write="mcollective" read="mcollective" admin="mcollective" />
                   <authorizationEntry queue="mcollective.>" write="mcollective" read="mcollective" admin="mcollective" />
+                  <!--
+                    The advisory topics are part of ActiveMQ, and all users need access to them.
+                    The "everyone" group is not special; you need to ensure every user is a member.
+                  -->
                   <authorizationEntry topic="ActiveMQ.Advisory.>" read="everyone" write="everyone" admin="everyone"/>
                 </authorizationEntries>
               </authorizationMap>
@@ -110,6 +177,11 @@
           </authorizationPlugin>
         </plugins>
 
+        <!--
+          The systemUsage controls the maximum amount of space the broker will
+          use for messages. For more information, see:
+          http://docs.puppetlabs.com/mcollective/deploy/middleware/activemq.html#memory-and-temp-usage-for-messages-systemusage
+        -->
         <systemUsage>
             <systemUsage>
                 <memoryUsage>
@@ -124,10 +196,25 @@
             </systemUsage>
         </systemUsage>
 
+        <!--
+          The transport connectors allow ActiveMQ to listen for connections over
+          a given protocol. MCollective uses Stomp, and other ActiveMQ brokers
+          use OpenWire. You'll need different URLs depending on whether you are
+          using TLS. For more information, see:
+
+          http://docs.puppetlabs.com/mcollective/deploy/middleware/activemq.html#transport-connectors
+        -->
         <transportConnectors>
-            <transportConnector name="openwire" uri="tcp://0.0.0.0:6166"/>
-            <transportConnector name="stomp" uri="stomp://0.0.0.0:6163"/>
+            <transportConnector name="openwire" uri="tcp://0.0.0.0:61616"/>
+            <transportConnector name="stomp" uri="stomp://0.0.0.0:61613"/>
         </transportConnectors>
     </broker>
+
+    <!--
+      Enable web consoles, REST and Ajax APIs and demos.
+      It also includes Camel (with its web console); see ${ACTIVEMQ_HOME}/conf/camel.xml for more info.
+
+      See ${ACTIVEMQ_HOME}/conf/jetty.xml for more details.
+    -->
     <import resource="jetty.xml"/>
 </beans>