Skip to content

Commit

Permalink
update quickstart
Browse files Browse the repository at this point in the history
Signed-off-by: qqeasonchen <qqeasonchen@gmail.com>
  • Loading branch information
qqeasonchen authored and xwm1992 committed Dec 27, 2021
1 parent 73ed0d4 commit 623f007
Show file tree
Hide file tree
Showing 9 changed files with 116 additions and 256 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ The protocol of eventmesh is easier and more convenient, you can read more [here


## Quick Start
1. Build and deploy event-store(default RocketMQ), see [instruction](https://rocketmq.apache.org/docs/quick-start/).
2. Build and deploy eventmesh-runtime, see instruction ['eventmesh-runtime quickstart'](docs/en/instructions/eventmesh-runtime-quickstart.md).
3. Run eventmesh-sdk-java demo, see instruction ['eventmesh-sdk-java quickstart'](docs/en/instructions/eventmesh-sdk-java-quickstart.md).
1. [event-store](https://rocketmq.apache.org/docs/quick-start/) (RocketMQ, ignore this step if use standalone).
2. [runtime quickstart](docs/en/instructions/eventmesh-runtime-quickstart.md) or [runtime quickstart with docker](docs/en/instructions/eventmesh-runtime-quickstart-with-docker.md).
3. [java examples ](docs/en/instructions/eventmesh-sdk-java-quickstart.md).

## Contributing
Contributions are always welcomed! Please see [CONTRIBUTING](CONTRIBUTING.md) for detailed guidelines.
Expand Down
6 changes: 3 additions & 3 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ eventmesh的通信协议更加简洁方便,详细内容,阅读更多[这里]
| WIP |Support AsyncAPI|

## 快速开始
1. 构建并部署event-store(RocketMQ), 请参见[说明](https://rocketmq.apache.org/docs/quick-start/)
2. 构建并部署eventmesh-runtime,请参见说明['eventmesh-runtime quickstart.zh-CN'](docs/cn/instructions/eventmesh-runtime-quickstart.zh-CN.md)
3. 运行eventmesh-sdk-java演示,请参见说明['eventmesh-sdk-java quickstart.zh-CN'](docs/cn/instructions/eventmesh-sdk-java-quickstart.zh-CN.md)
1. [event-store](https://rocketmq.apache.org/docs/quick-start/) (RocketMQ, ignore this step if use standalone).
2. [runtime quickstart](docs/en/instructions/eventmesh-runtime-quickstart.md) or [runtime quickstart with docker](docs/en/instructions/eventmesh-runtime-quickstart-with-docker.md).
3. [java examples ](docs/en/instructions/eventmesh-sdk-java-quickstart.md).

## 贡献
永远欢迎参与共建, 请参阅[贡献](CONTRIBUTING.zh-CN.md)了解详细指南
Expand Down
22 changes: 11 additions & 11 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -177,10 +177,10 @@ subprojects {
jar {
manifest {
attributes("Specification-Version": project.version,
"Specification-Vendor": "WeBank, Inc.",
"Specification-Vendor": "Apache",
"Specification-Title": project.name,
"Implementation-Version": project.version,
"Implementation-Vendor": "WeBank, Inc.",
"Implementation-Vendor": "Apache",
"Implementation-Title": project.name,
"Build-Jdk": project.findProperty("jdk")
)
Expand All @@ -199,13 +199,13 @@ subprojects {
copy {
into('../dist/apps/')
from project.jar.getArchivePath()
exclude 'eventmesh-common*.jar'
exclude 'eventmesh-connector-api*.jar'
exclude 'eventmesh-connector-plugin*.jar'
exclude 'eventmesh-admin*.jar'
exclude 'eventmesh-starter*.jar'
exclude 'eventmesh-test*.jar'
exclude 'eventmesh-sdk*.jar'
// exclude 'eventmesh-common*.jar'
// exclude 'eventmesh-connector-api*.jar'
// exclude 'eventmesh-connector-plugin*.jar'
// exclude 'eventmesh-admin*.jar'
// exclude 'eventmesh-starter*.jar'
// exclude 'eventmesh-test*.jar'
// exclude 'eventmesh-sdk*.jar'
}
copy {
into '../dist/lib'
Expand All @@ -219,8 +219,8 @@ subprojects {
exclude '**/*log4j2.xml*'
exclude '**/spring-boot-devtools*.jar'
exclude '**/mumble-sdk-test*.jar'
exclude '*connector-rocketmq*.jar'
exclude 'eventmesh-runtime*.jar'
exclude 'eventmesh*.jar'
// exclude 'eventmesh-runtime*.jar'
exclude 'commons-collections-3.2.2.jar'
}

Expand Down
74 changes: 74 additions & 0 deletions docs/en/instructions/eventmesh-runtime-quickstart-with-docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Quick start Instruction

## 3 Run with Docker

### 3.1 Pull

execute `docker pull eventmesh/eventmesh-rocketmq:v1.2.0` , you will get EventMesh image like below

![image-20210309155255510](../../images/docker/docker-image.png)

### 3.2 Configuration

> **prerequisite** : may be you need download the source code from git first and use the contents of these files(eventMesh.properties and rocketmq-client.properties) as a reference for the following actions.
**3.2.1 Files to configure**

Before run the container you should configure some files.

**eventMesh.properties**

| Configuration Key | Default Value | Remarks |
| ---------------------- | ------------- | -------------------------- |
| eventMesh.server.http.port | 10105 | EventMesh http server port |
| eventMesh.server.tcp.port | 10000 | EventMesh tcp server port |

**rocketmq-client.properties**

| Configuration Key | Default Value | Remarks |
| --------------------------------- | ----------------------------- | -------------------------------- |
| eventMesh.server.rocketmq.namesrvAddr | 127.0.0.1:9876;127.0.0.1:9876 | RocketMQ namesrv default address |

After pull the EventMesh image to your host machine, you can execute command below to configure **eventMesh.properties**
and **rocketmq-client.properties**

**3.2.2 Create Files**

```shell
mkdir -p /data/eventmesh/rocketmq/conf
cd /data/eventmesh/rocketmq/conf
vi eventMesh.properties
vi rocketmq-client.properties
```

The contents of these files can reference
from [eventMesh.properties](https://github.com/WeBankFinTech/EventMesh/blob/develop/eventmesh-runtime/conf/eventMesh.properties)
and [rocketmq-client.properties](https://github.com/WeBankFinTech/EventMesh/blob/develop/eventmesh-runtime/conf/rocketmq-client.properties)

### 3.3 Run

**3.3.1 run**

execute command below to run container

```
docker run -d -p 10000:10000 -p 10105:10105 -v /data/eventmesh/rocketmq/conf/eventMesh.properties:/data/app/eventmesh/conf/eventMesh.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 : binding the container port with host machine port
>
> -v : mount the container configuration files with host machine files
**3.3.2 check container**

execute `docker ps` to check the container health

![image-docker-ps](../../images/docker/docker-ps.png)

execute `docker logs [container id]` you will get following result:

![image-docker-logs](../../images/docker/docker-logs.png)

execute `docker exec -it [container id] /bin/bash` you will go into the container and see the details:

![image-docker-exec](../../images/docker/docker-exec.png)
Loading

0 comments on commit 623f007

Please sign in to comment.