This documentation is for older WSO2 products. View documentation for the latest release.
Page Comparison - Setting up a Cluster (v.36 vs v.37) - Clustering Guide 4.2.0 - WSO2 Documentation

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated


  1. Restart the configured load balancer.
  2. Start the manager node. The additional -Dsetup argument creates the required tables in the database. 
    sh <PRODUCT_HOME>/bin/ -Dsetup
  3. Start the two worker nodes. The additional -DworkerNode=true argument indicates that this is a worker node. This parameter basically makes a server read-only. A node with this parameter will not be able to do any changes such as writing or making modifications to the deployment repository etc. This parameter also enables the worker profile, where the UI bundles will not be activated and only the back end bundles will be activated once the server starts up. When you configure the axis2.xml file, the cluster sub domain must indicate that this node belongs to the "worker" sub domain in the cluster.


    Tip: It is recommendation is to delete the <PRODUCT_HOME>/repository/deployment/server directory and create an empty server directory in the worker node. This is done to avoid any SVN conflicts that may arise.

    It is recommendation is to delete the  <PRODUCT_HOME>/repository/deployment/server  directory and create the following directory structure in order to avoid any SVN conflicts that may arise.

    • <PRODUCT_HOME>/repository/deployment/server

      • <PRODUCT_HOME>/repository/deployment/server/synapse-configs/

        • <PRODUCT_HOME>/repository/deployment/server/synapse-configs/default

    As depicted above you need to create an empty directory named server in the <APIM_Worker_HOME>/repository/deployment directory. Thereafter, create a subdirectory named synapse-configs under the server directory, and create another subdirectory named default under the synapse-configs directory. This is done to avoid any SVN conflicts that may arise.

    sh <PRODUCT_HOME>/bin/ -DworkerNode= true

  4. Check for ‘member joined’ log messages in all consoles.

    titleAdditional information on logs and new nodes

    When you terminate one node, all nodes identify that the node has left the cluster. The same applies when a new node joins the cluster. 

    If you want to add another new worker node, you can simply copy worker1 without any changes if you are running it on a new server (such as If you intend to use the new node on a server where another WSO2 product is running, you can use a copy of worker1 and change the port offset accordingly in the carbon.xml file. You also have to change localMemberPort in axis2.xml if that product has clustering enabled. Be sure to map all host names to the relevant IP addresses when creating a new node. The log messages indicate if the new node joins the cluster.

  5. Access management console through the LB using the following URL:
  6. Test load distribution via