[ISSUE apache#219]Supply detail information or read.me for eventmesh …

…running in docker
xwm1992 · Mar 11, 2021 · 6984ea9 · 6984ea9
1 parent bc5152a
commit 6984ea9
Show file tree

Hide file tree

Showing 50 changed files with 2,174 additions and 210 deletions.
diff --git a/README.md b/README.md
@@ -49,7 +49,7 @@ The protocol of eventmesh is easier and convenient, you can read more [here](doc
 | v1.0.0  |Support java-sdk , tcp pub/sub, http pub|
 | v1.1.0  |Support RocketMQ as eventstore|
 | v1.1.1  |Support https|
-| v1.2.0  |Support Plug-in architecture, support http sub|
+| v1.2.0  |Support Plug-in architecture, support http sub, support cloud native deploy|
 | V1.3.0 |Support CloudEvents protocol|
 |         |Support Event transaction|
 |         |Support Event filter|

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -45,7 +45,7 @@ eventmesh的通信协议更加简洁方便，详细内容，阅读更多[这里]
 | v1.0.0  | Support java-sdk , tcp pub/sub, http pub                     |
 | v1.1.0  | Support RocketMQ as eventstore                               |
 | v1.1.1  | Support https                                                |
-| v1.2.0  | Support Plug-in architecture, support http sub               |
+| v1.2.0  | Support Plug-in architecture, support http sub, support cloud native deploy |
 | V1.3.0  | Support CloudEvents protocol                                 |
 |         | Support Event transaction                                    |
 |         | Support Event filter                                         |

diff --git a/build.gradle b/build.gradle
@@ -44,6 +44,7 @@ allprojects {
     clean.doFirst {
         delete 'build'
         delete 'dist'
+        delete 'out'
     }
 
     if (project.findProperty("snapshot") instanceof String) {
@@ -235,6 +236,10 @@ subprojects {
             copy {
                 into('../dist/apps/')
                 from project.jar.getArchivePath()
+                exclude 'eventmesh-common*.jar'
+                exclude 'eventmesh-connector-api*.jar'
+                exclude 'eventmesh-registry*.jar'
+                exclude 'eventmesh-starter*.jar'
             }
             copy {
                 into '../dist/lib'
@@ -248,19 +253,20 @@ subprojects {
                 exclude '**/*log4j2.xml*'
                 exclude '**/spring-boot-devtools*.jar'
                 exclude '**/mumble-sdk-test*.jar'
-                exclude '**/defibus*.jar'
-                exclude '*log4j*.jar'
+                exclude '*connector-rocketmq*.jar'
+                exclude 'eventmesh-runtime*.jar'
+//                exclude '*log4j*.jar'
                 exclude 'commons-collections-3.2.2.jar'
             }
 
             copy {
                 into '../dist/bin'
-                from '../script'
+                from '../eventmesh-runtime/bin'
             }
 
             copy {
                 into '../dist/conf'
-                from '../conf/'
+                from '../eventmesh-runtime/conf'
             }
         }
     }

diff --git a/docker/eventmesh-defibus/Dockerfile b/docker/eventmesh-defibus/Dockerfile
diff --git a/docker/eventmesh-rocketmq/Dockerfile b/docker/eventmesh-rocketmq/Dockerfile
@@ -4,8 +4,7 @@ MAINTAINER mikexue mike_xwm@126.com
 
 WORKDIR /data
 RUN mkdir /data/app
-ADD eventmesh-runtime_1.2.0-SNAPSHOT.tar.gz /data/app/eventmesh
-COPY eventmesh-connector-rocketmq-1.2.0.jar /data/app/eventmesh/apps
+ADD EventMesh_1.2.0-SNAPSHOT.tar.gz  /data/app/eventmesh
 WORKDIR /data/app/eventmesh/bin
 
 EXPOSE 10000
@@ -14,3 +13,4 @@ EXPOSE 10105
 ENV DOCKER true
 
 CMD sh start.sh
+
diff --git a/docs/README.md b/docs/README.md
@@ -37,7 +37,7 @@ Key components:
 | ----    | ----    |
 | v1.0.0  |Support pub/sub, http api, java-sdk|
 | v1.1.0  |Support rocketmq as eventstore|
-| v1.2.0  |Support Plug-in architecture, support http sub|
+| v1.2.0  |Support Plug-in architecture, support http sub，support cloud native deploy|
 | V1.3.0 |Support CloudEvents protocol|
 |   |Support transaction event|
 |         |Support Event Sourcing|

diff --git a/docs/cn/instructions/eventmesh-runtime-quickstart.zh-CN.md b/docs/cn/instructions/eventmesh-runtime-quickstart.zh-CN.md
@@ -95,3 +95,175 @@ dependencies {
 运行com.webank.eventmesh.starter.StartUp的主要方法
 ```
 
+
+
+## 3 Docker 运行
+
+### 3.1 拉取镜像
+
+执行 `docker pull eventmesh/eventmesh-rocketmq:v1.2.0` , 你将会获取到EventMesh的镜像，如下图所示：
+
+![image-20210309155255510](D:\Ideaworkspace\workspace1\xwm1992\1.2.0\EventMesh\docs\images\docker\docker-image.png)
+
+### 3.2 配置
+
+> **预先准备** : 你可能需要从github上下载源代码，并参考这两个文件(proxy.properties 和 rocketmq-client.properties)的内容来做下面的操作
+
+**3.2.1 需要配置的文件**
+
+在运行容器之前，你需要配置如下文件：
+
+**proxy.properties** 
+
+| 配置项                 | 默认值 | 备注                    |
+| ---------------------- | ------ | ----------------------- |
+| proxy.server.http.port | 10105  | EventMesh http 服务端口 |
+| proxy.server.tcp.port  | 10000  | EventMesh tcp 服务端口  |
+
+**rocketmq-client.properties**
+
+| 配置项                            | 默认值                        | 备注                  |
+| --------------------------------- | ----------------------------- | --------------------- |
+| proxy.server.rocketmq.namesrvAddr | 127.0.0.1:9876;127.0.0.1:9876 | RocketMQ namesrv 地址 |
+
+拉取了EventMesh镜像到你的宿主机后，你可以执行下面的命令来完成**proxy.properties**和**rocketmq-client.properties** 文件的配置
+
+**3.2.2 创建文件**
+
+```shell
+mkdir -p /data/eventmesh/rocketmq/conf
+cd /data/eventmesh/rocketmq/conf
+vi proxy.properties
+vi rocketmq-client.properties
+```
+
+这两个文件内容可以参考 [proxy.properties](https://github.com/WeBankFinTech/EventMesh/blob/develop/eventmesh-runtime/conf/proxy.properties) 和 [rocketmq-client.properties](https://github.com/WeBankFinTech/EventMesh/blob/develop/eventmesh-runtime/conf/rocketmq-client.properties)
+
+### 3.3 运行
+
+**3.3.1 运行**
+
+执行下面的命令来运行容器
+
+```shell
+docker run -d -p 10000:10000 -p 10105:10105 -v /data/eventmesh/rocketmq/conf/proxy.properties:/data/app/eventmesh/conf/proxy.properties -v /data/eventmesh/rocketmq/conf/rocketmq-client.properties:/data/app/eventmesh/conf/rocketmq-client.properties docker.io/eventmesh/eventmesh-rocketmq:v1.2.0
+```
+
+> -p : 将容器内端口与宿主机端口绑定，容器的端口应与配置文件中的端口一致
+>
+> -v : 将容器内的配置文件挂载到宿主机下，需注意配置文件的路径
+
+**3.3.2 检查容器的运行状况**
+
+执行 `docker ps` 来检查容器的运行状况
+
+![image-20210309155917269](D:\Ideaworkspace\workspace1\xwm1992\1.2.0\EventMesh\docs\images\docker\docker-ps.png)
+
+执行 `docker logs [container id]` 可以得到如下结果
+
+![image-20210309195623836](D:\Ideaworkspace\workspace1\xwm1992\1.2.0\EventMesh\docs\images\docker\docker-logs.png)
+
+执行 `docker exec -it [container id] /bin/bash` 可以进入到容器中并查看详细信息
+
+![image-20210309200327627](D:\Ideaworkspace\workspace1\xwm1992\1.2.0\EventMesh\docs\images\docker\docker-exec.png)
+
+### 3.4 测试
+
+**预先准备** ：RocketMQ Namesrv & Broker
+
+你可以通过[这里](https://github.com/apache/rocketmq-docker)来构建rocketmq镜像或者从 docker hub上获取rocketmq镜像.
+
+```shell
+#获取namesrv镜像
+docker pull rocketmqinc/rocketmq-namesrv:4.5.0-alpine
+#获取broker镜像
+docker pull rocketmqinc/rocketmq-broker:4.5.0-alpine
+
+#运行namerv容器 
+docker run -d -p 9876:9876 -v `pwd` /data/namesrv/logs:/root/logs -v `pwd`/data/namesrv/store:/root/store --name rmqnamesrv  rocketmqinc/rocketmq-namesrv:4.5.0-alpine sh mqnamesrv 
+
+#运行broker容器 
+docker run -d -p 10911:10911 -p 10909:10909 -v `pwd`/data/broker/logs:/root/logs -v `pwd`/data/broker/store:/root/store --name rmqbroker --link rmqnamesrv:namesrv -e "NAMESRV_ADDR=namesrv:9876" rocketmqinc/rocketmq-broker:4.5.0-alpine sh mqbroker -c ../conf/broker.conf
+```
+
+这里 **rocketmq-broker ip** 是 **pod ip**, 如果你想修改这个ip, 可以通过挂载容器中 **broker.conf** 文件的方式并修改文件中的 **brokerIP1** 配置项为自定义值
+
+**3.4.1 运行示例**
+
+Windows
+
+- Windows系统下运行示例可以参考[这里](https://github.com/WeBankFinTech/EventMesh/blob/develop/docs/en/instructions/eventmesh-sdk-java-quickstart.md)
+
+Linux
+
+- **获取 eventmesh-test_1.2.0-SNAPSHOT.tar.gz**
+
+  你可以从我们的 **releases** 获取或者**通过源码的方式进行构建**
+
+  **通过源码的方式进行构建**：
+
+  ```shell
+  cd /* Your Deploy Path */EventMesh/eventmesh-test 
+  gradle clean testdist testtar -x test`
+  ```
+
+  可以在 `/eventmesh-test/build` 目录下获得 **eventmesh-test_1.2.0-SNAPSHOT.tar.gz** 
+
+- **修改配置文件**
+
+  ```shell
+  #上传
+  upload eventmesh-test_1.2.0-SNAPSHOT.tar.gz
+  #解压
+  tar -zxvf eventmesh-test_1.2.0-SNAPSHOT.tar.gz
+  #配置
+  cd conf
+  config your application.properties
+  ```
+
+- **运行**
+
+  TCP Sub 
+
+  ```shell
+  cd bin
+  sh tcp_sub.sh
+  ```
+
+  TCP Pub
+
+  ```shell
+  cd bin
+  sh tcp_pub.sh
+  ```
+
+  TCP Sub Broadcast
+
+  ```shell
+  cd bin
+  sh tcp_sub_broadcast.sh
+  ```
+
+  TCP Pub Broadcast
+
+  ```shell
+  cd bin
+  sh tcp_pub_broadcast.sh
+  ```
+
+  HTTP Sub
+
+  ```shell
+  cd bin
+  sh http_sub.sh
+  ```
+
+  HTTP Pub
+
+  ```shell
+  cd bin
+  sh http_pub.sh
+  ```
+
+  之后 , 你可以在 `/logs` 目录下面看到不同模式的运行日志
+