Configuring Custom Domain Names for Event Broker Services

By default, event broker services use the messaging.solace.cloud domain name as part of their fully-qualified domain name (FQDN). You can configure a custom domain name for your event broker service, such as example.com. You can also add a custom hostname to the custom domain name, for example customhostname.example.com, to provide an alternative custom FDQN for accessing your event broker service.

Using custom domain names provides many benefits, including:

  • TLS certificate management: You control the process of managing the TLS server certificate containing your custom hostname. You decide how the certificate is created, how the certificate is signed, which event broker services you install the certificate on (so they use your custom hostname), and manage the certificates lifecycle.

  • Configuration: Custom domain names can decrease errors when configuring client application connectivity to your event broker service because they are easier to remember.

  • Security and isolation: You can increase the security of your event broker service. For example, you could configure the custom domain to be recognized only within your internal network, and configure your DNS server to resolve the custom domain to internal IP addresses only, to isolate the event broker service from the internet.

  • Migration: If required, you can move the custom domain name to a different event broker service with the same TLS server certificate installed, with no need to reconfigure connecting client applications.

  • Branding: Client applications connect to the event broker service using a hostname containing your unique brand identity, rather than a generic IP address, or the messaging.solace.cloud domain, increasing the trustworthiness of your event broker service.

To use a custom hostname name with a custom domain name, see Configuring Custom Hostnames for an Event Broker Service.

For more information, see the following sections:

Considerations for Using Custom Domain Names

There are requirements beyond the Considerations for Using Custom Hostnames, when configuring a hostname with a custom domain name:

  • Configuring custom domain names requires creating, signing, and installing of a custom TLS server certificate containing the a hostname with the custom domain name to be used for the event broker service. The hostname in the certificate can be either:
    • a fully qualified domain name (FQDN) (example.domain.com)
    • a wildcard hostname (*.domain.com)
  • You must add the custom domain name to your domain.
  • The custom domain must have a CNAME pointing to the generated hostname for the event broker service in the .messaging.solace.cloud domain. You can find the default hostname on the Event broker service Status page.
    • You can alternatively use options such as a private DNS zone with an A or Alias record to point your hostname to a load balancer without resolving over the internet. In this case, you do not need a CNAME point to the generated .messaging.solace.cloud domain. For more information, refer to your networking documentation.
  • To enable the hostname with the custom domain name for the event broker service, you must set the hostname it to default after configuring it. For more information, see Setting a Hostname as Default.
  • If you have configured single-sign on (SSO) for your event broker service, you may need to update your identity provider (IdP) with the new FQDN of the event broker service to continue using single sign-on (SSO) for event broker management. For more information, see Considerations for Using Custom Hostnames with Single-Sign On Enabled Event Broker Services.

Adding a Custom Domain Name

You can add a custom domain name to an existing event broker service and configure the hostname with custom domain as the default URL for client connections and for accessing PubSub+ Broker Manager by setting it as the default hostname. The following procedure instructs you on how to do both.

You must install a custom TLS server certificate containing the hostname with the domain name you want to use for the event broker service before adding a custom domain name. It is your responsibility to create the certificate and have it signed. For more information, see Managing Custom TLS Server Certificates for an Event Broker Service.

To add a custom domain hostname to an existing event broker service and set it as the default, perform these 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 you want to add custom domain name to.
  4. Select the Manage tab and then click Advanced Options.
  5. Scroll to Hostnames and click Add to open the Add New Hostname dialog. When a custom TLS server certificate is installed on the event broker service, a DNS Name field appears at the top of the dialog.
  6. Use the DNS Name drop-down list to select a custom domain name from those available on the custom TLS certificate. Note the following:
    • If no custom domain names appear, your custom TLS certificate may not contain domain names, or may be installed incorrectly. Contact Solace for support.
    • Asterisks in the listed hostnames are wildcards. Wildcards have the following affects:
      • Hostnames preceded with an asterisk (for example, *.example.com) allow entry of a custom hostname using the Hostname field. See Adding a Custom Hostname .
      • Hostnames without an asterisk (for example, service.example.cloud) are fully qualified domain names (FQDN). The Hostname field populates with the hostname associated to the custom domain name and is not accessible.
  7. In the Select the endpoint to assign the hostname to list, select an endpoint. Endpoint availability depends on event broker service configuration. See Changing the Port Configuration for Event Broker Services for information.
  8. Click Add Hostname to add the hostname with custom domain name to the list of available hostnames for the event broker service.
  9. Click the ellipses associated to the hostname with custom domain you just added and click Set as Default. The default moves to the selected hostname. See Setting a Hostname as Default for more information.

    If you do not set the hostname with custom domain as the default, your custom FQDN will not work.

You can confirm that the custom domain hostname is configured properly by accessing the Broker Manager using the hostname with custom domain name. Click Open Broker Manager. When configured properly, the URL in the address bar will be the hostname containing the custom domain, for example https://myservice.example.com:943/....