Configuring Custom Domain Hostnames for Event Broker Services

Custom Domain Hostnames for event broker services is a Controlled-Availability (CA) feature. Please contact Solace to see if this feature is suitable for your use case and deployment requirements.

Typically, an event broker service uses messaging.solace.cloud domain as part of the fully-qualified domain name (FQDN). You can create a custom hostname of mycustomhostname to give a FQDN of mycustomhostname.messaging.solace.cloud). If required, you can use a custom domain instead with a custom hostname to create a custom domain hostname, such as mycustomhostname.example.com to use as an alternate hostname to access the event broker service.

Using custom domain hostnames requires additional configuration for your event broker services to configure your domain. These configuration requirements are detailed in Considerations for Custom Domain Hostnames. The use of custom domain hostnames is disabled unless a custom TLS certificate is installed on your event broker service. To add custom domain hostname, see Adding a Hostname with Custom Domain Name.

Considerations for Custom Domain Hostnames

Beyond the considerations for using hostnames in custom domains, using a custom domain hostname has several configuration requirements and affects for your event broker service, including:

  • The event broker service requires a custom TLS certificate containing your hostnames with a custom domain. You must provide this custom TLS certificate and contact Solace when you are ready to install it on the event broker service. Using a custom domain has specific configuration requirements that are required during deployment of PubSub+ Cloud and may not be available in all regions.
  • A properly configured DNS with hostnames containing the custom domain hostname. You must also configure these hostnames to have a CNAME that points to initial, generated hostname in the .messaging.solace.cloud domain for the event broker service. You can locate the hostname on the Status page for the event broker service in Cluster Manager. For more information, see Find Your Event Broker Service Connection Information .
  • After adding a custom domain hostname, you may need to update your identity provider (IdP) with the new hostname and domain to continue using single sign-on (SSO) for event broker management, depending on the configuration of your IdP. For more information, see Considerations Using Custom Hostnames and Event Broker Service (SSO) .
  • This feature does not provide validation of the configuration of the custom domain hostname (or the custom domain). If you are having connectivity issues, check that the CNAME for your hostnames in your DNS points to the correct event broker service's .messaging.solace.cloud address. Also, ensure that your custom TLS certificate is installed, and that its hostnames contain the custom domain name.
  • If you are moving a hostname containing a custom domain name to a different event broker service, you must ensure that the destination event broker service:has a custom TLS certificate containing the custom domain installed on it. There is no validation in the that prevents you from moving your custom domain hostname. Without a custom TLS certificate on the event broker service that you're moving the custom domain hostname to, connections to that custom domain hostname fail.
  • Depending on your network configuration, you may be required to update your DNS server to ensure that the CNAME for the host record points to the event broker service's system-generated hostname (the .messaging.solace.cloud address that you moved the custom domain hostname to).

Adding a Hostname with Custom Domain Name

You can add a hostname with custom domain name to an existing event broker service. Optionally, you can set it as the primary URL used to access your event broker service via the PubSub+ Broker Manager and client connections.

To add acustom domain hostname to an existing event broker service, 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 into the PubSub+ Cloud Console.
  2. Select Cluster Manager from the navigation bar.
  3. Click on the event broker service you want to add a hostname with custom domain hostname 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. With a custom TLS certificate installed, the DNS Name field starts in an active state with the Hostname field inactive.
  6. Use the drop-down in the DNS Name field to select a custom domain hostname from those available on the custom TLS certificate. Note the following:
    • If a list of custom domain names does not appear when you click on the DNS Name field, your custom TLS certificate may not contain domain names, or may be installed incorrectly. Contact Solace for support.
    • Selecting a custom domain hostname without an asterisk wildcard (for example, service.example.cloud) populates the Hostname field with the selected custom domain hostname. The Hostname field remains inaccessible.
    • Selecting a custom domain name with an asterisk wildcard (for example, *.example.com) or the default .messaging.solace.cloud domain allows access to the Hostname field. You can use the Hostname field to assign the hostname to the custom domain. See Configuring Custom Domain Hostnames for Event Broker Services.
  7. Use the Select the endpoint to assign the hostname to field and assign an endpoint. The type of endpoint available depends on the configured endpoints for the event broker service. See Changing the Port Configuration for Event Broker Services for information.
  8. Click Add Hostname to add the hostname with custom domain to the list of available hostnames.
  9. (Optional) Click the ellipses associated to the hostname with custom domain and click Set as Default. The default moves to the selected hostname. See Configuring Custom Domain Hostnames for Event Broker Services for more information.

You can confirm that the custom domain hostname is configured properly by accessing the Broker Manager.

  • You can choose to make the custom domain hostname the primary URL used to access it from PubSub+ Broker Manager. See Configuring Custom Domain Hostnames for Event Broker Services for more information.
    • If you have done so, click Open Broker Manager. If for your event broker service Broker Manager to validate that the URL in the address bar is the custom domain hostname. For example https://myservice.example.com:943/....
    • If the URL is incorrect, ensure that you update your DNS server so that the CNAME for the host record points to the event broker service's system-generated hostname.