Skip to content

Conversation

gobbq
Copy link
Contributor

@gobbq gobbq commented May 13, 2022

Make sure set the target branch to develop

What is the purpose of the change

Add a rough guide for RocketMQ deployment, include three different environments:

  • Run RocketMQ locally
  • Run RocketMQ in Docker
  • Run RocketMQ in Kubernetes

Brief changelog

add a rough guide for quick start

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.

  • Make sure there is a Github issue 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.
  • 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.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • 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.
  • 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.

@li-xiao-shuang
Copy link
Member

This is a good idea, I think that would be better to put it on https://rocketmq.apache.org/docs/quick-start/

README.md Outdated
Comment on lines 54 to 60
$ wget https://archive.apache.org/dist/rocketmq/4.9.3/rocketmq-all-4.9.3-bin-release.zip
```

Unpack the release:
```shell
$ unzip rocketmq-all-4.9.3-bin-release.zip
$ cd rocketmq-all-4.9.3-bin-release
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'd better not use static version (4.9.3) here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'd better not use static version (4.9.3) here.

That‘s what I think, but I didn't find a common method to express the release url of the latest version in Apache mirror.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ye

This paragraph guides you through steps of installing RocketMQ in different ways.
For local development and testing, only one instance will be created for each component.

### Run RocketMQ locally
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hope that quick start guides for Windows would be supplemented.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hope that quick start guides for Windows would be supplemented.

OK,this is done in the latest commit.

@codecov-commenter
Copy link

codecov-commenter commented May 13, 2022

Codecov Report

Merging #4302 (8e783a3) into develop (fd484ae) will increase coverage by 0.03%.
The diff coverage is n/a.

@@              Coverage Diff              @@
##             develop    #4302      +/-   ##
=============================================
+ Coverage      48.18%   48.21%   +0.03%     
- Complexity      5081     5088       +7     
=============================================
  Files            642      642              
  Lines          42780    42762      -18     
  Branches        5599     5596       -3     
=============================================
+ Hits           20612    20617       +5     
+ Misses         19660    19633      -27     
- Partials        2508     2512       +4     
Impacted Files Coverage Δ
...org/apache/rocketmq/store/ha/WaitNotifyObject.java 66.07% <0.00%> (-5.36%) ⬇️
...org/apache/rocketmq/common/stats/StatsItemSet.java 47.76% <0.00%> (-2.99%) ⬇️
...n/java/org/apache/rocketmq/store/ha/HAService.java 71.09% <0.00%> (-0.76%) ⬇️
...ain/java/org/apache/rocketmq/store/MappedFile.java 51.05% <0.00%> (ø)
...a/org/apache/rocketmq/broker/BrokerController.java 46.63% <0.00%> (ø)
...org/apache/rocketmq/store/DefaultMessageStore.java 55.56% <0.00%> (+0.15%) ⬆️
.../apache/rocketmq/logging/inner/LoggingBuilder.java 64.71% <0.00%> (+0.31%) ⬆️
...ava/org/apache/rocketmq/store/ha/HAConnection.java 66.97% <0.00%> (+0.45%) ⬆️
...a/org/apache/rocketmq/store/StoreStatsService.java 38.09% <0.00%> (+0.56%) ⬆️
...g/apache/rocketmq/broker/util/ServiceProvider.java 47.43% <0.00%> (+1.00%) ⬆️
... and 6 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fd484ae...8e783a3. Read the comment docs.

@coveralls
Copy link

coveralls commented May 13, 2022

Coverage Status

Coverage increased (+0.02%) to 52.07% when pulling 8e783a3 on gobbq:develop into fd484ae on apache:develop.

@gobbq gobbq closed this May 17, 2022
@gobbq gobbq reopened this May 17, 2022
@gobbq
Copy link
Contributor Author

gobbq commented May 17, 2022

This is a good idea, I think that would be better to put it on https://rocketmq.apache.org/docs/quick-start/

Thanks, I think this is for that most people don't want to check out the official website.

@duhenglucky duhenglucky merged commit 2e58c7d into apache:develop May 19, 2022
@duhenglucky duhenglucky added this to the 4.9.4 milestone May 19, 2022
GenerousMan pushed a commit to GenerousMan/rocketmq that referenced this pull request Aug 12, 2022
* add a rough guide for quick start

* add github link of the rocketmq operator

* add install steps for Windows

Co-authored-by: 文泊 <[email protected]>
@xiaodaweic
Copy link

这是个好主意,我认为将其放在https://rocketmq.apache.org/docs/quick-start/上会更好

谢谢,我认为这是因为大多数人不想查看官方网站。

我认为大多数都会以官方网站做参考,至少我是这样的。现在rocket官方文档太简陋。我目前找不docker版本的rocket5。dockerhub上的现在是4.9.4
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants