Replicate a map across clusters in a WAN

Run the following Docker command in a terminal, replacing the <YOUR_LICENSE_KEY> placeholder with your Hazelcast Enterprise Edition license key:

docker run \
    -p 5701:5701 \
    --network hazelcast-network \
    -e HZ_NETWORK_PUBLICADDRESS=host.docker.internal:5701 \ (1)
    -e HZ_LICENSEKEY=<YOUR_LICENSE_KEY> \ (2)
    -e HZ_MANAGEMENTCENTER_CONSOLEENABLED=true \
    -e HZ_CLUSTERNAME=London \
    hazelcast/hazelcast-enterprise:5.7.0-SNAPSHOT

Create a hazelcast.yaml (or XML) configuration file in a ~/config-tokyo directory, replacing the <YOUR_LICENSE_KEY> placeholder:

hazelcast:
  cluster-name: Tokyo
  license-key: <YOUR_LICENSE_KEY>
  jet:
    enabled: true
  wan-replication: (1)
    london-wan-rep:
      batch-publisher:
        londonPublisherId:
          cluster-name: London
          target-endpoints: host.docker.internal:5701
  map:
    cities: (2)
      wan-replication-ref:
        london-wan-rep: (3)
          republishing-enabled: false

<hazelcast>
    <cluster-name>Tokyo</cluster-name>
    <license-key><YOUR_LICENSE_KEY></license-key>
    <jet enabled="true" />
    <wan-replication name="london-wan-rep"> (1)
        <batch-publisher>
            <cluster-name>London</cluster-name>
            <publisher-id>londonPublisherId</publisher-id>
            <target-endpoints>host.docker.internal:5701</target-endpoints>
    <map name="cities"> (2)
        <wan-replication-ref name="london-wan-rep"> (3)
    </map>
</hazelcast>

Open a new terminal and start the active cluster as follows:

docker run \
     --network hazelcast-network \
     -e JAVA_OPTS="-Dhazelcast.config=/opt/hazelcast/config_ext/hazelcast.yaml" -v ~/config-tokyo:/opt/hazelcast/config_ext hazelcast/hazelcast-enterprise:5.7.0-SNAPSHOT

2024-11-23 11:39:14,198 [ INFO] [main] [c.h.i.c.ClusterService]: [172.18.0.3]:5701 [Tokyo] [5.7.0-SNAPSHOT]

Members {size:1, ver:1} [
	Member [172.18.0.3]:5701 - 98d9a815-5eb3-4341-bec1-e9816cee44b5 this
]

Note the member IP address and port for connecting to this cluster later via Management Center.

Open a new terminal and start Management Center using the following code:

docker run \
    --network hazelcast-network \
    -p 8080:8080 hazelcast/management-center:latest-snapshot

Open a web browser and go to localhost:8080.

Enable Dev Mode and click Connect.

Enter the passive cluster’s name (London) and the IP address and port e.g. host.docker.internal:5701.

Click Connect again and enter the active cluster’s name (Tokyo) and the IP address and port e.g. 172.18.0.3:5701.

Select Tokyo from the Cluster dropdown in the Top Menu.

Open the Settings window from the top right of the screen.

Select the License tab, paste your Enterprise license key in and click Update License.

You can verify that the Tokyo cluster has WAN Replication enabled by clicking Cluster > WAN Replication.

In a new terminal, start the SQL shell for the Tokyo cluster, replacing the IP address if needed i.e. this example assumes Tokyo is running on 172.18.0.3:5701:

docker run --network hazelcast-network -it --rm hazelcast/hazelcast-enterprise:5.7.0-SNAPSHOT hz-cli --targets [email protected]:5701 sql

When you see the SQL shell prompt (sql>), type the following command and press Enter to create the map:

CREATE MAPPING cities (__key INT, country VARCHAR, city VARCHAR)
TYPE IMap
OPTIONS ('keyFormat'='int', 'valueFormat' = 'json-flat');

Next, add city data to the map as follows:

INSERT INTO cities VALUES
(1,'Australia','Canberra'),
(2,'Croatia','Zagreb'),
(3,'Czech Republic','Prague'),
(4,'England','London'),
(5,'Turkey','Ankara'),
(6,'United States','Washington, DC');

You can confirm the entries have been added to the map by running:

SELECT * FROM cities;

You can also see the map and its entries in Management Center, using the SQL browser. Select Tokyo from the Cluster dropdown in the Top Menu.

Click Storage > Maps and check you can see the cities map:

Click SQL Browser from the left-hand Tools menu and enter SELECT * FROM cities; as your query.

Click Execute Query and you should see your newly created map containing the city data.

Close the SQL browser.

Select London from the Cluster dropdown in the Top Menu.

Click Storage > Maps and check you can see the cities map.

You can query the map entries on the London cluster using the SQL browser in Management Center. First, you need to create a mapping so that the London cluster can read the map entries. Open the SQL Browser again and select the Connector Wizard.

Enter the following query and click CONFIRM AND RUN:

CREATE MAPPING cities (__key INT, country VARCHAR, city VARCHAR)
TYPE IMap
OPTIONS ('keyFormat'='int', 'valueFormat' = 'json-flat');

You should see confirmation the mapping is successful and you can Close the Connector Wizard.

You can now enter the SELECT * FROM cities; query into the SQL Browser and Execute to see the replicated cities map.

Close the SQL Browser.

Select London from the Cluster dropdown in the Top Menu and open the SQL Browser again.

Choose cities in the select a map field and execute the default SELECT * FROM "cities" query:

Update one of the map entries using the following query:

SINK INTO cities VALUES
(1, 'Austria', 'Vienna');

Close the SQL Browser and select the passive cluster (London) from the Cluster dropdown.

Open the SQL Browser again, choose cities in the select a map field and execute the default query.

You should be able to see the 1 _key entry updated through replication.

Go to Cluster > Administration, and select the Cluster State tab.

Click Shutdown and confirm the dialog that appears.