You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Extra tips about Connectivity and High Availability (#4359)
* docs: Add connectivity and failover clarifications from field feedback
- GCP PSC: Add troubleshooting callout that Connectivity Rules are mandatory
- AWS PrivateLink: Document direct VPCE targeting without per-namespace DNS
- Failovers: Clarify that successful failover API calls guarantee completion
- HA connectivity: Warn about Private Hosted Zones blocking failover routing
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* Quick updates about failover and connectivity
* move sections and point to alternative early
* fix build error
---------
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: Lenny Chen <lenny.chen@temporal.io>
Copy file name to clipboardExpand all lines: docs/cloud/connectivity/aws-connectivity.mdx
+24-6Lines changed: 24 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,6 +29,8 @@ This one-way connection means Temporal cannot establish a connection back to you
29
29
This is useful if normally you block traffic egress as part of your security protocols.
30
30
If you use a private environment that does not allow external connectivity, you will remain isolated.
31
31
32
+
After creating the PrivateLink endpoint, configure your clients to use it through either [private DNS](#configuring-private-dns-for-aws-privatelink) or [direct VPCE targeting](#direct-vpce) (single-region Namespaces only).
33
+
32
34
## Requirements
33
35
34
36
Your AWS PrivateLink endpoint must be in the same region as your Temporal Cloud namespace. If using [replication for High Availability](/cloud/high-availability), the PL connection must be in the same region as one of the replicas.
@@ -74,14 +76,10 @@ Individual Namespaces do not use separate services.
74
76
This can take up to 10 minutes.
75
77
12. Once the status is "Available", the AWS PrivateLink is ready for use.
76
78
77
-
:::caution
78
-
You still need to set up private DNS or override client configuration for your clients to actually use the new PrivateLink connection to connect to Temporal Cloud.
79
-
80
-
See [configure private DNS for AWS PrivateLink](#configuring-private-dns-for-aws-privatelink)
81
-
:::
82
-
83
79

84
80
81
+
The next step is to [configure private DNS](#configuring-private-dns-for-aws-privatelink) so your clients can use the PrivateLink connection. For single-region Namespaces that don't need per-Namespace DNS records, you can use [direct VPCE targeting](#direct-vpce) instead.
82
+
85
83
## Configuring Private DNS for AWS PrivateLink
86
84
87
85
### Why configure private DNS?
@@ -230,6 +228,26 @@ Consider how you’ll configure Workers for this setup.
230
228
You can either have Workers run in both regions continuously or establish connectivity between regions using Transit Gateway or VPC Peering.
231
229
This way, Workers can access the newly activated region once failover occurs.
232
230
231
+
## Direct VPCE targeting without per-Namespace DNS {#direct-vpce}
232
+
233
+
For single-region Namespaces, you can avoid creating DNS records for each Namespace by pointing Workers directly at the VPC Endpoint and overriding the TLS Server Name Indicator (SNI):
234
+
235
+
1. Create the PrivateLink VPC Endpoint (one per region — all Namespaces in that region share it).
236
+
2. Configure each Worker with:
237
+
-**Endpoint**: the VPC Endpoint DNS name (e.g., `vpce-0123456789abcdef-abc.us-east-1.vpce.amazonaws.com:7233`)
238
+
-**Server name** (SNI override): the Namespace Endpoint value (e.g., `my-namespace.my-account.tmprl.cloud`)
239
+
240
+
With this approach, new Namespaces do not require new DNS records.
241
+
242
+
:::warning Not compatible with High Availability Namespaces
243
+
244
+
This approach does not work for Namespaces with High Availability features.
245
+
HA Namespaces rely on Temporal's public DNS CNAME records to route traffic to the active region during failover.
246
+
If you bypass DNS, your Workers cannot follow the CNAME to the new region.
247
+
For HA Namespaces, use [private DNS](#configuring-private-dns-for-aws-privatelink) instead.
248
+
249
+
:::
250
+
233
251
## Available AWS regions, PrivateLink endpoints, and DNS record overrides
234
252
235
253
The following table lists the available Temporal regions, PrivateLink endpoints, and regional endpoints used for DNS record overrides:
Copy file name to clipboardExpand all lines: docs/cloud/connectivity/gcp-connectivity.mdx
+8Lines changed: 8 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -79,6 +79,14 @@ Individual Namespaces do not use separate services.
79
79
80
80
7. Once the status is "Accepted", the GCP Private Service Connect endpoint is ready for use.
81
81
82
+
:::tip Connectivity Rule required
83
+
84
+
If your Private Service Connect connection status is not becoming "Active", verify that you have [created a Connectivity Rule](/cloud/connectivity#creating-a-connectivity-rule).
85
+
Connectivity Rules are mandatory for GCP Private Service Connect connections.
86
+
The connection will not become active without one.
87
+
88
+
:::
89
+
82
90
- Take note of the **IP address** that has been assigned to your endpoint, as it will be used to connect to Temporal Cloud.
Copy file name to clipboardExpand all lines: docs/cloud/high-availability/failovers.mdx
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -278,6 +278,10 @@ Both methods return a [`FailoverNamespaceRegionResponse`](https://buf.build/temp
278
278
279
279
</Tabs>
280
280
281
+
Once the failover async operation returns successfully, the Namespace will be failed over.
282
+
Temporal manages retries for the failover workflow.
283
+
In the rare event that an internal error prevents the failover from completing, the Temporal on-call team is automatically paged to intervene and force the failover to completion.
284
+
281
285
Temporal fails over the primary to the replica.
282
286
When you're ready to fail back, follow these failover instructions to move the primary back to the original.
0 commit comments