Changing the Cluster Name for an Event Broker Service

If you want to create a DMR cluster with multiple event broker services in it, the cluster name for each service must have the same cluster name. Event broker services in a DMR cluster are aware of each other through the DMR internal links that connect them. The DMR cluster seamlessly routes every event published to it to the consuming applications connected to any event broker service in the same cluster. For more information, see Horizontal Scaling.

Creating an event broker service places it in its own cluster with a generated cluster name. You can set the same cluster name for multiple event broker services so that they belong to the same DMR cluster. For best practices to organize your DMR cluster, see DMR Best Practices.

These are some reasons that you may want to change the cluster name for an existing event broker service:

  • Add the existing event broker service to a DMR cluster. For example, you have forgotten to set the cluster name when you created the event broker service.
  • Remove the event broker service from an existing DMR cluster if there are no external DMR links configured on it.

These are a few considerations before you change the cluster name for an event broker service:

  • The cluster name for the event broker service that you are editing cannot be part of an event mesh or another DMR cluster, which has external or internal DMR links configured, respectively.
    • To remove an event broker service from an event mesh (remove the external links), you can either:
      • In the PubSub+ Cloud Console, use Mesh Manager to remove the event broker service from the event mesh. This removes the external links for you
      • In Broker Manager, remove the DMR external links manually. Removing all external links removes the event broker service from the event mesh.
    • To remove an event broker service from a DMR cluster (remove its internal links), contact Solace as at this time, it is not possible to remove the links in the PubSub+ Cloud Console or in Broker Manager.
  • When you specify a new cluster name, ensure that the name is 1 to 64 characters long, and includes only alphanumeric characters, dashes, or underscores.

To change the cluster name, perform the following steps:

  1. Log in to the PubSub+ Cloud Console if you have not done so yet. The URL to access the Cloud Console differs based on your authentication scheme. For more information, see Logging In to the PubSub+ Cloud Console.
  2. Select Cluster Manager from the navigation bar.
  3. Select the event broker service with the cluster name you want to change. If the event broker service is not listed, make sure you have the right environment selected. For more information, see Selecting Environments.
  4. On the Service Details page, select the Manage tab and then click Advanced Options.
  5. On the Cluster Name tile, click Edit.
  6. In the Edit Cluster Name dialog, click the New Cluster Name list and do one of the following: 
    • Select an existing cluster from the list. You can start typing the cluster name to filter the list of existing cluster names.
    • Type a new cluster name and then click Select to create a new cluster name. Ensure that your cluster name is 1 to 64 characters long, and only includes alphanumeric characters, dashes, or underscores.

  7. Click Save.

In the Edit Cluster Name dialog, an indicator shows the status of the cluster name change. If the change was successful, click Close, otherwise correct the cluster name, and click Try Again.

After you have configured your event broker services with the appropriate cluster names and you're ready to create your DMR cluster, contact Solace for assistance as the ability to create the DMR cluster (the internal links) in the PubSub+ Cloud Console is not yet available.