Skip to content

docs(gateway): improve cluster deployment guide#577

Merged
kvinwang merged 2 commits intomasterfrom
docs/improve-gateway-cluster-deployment
Mar 19, 2026
Merged

docs(gateway): improve cluster deployment guide#577
kvinwang merged 2 commits intomasterfrom
docs/improve-gateway-cluster-deployment

Conversation

@kvinwang
Copy link
Collaborator

@kvinwang kvinwang commented Mar 19, 2026

Summary

Improvements to the gateway cluster deployment documentation and deploy scripts, based on hands-on 2-node cluster deployment experience.

Documentation (gateway/docs/cluster-deployment.md)

  • Add CVM deployment section (section 3) covering env vars, deploy steps, port planning for single-host setups
  • Add app ingress and port routing section (section 4) with SNI format explanation
  • Add test app deployment section (section 5) with end-to-end verification steps
  • Add resource sizing table and networking modes (user vs bridge) overview
  • Fix subnet scheme to use SUBNET_INDEX 0-based allocation (10.8.0.0/18, 10.8.64.0/18) matching deploy-to-vmm.sh
  • Add SUBNET_INDEX mapping table and cluster sync/peer discovery explanation
  • Add image version note: sync enable logic differs between gateway image versions
  • Fix gateway-1 config: first node should have bootnode = "", not point to gateway-2
  • Expand verification section with Admin.Status API and health check criteria
  • Add Cloudflare DNS:Edit permission requirement note

Scripts

  • Extract bootstrap logic into standalone bootstrap-cluster.sh for independent admin config
  • Simplify deploy-to-vmm.sh to focus on CVM deployment only

Test plan

  • Deployed 2-node gateway cluster on gw-test4.kvin.wang following the updated doc
  • Verified cluster sync between both nodes
  • Deployed test app (nginx) and confirmed proxy access through both gateway nodes
  • bootstrap-cluster.sh tested: ACME config, DNS credential, ZT-Domain all set up correctly

…cripts

Documentation improvements based on hands-on 2-node cluster deployment:
- Add CVM deployment section (section 3) with env vars, deploy steps, and
  port planning for single-host multi-node setups
- Add app ingress and port routing section (section 4) explaining SNI format
- Add test app deployment section (section 5) with end-to-end verification
- Add resource sizing and networking modes overview
- Fix subnet scheme to use SUBNET_INDEX 0-based allocation matching deploy
  script behavior
- Add SUBNET_INDEX mapping table and cluster sync/peer discovery docs
- Add image version note about sync enable logic differences
- Fix gateway-1 config: first node should have empty bootnode
- Expand verification section with health check criteria
- Add Cloudflare DNS:Edit permission note

Script changes:
- Extract bootstrap logic from deploy-to-vmm.sh into standalone
  bootstrap-cluster.sh for independent admin configuration
- Simplify deploy-to-vmm.sh to focus on CVM deployment only
@kvinwang kvinwang force-pushed the docs/improve-gateway-cluster-deployment branch from d5112bb to b724b75 Compare March 19, 2026 03:51
- gateway-1 bootnode: use "none" (matching actual deployment)
- disk sizing: use 20 GB for all workload tiers
@kvinwang kvinwang merged commit e628bc3 into master Mar 19, 2026
14 checks passed
@Leechael Leechael deleted the docs/improve-gateway-cluster-deployment branch March 19, 2026 07:04
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.

1 participant