You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by GitBox <gi...@apache.org> on 2022/12/24 08:17:14 UTC
[GitHub] [rocketmq] mxsm opened a new pull request, #5771: [ISSUE #5770]Translation controller quick_start.md chinese document to english document
mxsm opened a new pull request, #5771:
URL: https://github.com/apache/rocketmq/pull/5771
**Make sure set the target branch to `develop`**
## What is the purpose of the change
close #5770
## Brief changelog
- Translation controller quick_start.md chinese document to english document
## Verifying this change
XXXX
Follow this checklist to help us incorporate your contribution quickly and easily. Notice, `it would be helpful if you could finish the following 5 checklist(the last one is not necessary)before request the community to review your PR`.
- [x] Make sure there is a [Github issue](https://github.com/apache/rocketmq/issues) filed for the change (usually before you start working on it). Trivial changes like typos do not require a Github issue. Your pull request should address just this issue, without pulling in other changes - one PR resolves one issue.
- [x] Format the pull request title like `[ISSUE #123] Fix UnknownException when host config not exist`. Each commit in the pull request should have a meaningful subject line and body.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit-test(over 80% coverage) to verify your logic correction, more mock a little better when cross module dependency exist. If the new feature or significant change is committed, please remember to add integration-test in [test module](https://github.com/apache/rocketmq/tree/master/test).
- [x] Run `mvn -B clean apache-rat:check findbugs:findbugs checkstyle:checkstyle` to make sure basic checks pass. Run `mvn clean install -DskipITs` to make sure unit-test pass. Run `mvn clean test-compile failsafe:integration-test` to make sure integration-test pass.
- [ ] If this contribution is large, please file an [Apache Individual Contributor License Agreement](http://www.apache.org/licenses/#clas).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [rocketmq] mxsm commented on pull request #5771: [ISSUE #5770]Translation controller quick_start.md chinese document to english document
Posted by GitBox <gi...@apache.org>.
mxsm commented on PR #5771:
URL: https://github.com/apache/rocketmq/pull/5771#issuecomment-1364486572
@tsunghanjacktsai PTAL~
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [rocketmq] codecov-commenter commented on pull request #5771: [ISSUE #5770]Translation controller quick_start.md chinese document to english document
Posted by GitBox <gi...@apache.org>.
codecov-commenter commented on PR #5771:
URL: https://github.com/apache/rocketmq/pull/5771#issuecomment-1367090734
# [Codecov](https://codecov.io/gh/apache/rocketmq/pull/5771?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) Report
> Merging [#5771](https://codecov.io/gh/apache/rocketmq/pull/5771?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (fd03c67) into [develop](https://codecov.io/gh/apache/rocketmq/commit/9f8e85bb7640a3264fb6d7f43ed3834546f73fcf?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (9f8e85b) will **decrease** coverage by `0.03%`.
> The diff coverage is `n/a`.
```diff
@@ Coverage Diff @@
## develop #5771 +/- ##
=============================================
- Coverage 42.40% 42.36% -0.04%
+ Complexity 8231 8225 -6
=============================================
Files 1060 1060
Lines 73363 73363
Branches 9601 9601
=============================================
- Hits 31108 31083 -25
- Misses 38341 38364 +23
- Partials 3914 3916 +2
```
| [Impacted Files](https://codecov.io/gh/apache/rocketmq/pull/5771?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) | Coverage Δ | |
|---|---|---|
| [...e/rocketmq/store/ha/autoswitch/EpochFileCache.java](https://codecov.io/gh/apache/rocketmq/pull/5771/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3RvcmUvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL3JvY2tldG1xL3N0b3JlL2hhL2F1dG9zd2l0Y2gvRXBvY2hGaWxlQ2FjaGUuamF2YQ==) | `77.08% <0.00%> (-4.17%)` | :arrow_down: |
| [...controller/impl/DefaultBrokerHeartbeatManager.java](https://codecov.io/gh/apache/rocketmq/pull/5771/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-Y29udHJvbGxlci9zcmMvbWFpbi9qYXZhL29yZy9hcGFjaGUvcm9ja2V0bXEvY29udHJvbGxlci9pbXBsL0RlZmF1bHRCcm9rZXJIZWFydGJlYXRNYW5hZ2VyLmphdmE=) | `82.27% <0.00%> (-3.80%)` | :arrow_down: |
| [...ketmq/proxy/grpc/v2/channel/GrpcClientChannel.java](https://codecov.io/gh/apache/rocketmq/pull/5771/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-cHJveHkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL3JvY2tldG1xL3Byb3h5L2dycGMvdjIvY2hhbm5lbC9HcnBjQ2xpZW50Q2hhbm5lbC5qYXZh) | `49.07% <0.00%> (-2.78%)` | :arrow_down: |
| [...pl/consumer/ConsumeMessageConcurrentlyService.java](https://codecov.io/gh/apache/rocketmq/pull/5771/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-Y2xpZW50L3NyYy9tYWluL2phdmEvb3JnL2FwYWNoZS9yb2NrZXRtcS9jbGllbnQvaW1wbC9jb25zdW1lci9Db25zdW1lTWVzc2FnZUNvbmN1cnJlbnRseVNlcnZpY2UuamF2YQ==) | `47.05% <0.00%> (-2.27%)` | :arrow_down: |
| [...a/org/apache/rocketmq/filter/util/BloomFilter.java](https://codecov.io/gh/apache/rocketmq/pull/5771/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-ZmlsdGVyL3NyYy9tYWluL2phdmEvb3JnL2FwYWNoZS9yb2NrZXRtcS9maWx0ZXIvdXRpbC9CbG9vbUZpbHRlci5qYXZh) | `60.43% <0.00%> (-2.20%)` | :arrow_down: |
| [...mq/store/ha/autoswitch/AutoSwitchHAConnection.java](https://codecov.io/gh/apache/rocketmq/pull/5771/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3RvcmUvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL3JvY2tldG1xL3N0b3JlL2hhL2F1dG9zd2l0Y2gvQXV0b1N3aXRjaEhBQ29ubmVjdGlvbi5qYXZh) | `70.00% <0.00%> (-1.09%)` | :arrow_down: |
| [.../org/apache/rocketmq/store/index/IndexService.java](https://codecov.io/gh/apache/rocketmq/pull/5771/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3RvcmUvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL3JvY2tldG1xL3N0b3JlL2luZGV4L0luZGV4U2VydmljZS5qYXZh) | `59.00% <0.00%> (-1.00%)` | :arrow_down: |
| [...ent/impl/consumer/DefaultLitePullConsumerImpl.java](https://codecov.io/gh/apache/rocketmq/pull/5771/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-Y2xpZW50L3NyYy9tYWluL2phdmEvb3JnL2FwYWNoZS9yb2NrZXRtcS9jbGllbnQvaW1wbC9jb25zdW1lci9EZWZhdWx0TGl0ZVB1bGxDb25zdW1lckltcGwuamF2YQ==) | `69.37% <0.00%> (-0.63%)` | :arrow_down: |
| [...he/rocketmq/client/impl/consumer/ProcessQueue.java](https://codecov.io/gh/apache/rocketmq/pull/5771/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-Y2xpZW50L3NyYy9tYWluL2phdmEvb3JnL2FwYWNoZS9yb2NrZXRtcS9jbGllbnQvaW1wbC9jb25zdW1lci9Qcm9jZXNzUXVldWUuamF2YQ==) | `61.50% <0.00%> (-0.45%)` | :arrow_down: |
| [...main/java/org/apache/rocketmq/store/CommitLog.java](https://codecov.io/gh/apache/rocketmq/pull/5771/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3RvcmUvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL3JvY2tldG1xL3N0b3JlL0NvbW1pdExvZy5qYXZh) | `65.30% <0.00%> (ø)` | |
| ... and [4 more](https://codecov.io/gh/apache/rocketmq/pull/5771/diff?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) | |
:mega: We’re building smart automated test selection to slash your CI/CD build times. [Learn more](https://about.codecov.io/iterative-testing/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [rocketmq] Oliverwqcwrw commented on a diff in pull request #5771: [ISSUE #5770]Translation controller quick_start.md chinese document to english document
Posted by GitBox <gi...@apache.org>.
Oliverwqcwrw commented on code in PR #5771:
URL: https://github.com/apache/rocketmq/pull/5771#discussion_r1058751088
##########
docs/en/controller/quick_start.md:
##########
@@ -0,0 +1,200 @@
+# Master-Slave automatic switch Quick start
+
+## Introduction
+
+
+
+This document mainly introduces how to quickly build a RocketMQ cluster that supports automatic master-slave switch, as shown in the above diagram. The main addition is the Controller component, which can be deployed independently or embedded in the NameServer.
+
+For detailed design ideas, please refer to [Design Ideas](https://chat.openai.com/chat/design.md).
+
+For detailed guidelines on new cluster deployment and old cluster upgrades, please refer to [Deployment Guide](https://chat.openai.com/chat/deploy.md).
+
+## Compile RocketMQ source code
+
+```shell
+$ git clone https://github.com/apache/rocketmq.git
+
+$ cd rocketmq
+
+$ mvn -Prelease-all -DskipTests clean install -U
+```
+
+## Quick deployment
+
+After successful build
+
+```shell
+#{rocketmq-version} replace with rocketmq actual version. example: 5.0.0-SNAPSHOT
+$ cd distribution/target/rocketmq-{rocketmq-version}/rocketmq-{rocketmq-version}/
+
+$ sh bin/controller/fast-try.sh start
+```
+
+If the above steps are successful, you can view the status of the Controller using the operation and maintenance command.
+
+```shell
+$ sh bin/mqadmin getControllerMetaData -a localhost:9878
+```
+
+`-a` represents the address of any controller in the cluster
+
+At this point, you can send and receive messages in the cluster and perform switch testing.
+
+If you need to shut down the quick cluster, you can execute：
Review Comment:
@lizhanhui agree with
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [rocketmq] Oliverwqcwrw merged pull request #5771: [ISSUE #5770]Translation controller quick_start.md chinese document to english document
Posted by GitBox <gi...@apache.org>.
Oliverwqcwrw merged PR #5771:
URL: https://github.com/apache/rocketmq/pull/5771
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [rocketmq] Oliverwqcwrw commented on a diff in pull request #5771: [ISSUE #5770]Translation controller quick_start.md chinese document to english document
Posted by GitBox <gi...@apache.org>.
Oliverwqcwrw commented on code in PR #5771:
URL: https://github.com/apache/rocketmq/pull/5771#discussion_r1058681047
##########
docs/en/controller/quick_start.md:
##########
@@ -0,0 +1,200 @@
+# Master-Slave automatic switch Quick start
+
+## Introduction
+
+
+
+This document mainly introduces how to quickly build a RocketMQ cluster that supports automatic master-slave switch, as shown in the above diagram. The main addition is the Controller component, which can be deployed independently or embedded in the NameServer.
+
+For detailed design ideas, please refer to [Design Ideas](https://chat.openai.com/chat/design.md).
+
+For detailed guidelines on new cluster deployment and old cluster upgrades, please refer to [Deployment Guide](https://chat.openai.com/chat/deploy.md).
+
+## Compile RocketMQ source code
+
+```shell
+$ git clone https://github.com/apache/rocketmq.git
+
+$ cd rocketmq
+
+$ mvn -Prelease-all -DskipTests clean install -U
+```
+
+## Quick deployment
+
+After successful build
+
+```shell
+#{rocketmq-version} replace with rocketmq actual version. example: 5.0.0-SNAPSHOT
+$ cd distribution/target/rocketmq-{rocketmq-version}/rocketmq-{rocketmq-version}/
+
+$ sh bin/controller/fast-try.sh start
+```
+
+If the above steps are successful, you can view the status of the Controller using the operation and maintenance command.
+
+```shell
+$ sh bin/mqadmin getControllerMetaData -a localhost:9878
+```
+
+`-a` represents the address of any controller in the cluster
+
+At this point, you can send and receive messages in the cluster and perform switch testing.
+
+If you need to shut down the quick cluster, you can execute：
Review Comment:
```suggestion
If you need to shutdown the cluster quickly, you can execute：
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [rocketmq] lizhanhui commented on pull request #5771: [ISSUE #5770]Translation controller quick_start.md chinese document to english document
Posted by GitBox <gi...@apache.org>.
lizhanhui commented on PR #5771:
URL: https://github.com/apache/rocketmq/pull/5771#issuecomment-1367950270
@Oliverwqcwrw It looks you need to confirm the change meets your request-change and dismiss it in order to make this pull request mergeable
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [rocketmq] mxsm commented on pull request #5771: [ISSUE #5770]Translation controller quick_start.md chinese document to english document
Posted by GitBox <gi...@apache.org>.
mxsm commented on PR #5771:
URL: https://github.com/apache/rocketmq/pull/5771#issuecomment-1367313368
@lizhanhui @Oliverwqcwrw fixed, PTAL~
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [rocketmq] lizhanhui commented on a diff in pull request #5771: [ISSUE #5770]Translation controller quick_start.md chinese document to english document
Posted by GitBox <gi...@apache.org>.
lizhanhui commented on code in PR #5771:
URL: https://github.com/apache/rocketmq/pull/5771#discussion_r1058737244
##########
docs/en/controller/quick_start.md:
##########
@@ -0,0 +1,200 @@
+# Master-Slave automatic switch Quick start
+
+## Introduction
+
+
+
+This document mainly introduces how to quickly build a RocketMQ cluster that supports automatic master-slave switch, as shown in the above diagram. The main addition is the Controller component, which can be deployed independently or embedded in the NameServer.
+
+For detailed design ideas, please refer to [Design Ideas](https://chat.openai.com/chat/design.md).
+
+For detailed guidelines on new cluster deployment and old cluster upgrades, please refer to [Deployment Guide](https://chat.openai.com/chat/deploy.md).
+
+## Compile RocketMQ source code
+
+```shell
+$ git clone https://github.com/apache/rocketmq.git
+
+$ cd rocketmq
+
+$ mvn -Prelease-all -DskipTests clean install -U
+```
+
+## Quick deployment
+
+After successful build
+
+```shell
+#{rocketmq-version} replace with rocketmq actual version. example: 5.0.0-SNAPSHOT
+$ cd distribution/target/rocketmq-{rocketmq-version}/rocketmq-{rocketmq-version}/
+
+$ sh bin/controller/fast-try.sh start
+```
+
+If the above steps are successful, you can view the status of the Controller using the operation and maintenance command.
+
+```shell
+$ sh bin/mqadmin getControllerMetaData -a localhost:9878
+```
+
+`-a` represents the address of any controller in the cluster
+
+At this point, you can send and receive messages in the cluster and perform switch testing.
+
+If you need to shut down the quick cluster, you can execute：
Review Comment:
@Oliverwqcwrw `shutdown` is a noun... `need to shut down the cluster quickly` is the correct way.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [rocketmq] mxsm commented on a diff in pull request #5771: [ISSUE #5770]Translation controller quick_start.md chinese document to english document
Posted by GitBox <gi...@apache.org>.
mxsm commented on code in PR #5771:
URL: https://github.com/apache/rocketmq/pull/5771#discussion_r1058683527
##########
docs/en/controller/quick_start.md:
##########
@@ -0,0 +1,200 @@
+# Master-Slave automatic switch Quick start
+
+## Introduction
+
+
+
+This document mainly introduces how to quickly build a RocketMQ cluster that supports automatic master-slave switch, as shown in the above diagram. The main addition is the Controller component, which can be deployed independently or embedded in the NameServer.
+
+For detailed design ideas, please refer to [Design Ideas](https://chat.openai.com/chat/design.md).
+
+For detailed guidelines on new cluster deployment and old cluster upgrades, please refer to [Deployment Guide](https://chat.openai.com/chat/deploy.md).
+
+## Compile RocketMQ source code
+
+```shell
+$ git clone https://github.com/apache/rocketmq.git
+
+$ cd rocketmq
+
+$ mvn -Prelease-all -DskipTests clean install -U
+```
+
+## Quick deployment
+
+After successful build
+
+```shell
+#{rocketmq-version} replace with rocketmq actual version. example: 5.0.0-SNAPSHOT
+$ cd distribution/target/rocketmq-{rocketmq-version}/rocketmq-{rocketmq-version}/
+
+$ sh bin/controller/fast-try.sh start
+```
+
+If the above steps are successful, you can view the status of the Controller using the operation and maintenance command.
+
+```shell
+$ sh bin/mqadmin getControllerMetaData -a localhost:9878
+```
+
+`-a` represents the address of any controller in the cluster
+
+At this point, you can send and receive messages in the cluster and perform switch testing.
+
+If you need to shut down the quick cluster, you can execute：
Review Comment:
@Oliverwqcwrw I will fix it later, thanks for you review
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org