Skip to main content

Enable high availability

Support, stability, and dependency info

High-availability Namespaces are in Public Preview for Temporal Cloud.

Some audits, updates. Needs intros, re-org

You can enable the high-availability Namespace feature for your existing Namespace by adding a second zone to your Namespace. After adding the second zone, Temporal Cloud begins data replication for your new standby replica. Temporal Cloud notifies you once the replication has caught up and both Namespace zones are in sync.

Advantages of using a high-availability Namespace:

  • No manual deployment or configuration needed, just simple push-button operation.
  • Open Workflows continue in the standby region with minimal interruption and data loss.
  • No changes needed for Worker and Workflow code during setup or failover.
  • 99.99% Contractual SLA.

Create a multi-region Namespace​

The following sections explain how to create a new multi-region Namespace (MRN). MRNs provide multi-region deployment backed by Temporal's data replication and active-standby features.

tip

While reading through this coverage, remember that pairing is currently limited to regions within the same continent.

Temporal Cloud Web UI​

During Namespace creation, specify the first region for the Namespace. Then, select the “Add a region” option. Adding a second region enables multi-region Namespace capabilities.

Temporal 'tcld' CLI​

Start with the following command to create the new multi-region Namespace:

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

Include both regions by specifying the region codes as arguments to the --region flags. Before pressing return, add your authentication credentials. For example, --ca-certificate-file <path-to-pem-file>.

Upgrade an existing single-zone Namespace for high-availability functionality​

You can upgrade existing ssingle-zone Namespace for high-availability by adding a standby zone. The following sections show you how.

The following material has not been audited for MRN/HAN

Temporal Cloud Web UI​

To upgrade an existing Namespace to a multi-region Namespace:

  1. Visit Temporal Cloud Namespaces in your Web browser
  2. Navigate to the Namespace details page
  3. Select the “Add a region” button.
  4. Select the standby region you want to add to this Namespace

You will see an estimated time for replication. This time is based on your selection and the size and scale of Workflows in your Namespace, An email alert is sent once your multi-region Namespace is ready for use.

Temporal 'tcld' CLI​

At the command line, enter:

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

Specify the region code for the new region to add. Before pressing return, add your authentication credentials. For example, --ca-certificate-file <path-to-pem-file>. An email alert is sent once your multi-region Namespace is ready for use.

Discontinuing multi-region availability​

Disabling multi-region removes the high availability and automatic failover features that provide Temporal's highest service level agreement. To disable the feature and end charges, users must contact Temporal Support directly. MRN-specific charges for replication will stop once this decommissioning procedure completes.

  • When making your request you must let us know which region you want the Namespace to land in after removing the standby region.
  • If you cease services in the middle of the month, your Namespace will be converted to a single region Namespace within 1 business day.
  • Temporal won't retain replicated data in the standby region once multi-region has been disabled.
  • After disabling multi-region, Temporal Cloud cannot re-enable the feature for a given Namespace for seven days.