This version of the product has reached End of Life and is no longer supported.

To Configure a Mule Hazelcast Server

This step is only necessary if you intend to deploy your Mule applications into clusters in PCF. For an explanation about the benefits of having your applications deployed as a cluster, see Mule High Availability Clusters.

If you don’t have a Hazelcast cluster configured, you must configure one using the Mule Hazelcast server provided by MuleSoft.

Once the cluster is installed, take note of the cluster node IPs and ports and the cluster group name and password. You will need this information to bind Mule runtime instances to the cluster.

Hazelcast as a PCF user-provided service

In order to allow your Mule applications to adopt the cluster configuration, you must create a user-provided service in PCF for each of the nodes in the Hazelcast cluster that you will be connecting your Mule applications to. You can do that through the following command:


In the above command, replace the following placeholders:

  • HAZELCAST_NODE_NAME: Logical name of the Hazelcast node from the cluster that you are defining. It must start with hazelcast.

  • HAZELCAST_NODE_IP: IP to connect to the Hazelcast node

  • HAZELCAST_NODE_PORT: Port to connect to the Hazelcast node

  • HAZELCAST_CLUSTER_GROUP_NAME: Group name set in the Hazelcast cluster configuration

  • HAZELCAST_CLUSTER_GROUP_PASSWORD: Group password set in the Hazelcast cluster configuration

For example:

cf cups hazelcast_dev_node1 -p '{"host":"","port":"5701","clusterId":"dev","clusterPassword":"dev-pass"}'
Setting this up is an optional step when configuring Anypoint Platform for PCF. You need this in case you plan to deploy your applications to clusters on PCF.

Mule Hazelcast server is a customization of the hazelcast distribution adapted for the needs of the Mule Runtime.

This custom implementation doesn’t change the Hazelcast behavior at all. It just set up basic configuration required by the Mule Runtime plus default configuration for logging using log4j.


The only requirement is to have JDK 1.8 installed and the JAVA_HOME environment variable properly set


To install:
  • If you don’t have an available Hazelcast distribution, you can download @ here

  • Unzip the distribution into your working directory

  • Execute bin/start.sh (in linux) or bin.start.bat (in windows)

This will start a Hazelcast server node using the default configuration located in the conf/hazelcast.xml file.


Log4j Configuration

To configure log4j just customize the log4j configuration file located in conf/log4.xml.

Hazelcast Configuration

To customize the Hazelcast configuration, just modify the file located in conf/hazelcast.xml following the hazelcast documentation instructions. Take into account that the Hazelcast version being used is 3.6.2.

Proper configuration requires:

  • Change the default group name and group password. These values are used to define a cluster with Hazelcast. All nodes with the same group name/password will create a cluster

  • Configure the network parameters for proper communication between the cluster nodes

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub