Add MariaDB distributed disaster recovery (DC-DR) guide#939
Open
tamalsaha wants to merge 1 commit into
Open
Conversation
Signed-off-by: Tamal Saha <tamal@appscode.com>
![kodiak-appscode[bot]](https://avatars.githubusercontent.com/in/92481?s=60&v=4){kind=small}
📝 WalkthroughWalkthroughThis PR adds new documentation for MariaDB Cross Data Center Disaster Recovery (DC-DR) under the distributed MariaDB guides, including an index page, an architecture overview, a step-by-step setup guide, and example YAML manifests for a ChangesMariaDB DC-DR Documentation
Sequence Diagram(s)sequenceDiagram
participant Client
participant dr-controlplane
participant ActiveDC as Active DC Galera
participant StandbyDC as Standby DC Galera
Client->>dr-controlplane: Switchover annotation
dr-controlplane->>dr-controlplane: Update primary-dc Lease
dr-controlplane->>ActiveDC: Quiesce writes, GTID catch-up
ActiveDC->>StandbyDC: Async GTID replication
dr-controlplane->>StandbyDC: Promote to Primary
Client->>StandbyDC: Route writes to new active DC
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (7)
docs/guides/mariadb/distributed/disaster-recovery/overview/index.md (1)
86-91: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAdd language tags to fenced code blocks.
Several fenced code blocks lack language identifiers, which triggers markdownlint warnings and can cause incorrect syntax highlighting:
- Line 86: Use
textfor the ConfigMap structure pseudo-code.- Line 188: Use
yamlfor the annotation example.- Line 237: Use
textfor the ASCII architecture diagram.- Line 274: Use
yamlfor the annotation example.📝 Proposed fixes
-``` +```text ConfigMap primary-dc (namespace dc-failover, on each spoke)-``` +```yaml dr.kubedb.com/switchover-to: <dc>-``` +```text dr-controlplane (3 site etcd quorum)-``` +```yaml dr.kubedb.com/enabled: "true"Also applies to: 188-190, 237-262, 274-276
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guides/mariadb/distributed/disaster-recovery/overview/index.md` around lines 86 - 91, Add language identifiers to the fenced code blocks in the disaster-recovery overview markdown so markdownlint stops flagging them and syntax highlighting is correct; update the ConfigMap pseudo-code and ASCII diagram blocks to use text, and the annotation example blocks to use yaml. Check the affected fenced sections in this document and ensure each fence has the appropriate language tag.docs/guides/mariadb/distributed/disaster-recovery/setup/index.md (5)
235-235: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueHyphenate compound modifier in heading: "read-only".
"read only" should be "read-only" for correct compound-modifier hyphenation in the heading.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guides/mariadb/distributed/disaster-recovery/setup/index.md` at line 235, Update the heading in the disaster recovery setup guide to use the hyphenated compound modifier “read-only” instead of “read only”. This is a straightforward wording fix in the markdown heading “Confirm the standby DC is read only and following”; change only the heading text so it reads naturally and consistently with standard compound-modifier usage.
67-67: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueHyphenate compound modifier: "self-contained".
"self contained Galera cluster" should be "self-contained Galera cluster" for correct compound-modifier hyphenation.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guides/mariadb/distributed/disaster-recovery/setup/index.md` at line 67, The phrase in the disaster-recovery setup doc uses an unhyphenated compound modifier; update the wording around the “self contained Galera cluster” text to “self-contained Galera cluster” for correct grammar. Locate the sentence describing each cluster and adjust only that compound adjective in the markdown content.
43-43: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueHyphenate compound modifier: "three-site".
"three site etcd quorum" should be "three-site etcd quorum" for correct compound-modifier hyphenation.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guides/mariadb/distributed/disaster-recovery/setup/index.md` at line 43, Update the wording in the affected disaster-recovery setup text to hyphenate the compound modifier by changing the phrase used with the etcd quorum to “three-site etcd quorum”; keep the rest of the sentence unchanged and ensure the copy in the same section remains consistent with that terminology.
268-268: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valuePrefer "deliberately" over "on purpose".
"on purpose" is colloquial; "deliberately" is more precise for technical documentation.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guides/mariadb/distributed/disaster-recovery/setup/index.md` at line 268, Replace the colloquial phrase “on purpose” in the disaster-recovery setup prose with “deliberately” to keep the documentation precise and technical; update the sentence in the affected paragraph without changing its meaning.
15-15: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueDescriptive link text recommended.
The "here" link text is not descriptive per markdownlint MD059. Consider: "Please start with the KubeDB quickstart guide."
- > **New to KubeDB?** Please start [here](/docs/README.md). + > **New to KubeDB?** Please start with the [KubeDB quickstart guide](/docs/README.md).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guides/mariadb/distributed/disaster-recovery/setup/index.md` at line 15, The introductory markdown link text is too generic and should be made descriptive to satisfy the link-text lint rule. Update the sentence containing the link to /docs/README.md in this guide so it uses meaningful text like the KubeDB quickstart guide, and keep the rest of the sentence intact while making the anchor text descriptive enough to indicate what the target page is.docs/guides/mariadb/distributed/disaster-recovery/setup/yamls/placement-policy.yaml (1)
12-13: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueHyphenate in comment: "self-contained".
"self contained" should be "self-contained" in the comment describing the Galera cluster.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/guides/mariadb/distributed/disaster-recovery/setup/yamls/placement-policy.yaml` around lines 12 - 13, Update the comment in placement-policy.yaml so the description of the Galera cluster uses the hyphenated form “self-contained” instead of “self contained.” Keep the change limited to the surrounding failoverPolicy commentary and preserve the existing meaning and wording otherwise.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/guides/mariadb/distributed/disaster-recovery/overview/index.md`:
- Around line 86-91: Add language identifiers to the fenced code blocks in the
disaster-recovery overview markdown so markdownlint stops flagging them and
syntax highlighting is correct; update the ConfigMap pseudo-code and ASCII
diagram blocks to use text, and the annotation example blocks to use yaml. Check
the affected fenced sections in this document and ensure each fence has the
appropriate language tag.
In `@docs/guides/mariadb/distributed/disaster-recovery/setup/index.md`:
- Line 235: Update the heading in the disaster recovery setup guide to use the
hyphenated compound modifier “read-only” instead of “read only”. This is a
straightforward wording fix in the markdown heading “Confirm the standby DC is
read only and following”; change only the heading text so it reads naturally and
consistently with standard compound-modifier usage.
- Line 67: The phrase in the disaster-recovery setup doc uses an unhyphenated
compound modifier; update the wording around the “self contained Galera cluster”
text to “self-contained Galera cluster” for correct grammar. Locate the sentence
describing each cluster and adjust only that compound adjective in the markdown
content.
- Line 43: Update the wording in the affected disaster-recovery setup text to
hyphenate the compound modifier by changing the phrase used with the etcd quorum
to “three-site etcd quorum”; keep the rest of the sentence unchanged and ensure
the copy in the same section remains consistent with that terminology.
- Line 268: Replace the colloquial phrase “on purpose” in the disaster-recovery
setup prose with “deliberately” to keep the documentation precise and technical;
update the sentence in the affected paragraph without changing its meaning.
- Line 15: The introductory markdown link text is too generic and should be made
descriptive to satisfy the link-text lint rule. Update the sentence containing
the link to /docs/README.md in this guide so it uses meaningful text like the
KubeDB quickstart guide, and keep the rest of the sentence intact while making
the anchor text descriptive enough to indicate what the target page is.
In
`@docs/guides/mariadb/distributed/disaster-recovery/setup/yamls/placement-policy.yaml`:
- Around line 12-13: Update the comment in placement-policy.yaml so the
description of the Galera cluster uses the hyphenated form “self-contained”
instead of “self contained.” Keep the change limited to the surrounding
failoverPolicy commentary and preserve the existing meaning and wording
otherwise.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 9a0f9ce6-6739-45db-b7d2-1079689a7685
📒 Files selected for processing (5)
docs/guides/mariadb/distributed/disaster-recovery/_index.mddocs/guides/mariadb/distributed/disaster-recovery/overview/index.mddocs/guides/mariadb/distributed/disaster-recovery/setup/index.mddocs/guides/mariadb/distributed/disaster-recovery/setup/yamls/mariadb.yamldocs/guides/mariadb/distributed/disaster-recovery/setup/yamls/placement-policy.yaml
|
Visit the preview URL for this PR (updated for commit 85f3806): https://kubedb-v2-hugo--pr939-pr-mariadb-dc-dr-doc-jaw1axzd.web.app (expires Tue, 07 Jul 2026 21:44:14 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 0f29ae8ae0bd54a99bf2b223b6833be47acd5943 |
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
1 participant
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.
Summary
Adds a new Disaster Recovery (DC-DR) subsection under the MariaDB distributed guide, documenting the cross data center disaster recovery design for distributed MariaDB.
New section
docs/guides/mariadb/distributed/disaster-recovery/:overview/index.md(weight 10): architecture and concepts. Covers why a stretched Galera cluster is fragile across DCs, the per Member DC self contained Galera model with strictly intra-DC quorum, thedr-controlplanethree site etcd quorum and the singleprimary-dcLease, the projected marker ConfigMap fail-closed fence (namespacedc-failover, 30s TTL), the net-new leader to leader GTID asynchronous cross-DC link and its required Galera to Galera GTID config, role labeling so only the active DC resolves on the primary Service, the Arbiter DC and per-DC garbd, planned switchover (zero RPO) vs unplanned failover vs SST re-seed failback, the cross-DC lag guard, andstatus.disasterRecovery. Includes a text architecture diagram (no image files).setup/index.md(weight 20): how-to that enables DC-DR, applies a PlacementPolicy withfailoverPolicy(mode TwoDC, trigger scope Global) and Member/ArbiterdistributionRules, creates the distributed MariaDB CR, and verifies exactly one writable DC (Lease, status, role labels, standby read-only fence, write rejection). Also shows the planned switchover annotation.setup/yamls/: example PlacementPolicy (two Member DCs plus one Arbiter DC) and a distributed MariaDB manifest, mirroring the design's key patterns.The section sorts at weight 40, between the distributed overview (10) and autoscaler (47).
All pages use the standard Hugo
docs_{{ .version }}menu templating and theNew to KubeDB?lead line. No em-dashes. Internal links use root-absolute/docs/...paths.Summary by CodeRabbit