-
Notifications
You must be signed in to change notification settings - Fork 321
Document Nexus with Global Namespaces (multi-region failover) for self-hosted #4906
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
stephanos
wants to merge
54
commits into
main
Choose a base branch
from
stephan/self-hosted-nexus-global-namespaces
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+79
−24
Open
Changes from all commits
Commits
Show all changes
54 commits
Select commit
Hold shift + click to select a range
2fa885e
Add self-hosted Nexus guidance for Global Namespace failover
stephanos 4ac3d82
Update temporal-nexus.mdx
stephanos 5cab211
Apply docs style pass and note split-active-Cluster failover
stephanos 81c5e94
Refine failover section: target-types note and Vale fixes
stephanos 16a8c65
Clarify forwarding config and avoid duplicating Multi-Cluster Replica…
stephanos f8db375
Link dcRedirectionPolicy to config reference; clarify clusterInformat…
stephanos b9b66c8
Update temporal-nexus.mdx
stephanos f0dfd7e
De-duplicate httpAddress step against Enable Nexus
stephanos 1276f5e
Tighten failover behavior bullets
stephanos 87d8e8e
Shorten the httpAddress configuration step
stephanos 88f2f08
Update temporal-nexus.mdx
stephanos bd91b56
Drop operator cluster upsert caveat from httpAddress step
stephanos af98ee2
Update temporal-nexus.mdx
stephanos 383a7a4
Elaborate auto-forwarding setting and fix failover diagram
stephanos e90c423
Fix mermaid parse error and soften auto-forwarding wording
stephanos 70e982c
Fix cut-off note in failover diagram
stephanos 030e6e3
Update temporal-nexus.mdx
stephanos 628cb01
Replace failover sequence diagram with cluster/namespace topology
stephanos 65a3a91
Show before/after failover states in the diagram
stephanos 0853333
Use a sequence diagram with Cluster boxes for failover
stephanos c76f7ea
Add boom emoji to the failover note in the diagram
stephanos 92a7ad7
Use full 'Namespace', HTML bold for active-Cluster notes, rename fina…
stephanos 63eed47
Revert HTML bold in diagram notes (not rendered under strict mermaid)
stephanos 29d8dc0
Shorten failover behavior bullets
stephanos 4ae5112
Make failover bullets value-first
stephanos 0ee8078
Update temporal-nexus.mdx
stephanos ff8096b
Update temporal-nexus.mdx
stephanos 49cade2
Restore async-replication caveat and fix proper-noun casing
stephanos 75fe1a4
Reframe abrupt-loss note as a warning admonition
stephanos 41f7c06
Soften abrupt-loss note (warning to note, neutral wording)
stephanos 01a3064
Update temporal-nexus.mdx
stephanos 9b62220
Fold callback-delivery detail into the failover lead-in
stephanos 1dee3a4
Show a failed callback attempt and retry in the diagram
stephanos 29c41c3
Clarify forwarding: Nexus vs client-API paths; drop selected-apis-for…
stephanos b2e663d
Update temporal-nexus.mdx
stephanos e42e4f9
Demote dcRedirectionPolicy to optional in forwarding step
stephanos 3c2a9dc
Update temporal-nexus.mdx
stephanos 7dd7098
Update temporal-nexus.mdx
stephanos 62a080e
Update temporal-nexus.mdx
stephanos b40a311
Update temporal-nexus.mdx
stephanos 3d71d3e
Update temporal-nexus.mdx
stephanos 9d37e2f
Update temporal-nexus.mdx
stephanos 7f04fe6
Update temporal-nexus.mdx
stephanos 4f8ffe6
Use a flowchart with Cluster subgraphs for the failover diagram
stephanos 92b3a52
Give the mermaid linter a DOM so it can parse sequence box
stephanos d2e20f4
Restore sequence box failover diagram; note selected-apis-forwarding
stephanos f7576ed
Update temporal-nexus.mdx
stephanos 668317e
Update temporal-nexus.mdx
stephanos 80a3e42
Use global-jsdom for the mermaid linter DOM setup
stephanos 05e3d32
Update temporal-nexus.mdx
stephanos ff720fd
Clarify the advertise-httpAddress step
stephanos 6ee1921
Reword step 2 so the reader is the actor, not the section
stephanos 251345f
Update temporal-nexus.mdx
stephanos 87a5226
Update temporal-nexus.mdx
stephanos File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,11 @@ | ||
| // Set up a browser-like DOM before loading mermaid. mermaid.parse() uses DOM | ||
| // APIs for some diagram syntaxes (for example a sequence diagram `box`) and | ||
| // otherwise fails headless with "window is not defined". | ||
| import 'global-jsdom/register'; | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This was needed to make the mermaid chart above work; the |
||
|
|
||
| import fs from 'node:fs/promises'; | ||
| import path from 'node:path'; | ||
| import DOMPurify from 'dompurify'; | ||
| import mermaidModule from 'mermaid'; | ||
|
|
||
| const mermaid = mermaidModule.default ?? mermaidModule; | ||
| import mermaid from 'mermaid'; | ||
| const DOCS_ROOT = path.resolve('docs'); | ||
| const MARKDOWN_EXTENSIONS = new Set(['.md', '.mdx']); | ||
|
|
||
|
|
@@ -109,20 +111,6 @@ async function lintFile(filePath) { | |
| } | ||
|
|
||
| async function main() { | ||
| // Mermaid's parser may call DOMPurify hooks for some diagram syntaxes. | ||
| // In Node (without a browser window), dompurify can resolve to a minimal | ||
| // implementation that lacks hook APIs; provide no-op hooks so syntax-only | ||
| // parsing still works in CI. | ||
| if (typeof DOMPurify.addHook !== 'function') { | ||
| DOMPurify.addHook = () => {}; | ||
| } | ||
| if (typeof DOMPurify.removeHook !== 'function') { | ||
| DOMPurify.removeHook = () => {}; | ||
| } | ||
| if (typeof DOMPurify.sanitize !== 'function') { | ||
| DOMPurify.sanitize = (value) => value; | ||
| } | ||
|
|
||
| mermaid.initialize({ startOnLoad: false }); | ||
|
|
||
| const markdownFiles = await walk(DOCS_ROOT); | ||
|
|
||
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
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wasn't sure if this should be optional or recommended?