You can clone an event broker service using Cluster Manager. Cloning an event broker service allows you to create copies of existing event broker services, including their configurations. The copy includes most of the event broker service configurations, including clients, queues, connectors, access control, and caches. For a list of items that aren't cloned, see the Considerations for Cloning an Event Broker Service.
You can combine cloning with custom hostnames to connect your applications to the cloned event broker service. This prevents the need to reconfigure the connectivity of the applications. Using custom hostnames allows you to migrate your event broker services quickly, without downtime. You perform all these functions from the Cloud Console. See Configuring Custom Hostnames for an Event Broker Service for more information.
Use Cases
Cloning event broker service saves you time that would otherwise be spent configuring new services. Below are some sample use cases where cloning would prove valuable:
- Moving to a New Region or Cloud Provider
-
You can use cloning to copy event broker services to a new region. You may do this to keep the physical distance between your event broker services and applications to a minimum, keeping latency low. Cloning is also an efficient way to migrate your event broker service to a new cloud provider. Maybe you want to change cloud providers to meet your evolving business needs, or to expand the event broker services in your event mesh to providers to increase resiliency. Cloning provides a simple method of achieving this by moving your already configured event broker services.
- Deploying or Expanding an Event Mesh
-
Cloning event broker services can speed up the deployment of your event mesh. You can create a single event broker service and configure it as a starting point to meet your event mesh requirements. Once this basic event broker service is configured, you can clone it, using it as the template for other event broker services the event mesh. If you are concerned with disaster recovery, you can clone event broker services to new regions to increase the resiliency of your event mesh.
Considerations for Cloning an Event Broker Service
Consider the following information when using the Cloud Console to clone an event broker service:
- You can only clone event broker services that are version 10.0 or greater. If the event broker service you want to clone is not 10.0 or greater, you must upgrade it before cloning. See Upgrading Event Broker Services in PubSub+ Cloud .
- You must have the Mission Control Manager or Administrator role. For more information, see Roles and Permissions.
- Before cloning event broker services, we recommend that you confirm that the target region (datacenter) has the service classes that you require.
- Your account must also have enough available services to create new event broker services. The number of services that you can create in your account are based on your service limits. If you require more services or have reached your service limits, see Increasing Your Capacity or Number of Event Broker Services.
- You can only create a clone event broker service with the same service class and version as the source event broker service. To upscale or upgrade an event broker service, see Upscaling Event Broker Services and Upgrading Event Broker Services in PubSub+ Cloud .
-
If your organization uses environments, you clone event broker services in the environment you currently have selected. This is reflected by the read-only Environment field on the Clone Service page. Your currently selected environment affects the options available in the Cloud and Region fields. For more information, see Creating and Managing Environments.
- Cloning copies any additional spool size you have configured for the source event broker service. You must ensure you have enough remaining GB in your message spool expansion to clone the event broker service. For more information, see Configuring Message Spool Sizes
-
During the clone process, the following event broker services configurations are not cloned:
- Bridge configuration
- Event mesh configuration (Dynamic Message Routing (DMR) configuration)
- Distributed tracing configuration
- Single sign-on (SSO) configuration (OAuth profiles)
- Event broker service SSO (for management access)
- Any client certificates other than those used for REST delivery points (RDPs)
- Domain and Client Certificate Authorities (CA). You can choose to clone them by enabling the option to do so on the Create Service: Clone page.
-
Cloning enables the same ports and port numbers from the source service. After the cloned service is created, you can change the enabled connection endpoints or edit the ports. For more information about the port details, see Details for Port Configuration.
Port numbers are not cloned if you are using NodePort. The same ports will be enabled or disabled, but new numbers will be generated after service creation.
- Cloning does not copy over any messages from the source event broker service.
- Cloning an event broker service with deletion protection enabled creates a new event broker service that also has deletion protection enabled. If creation of the new event broker service fails, the deletion protection is disabled, allowing you to delete it.
Cloning an Event Broker Service
- 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
- Select Cluster Manager
on the navigation bar. -
Select an environment if prompted to do so. For more information see Selecting an Environment.
- Select the event broker service you want to clone, click Actions
and select Clone Service.
The Create Service: Clone Pre-Check dialog opens.
The Create Service: Clone Pre-Check dialog includes a list of pre-check validations as well as any warning or errors. These items are related to the information and prerequisites listed in Considerations for Cloning an Event Broker Service.
- Pre-check validations passed—items that passed validation, shown for informational purposes
- Warnings—items that can't or won't be cloned, shown for informational purposes only
- Errors—items preventing the clone process from continuing. Errors indicate the issue and actions you can take to remedy them
- Click Continue.
The Clone Service page opens.
Most of the fields on the Clone Service page populate with information from the source event broker service. You can change some of the fields, including:
- Service Name—The default value is the same name as the source event broker service appended with '- Clone'. You can optionally enter a new name for the clone event broker service.
- Environment—The default value is the same environment as the source event broker service. You can use the field to choose a different environment. Your choice in the environment field affects the options in the Cloud and Region fields. For more information, see Creating and Managing Environments.
- Cloud—The default value is the same cloud provider as the source event broker service. You can use the field to choose a different cloud provider.
- Region—The default value is the same region as the source event broker service. You can use the field to choose a different region.
- (Optional) Click Advanced Connection Options to see the configuration of the connectivity options for the cloned event broker service, including:
- Message VPN Name
- Cluster Name
- (Optional) Click Port Configuration to change the connection endpoints. For more information, see Configuring Client and Management Ports.
- (Optional) Under Clone Options, select the Certificate Authorities check box if you want to copy the client and domain CA certificates from the source event broker service. See Managing Domain and Client Certificate Authorities for more information.
- Click Clone Service.
Cloning the source event broker service takes a few minutes. When cloning is complete, your new event broker service starts. You can view your created service in Cluster Manager on the Services page. See Viewing Event Broker Services.