8.4.4. ActiveMQ
ActiveMQ uses the term broker to identify an ActiveMQ server. However, this section distinguishes ActiveMQ brokers from OpenShift Enterprise broker hosts.
Because ActiveMQ services can be configured for redundancy, this section demonstrates redundancy with three servers to configure a redundant network of ActiveMQ brokers. This configuration provides the following advantages:
- Distributes queues and topics among ActiveMQ brokers
- Allows clients to connect to any Active MQ broker on the network
- Failover to another ActiveMQ broker if one fails
Connecting all ActiveMQ brokers to each other achieves this redundancy. See the following ActiveMQ documentation for more background information:
- Clustering - http://activemq.apache.org/clustering.html
- How do distributed queues work - http://activemq.apache.org/how-do-distributed-queues-work.html
8.4.4.1. Configuring a Network of ActiveMQ Brokers
This section describes how to configure a network of ActiveMQ brokers, and the example instructions show a configuration of three ActiveMQ brokers found on the following hosts:
activemq1.example.com
activemq2.example.com
activemq3.example.com
Use the same configuration for all hosts, but substitute specific information to suit the requirements of each host.
Networked ActiveMQ brokers are configured differently from what is described in the basic installation. The following procedure describes how to configure a network of ActiveMQ brokers.
Procedure 8.14. To Configure a Network of ActiveMQ Brokers:
- Install ActiveMQ with:
#
yum install -y activemq
- Modify the
/etc/activemq/activemq.xml
configuration file. Red Hat recommends downloading and using the sampleactivemq.xml
file provided at https://raw.github.com/openshift/openshift-extras/enterprise-2.2/enterprise/install-scripts/activemq-network.xml as a starting point. Modify the host names, user names, and passwords to suit your requirements.However, if you choose to modify the default/etc/activemq/activemq.xml
configuration file, use the following instructions to do so. Each change that must be made in the default/etc/activemq/activemq.xml
file is described accordingly. Red Hat recommends that you create a backup of the default/etc/activemq/activemq.xml
file before modifying it, using the following command:#
cp /etc/activemq/activemq.xml{,.orig}
- In the
broker
element, modify thebrokerName
anddataDirectory
attributes, and adduseJmx="true"
:<broker xmlns="http://activemq.apache.org/schema/core" brokerName="activemq1.example.com" useJmx="true" dataDirectory="${activemq.base}/data">
- Modify the
destinationPolicy
element:<destinationPolicy> <policyMap> <policyEntries> <policyEntry topic=">" producerFlowControl="false"/> <policyEntry queue="*.reply.>" gcInactiveDestinations="true" inactiveTimoutBeforeGC="300000" /> </policyEntries> </policyMap> </destinationPolicy>
- Comment out or remove the
persistenceAdapter
element, and replace it with thenetworkConnectors
element. This example is for the first ActiveMQ broker.<networkConnectors> <networkConnector name="broker1-broker2-topic" uri="static:(tcp://activemq2.example.com:61616)" userName="amquser" password="amqpass"> <excludedDestinations> <queue physicalName=">" /> </excludedDestinations> </networkConnector> <networkConnector name="broker1-broker2-queue" uri="static:(tcp://activemq2.example.com:61616)" userName="amquser" password="amqpass" conduitSubscriptions="false"> <excludedDestinations> <topic physicalName=">" /> </excludedDestinations> </networkConnector> <networkConnector name="broker1-broker3-topic" uri="static:(tcp://activemq3.example.com:61616)" userName="amquser" password="amqpass"> <excludedDestinations> <queue physicalName=">" /> </excludedDestinations> </networkConnector> <networkConnector name="broker1-broker3-queue" uri="static:(tcp://activemq3.example.com:61616)" userName="amquser" password="amqpass" conduitSubscriptions="false"> <excludedDestinations> <topic physicalName=">" /> </excludedDestinations> </networkConnector> </networkConnectors>
ThenetworkConnectors
element provides one-way message paths to other ActiveMQ brokers on the network. For a fault-tolerant configuration, thenetworkConnector
element for each ActiveMQ broker must point to the other ActiveMQ brokers, and is specific to each host. In the example above, theactivemq1.example.com
host is shown.EachnetworkConnector
element requires a unique name and ActiveMQ broker. The names used here are in thelocalhost -> remotehost
format, reflecting the direction of the connection. For example, the first ActiveMQ broker has anetworkConnector
element name prefixed withbroker1-broker2
, and the address corresponds to a connection to the second host.TheuserName
andpassword
attributes are for connections between the ActiveMQ brokers, and match the definitions described in the next step. - Add the
plugins
element to define authentication and authorization for MCollective, inter-broker connections, and administration purposes. Theplugins
element must be after thenetworkConnectors
element. Substitute user names and passwords according to your local IT policy.<plugins> <statisticsBrokerPlugin/> <simpleAuthenticationPlugin> <users> <authenticationUser username="mcollective" password="marionette" groups="mcollective,everyone"/> <authenticationUser username="amquser" password="amqpass" groups="admins,everyone"/> <authenticationUser username="admin" password="password" groups="mcollective,admin,everyone"/> </users> </simpleAuthenticationPlugin> <authorizationPlugin> <map> <authorizationMap> <authorizationEntries> <authorizationEntry queue=">" write="admins" read="admins" admin="admins" /> <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" /> <authorizationEntry topic="ActiveMQ.Advisory.>" read="everyone" write="everyone" admin="everyone"/> </authorizationEntries> </authorizationMap> </map> </authorizationPlugin> </plugins>
- Add the
stomp
transportConnector
(for use by MCollective) to thetransportConnectors
element. Theopenwire
transportConnector
is used for ActiveMQ inter-broker transport, and must not be modified. Configure thetransportConnectors
element as shown in the following example.<transportConnectors> <transportConnector name="openwire" uri="tcp://0.0.0.0:61616"/> <transportConnector name="stomp" uri="stomp://0.0.0.0:61613"/> </transportConnectors>
- Secure the ActiveMQ console by configuring Jetty, as described in the basic installation.
- Enable authentication and restrict the console to
localhost
:#
cp /etc/activemq/jetty.xml{,.orig}
#sed -i -e '/name="authenticate"/s/false/true/' /etc/activemq/jetty.xml
- Change the default
admin
password in the/etc/activemq/jetty-realm.properties
file. The password is the same as theadmin
password in the authentication plug-in.#
cp /etc/activemq/jetty-realm.properties{,.orig}
#sed -i -e '/admin:/s/admin,/password,/' /etc/activemq/jetty-realm.properties
- Modify the firewall to allow ActiveMQ
stomp
andopenshift
traffic:#
lokkit --port=61613:tcp
#lokkit --port=61616:tcp
The basic installation only opens port 61613. Here, port 61616 has also been opened to allow ActiveMQ inter-broker traffic. - Restart the ActiveMQ service and make it persistent on boot:
#
service activemq restart
#chkconfig activemq on
Note
If you use the kickstart bash script, the
configure_activemq
function performs these steps when multiple members are specified with CONF_ACTIVEMQ_REPLICANTS
.