Skip to content

[ISSUE #9004] docs: add nginx load balancing guide for Nacos cluster#15213

Closed
EvanYao826 wants to merge 1 commit into
alibaba:developfrom
EvanYao826:docs/nginx-cluster-load-balance
Closed

[ISSUE #9004] docs: add nginx load balancing guide for Nacos cluster#15213
EvanYao826 wants to merge 1 commit into
alibaba:developfrom
EvanYao826:docs/nginx-cluster-load-balance

Conversation

@EvanYao826
Copy link
Copy Markdown

What does this PR do?

Closes #9004: Add official documentation for using Nginx as a load balancer for a Nacos cluster.

Problem

Many users need to use Nginx to load balance a Nacos cluster, but there was no official guide. Online tutorials are often incomplete — most miss the critical stream block for gRPC proxying, causing client connection failures.

Changes

Added doc/nginx-cluster-load-balance-guide.md covering:

  • Why use Nginx instead of comma-separated server addresses
  • Complete Nginx configuration for both HTTP (8848) and gRPC (9848) protocols
  • Port mapping explanation (Nacos gRPC = HTTP port + 1000)
  • Client configuration examples
  • Troubleshooting common issues

The guide is based on the solution shared in the issue comments by the original reporter, enhanced with best practices and additional context.

Assisted-by: Hermes Agent

@github-actions
Copy link
Copy Markdown

Thanks for your this PR. 🙏
Please check again for your PR changes whether contains any usage/api/configuration change such as Add new API , Add new configuration, Change default value of configuration.
If so, please add or update documents(markdown type) in docs/next/ for repository nacos-group/nacos-group.github.io


感谢您提交的PR。 🙏
请再次查看您的PR内容,确认是否包含任何使用方式/API/配置参数的变更,如:新增API新增配置参数修改默认配置等操作。
如果是,请确保在提交之前,在仓库nacos-group/nacos-group.github.io中的docs/next/目录下添加或更新文档(markdown格式)。

@github-actions
Copy link
Copy Markdown

⚠️ Commit Author Verification Failed

The following commits have author emails not linked to any GitHub account.
This will prevent CLA signing and block your PR from being merged.

Commit Author Email
f750b9b EvanYao826 evanyao826@gmail.com

How to fix:

  1. Add your commit email to your GitHub account: https://github.com/settings/emails
  2. Or update your local git config to use an email already linked to GitHub:
    git config user.name "Your GitHub Username"
    git config user.email "your-github-email@example.com"
    
  3. Amend your commits and force-push:
    git rebase -i HEAD~1 # mark commits as "edit" and amend author
    git push --force-with-lease
    

This check will re-run automatically after you push.

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented May 21, 2026

CLA assistant check
All committers have signed the CLA.

@EvanYao826
Copy link
Copy Markdown
Author

I have read the CLA Document and I hereby sign the CLA

@EvanYao826 EvanYao826 force-pushed the docs/nginx-cluster-load-balance branch from f750b9b to dcbcafb Compare May 21, 2026 13:09
@KomachiSion
Copy link
Copy Markdown
Collaborator

please add document into nacos-group/nacos-group.github.io

@EvanYao826
Copy link
Copy Markdown
Author

Got it, I will add the documentation to nacos-group/nacos-group.github.io and update this PR accordingly. Will follow up shortly.

@EvanYao826
Copy link
Copy Markdown
Author

I have added the documentation to nacos-group/nacos-group.github.io:

nacos-group/nacos-group.github.io#1082

The guide is added under guide/admin/nginx-cluster-load-balance-guide.md in both English and Chinese versions.

@KomachiSion
Copy link
Copy Markdown
Collaborator

I have added the documentation to nacos-group/nacos-group.github.io:

nacos-group/nacos-group.github.io#1082

The guide is added under guide/admin/nginx-cluster-load-balance-guide.md in both English and Chinese versions.

Thanks, I will review in that PR.

@KomachiSion
Copy link
Copy Markdown
Collaborator

@EvanYao826 I reviewed with some comment in document PR.

EvanYao826 added a commit to EvanYao826/nacos-group.github.io that referenced this pull request May 25, 2026
Add documentation for using Nginx as a load balancer for a Nacos cluster,
covering both HTTP (8848) and gRPC (9848) protocols.

Closes alibaba/nacos#9004
Related: alibaba/nacos#15213

Assisted-by: Hermes Agent
…luster

Add comprehensive guide for using Nginx as a load balancer with Nacos clusters.
Covers HTTP and gRPC (stream) proxying, port mapping, and troubleshooting.

Assisted-by: Hermes Agent
@EvanYao826 EvanYao826 force-pushed the docs/nginx-cluster-load-balance branch from dcbcafb to 6676445 Compare May 25, 2026 11:33
@EvanYao826 EvanYao826 closed this May 25, 2026
@EvanYao826
Copy link
Copy Markdown
Author

Closing this PR as the documentation has been moved to nacos-group/nacos-group.github.io#1082 per @KomachiSion's request.

The guide is now maintained in the documentation repository under guide/admin/nginx-cluster-load-balance-guide.md (both English and Chinese versions), updated for Nacos 3.x console port (8080).

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.

分享:使用nginx做nacos集群负载均衡

3 participants