From a3e54fcb1bc8836a7152fd660d718e60bbab6ad5 Mon Sep 17 00:00:00 2001 From: mxsm Date: Mon, 5 Sep 2022 08:27:48 +0800 Subject: [PATCH] [ISSUE #4993] Polish the documents for mq Dledger Quick Deployment (#4994) --- docs/cn/dledger/quick_start.md | 39 +++++++++++++++++++--------------- docs/en/dledger/quick_start.md | 39 +++++++++++++++++++--------------- 2 files changed, 44 insertions(+), 34 deletions(-) diff --git a/docs/cn/dledger/quick_start.md b/docs/cn/dledger/quick_start.md index 2c88271bba..8311395d99 100644 --- a/docs/cn/dledger/quick_start.md +++ b/docs/cn/dledger/quick_start.md @@ -11,33 +11,36 @@ #### 1.1 构建 DLedger -`git clone https://github.com/openmessaging/dledger.git` - -`cd dledger` - -`mvn clean install -DskipTests` +```shell +$ git clone https://github.com/openmessaging/dledger.git +$ cd dledger +$ mvn clean install -DskipTests +``` #### 1.2 构建 RocketMQ -`git clone https://github.com/apache/rocketmq.git` - -`cd rocketmq` - -`git checkout -b store_with_dledger origin/store_with_dledger` - -`mvn -Prelease-all -DskipTests clean install -U` +```shell +$ git clone https://github.com/apache/rocketmq.git +$ cd rocketmq +$ git checkout -b store_with_dledger origin/store_with_dledger +$ mvn -Prelease-all -DskipTests clean install -U +``` ### 2. 快速部署 在构建成功后 -`cd distribution/target/apache-rocketmq` - -`sh bin/dledger/fast-try.sh start` +```shell +#{rocketmq-version} replace with rocketmq actual version. example: 5.0.0-SNAPSHOT +$ cd distribution/target/rocketmq-{rocketmq-version}/rocketmq-{rocketmq-version} +$ sh bin/dledger/fast-try.sh start +``` 如果上面的步骤执行成功,可以通过 mqadmin 运维命令查看集群状态。 -`sh bin/mqadmin clusterList -n 127.0.0.1:9876` +```shell +$ sh bin/mqadmin clusterList -n 127.0.0.1:9876 +``` 顺利的话,会看到如下内容: @@ -49,7 +52,9 @@ 关闭快速集群,可以执行: -`sh bin/dledger/fast-try.sh stop` +```shell +$ sh bin/dledger/fast-try.sh stop +``` 快速部署,默认配置在 conf/dledger 里面,默认的存储路径在 /tmp/rmqstore。 diff --git a/docs/en/dledger/quick_start.md b/docs/en/dledger/quick_start.md index 762f31a8a9..83fa762364 100644 --- a/docs/en/dledger/quick_start.md +++ b/docs/en/dledger/quick_start.md @@ -10,33 +10,36 @@ Build phase contains two parts, first, build DLedger, then build RocketMQ. #### 1.1 Build DLedger -`git clone https://github.com/openmessaging/dledger.git` - -`cd dledger` - -`mvn clean install -DskipTests` +```shell +$ git clone https://github.com/openmessaging/dledger.git +$ cd dledger +$ mvn clean install -DskipTests +``` #### 1.2 Build RocketMQ -`git clone https://github.com/apache/rocketmq.git` - -`cd rocketmq` - -`git checkout -b store_with_dledger origin/store_with_dledger` - -`mvn -Prelease-all -DskipTests clean install -U` +```shell +$ git clone https://github.com/apache/rocketmq.git +$ cd rocketmq +$ git checkout -b store_with_dledger origin/store_with_dledger +$ mvn -Prelease-all -DskipTests clean install -U +``` ### 2. Quick Deployment after build successful -`cd distribution/target/apache-rocketmq` - -`sh bin/dledger/fast-try.sh start` +```shell +#{rocketmq-version} replace with rocketmq actual version. example: 5.0.0-SNAPSHOT +$ cd distribution/target/rocketmq-{rocketmq-version}/rocketmq-{rocketmq-version} +$ sh bin/dledger/fast-try.sh start +``` if the above commands executed successfully, then check cluster status by using mqadmin operation commands. -`sh bin/mqadmin clusterList -n 127.0.0.1:9876` +```shell +$ sh bin/mqadmin clusterList -n 127.0.0.1:9876 +``` If everything goes well, the following content will appear: @@ -48,7 +51,9 @@ After startup successful, producer can produce message, and then test failover s Stop cluster fastly, execute the following command: -`sh bin/dledger/fast-try.sh stop` +```shell +$ sh bin/dledger/fast-try.sh stop +``` Quick deployment, default configuration is in directory conf/dledger,default storage path is /tmp/rmqstore.