You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tubemq.apache.org by GitBox <gi...@apache.org> on 2020/06/07 08:13:56 UTC
[GitHub] [incubator-tubemq-website] dockerzhang opened a new pull request #35: make quick start doc more easy for reading
dockerzhang opened a new pull request #35:
URL: https://github.com/apache/incubator-tubemq-website/pull/35
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-tubemq-website] guangxuCheng commented on a change in pull request #35: [TUBEMQ-221]make quick start doc more easy for reading
Posted by GitBox <gi...@apache.org>.
guangxuCheng commented on a change in pull request #35:
URL: https://github.com/apache/incubator-tubemq-website/pull/35#discussion_r436444852
##########
File path: docs/zh-cn/quick_start.md
##########
@@ -1,51 +1,70 @@
-## 准备工作
+## 编译和构建
+### 准备工作
-- Java 1.7 或 1.8(Java 9 及以上，未经测试验证)
-- Maven 3.* 及以上
+- Java JDK 1.7 或 1.8
+- Maven 3.3+
-## 构建
-
-### 从下载的发行版代码包构建
-在TubeMQ根目录下执行命令：
+### 从源码包构建
+- 编译和打包：
```bash
mvn clean package -DskipTests
```
-在根目录执行 `mvn clean install` 之后，可以单独对每个 module 进行构建。
-### 基于源代码构建
+- （可选）使用Docker编译：
+```bash
+docker run -v REPLACE_WITH_SOURCE_PATH:/tubemq apachetubemq/tubemq-build clean package -DskipTests
+```
+- 单元测试：
+```bash
+mvn test
+```
+- 单独对每个 module 进行构建：
+```bash
+mvn clean install
+cd module-name (比如: tubemq-client)
+mvn test
+```
+构建完成之后，在 `tubemq-server/target` 目录下会有 **tubemq-server-[TUBEMQ-VERSION]-bin.tar.gz** 文件。
+这是 TubeMq 的部署包，包含了脚本、配置文件、依赖以及 web GUI相关的内容。
+### 配置IDE开发环境
在IDE中构建和调试源码，需要先运行以下命令：
```bash
mvn compile
```
执行之后，会生成 `protoc` 文件对应的 java source file，位于 `target/generated-sources` 目录。
-然后就可以在 IDE 中打开 TubeMQ 工程。
-
-你可以跳到 下一章 部署运行 ， 除非你准备自己编译proto 文件。（通常不需要，mvn会自动下载protoc 构建)。
-
-如果你打算使用本地的 `protoc` 可执行文件，你可以修改 `tubemq-core/pom.xml` 下的 `protobuf-maven-plugin` 的配置，如下所示。
-
+（可选）如果你打算使用本地的 `protoc` 可执行文件，你可以修改 `tubemq-core/pom.xml` 下的 `protobuf-maven-plugin` 的配置，如下所示。
```xml
<configuration>
<outputDirectory>${project.build.directory}/generated-sources/java</outputDirectory>
<protocExecutable>/usr/local/bin/protoc</protocExecutable>
</configuration>
```
## 部署运行
-构建完成之后，在 `tubemq-server/target` 目录下会有 **tubemq-server-x.x.x-bin.tar.gz** 文件.
-这是 Server 的部署包，包含了脚本、配置文件、依赖以及 web GUI相关的内容。
+### 部署TubeMQ Standalone
+Standalone模式可以在一个容器中启动zookeeper/master/broker服务：
+```
+docker run -p 8080:8080 -p 8000:8000 --name tubemq -d apachetubemq/tubemq-all:latest
+```
+容器拉起后，可在浏览器访问` http://127.0.0.1:8080`，然后参考下面`快速使用`部分开始使用。
-首次部署，只需要解压部署包，解压之后的目录结构如下：
+**注意**：Standalone模式只可用于开发和体验，不可作为生产集群。
+### 部署TubeMQ集群
+#### 准备工作
+- ZooKeeper集群
+- [tubemq-server-[TUBEMQ-VERSION]-bin.tar.gz](download/download.md)安装包
+
Review comment:
Ditto
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-tubemq-website] dockerzhang closed pull request #35: make quick start doc more easy for reading
Posted by GitBox <gi...@apache.org>.
dockerzhang closed pull request #35:
URL: https://github.com/apache/incubator-tubemq-website/pull/35
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-tubemq-website] guangxuCheng commented on a change in pull request #35: [TUBEMQ-221]make quick start doc more easy for reading
Posted by GitBox <gi...@apache.org>.
guangxuCheng commented on a change in pull request #35:
URL: https://github.com/apache/incubator-tubemq-website/pull/35#discussion_r436444695
##########
File path: docs/en-us/quick_start.md
##########
@@ -33,23 +45,32 @@ If you want to use local `protoc` executable, you can change the configuration o
</configuration>
```
-## Deploy
-After the build, please go to `tubemq-server/target`. You can find the
-**tubemq-server-x.x.x-bin.tar.gz** file. It is the server deployment package, which includes
-scripts, configuration files, dependency jars and web GUI code.
+## Deploy and Start
+### Deploy TubeMQ Standalone
+Standalone mode starts zookeeper/master/broker services in one docker container：
+```
+docker run -p 8080:8080 -p 8000:8000 --name tubemq -d apachetubemq/tubemq-all:latest
+```
+Afater container is running, you can access ` http://127.0.0.1:8080`, and reference to next `Quick Start` chapter for experience.
-For the first time deployment, we just need to extract the package file. For example, we put these
-files into the `/opt/tubemq-server`, here's the folder structure.
+**Tips**：Standalone Mode is only available for development and experience, it's not designed for production environment.
+
+### Deploy TubeMQ Cluster
+#### Prerequisites
+- ZooKeeper Cluster
+- [tubemq-server-[TUBEMQ-VERSION]-bin.tar.gz](download/download.md) package file
Review comment:
Still discussing how to add a download page, so this link may be wrong
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-tubemq-website] wf123537200 merged pull request #35: [TUBEMQ-221]make quick start doc more easy for reading
Posted by GitBox <gi...@apache.org>.
wf123537200 merged pull request #35:
URL: https://github.com/apache/incubator-tubemq-website/pull/35
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-tubemq-website] guangxuCheng commented on pull request #35: [TUBEMQ-221]make quick start doc more easy for reading
Posted by GitBox <gi...@apache.org>.
guangxuCheng commented on pull request #35:
URL: https://github.com/apache/incubator-tubemq-website/pull/35#issuecomment-640348714
blocked by #34
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org