docs(ha): clarify that disablePassivePollerForwarding only stops Worker polls - #5014
Open
lukeknep wants to merge 1 commit into
Open
docs(ha): clarify that disablePassivePollerForwarding only stops Worker polls#5014lukeknep wants to merge 1 commit into
lukeknep wants to merge 1 commit into
Conversation
…er polls Client APIs are still forwarded from the passive replica to the active region when disablePassivePollerForwarding is enabled, so Workflow starters, Signal senders, and Queries in the passive region keep succeeding even though that region's Workers receive no tasks. - enable.mdx: replace the single-line note with a linkable subsection listing the forwarded Workflow, Standalone Activity, and Standalone Nexus Operation APIs, and link the whitelist in the Temporal Server source as the list of record. - architecture-patterns.mdx: scope the Active/Hot-Passive claims to Workflow and Activity Task processing; note that Clients in the secondary region still forward and pay the cross-region hop. - index.mdx, ha-connectivity.mdx: say which traffic forwarding can be turned off for and which is always forwarded. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
| | **[Active/Hot-Passive](#active-hot)** | Both regions; secondary on warm standby | Low RTO with all task processing in the active region; fast Worker failover with no cold start | More configuration and the cost of a full standby fleet | | ||
| | **[Active/Active](#active-active)** | All regions, all processing Workflows | Low RTO with Workers active in every region; fast failover that uses fleet capacity instead of a standby fleet | Cross-region requests add Workflow latency; external systems need a cross-region consistency story | | ||
|
|
||
| ## Active/Passive {/* #active-cold */} |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Active/Passive ********************' should use sentence-style capitalization.
Contributor
📖 Docs PR preview links |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
disablePassivePollerForwardingstops Worker polls from being forwarded off the passive replica. It does not stop Client requests: Workflow and Standalone Activity Starts, Signals, Signal-with-Start, Queries, Cancels, Terminates, and Deletes are all still forwarded to the active region and succeed. SeeselectedAPIsForwardingRedirectionPolicyWhitelistedAPIs.The HA docs implied the setting isolated the passive region more completely than it does, so a reader could reasonably expect a Workflow starter in the passive region to fail. It doesn't — only that region's Workers stop receiving tasks.
Changes
enable.mdx— replaced the one-line note with a linkable subsection, "Client requests are forwarded regardless of this setting" (#client-requests-still-forwarded). Lists the forwarded Workflow, Standalone Activity, and Standalone Nexus Operation APIs in a table, links the Server source as the list of record, and states the consequence: a Client on the passive replica keeps working, and the active region's Workers process the resulting tasks.architecture-patterns.mdx— Active/Hot-Passive claims scoped to Workflow and Activity Task processing. "Strict single-region behavior... guaranteed to act like a single region" was the most overstated line. The component table and benefits now note that Clients in the secondary region still forward and pay the cross-region hop.index.mdx,ha-connectivity.mdx— the request-forwarding overviews now distinguish the traffic you can turn off from the traffic that is always forwarded.docs/cli/command-reference/cloud/namespace.mdxis untouched because it is generated from the CLI.Testing
yarn buildpasses; new links and anchors resolve.🤖 Generated with Claude Code
┆Attachments: EDU-6867 docs(ha): clarify that disablePassivePollerForwarding only stops Worker polls