Managing Dynamic Message Routing for an Event Broker Service

If you want to create a Dynamic Message Routing (DMR) cluster containing multiple event broker services, each event broker service must have DMR enabled and share the same cluster name. After enabling DMR and sharing a cluster name, you must create DMR links between the event broker services. You can use Mesh Manager to create an event mesh with external links between DMR clusters (for multi-site scaling), or configure the internal links within a cluster (for horizontal scaling) in Broker Manager at Clustering > Links > Internal Links. For more information, see Understanding Event Meshes and Mesh Manager.

For event broker services created with versions:

  • LTS version 10.25.0.380-58

  • LTS version 10.26.0.9000-18

  • Rolling version 10.26.7.12655-17

or later, DMR is disabled by default. If you want your event broker service to have DMR enabled, you must explicitly enable DMR and specify a cluster name at service creation, or enable DMR afterward via the Manage tab for the event broker service in Cluster Manager .

For event broker services created with versions before:

  • LTS version 10.25.0.380-58

  • LTS version 10.26.0.9000-18

  • Rolling version 10.26.7.12655-17

DMR is enabled by default with an auto-generated cluster name. To add multiple services to the same DMR cluster, they must share the same cluster name and have DMR links configured between them. For best practices to organize your DMR cluster, see Best Practices for Designing an Event Mesh with DMR.

Enabling DMR

Enabling DMR allows the service to participate in an event mesh. For more information, see Understanding Event Meshes and Mesh Manager.

For event broker services created with version:

  • LTS version 10.25.0.380-58

  • LTS version 10.26.0.9000-18

  • Rolling version 10.26.7.12655-17

and later, DMR is disabled by default. You must enable DMR before the service can participate in an event mesh or DMR cluster.

To enable DMR on an existing event broker service, perform these steps:

  1. Log in to the Solace 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 Solace Cloud Console.
  2. On the navigation bar, select Cluster Manager .
  3. Select the event broker service that you want to configure. 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, click the Manage tab.
  5. On the Management Settings menu, select System Configuration.
  6. On the DMR Cluster: Disabled tile, click Enable.
  7. In the Enable DMR Cluster dialog, enter a cluster name or select an existing cluster from the list. Ensure the cluster name is 1 to 64 characters and includes only alphanumeric characters, dashes, or underscores.
  8. Click Save.

Changing the Cluster Name

For event broker services that already have DMR enabled, you can change the cluster name. Here are some reasons why you may want to change the change the cluster name:

  • Add the event broker service to a different DMR cluster by specifying a matching cluster name.

  • Remove the event broker service from an existing DMR cluster if there are no external DMR links configured on it.

Consider the following information 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.

  • When you specify a new cluster name, ensure that the name is 1 to 64 characters long, and includes only alphanumeric characters, dashes, and underscores.

To change the cluster name, perform these steps:

  1. Log in to the Solace 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 Solace Cloud Console.
  2. On the navigation bar, select Cluster Manager .
  3. Select the event broker service that you want to configure. 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, click the Manage tab.
  5. On the Management Settings menu, select System Configuration.
  6. On the DMR Cluster: <name> tile, click Edit.
  7. 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.
  8. 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.

Disabling DMR

You can disable DMR on an event broker service if it is not part of an event mesh and has no DMR links configured.

Before disabling DMR, ensure the event broker service is not participating in an event mesh. Disabling DMR removes the cluster configuration prevents the event broker service from routing messages using DMR.

To disable DMR on your event broker service, perform these steps:

  1. Log in to the Solace 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 Solace Cloud Console.
  2. On the navigation bar, select Cluster Manager .
  3. Select the event broker service that you want to configure. 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, click the Manage tab.
  5. On the Management Settings menu, select System Configuration.
  6. On the DMR Cluster: <name> tile, clear the Enable DMR cluster checkbox, and click Save.
  7. In the confirmation dialog, click Disable.