From 2a53918817720dd08cb5a76e010d763cbfc3f1f1 Mon Sep 17 00:00:00 2001
From: zhouxiang <zhouxiang.zzx@alibaba-inc.com>
Date: Fri, 29 Apr 2022 15:36:54 +0800
Subject: [PATCH] [ISSUE #3949] Add deploy guide

---
 docs/en/README.md             |  3 +++
 docs/en/proxy/deploy_guide.md | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 35 insertions(+)
 create mode 100644 docs/en/proxy/deploy_guide.md

diff --git a/docs/en/README.md b/docs/en/README.md
index b24d2403fd..79703efbe1 100644
--- a/docs/en/README.md
+++ b/docs/en/README.md
@@ -33,6 +33,9 @@
 
 - [Cluster Deployment](dledger/deploy_guide.md)：introduce how to deploy Dledger in cluster.
 
+- [GRPC Proxy Deployment](proxy/deploy_guide.md)
+Introduce how to deploy gRPC proxy (both `Local` mode and `Cluster` mode).
+
 ### 5. Operation and maintenance management
 - [Operation](operation.md)：introduce RocketMQ's deployment modes that including single-master mode, multi-master mode, multi-master multi-slave mode and so on, as well as the usage of operation tool mqadmin.
 
diff --git a/docs/en/proxy/deploy_guide.md b/docs/en/proxy/deploy_guide.md
new file mode 100644
index 0000000000..6447d5b6b0
--- /dev/null
+++ b/docs/en/proxy/deploy_guide.md
@@ -0,0 +1,32 @@
+# RocketMQ Proxy Deployment Guide
+
+## Overview
+RocketMQ Proxy supports two deployment modes, `Local` mode and `Cluster` mode. 
+
+With `Local` mode, `Proxy` deployed with `Broker` in the same process with inter-process communication.
+
+While `Cluster` mode, `Proxy` is a single cluster who communicate `Broker` with remote procedure call. In this way, `Proxy` acts as a stateless computing components while `Broker` is a stateful components with local storage. This form of deployment makes RocketMQ an architecture of separation of computing and storage.
+
+## Configuration
+The configuration applies to both the `Cluster` mode and `Local` mode, whose default path is distribution/conf/rmq-proxy.json directory. 
+
+## `Cluster` mode
+* Set configuration field `nameSrvAddr`.
+* Set configuration field `proxyMode` to `cluster` (case insensitive).
+
+
+Run the command below.
+```shell
+nohup sh mqproxy &
+```
+The command will only run `Proxy` itself. It requires `Namesrv` and `Broker` components running.
+
+## `Local` mode
+* Set configuration field `nameSrvAddr`.
+* Set configuration field `proxyMode` to `local` (case insensitive).
+
+Run the command below.
+```shell
+nohup sh mqproxy &
+```
+The command will not only run `Proxy`, but also run `Broker`. It requires `Namesrv` only and there's no need for extra `Broker`.
\ No newline at end of file