This is a prerelease version.

View latest

Connecting to a Cluster from the UI

6.0-SNAPSHOT 5.7 5.6 5.5 5.4 5.3 5.2 5.1 5.0 4.2022.01 4.2021.12

Management Center starts a Hazelcast client for each cluster that it is connected to. You can configure the Hazelcast client for Management Center, using the UI.

To connect Management Center to a Hazelcast cluster from the UI, you have two options:

  • Use the form fields.

  • Upload a client configuration file in XML or YAML format. (Recommended for more complex configurations.)

    If you enabled TLS/SSL on a Hazelcast cluster, you must use this option to configure the client TLS settings. For more information about client TLS configuration, see TLS in the Platform documentation.

When connecting to multiple clusters from the same instance of Management Center, make sure that the cluster names are unique. Management Center does not support simultaneous connections to more than one cluster with the same cluster name.

Using the Form Fields

  1. Click to Cluster Connections in the Top Bar.

  2. Click Add to start configuring a new connection.

    Add New Cluster Configuration

  3. Enter the name of the cluster that you want to connect to.

  4. Enter the hostnames or IP addresses of cluster members that you want to connect to. Press Enter after each address to add it to the list.

    As soon as Management Center connects to one member, it will auto-discover the other members of the cluster. But, for fault-tolerance, it’s best to add more than one member’s address to the list.

  5. Make sure that Enabled is On.

    If this field is Off, Management Center will save the configuration but will not try to connect to the cluster.

  6. Click Connect.

    Cluster Configuration Added

You will see the following:

Field Description

State

Current state of the cluster.

Safe Members

Total number of members in the cluster.

Clients

Total number of clients currently connected to the cluster, not including the Management Center client. See Clients

If your cluster has the Jet engine enabled, you will also see that the cluster support streaming and SQL.

To connect to another cluster, you can repeat these steps.

Using a Client Configuration File

  1. Create a client configuration file.

    • XML

    • YAML

    For help creating a client configuration file, see the full example reference on GitHub.

    Example XML file
    <hazelcast-client xmlns="http://www.hazelcast.com/schema/client-config"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xsi:schemaLocation="http://www.hazelcast.com/schema/client-config
                  http://www.hazelcast.com/schema/client-config/hazelcast-client-config-5.0.xsd">
  <cluster-name>dev</cluster-name>
  <network>
    <cluster-members>
      <address>127.0.0.1:5701</address>
      <address>127.0.0.2:5702</address>
    </cluster-members>
  </network>
</hazelcast-client>

    For help creating a client configuration file, see the full example reference on GitHub.

    Example YAML file
    hazelcast-client:
  cluster-name: dev
  network:
    cluster-members:
      - 127.0.0.1:5701
      - 127.0.0.2:5702

    As soon as Management Center connects to one member, it will auto-discover the other members of the cluster. But, for fault-tolerance, it’s best to add more than one member’s address to the cluster-members configuration.

  2. Click to Cluster Connections in the Top Bar.

  3. Click Add to start configuring a new connection.

    Add New Cluster Configuration

  4. Go to the Upload Client Config tab.

    Upload Config File

  5. Either drag and drop your configuration file into the box or click to browse your file system.

  6. Make sure that Enabled is On.

    If this field is Off, Management Center will save the configuration but will not try to connect to the cluster.

  7. Click Save Configuration.

You will see the following:

Field Description

State

Current state of the cluster.

Safe Members

Total number of members in the cluster.

Clients

Total number of clients currently connected to the cluster, not including the Management Center client. See Clients

If your cluster has the Jet engine enabled, you will also see that the cluster support streaming and SQL.

To connect to another cluster, you can repeat these steps with a different configuration file.

Management Center requires a connection to every member in order to collect its state, events and metrics so unisocket connections are not supported. An error message will be shown if the configuration uses a unisocket connection.

Cluster Connection Diagnosis

In case Management Center could not connect to a cluster, you can run the cluster connection diagnostics by clicking on the DIAGNOSE button.

Diagnose button

Management Center runs a bunch of connectivity checks including:

  • whether the hostname can be resolved

  • whether the connection ports are open

  • whether the configured cluster name matches the one configured on a member

  • whether Management Center can be authenticated by the members

  • whether Management Center has permissions to manage the cluster.

Cluster connection diagnosis result

Connection diagnostics process may take up to 30 seconds, please wait until you receive a FAIL check with an explanation or cancel the diagnostics.

Removing a Cluster Connection

To remove an existing connection to a cluster, go to Cluster Connections in the Top Bar and click the trash icon above the name of the cluster that you want to disconnect from Management Center.

Trash icon above the name of a cluster called dev

Editing a Cluster Connection

To edit an existing connection, go to Cluster Connections in the Top Bar and click the configure icon (next to the trash icon) above the name of the cluster.

Configure icon above the name of a cluster called dev

If you connected to the cluster from the form fields, you can edit the form.

If you connected to the cluster, using a client configuration file, you can upload a new configuration file.

To see the existing configuration file, click the eye icon above the box.

Next Steps

Explore the Clusters dashboard.

lifebuoy

Help and support