Enable High Availability

Support, stability, and dependency info

Same-region Replication and Multi-cloud Replication are in Public Preview.

Multi-region Replication is in General Availability

You can enable High Availability features (Single-region Replication, Multi-region Replication, or Multi-cloud Replication) for a new or existing Namespace by adding a replica. When you add a replica, Temporal Cloud begins asynchronously replicating ongoing and existing Workflow Executions.

Not all replication options are available in all regions. See the region documentation for the replication options available in each region.

Using private network connectivity with a HA namespace requires extra setup. See Connectivity for HA.

There are charges associated with Replication and enabling High Availability features. For pricing details, visit Temporal Cloud's Pricing page.

Create a Namespace with High Availability features

To create a new Namespace with High Availability features, you can use the Temporal Cloud UI or the tcld command line utility.

Web UI

1. Visit Temporal Cloud in your Web browser.
2. During Namespace creation, specify the primary region for the Namespace.
3. Select "Add a replica".
4. Choose the region for the replica.

The web interface will present an estimated time for replication to complete. This time is based on your selection and the size and scale of the Workflows in your Namespace.

tcld

At the command line, enter:

tcld namespace create \
   --namespace <namespace_id>.<account_id> \
   --region <primary_region> \
   --region <replica_region>

Specify the region codes as arguments to the two --region flags.

• Using the same region replicates to an isolation domain within that region.
• Using a different region replicates across regions.

If using API key authentication with the --api-key flag, you must add it directly after the tcld command and before namespace create.

Temporal Cloud sends an email alert to all Namespace Admins once your Namespace replica is ready for use.

Add High Availability to an existing Namespace

A replica can be added after a namespace has already been created.

Web UI

1. Visit Temporal Cloud Namespaces in your Web browser.
2. Navigate to the Namespace details page.
3. Select the “Add a replica” button.
4. Choose the region for the replica.

The web interface will present an estimated time for replication to complete. This time is based on your selection and the size and scale of the Workflows in your Namespace.

Temporal Cloud sends an email alert to all Namespace Admins once your Namespace replica is ready for use.

tcld

At the command line, enter:

tcld namespace add-region \
   --namespace <namespace_id>.<account_id> \
   --region <replica_region>

Specify the region code of the region where you want to create the replica as an argument to the --region flag.

If using API key authentication with the --api-key flag, you must add it directly after the tcld command and before namespace add-region.

Temporal Cloud sends an email alert once your Namespace is ready for use.

Change a replica location

caution

We discourage changing the location of your replica for deployed applications, except under exceptional circumstances. Changing the location of your Namespace replica will result in a mandatory 7-day waiting period before you can re-enable High Availability Namespace features.

Temporal Cloud can't change replica locations directly. To update the location, you need to remove the current replica and add a new one. Follow these steps to change the replica location:

1. Remove your replica. This disables High Availability for your Namespace.
2. Wait through the required 7-day waiting period.
3. Add a new replica to your Namespace.

You will receive an email alert once your Namespace is ready for use.

Disable High Availability (remove a replica)

To disable High Availability features on a Namespace, remove the replica from that Namespace. Removing a replica disables all High Availability features:

• Discontinues replication of the Workflows in the Namespace.
• Disables the Namespace's ability to trigger a failover to a different region or cloud.
• For Workers and Clients that use API keys, removing a replica requires connecting to the Namespace using the published regional endpoint for the Namespace's region.
  • Disables connecting to the Namespace with API keys and the Namespace's endpoint or the replica region's regional endpoint.
• Ends High Availability charges.

caution

After removing a Namespace's replica, you cannot re-enable replication on that same Temporal Cloud Namespace for seven days.

Follow these steps to remove a replica from a Namespace:

Web UI

1. If you are using API keys for authentication on this Namespace, configure your Workers and Clients that use API keys to connect with the regional Temporal Cloud endpoint for the Namespace's primary region.
2. Navigate to the Namespace details page in Temporal Cloud
3. Select the option to "Remove Replica" on the "Region" card.

tcld

First, if you are using API keys for authentication on this Namespace, configure your Workers and Clients that use API keys to connect with the regional Temporal Cloud endpoint for the Namespace's primary region.

Then, run the following command to remove the replica:

tcld namespace delete-region \
    --namespace <namespace_id>.<account_id> \
    --region <replica_region>

If you are using the --api-key flag to issue this CLI command, you must add it directly after the tcld command and before namespace delete-region

info

To remove a replica from a Namespace with API keys enabled, you need assistance from Temporal Support. Please contact support with the Namespace ID of the Namespace where you want to remove the replica. You must confirm that Workers and Clients with API keys have been configured to connect to the Namespace using the published regional endpoint.

This safeguard ensures that Workers and Clients continue running uninterrupted once Temporal Support removes the replica. After the replica is removed, if Workers and Clients with API keys attempt to use the Namespace endpoint or the former replica's regional endpoint, their requests will fail.