This documentation is for older versions of WSO2 products and may not be relevant now. Please see your respective product documentation for clustering details and configurations.

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: [AWS clustering] Update information on localMemberHost


  1. Enable clustering for this server. 
    <clustering class="org.wso2.carbon.core.clustering.hazelcast.HazelcastClusteringAgent" enable="true">
  2. Set the membership scheme to aws to enable the AWS registration method. 
    <parameter name="membershipScheme">aws</parameter>
  3. Specify the port used to communicate cluster messages. This must be any port number between 5701 and 5800.
    <parameter name="localMemberPort">5701</parameter>
  4. Specify the IP of the instance in the <localMemberHost> element. This must be set to the IP address bound to the network interface used to communicate with other members in the group.  Here's an example:
    <parameter name="localMemberHost"></parameter>

  5. Define the following AWS specific configurations. These are the AWS access key, secret key, security group, region (with or without the zone), tag key, and tag value. The AWS credentials and security group depend on your configurations in the Amazon EC2 instance. The tagKey and tagValue are optional and the rest of the following parameters are mandatory. The region defaults to us-east-1

    Code Block
    <parameter name="accessKey">xxxxxxxxxx</parameter>
    <parameter name="secretKey">yyyyyyyyyy</parameter>
    <parameter name="securityGroup">a_group_name</parameter>
    <parameter name="region">us-east-1</parameter> 
    // Make sure you do not add any zone values (e.g., a) to the region parameter.
    <parameter name="tagKey">a_tag_key</parameter>  
    <parameter name="tagValue">a_tag_value</parameter>  
    // If you are adding tags, they should be attached to the AWS instances.

    Tip: In order to provide specific permissions to create an access key and secret key for only this AWS clustering attempt, use the following custom policy block. Attach this to the user account that will operate AWS clustering in WSO2 products. The access key and secret key can only be used to list EC2 instance details in the AWS account.

    Code Block
    { "Version": "2012-10-17", 
    		 "Effect": "Allow",
    			 "Resource": [ "*" ]

    You can use the following link as a reference on how to add the custom IAM policy:

    For AWS clustering to work properly, you must set a specific tag key with a tag value for all EC2 instances that belong in the same cluster.

  6. Start the server as per the instructions in the Setting up a Cluster topic. If the cluster is set up successfully, you should not see any errors when the server starts up, and also see the following log message.

    Code Block
    [2015-06-23 09:26:41,674]  INFO - HazelcastClusteringAgent Using aws based membership management scheme

    When new members join the cluster, you should see messages similar to the following.

    Code Block
    [2015-06-23 09:27:08,044]  INFO - AWSBasedMembershipScheme Member joined [5327e2f9-8260-4612-9083-5e5c5d8ad567]: / 

    When members leave the cluster, you should see messages similar to the following.

    Code Block
    [2015-06-23 09:28:34,364]  INFO - AWSBasedMembershipScheme Member left [b2a30083-1cf1-46e1-87d3-19c472bb2007]: /