Skip to content

docs: update etcd-sync install and upgrade guidance#675

Open
timonwong wants to merge 2 commits intomasterfrom
docs/etcd-sync-install-upgrade
Open

docs: update etcd-sync install and upgrade guidance#675
timonwong wants to merge 2 commits intomasterfrom
docs/etcd-sync-install-upgrade

Conversation

@timonwong
Copy link
Copy Markdown
Contributor

@timonwong timonwong commented Apr 17, 2026

Summary

  • update etcd-sync installation guidance for the current Secret-based token workflow
  • add standby-cluster secret creation commands and current plugin field descriptions
  • update upgrade verification steps for bootstrap resources and leader-aware sync checks

Testing

  • git diff --check -- docs/en/install/global_dr.mdx docs/en/upgrade/upgrade_global_cluster.mdx

Summary by CodeRabbit

  • Documentation
    • Updated etcd Synchronizer plugin installation and upgrade procedures with clarified configuration steps and explicit setup requirements.
    • Enhanced post-installation verification guidance including job status checks and resource validation procedures.
    • Refined leader identification and resynchronization workflow documentation for improved operational consistency.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 17, 2026

Warning

Rate limit exceeded

@timonwong has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 16 minutes and 42 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 16 minutes and 42 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3937e520-93a4-4b2a-9cd7-9131d99bb9ea

📥 Commits

Reviewing files that changed from the base of the PR and between cb4bad2 and b2b9fc6.

📒 Files selected for processing (1)
  • docs/en/install/global_dr.mdx

Walkthrough

The etcd Synchronizer plugin installation and upgrade documentation is expanded to mandate a new Secret-based token configuration, add explicit cluster endpoint and VIP parameters, implement lease-holder-based leader detection, and refactor verification and resynchronization procedures.

Changes

Cohort / File(s) Summary
etcd Synchronizer Documentation
docs/en/install/global_dr.mdx, docs/en/upgrade/upgrade_global_cluster.mdx
Introduction of etcd-sync-active-cluster-token Secret requirement, explicit configuration fields for Active Global Cluster VIP and ETCD Endpoints, updated verification steps to check etcd-sync-bootstrap Job and remote-etcd-* resources, and replacement of arbitrary pod selection with lease-holder-based leader identification and pod-specific resynchronization targeting.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested reviewers

  • chinameok

Poem

🐰 A token in secrets now leads the way,
Leader leases guide us through the fray,
Bootstrap jobs verify all is sound,
Documentation spins us all around! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main changes: updates to etcd-sync installation and upgrade documentation to reflect current Secret-based token workflow and verification procedures.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/etcd-sync-install-upgrade

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@timonwong
Copy link
Copy Markdown
Contributor Author

先不要合并,等待 etcd-sync 测试完成(包括 release-4.3)

合并这个之后,还需要往 release-4.3 去 cherry-pick

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/en/install/global_dr.mdx (1)

287-291: Routine Checks curl not updated for IPv6.

The verification snippet at Line 194-203 was updated to use curl -g with bracketed IPv6 hosts, but the Routine Checks command here still uses the bare curl $(kubectl get svc ...)/check form. In an IPv6 cluster this will produce an invalid URL for the same reason you fixed above. Consider updating it to match the new pattern for consistency.

♻️ Suggested alignment
-```bash
-curl $(kubectl get svc -n cpaas-system etcd-sync-monitor -o jsonpath='{.spec.clusterIP}')/check
-```
+```bash
+mirror_svc=$(kubectl get svc -n cpaas-system etcd-sync-monitor -o jsonpath='{.spec.clusterIP}')
+ipv6_regex="^[0-9a-fA-F:]+$"
+if [[ $mirror_svc =~ $ipv6_regex ]]; then
+  mirror_host="[$mirror_svc]"
+else
+  mirror_host="$mirror_svc"
+fi
+curl -g "http://${mirror_host}/check"
+```
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/en/install/global_dr.mdx` around lines 287 - 291, Update the Routine
Checks curl snippet that calls kubectl get svc for etcd-sync-monitor so it
handles IPv6 addresses like the earlier verification block: capture the service
IP into a variable (e.g., mirror_svc), detect if it's an IPv6 address (regex
match), wrap the host in brackets when IPv6 (mirror_host="[$mirror_svc]") and
then call curl with -g and the bracketed host (curl -g
"http://${mirror_host}/check"); replace the single-line curl $(kubectl ...)
invocation with this guarded approach to match the earlier change and avoid
invalid URLs on IPv6 clusters.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/en/install/global_dr.mdx`:
- Around line 287-291: Update the Routine Checks curl snippet that calls kubectl
get svc for etcd-sync-monitor so it handles IPv6 addresses like the earlier
verification block: capture the service IP into a variable (e.g., mirror_svc),
detect if it's an IPv6 address (regex match), wrap the host in brackets when
IPv6 (mirror_host="[$mirror_svc]") and then call curl with -g and the bracketed
host (curl -g "http://${mirror_host}/check"); replace the single-line curl
$(kubectl ...) invocation with this guarded approach to match the earlier change
and avoid invalid URLs on IPv6 clusters.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 12607ebc-b36e-4d4f-99ce-4cce9ec269f6

📥 Commits

Reviewing files that changed from the base of the PR and between 68e31d8 and cb4bad2.

📒 Files selected for processing (2)
  • docs/en/install/global_dr.mdx
  • docs/en/upgrade/upgrade_global_cluster.mdx

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Apr 17, 2026

Deploying alauda-container-platform with  Cloudflare Pages  Cloudflare Pages

Latest commit: b2b9fc6
Status: ✅  Deploy successful!
Preview URL: https://7483ff7a.alauda-container-platform.pages.dev
Branch Preview URL: https://docs-etcd-sync-install-upgra.alauda-container-platform.pages.dev

View logs

@chinameok
Copy link
Copy Markdown
Contributor

/lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants