You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@eventmesh.apache.org by mi...@apache.org on 2022/04/02 02:55:28 UTC
[incubator-eventmesh] branch master updated: Lint the documentations with markdownlint (#820)
This is an automated email from the ASF dual-hosted git repository.
mikexue pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-eventmesh.git
The following commit(s) were added to refs/heads/master by this push:
new 8054f27 Lint the documentations with markdownlint (#820)
8054f27 is described below
commit 8054f270711e1cc69d168e51cd58c53b915fb669
Author: Xiaoyang Liu <si...@gmail.com>
AuthorDate: Fri Apr 1 19:55:21 2022 -0700
Lint the documentations with markdownlint (#820)
Signed-off-by: Xiaoyang Liu <si...@gmail.com>
---
README.md | 22 +++--
README.zh-CN.md | 21 +++--
.../instructions/{eclipse.zh-CN.md => eclipse.md} | 0
.../eventmesh-metrics-Prometheus-instruction.md | 17 ++--
docs/cn/instructions/eventmesh-runtime-protocol.md | 17 ++--
.../eventmesh-runtime-quickstart-with-docker.md | 58 ++++++++++----
.../instructions/eventmesh-runtime-quickstart.md | 7 +-
.../instructions/eventmesh-sdk-java-quickstart.md | 6 +-
.../eventmesh-trace-Zipkin-instruction.md | 4 +-
docs/cn/instructions/quickstart.md | 11 +--
docs/cn/intro.md | 1 +
.../features/eventmesh-cloudevents-sdk-binding.md | 11 +--
.../en/features/eventmesh-metrics-export-design.md | 6 +-
.../en/features/eventmesh-schemaregistry-design.md | 6 +-
docs/en/features/eventmesh-stream-design.md | 93 +++++++++++++---------
docs/en/features/eventmesh-trace-design.md | 18 +++--
docs/en/features/eventmesh-workflow-design.md | 47 +++++------
docs/en/features/spi.md | 1 +
.../eventmesh-metrics-Prometheus-instruction.md | 17 ++--
.../eventmesh-runtime-quickstart-with-docker.md | 61 +++++++++-----
.../instructions/eventmesh-runtime-quickstart.md | 15 ++--
.../instructions/eventmesh-sdk-java-quickstart.md | 7 +-
docs/en/instructions/eventmesh-store-quickstart.md | 22 ++---
.../eventmesh-trace-Zipkin-instruction.md | 22 +++--
docs/en/intro.md | 4 +-
docs/en/roadmap.md | 3 +-
26 files changed, 292 insertions(+), 205 deletions(-)
diff --git a/README.md b/README.md
index c65920f..cba27ca 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
-# Apache EventMesh (incubating)
+# Apache EventMesh (Incubating)
+
[](https://github.com/apache/incubator-eventmesh/actions/workflows/ci.yml)
[](https://codecov.io/gh/apache/incubator-eventmesh)
[](https://lgtm.com/projects/g/apache/incubator-eventmesh/context:java)
@@ -10,20 +11,20 @@
[点我查看中文版](README.zh-CN.md)
+
## What is EventMesh?
+
EventMesh(incubating) is a dynamic event-driven application runtime used to decouple the application and backend middleware layer, which supports a wide range of use cases that encompass complex multi-cloud, widely distributed topologies using diverse technology stacks.
**Multi-runtime:**
-
**Orchestration:**
**Federation:**
-
**Components:**
* **eventmesh-runtime** : an middleware to transmit events between event producers and consumers, support cloud native apps and microservices.
@@ -35,23 +36,28 @@ EventMesh(incubating) is a dynamic event-driven application runtime used to deco
* **eventmesh-admin** : clients,topics,subscriptions and other management.
## Quick Start
+
1. [Store quickstart](docs/en/instructions/eventmesh-store-quickstart.md)
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 SDK examples](docs/en/instructions/eventmesh-sdk-java-quickstart.md).
## Documentation
+
See EventMesh [Documentation](docs/en/intro.md) for all documents.
## Roadmap
+
See EventMesh [Roadmap](docs/en/roadmap.md) for details.
## Contributing
+
Contributions are always welcomed! Please see [CONTRIBUTING](CONTRIBUTING.md) for detailed guidelines.
You can start with the issues labeled with good first issue.
[GitHub Issues](https://github.com/apache/incubator-eventmesh/issues)
## Landscape
+
<p align="center">
<br/><br/>
<img src="https://landscape.cncf.io/images/left-logo.svg" width="150"/> <img src="https://landscape.cncf.io/images/right-logo.svg" width="200"/>
@@ -60,17 +66,19 @@ EventMesh enriches the <a href="https://landscape.cncf.io/serverless?license=apa
</p>
## License
+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) Copyright (C) Apache Software Foundation.
## Community
+
| WeChat Assistant | WeChat public account | Slack |
| :----------------------------------------------------: | :----------------------------------------------------: | :----------------------------------------------------: |
|  |  |[Join slack chat](https://join.slack.com/t/apacheeventmesh/shared_invite/zt-11974dndy-cn3Aq638eleKwKPWP9tkLg) |
Mailing Lists:
-| Name | Description |Subscribe |Unsubscribe|Archive
+| Name | Description |Subscribe |Unsubscribe|Archive
| ---- | ---- |---- | ---- | ---- |
-|Users |User support and questions mailing list| [Subscribe](mailto:users-subscribe@eventmesh.incubator.apache.org) |[Unsubscribe](mailto:users-unsubscribe@eventmesh.incubator.apache.org) |[Mail Archives](https://lists.apache.org/list.html?users@eventmesh.apache.org)|
-|Development |Development related discussions| [Subscribe](mailto:dev-subscribe@eventmesh.incubator.apache.org) |[Unsubscribe](mailto:dev-unsubscribe@eventmesh.incubator.apache.org) |[Mail Archives](https://lists.apache.org/list.html?dev@eventmesh.apache.org)|
-|Commits |All commits to repositories| [Subscribe](mailto:commits-subscribe@eventmesh.incubator.apache.org) |[Unsubscribe](mailto:commits-unsubscribe@eventmesh.incubator.apache.org) |[Mail Archives](https://lists.apache.org/list.html?commits@eventmesh.apache.org)|
\ No newline at end of file
+|Users |User support and questions mailing list| [Subscribe](mailto:users-subscribe@eventmesh.incubator.apache.org) |[Unsubscribe](mailto:users-unsubscribe@eventmesh.incubator.apache.org) |[Mail Archives](https://lists.apache.org/list.html?users@eventmesh.apache.org)|
+|Development |Development related discussions| [Subscribe](mailto:dev-subscribe@eventmesh.incubator.apache.org) |[Unsubscribe](mailto:dev-unsubscribe@eventmesh.incubator.apache.org) |[Mail Archives](https://lists.apache.org/list.html?dev@eventmesh.apache.org)|
+|Commits |All commits to repositories| [Subscribe](mailto:commits-subscribe@eventmesh.incubator.apache.org) |[Unsubscribe](mailto:commits-unsubscribe@eventmesh.incubator.apache.org) |[Mail Archives](https://lists.apache.org/list.html?commits@eventmesh.apache.org)|
diff --git a/README.zh-CN.md b/README.zh-CN.md
index 26483ec..de7776e 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -1,4 +1,5 @@
-# Apache EventMesh (incubating)
+# Apache EventMesh (Incubating)
+
[](https://github.com/apache/incubator-eventmesh/actions/workflows/ci.yml)
[](https://codecov.io/gh/apache/incubator-eventmesh)
[](https://lgtm.com/projects/g/apache/incubator-eventmesh/context:java)
@@ -7,7 +8,9 @@
[](https://www.apache.org/licenses/LICENSE-2.0.html)
+
## 什么是Event Mesh？
+
EventMesh是一个动态的云原生事件驱动架构基础设施，用于分离应用程序和后端中间件层，它支持广泛的用例，包括复杂的混合云、使用了不同技术栈的分布式架构。
**多运行时:**
@@ -20,6 +23,7 @@ EventMesh是一个动态的云原生事件驱动架构基础设施，用于分
**组件:**
+
* **eventmesh-runtime** : 一种中间件，用于在事件产生者和使用者之间传输事件，支持云原生应用程序和微服务。
* **eventmesh-sdk-java** : 当前支持HTTP和TCP协议，未来会支持gRPC等。
* **eventmesh-connector-plugin** : 连接中间件的插件，如RocketMQ/Kafka/Redis/Pulsar等。
@@ -29,23 +33,28 @@ EventMesh是一个动态的云原生事件驱动架构基础设施，用于分
* **eventmesh-admin** : 客户端管理、主题管理、订阅管理和其他管理。
## 快速开始
+
1. [Store quickstart](docs/en/instructions/eventmesh-store-quickstart.md)
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 SDK examples](docs/en/instructions/eventmesh-sdk-java-quickstart.md).
## 文档
+
查看EventMesh [Documentation](docs/en/intro.md) 所有文档.
## Roadmap
+
查看EventMesh [Roadmap](docs/en/roadmap.md) 特性规划.
## 贡献
+
永远欢迎参与共建, 请参阅[贡献](CONTRIBUTING.zh-CN.md)了解详细指南
您可以从问题开始.
[GitHub Issues](https://github.com/apache/incubator-eventmesh/issues)
## Landscape
+
<p align="center">
<br/><br/>
<img src="https://landscape.cncf.io/images/left-logo.svg" width="150"/> <img src="https://landscape.cncf.io/images/right-logo.svg" width="200"/>
@@ -54,17 +63,19 @@ EventMesh enriches the <a href="https://landscape.cncf.io/serverless?license=apa
</p>
## License
+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) Copyright (C) Apache Software Foundation
## 开发社区
+
| 微信助手 | 微信公众号 | Slack |
| :----------------------------------------------------: | :----------------------------------------------------: | :----------------------------------------------------: |
|  |  |[加入slack](https://join.slack.com/t/apacheeventmesh/shared_invite/zt-11974dndy-cn3Aq638eleKwKPWP9tkLg) |
Mailing Lists:
-| 列表名称 | 描述 |订阅 |取消订阅|邮件列表存档
+| 列表名称 | 描述 |订阅 |取消订阅|邮件列表存档
| ---- | ---- |---- | ---- | ---- |
-|Users |用户支持与用户问题| [点击订阅](mailto:users-subscribe@eventmesh.incubator.apache.org) |[点击取消订阅](mailto:users-unsubscribe@eventmesh.incubator.apache.org) |[邮件列表存档](https://lists.apache.org/list.html?users@eventmesh.apache.org)|
-|Development |开发相关| [点击订阅](mailto:dev-subscribe@eventmesh.incubator.apache.org) |[点击取消订阅](mailto:dev-unsubscribe@eventmesh.incubator.apache.org) |[邮件列表存档](https://lists.apache.org/list.html?dev@eventmesh.apache.org)|
-|Commits |所有与仓库相关的commits信息通知| [点击订阅](mailto:commits-subscribe@eventmesh.incubator.apache.org) |[点击取消订阅](mailto:commits-unsubscribe@eventmesh.incubator.apache.org) |[邮件列表存档](https://lists.apache.org/list.html?commits@eventmesh.apache.org)|
+|Users |用户支持与用户问题| [点击订阅](mailto:users-subscribe@eventmesh.incubator.apache.org) |[点击取消订阅](mailto:users-unsubscribe@eventmesh.incubator.apache.org) |[邮件列表存档](https://lists.apache.org/list.html?users@eventmesh.apache.org)|
+|Development |开发相关| [点击订阅](mailto:dev-subscribe@eventmesh.incubator.apache.org) |[点击取消订阅](mailto:dev-unsubscribe@eventmesh.incubator.apache.org) |[邮件列表存档](https://lists.apache.org/list.html?dev@eventmesh.apache.org)|
+|Commits |所有与仓库相关的commits信息通知| [点击订阅](mailto:commits-subscribe@eventmesh.incubator.apache.org) |[点击取消订阅](mailto:commits-unsubscribe@eventmesh.incubator.apache.org) |[邮件列表存档](https://lists.apache.org/list.html?commits@eventmesh.apache.org)|
diff --git a/docs/cn/instructions/eclipse.zh-CN.md b/docs/cn/instructions/eclipse.md
similarity index 100%
rename from docs/cn/instructions/eclipse.zh-CN.md
rename to docs/cn/instructions/eclipse.md
diff --git a/docs/cn/instructions/eventmesh-metrics-Prometheus-instruction.md b/docs/cn/instructions/eventmesh-metrics-Prometheus-instruction.md
index f671253..067cd00 100644
--- a/docs/cn/instructions/eventmesh-metrics-Prometheus-instruction.md
+++ b/docs/cn/instructions/eventmesh-metrics-Prometheus-instruction.md
@@ -1,9 +1,10 @@
-## 通过Prometheus观察metrics
+# 通过 Prometheus 观察 Metrics
+
+## 下载 Prometheus
-### 1、下载Prometheus
官网：https://prometheus.io/
-本地下载Prometheus：https://prometheus.io/download/
+本地下载Prometheus：https://prometheus.io/download/
选择自己电脑对应的版本下载并解压缩
@@ -21,8 +22,6 @@
如果你十分了解Prometheus，可以自行配置，eventmesh默认的导出的端口为19090。
-
-
ps：如果需要更换端口的话，请修改eventmesh-runtime/conf/eventmesh.properties中的
```properties
@@ -30,7 +29,7 @@ ps：如果需要更换端口的话，请修改eventmesh-runtime/conf/eventmesh.
eventMesh.metrics.prometheus.port=19090
```
-### 3、运行Prometheus.exe和eventmesh
+## 运行 Prometheus 和 EventMesh
双击Prometheus.exe运行
@@ -40,10 +39,8 @@ eventMesh.metrics.prometheus.port=19090
打开浏览器访问：http://localhost:9090/
-
-
-### 4、输入你想观察的metrics
+### 输入想观察的 Metrics
输入’**eventmesh_**‘ 就会出现相关的指标的提示
-
\ No newline at end of file
+
diff --git a/docs/cn/instructions/eventmesh-runtime-protocol.md b/docs/cn/instructions/eventmesh-runtime-protocol.md
index d0933d4..b951201 100644
--- a/docs/cn/instructions/eventmesh-runtime-protocol.md
+++ b/docs/cn/instructions/eventmesh-runtime-protocol.md
@@ -83,7 +83,7 @@ public enum Command {
UNSUBSCRIBE_RESPONSE(11), //server回复client的取消订阅请求
//监听
- LISTEN_REQUEST(12), //client发给server的启动监听请求
+ LISTEN_REQUEST(12), //client发给server的启动监听请求
LISTEN_RESPONSE(13), //server回复client的监听请求
//RR
@@ -259,7 +259,6 @@ public class LiteMessage {
| ------------------ | ---------------------------- | -------------------------- | ---------------------- |
| 客户端接收异步事件 | HTTP_PUSH_CLIENT_ASYNC(105) | retCode | retCode值为0时代表成功 |
-
## gRPC 协议文档
#### 1. protobuf
@@ -270,7 +269,7 @@ public class LiteMessage {
#### 2. gRPC 数据模型
-- 消息
++ 消息
以下消息数据模型用于 `publish()`, `requestReply()` 和 `broadcast()` APIs.
@@ -326,7 +325,7 @@ message Response {
}
```
-- 订阅
++ 订阅
以下订阅数据模型用于 `subscribe()` 和 `unsubscribe()` APIs.
@@ -356,7 +355,7 @@ message Subscription {
}
```
-- 心跳
++ 心跳
以下心跳数据模型用于 `heartbeat()` API.
@@ -383,7 +382,7 @@ message Heartbeat {
#### 3. gRPC 服务接口
-- 事件生产端服务 APIs
++ 事件生产端服务 APIs
```
service PublisherService {
@@ -398,7 +397,7 @@ service PublisherService {
}
```
-- 事件消费端服务 APIs
++ 事件消费端服务 APIs
```
service ConsumerService {
@@ -412,10 +411,10 @@ service ConsumerService {
}
```
-- 客户端心跳服务 API
++ 客户端心跳服务 API
```
service HeartbeatService {
rpc heartbeat(Heartbeat) returns (Response);
}
-```
\ No newline at end of file
+```
diff --git a/docs/cn/instructions/eventmesh-runtime-quickstart-with-docker.md b/docs/cn/instructions/eventmesh-runtime-quickstart-with-docker.md
index 90da329..9834459 100644
--- a/docs/cn/instructions/eventmesh-runtime-quickstart-with-docker.md
+++ b/docs/cn/instructions/eventmesh-runtime-quickstart-with-docker.md
@@ -5,44 +5,53 @@
可选语言: [英文版本](../../en/instructions/eventmesh-runtime-quickstart-with-docker.md)，[中文版本](eventmesh-runtime-quickstart-with-docker.md)。
## 前提
+
1. 建议使用64位的 linux 系统。
2. 请预先安装 Docker Engine。 Docker 的安装过程可以参考 [docker 官方文档](https://docs.docker.com/engine/install/).
3. 建议掌握基础的 docker 概念和命令行，例如注册中心、挂载等等。不过这不是必须的，因为所有使用到的命令行都列出来了。
4. [RocketMQ 成功的在运行](https://rocketmq.apache.org/docs/quick-start/) 并且可以使用 ip 地址访问到。
## 获取 EventMesh 镜像
+
首先，你可以打开一个命令行，并且使用下面的 ```pull``` 命令从 [Docker Hub](https://registry.hub.docker.com/r/eventmesh/eventmesh/tags) 中下载[最新发布的 EventMesh](https://eventmesh.apache.org/events/release-notes/v1.3.0/) 。
+
```shell
sudo docker pull eventmesh/eventmesh:v1.3.0
```
+
在下载过程中和下载结束后，你可以看到命令行中显示以下的文字：
+
```shell
ubuntu@VM-16-4-ubuntu:~$ sudo docker pull eventmesh/eventmesh:v1.3.0
v1.3.0: Pulling from eventmesh/eventmesh
2d473b07cdd5: Downloading [======> ] 9.649MB/76.1MB
-2b97b2e51c1a: Pulling fs layer
-ccef593d4fe7: Pulling fs layer
-70beb7ae51cd: Waiting
-0a2cf32321af: Waiting
-5d764ea8950d: Waiting
-71d02dcd996d: Waiting
+2b97b2e51c1a: Pulling fs layer
+ccef593d4fe7: Pulling fs layer
+70beb7ae51cd: Waiting
+0a2cf32321af: Waiting
+5d764ea8950d: Waiting
+71d02dcd996d: Waiting
v1.3.0: Pulling from eventmesh/eventmesh
-2d473b07cdd5: Pull complete
-2b97b2e51c1a: Pull complete
-ccef593d4fe7: Pull complete
-70beb7ae51cd: Pull complete
-0a2cf32321af: Pull complete
-5d764ea8950d: Pull complete
-71d02dcd996d: Pull complete
+2d473b07cdd5: Pull complete
+2b97b2e51c1a: Pull complete
+ccef593d4fe7: Pull complete
+70beb7ae51cd: Pull complete
+0a2cf32321af: Pull complete
+5d764ea8950d: Pull complete
+71d02dcd996d: Pull complete
Digest: sha256:267a93a761e999790f8bd132b09541f0ffab551e8618097a4adce8e3e66bbe4e
Status: Downloaded newer image for eventmesh/eventmesh:v1.3.0
docker.io/eventmesh/eventmesh:v1.3.0
```
+
接下来，你可以使用以下命令列出并查看本地已有的镜像。
+
```shell
sudo docker images
```
+
终端中会显示如下所示的镜像信息，可以发现 EventMesh 镜像已经成功下载到本地了。
+
```shell
ubuntu@VM-16-4-ubuntu:~$ sudo docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
@@ -50,11 +59,13 @@ eventmesh/eventmesh v1.3.0 da0008c1d03b 7 days ago 922MB
```
## 准备配置文件
+
在根据 EventMesh 镜像运行对应容器之前，你需要创建一些配置文件。
本篇入门指导使用 RocketMQ 作为对接的中间件，所以需要两个配置文件，分别是：```eventMesh.properties``` 和 ```rocketmq-client.properties```。
首先，你需要使用下面的命令创建这两个文件。
+
```shell
sudo mkdir -p /data/eventmesh/rocketmq/conf
cd /data/eventmesh/rocketmq/conf
@@ -67,10 +78,12 @@ sudo touch rocketmq-client.properties
这个配置文件中包含 EventMesh 运行时环境和集成进来的其他插件所需的参数。
使用下面的 ```vi``` 命令编辑 ```eventmesh.properties```。
+
```shell
sudo vi eventmesh.properties
```
-在快速入门的阶段，你可以直接将 GitHub 仓库中的对应配置文件中的内容复制过来，链接为：https://github.com/apache/incubator-eventmesh/blob/1.3.0/eventmesh-runtime/conf/eventmesh.properties 。
+
+在快速入门的阶段，你可以直接将 GitHub 仓库中的对应配置文件中的内容复制过来，链接为：<https://github.com/apache/incubator-eventmesh/blob/1.3.0/eventmesh-runtime/conf/eventmesh.properties> 。
其中的一些默认属性键值对如下所示：
@@ -80,17 +93,17 @@ sudo vi eventmesh.properties
| eventMesh.server.tcp.port | 10000 | EventMesh tcp server port |
| eventMesh.server.grpc.port | 10205 | EventMesh grpc server port |
-
### 配置 rocketmq-client.properties
这个配置文件中包含 RocketMQ nameserver 的一些信息。
使用下面的 ```vi``` 命令编辑 ```rocketmq-client.properties```。
+
```shell
sudo vi rocketmq-client.properties
```
-在快速入门的阶段，你可以直接将 GitHub 仓库中的对应配置文件中的内容复制过来，链接为：https://github.com/apache/incubator-eventmesh/blob/1.3.0/eventmesh-runtime/conf/rocketmq-client.properties 。但要记得将默认值改为一个实际正在运行的 nameserver 地址。
+在快速入门的阶段，你可以直接将 GitHub 仓库中的对应配置文件中的内容复制过来，链接为：<https://github.com/apache/incubator-eventmesh/blob/1.3.0/eventmesh-runtime/conf/rocketmq-client.properties> 。但要记得将默认值改为一个实际正在运行的 nameserver 地址。
默认的键值对示例如下所示：
@@ -98,15 +111,17 @@ sudo vi rocketmq-client.properties
|---------------------------------------|-------------------------------|----------------------------------|
| eventMesh.server.rocketmq.namesrvAddr | 127.0.0.1:9876;127.0.0.1:9876 | RocketMQ namesrv default address |
-
## 运行 EventMesh
+
现在你就可以开始根据下载好的 EventMesh 镜像运行容器了。
使用到的命令是 ```docker run```，有以下两点内容需要格外注意。
+
1. 绑定容器端口和宿主机端口：使用 ```docker run``` 的 ```-p``` 选项。
2. 将宿主机中的两份配置文件挂在到容器中：使用 ```docker run``` 的 ```-v``` 选项。
综合一下，对应的启动命令为：
+
```shell
sudo docker run -d \
> -p 10000:10000 -p 10105:10105 \
@@ -114,40 +129,49 @@ sudo docker run -d \
> -v /data/eventmesh/rocketmq/conf/rocketmq-client.properties:/data/app/eventmesh/conf/rocketmq-client.properties \
> eventmesh/eventmesh:v1.3.0
```
+
如果运行命令之后看到新输出一行字符串，那么运行 EventMesh 镜像的容器就启动成功了。
接下来，你可以使用下面的命令查看容器的状态。
+
```shell
sudo docker ps
```
如果成功的话，你会看到终端打印出了如下所示容器的信息，其中就有运行 EventMesh 镜像的容器。
+
```shell
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
d1e1a335d4a9 eventmesh/eventmesh:v1.3.0 "/bin/sh -c 'sh star…" About a minute ago Up About a minute 0.0.0.0:10000->10000/tcp, :::10000->10000/tcp, 0.0.0.0:10105->10105/tcp, :::10105->10105/tcp focused_bartik
```
+
从这个信息中可以看出，```container id``` 是 ```d1e1a335d4a9```，随机 ```name``` 是 ```focused_bartik```，它们都可以用来唯一标识这个容器。**注意**：在你的电脑中，它们的值可能跟这里的不同。
## 管理 EventMesh 容器
+
在成功的运行了 EventMesh 容器后，你可以通过进入容器、查看日志、删除容器等方式管理容器。
**进入容器** 命令示例：
+
```shell
sudo docker exec -it [your container id or name] /bin/bash
```
在容器中 **查看日志** 命令示例：
+
```shell
cd ../logs
tail -f eventmesh.out
```
**删除容器** 命令示例:
+
```shell
sudo docker rm -f [your container id or name]
```
## 探索更多
+
既然 EventMesh 已经通过容器运行了，现在你可以参考 [```eventmesh-examples``` 模块](https://github.com/apache/incubator-eventmesh/tree/master/eventmesh-examples) 编写并测试自己的代码了。
希望你享受这个过程并获得更多收获！
diff --git a/docs/cn/instructions/eventmesh-runtime-quickstart.md b/docs/cn/instructions/eventmesh-runtime-quickstart.md
index 5adecc4..60b4b9a 100644
--- a/docs/cn/instructions/eventmesh-runtime-quickstart.md
+++ b/docs/cn/instructions/eventmesh-runtime-quickstart.md
@@ -73,11 +73,15 @@ sh start.sh
***2.3.2.1 安装插件***
有两种方式安装插件
+
- classpath加载：本地开发可以通过在eventmesh-starter模块build.gradle中进行声明，例如声明使用rocketmq插件
+
```java
implementation project(":eventmesh-connector-plugin:eventmesh-connector-rocketmq")
```
+
- 文件加载：通过将插件安装到插件目录，EventMesh在运行时会根据条件自动加载插件目录下的插件，可以通过执行以下命令安装插件
+
```shell
./gradlew clean jar dist && ./gradlew installPlugin
```
@@ -86,6 +90,7 @@ sh start.sh
EventMesh会默认加载dist/plugin目录下的插件，可以通过`-DeventMeshPluginDir=your_plugin_directory`来改变插件目录。运行时需要使用的插件实例可以在
`confPath`目录下面的`eventmesh.properties`中进行配置。例如通过以下设置声明在运行时使用rocketmq插件。
+
```properties
#connector plugin
eventMesh.connector.plugin.type=rocketmq
@@ -99,6 +104,7 @@ eventMesh.connector.plugin.type=rocketmq
-Deventmesh.home=eventmesh-runtime
-DconfPath=eventmesh-runtime/conf
```
+
> 注：如果操作系统为Windows, 可能需要将文件分隔符换成\
**2.3.4 启动运行**
@@ -278,4 +284,3 @@ Linux
```
之后 , 你可以在 `/logs` 目录下面看到不同模式的运行日志
-
diff --git a/docs/cn/instructions/eventmesh-sdk-java-quickstart.md b/docs/cn/instructions/eventmesh-sdk-java-quickstart.md
index a23df59..2f45924 100644
--- a/docs/cn/instructions/eventmesh-sdk-java-quickstart.md
+++ b/docs/cn/instructions/eventmesh-sdk-java-quickstart.md
@@ -1,7 +1,7 @@
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.eventmesh/eventmesh-sdk-java)
-
# 如何运行 eventmesh-sdk-java 演示
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.eventmesh/eventmesh-sdk-java)
+
> EventMesh-sdk-java作为客户端，与eventmesh-runtime通信，用于完成消息的发送和接收。
>
> EventMesh-sdk-java支持异步消息和广播消息。异步消息表示生产者只发送消息，不关心回复消息。广播消息表示生产者发送一次消息，所有订阅广播主题的消费者都将收到消息
@@ -120,4 +120,4 @@ TCP, HTTP 和 GRPC 示例都在**eventmesh-example**模块下
```
运行 org.apache.eventmesh.grpc.pub.eventmeshmessage.BatchPublishInstance 的主要方法
-```
\ No newline at end of file
+```
diff --git a/docs/cn/instructions/eventmesh-trace-Zipkin-instruction.md b/docs/cn/instructions/eventmesh-trace-Zipkin-instruction.md
index 03257b6..913ee05 100644
--- a/docs/cn/instructions/eventmesh-trace-Zipkin-instruction.md
+++ b/docs/cn/instructions/eventmesh-trace-Zipkin-instruction.md
@@ -1,4 +1,4 @@
-## 通过Zipkin观察trace
+# 通过 Zipkin 观察 Trace
### 1、下载和运行Zipkin
@@ -46,4 +46,4 @@ eventmesh.trace.export.zipkin.port=9411
### 4、观察
-浏览器打开： **localhost:9411**
\ No newline at end of file
+浏览器打开： **localhost:9411**
diff --git a/docs/cn/instructions/quickstart.md b/docs/cn/instructions/quickstart.md
index c02b536..3d924dc 100644
--- a/docs/cn/instructions/quickstart.md
+++ b/docs/cn/instructions/quickstart.md
@@ -1,6 +1,6 @@
# 快速入门说明
-### 依赖
+## 依赖
```
建议使用64位操作系统，建议使用Linux / Unix；
@@ -8,11 +8,11 @@
Gradle至少为5.6, 推荐 5.6.*
```
-### 部署eventmesh-store
+### 部署 eventmesh-store
阅读更多[这里](eventmesh-store-quickstart.zh-CN.md)
-### 部署eventmesh-runtime
+### 部署 eventmesh-runtime
阅读更多[这里](eventmesh-runtime-quickstart.zh-CN.md)
@@ -24,5 +24,6 @@ Gradle至少为5.6, 推荐 5.6.*
阅读更多[这里](eventmesh-runtime-protocol.zh-CN.md)
-### eventMesh 导入Eclipse 快速入门说明
-阅读更多[这里](eclipse.zh-CN.md)
+### EventMesh 导入 Eclipse 快速入门说明
+
+阅读更多[这里](eclipse.md)
diff --git a/docs/cn/intro.md b/docs/cn/intro.md
index 3aae2a3..74e8f43 100644
--- a/docs/cn/intro.md
+++ b/docs/cn/intro.md
@@ -1,4 +1,5 @@
# Apache EventMesh (Incubating)
+
[](https://github.com/apache/incubator-eventmesh/actions/workflows/ci.yml)
[](https://codecov.io/gh/apache/incubator-eventmesh)
[](https://lgtm.com/projects/g/apache/incubator-eventmesh/context:java)
diff --git a/docs/en/features/eventmesh-cloudevents-sdk-binding.md b/docs/en/features/eventmesh-cloudevents-sdk-binding.md
index af1b258..559d367 100644
--- a/docs/en/features/eventmesh-cloudevents-sdk-binding.md
+++ b/docs/en/features/eventmesh-cloudevents-sdk-binding.md
@@ -55,16 +55,16 @@ should be an easy way to achieve the requirements.
##### SDK side for publish
- add the CloudEvents identifier in `package` header
-- use `CloudEventBuilder` build the CloudEvent and put it into the `package` body
+- use `CloudEventBuilder` build the CloudEvent and put it into the `package` body
##### SDK side for subscribe
- add `convert` function under the `ReceiveMsgHook` interface, for converting the `package` body to the specific protocol with the identifier in `package` header
-- different protocols should implement the `ReceiveMsgHook` interface
+- different protocols should implement the `ReceiveMsgHook` interface
##### Server side for publish
-- design the protocol convert api contains `decodeMessage` interface which convert the package's body to CloudEvent
+- design the protocol convert api contains `decodeMessage` interface which convert the package's body to CloudEvent
- update `Session.upstreamMsg()` in `MessageTransferTask` change the input parameter Message to CloudEvent, the CloudEvent use the last step `decodeMessage` api convert
- update `SessionSender.send()` change the input parameter `Message` to `CloudEvent`
- update `MeshMQProducer` api support send `CloudEvents` in runtime
@@ -78,7 +78,7 @@ should be an easy way to achieve the requirements.
- update the `MeshMQPushConsumer.updateOffset()` implementation change the the input parameter `Message` to `CloudEvent`
-- update `DownStreamMsgContext` , change the input parameter `Message` to `CloudEvent`, update the `DownStreamMsgContext.ackMsg`
+- update `DownStreamMsgContext` , change the input parameter `Message` to `CloudEvent`, update the `DownStreamMsgContext.ackMsg`
#### For HTTP
@@ -104,4 +104,5 @@ should be an easy way to achieve the requirements.
## Appendix
### References
-- https://cloudevents.github.io/sdk-java/kafka
\ No newline at end of file
+
+- <https://cloudevents.github.io/sdk-java/kafka>
diff --git a/docs/en/features/eventmesh-metrics-export-design.md b/docs/en/features/eventmesh-metrics-export-design.md
index a8f5958..ad67816 100644
--- a/docs/en/features/eventmesh-metrics-export-design.md
+++ b/docs/en/features/eventmesh-metrics-export-design.md
@@ -16,7 +16,7 @@ Power your metrics and alerting with a leading open-source monitoring solution.
- Powerful queries
- Great visualization
- Efficient storage
-- Simple operation
+- Simple operation
- Precise alerting
- Many client libraries
- Many integrations
@@ -42,6 +42,6 @@ use the meter instrument provided by OpenTelemetry to observe the metrics exist
## Appendix
-#### References
+### References
-https://github.com/open-telemetry/docs-cn/blob/main/QUICKSTART.md#%E5%88%9B%E5%BB%BA%E5%9F%BA%E7%A1%80Span
\ No newline at end of file
+<https://github.com/open-telemetry/docs-cn/blob/main/QUICKSTART.md#%E5%88%9B%E5%BB%BA%E5%9F%BA%E7%A1%80Span>
diff --git a/docs/en/features/eventmesh-schemaregistry-design.md b/docs/en/features/eventmesh-schemaregistry-design.md
index 32f0871..60ef256 100644
--- a/docs/en/features/eventmesh-schemaregistry-design.md
+++ b/docs/en/features/eventmesh-schemaregistry-design.md
@@ -81,7 +81,7 @@ Second is the integration of Open Schema in Eventmesh, which includes validation
As for the first proposal, some developing statuses are as follows.
-**Status Code and Exception Code**
+#### Status Code and Exception Code
No. | Status Code | Exception Code | Description | status
--- | :---: | :---: | :---: | :---:
@@ -97,7 +97,7 @@ No. | Status Code | Exception Code | Description | status
10 | 500 | 50001 | Storage Service Exception | ✔
11 | ^ | 50002 | Timeout Exception | ✔
-**API developing status** :
+#### API developing status
No. | Type | URL | response | exception | code | test
--- | --- | --- | --- | --- | --- | ---
@@ -115,7 +115,7 @@ No. | Type | URL | response | exception | code | test
12 | GET | /compatibility/(string: subject) | `Compatibility.class` | 40101\40402\50001 | ✔ | ❌
13 | PUT | /compatibility/(string: subject) | `Compatibility.class` | 40101\40402\40901\42204\50001 | - | ❌
-**Overall Project Structure**
+#### Overall Project Structure
```SchemaController.java```+```SchemaService.java``` : ```OpenSchema 7.1.1~7.1.2 (API 1~2)```
diff --git a/docs/en/features/eventmesh-stream-design.md b/docs/en/features/eventmesh-stream-design.md
index c9db8d9..c647aea 100644
--- a/docs/en/features/eventmesh-stream-design.md
+++ b/docs/en/features/eventmesh-stream-design.md
@@ -6,16 +6,16 @@
cloud-native eventing infrastructure.
## An overview of Event Streaming
-
-Event Streaming is an implementation of Pub/Sub architecture pattern,it consist of
--Message or Event : Change of State.
+Event Streaming is an implementation of Pub/Sub architecture pattern,it consist of
--Topic : Partition in messaging middle ware broker.
+- Message or Event: Change of State.
--Consumer : Can subscribe to read events from broker topic.
+- Topic: Partition in messaging middle ware broker.
--Producer : Generate events
+- Consumer: Can subscribe to read events from broker topic.
+
+- Producer: Generate events
Streaming of event is continuous flow of events in order to maintain order between events, events flow should be in a specific direction means from producers to consumers.
@@ -33,78 +33,97 @@ Streaming of event is continuous flow of events in order to maintain order betwe
We are introduce EventMesh Stream component allow us to use programming model and binder abstractions
from Spring Cloud Stream natively within Apache Camel.
-[Spring-Cloud-Stream](https://spring.io/projects/spring-cloud-stream) Spring Cloud Stream is a framework for building
+[Spring-Cloud-Stream](https://spring.io/projects/spring-cloud-stream) Spring Cloud Stream is a framework for building
highly scalable event-driven microservices connected with shared messaging systems.
-[Apache Camel](https://camel.apache.org/) Camel is an Open Source integration framework that empowers you to quickly
+[Apache Camel](https://camel.apache.org/) Camel is an Open Source integration framework that empowers you to quickly
and easily integrate various systems consuming or producing data.
## Architecture
+
## Design
-### EventMesh-Stream Component:
-```
- - Event
- - Event Channel
- - Event EndPoint
- - Event Pipes & Filters
- - Event Routes
- - Event Converter
-```
+### EventMesh-Stream Component
+
+- Event
+- Event Channel
+- Event EndPoint
+- Event Pipes & Filters
+- Event Routes
+- Event Converter
+
#### Event
+
> A event is the smallest unit for transmitting data in system. It structure divided into headers, body and attachments.
+
#### Event Channel
+
> A event channel is a logical channel in system, we are achieving by Spring Cloud Stream programming model, it has abstract functionality around messaging channels(As of now Spring `MessageChannel`).
+
#### Event EndPoint
+
> A event endpoint is the interface between an application and a messaging system. We can define two types of endpoint
- - Consumer endpoint - Appears at start of a route and read incoming events from an incoming channel.
- - Producer endpoint - Appears at end of a route and write incoming events to an outgoing channel.
+
+- Consumer endpoint - Appears at start of a route and read incoming events from an incoming channel.
+- Producer endpoint - Appears at end of a route and write incoming events to an outgoing channel.
+
#### Event Pipes & Filters
+
> We can construct a route by creating chain of filters( Apache Camel `Processor`), where the output of one filter is fed into input for next filter in the pipeline.
The main advantage of the pipeline is that you can create complex event processing logic.
+
#### Event Routes
+
> A event router, is a type of filter on consumer and redirect them to the appropriate target endpoint based on a decision criteria.
+
#### Event Converter
+
> The event converter that modifies the contents of a event, translating it to a different format(i.e cloudevents -> Event (Camel) -> Binder Message(Spring Message) and vice versa).
-## EventMesh-Stream Component Interfaces:
-#### Component
+## EventMesh-Stream Component Interfaces
+
+### Component
+
Component interface is the primary entry point, you can use Component object as a factory to create EndPoint objects.
-#### EndPoint
+
+### EndPoint
+
EndPoint which is act as factories for creating Consumer, Producer and Event objects.
- -createConsumer() — Creates a consumer endpoint, which
-represents the source endpoint at the beginning of a route.
- -createProducer() — Creates a producer endpoint, which represents the target endpoint at the
-end of a route.
+
+- createConsumer() — Creates a consumer endpoint, which represents the source endpoint at the beginning of a route.
+- createProducer() — Creates a producer endpoint, which represents the target endpoint at the end of a route.
+
#### Producer
+
User can create following types of producer
> Synchronous Producer-Processing thread blocks until the producer has finished the event processing.
-
+
-```
In future Producer Types:
- - Asynchronous Producer - Producer process the event in a sub-thread.
-```
+
+- Asynchronous Producer - Producer process the event in a sub-thread.
+
#### Consumer
-User can create following types of consumer
+
+User can create following types of consumer
> Event-driven consumer-the processing of an incoming request is initiated when message binder call a method in consumer.
-
+
-```
In Future
- - Scheduled poll consumer
- - Custom polling consumer
-```
+
+- Scheduled poll consumer
+- Custom polling consumer
## Appendix
### References
-- https://donovanmuller.blog/camel-spring-cloud-stream/
+
+- <https://donovanmuller.blog/camel-spring-cloud-stream/>
diff --git a/docs/en/features/eventmesh-trace-design.md b/docs/en/features/eventmesh-trace-design.md
index 81e6c23..4c725b0 100644
--- a/docs/en/features/eventmesh-trace-design.md
+++ b/docs/en/features/eventmesh-trace-design.md
@@ -16,9 +16,9 @@ OpenTelemetry is a collection of tools, APIs, and SDKs. You can use it to instru
## Design Details
-* SpanProcessor: BatchSpanProcessor
+- SpanProcessor: BatchSpanProcessor
-* Exporter: log(default), would be changed from properties
+- Exporter: log(default), would be changed from properties
```java
// Configure the batch spans processor. This span processor exports span in batches.
@@ -49,7 +49,7 @@ super.textMapPropagator = openTelemetryTraceFactory.getTextMapPropagator();
## Problems
-#### How to set different exporter in class 'OpenTelemetryTraceFactory'?(Solved)
+### How to set different exporter in class 'OpenTelemetryTraceFactory'? (Solved)
After I get the exporter type from properties, how to deal with it.
@@ -58,12 +58,15 @@ The 'logExporter' only needs to new it.
But the 'zipkinExporter' needs to new and use the "getZipkinExporter()" method.
## Solutions
-#### Solution of different exporter
+
+### Solution of different exporter
+
Use reflection to get an exporter.
First of all, different exporter must implement the interface 'EventMeshExporter'.
Then we get the exporter name from the configuration and reflect to the class.
+
```java
//different spanExporter
String exporterName = configuration.eventMeshTraceExporterType;
@@ -79,11 +82,10 @@ Additional, this will surround with try catch.If the specified exporter cannot b
SPI(To be completed)
-
## Appendix
-#### References
+### References
-https://github.com/open-telemetry/docs-cn/blob/main/QUICKSTART.md
+<https://github.com/open-telemetry/docs-cn/blob/main/QUICKSTART.md>
-https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/netty
+<https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/netty>
diff --git a/docs/en/features/eventmesh-workflow-design.md b/docs/en/features/eventmesh-workflow-design.md
index 8c2709b..4873a34 100644
--- a/docs/en/features/eventmesh-workflow-design.md
+++ b/docs/en/features/eventmesh-workflow-design.md
@@ -2,7 +2,7 @@
## Business Problem
-Imaging you are building a simple Order Management System for an E-Commerce Store.
+Imaging you are building a simple Order Management System for an E-Commerce Store.
The system should be able to receive and provision new orders from a store website. The provisioning process
should be able to process all orders, handle payments, as well as process shipments.
@@ -22,24 +22,24 @@ We use [CNCF Serverless Workflow](https://serverlessworkflow.io/) to describe th
CNCF Serverless Workflow defines a vendor-neutral, open-source, and fully community-driven ecosystem
for defining and running DSL-based workflows that target the Serverless technology domain.
-Serverless Workflow defines a Domain Specific Language (DSL)
+Serverless Workflow defines a Domain Specific Language (DSL)
to describe stateful and stateless workflow-based orchestrations of serverless functions and microservices.
More about this can be found in its [official github site](https://github.com/serverlessworkflow/specification)
## EventMesh Workflow
-We leverage Serverless Workflow DSL to describe the EventMesh workflow. Based on its spec, the workflow is consists of a series of
+We leverage Serverless Workflow DSL to describe the EventMesh workflow. Based on its spec, the workflow is consists of a series of
workflow states used to describe the control-flow logic.
At this time we only support event related workflow states. See the supported states in [Workflow DSL Design](#workflow-dsl-design-wip).
-A `workflow state` can include applicable `actions`, or services/functions that should be invoked during workflow execution.
+A `workflow state` can include applicable `actions`, or services/functions that should be invoked during workflow execution.
These `actions` can reference reusable `function` definitions which define how these functions/services should be invoked.
-They can also reference events that trigger event-based service invocations, and events to wait for that denote completion of
-such event-based service invocation completion.
+They can also reference events that trigger event-based service invocations, and events to wait for that denote completion of
+such event-based service invocation completion.
In EDA solution, we usually defined our event-driven microservice using AsyncAPI.
-Serverless workflow `function` definitions support defining invocation semantics using AsyncAPI.
+Serverless workflow `function` definitions support defining invocation semantics using AsyncAPI.
See [Using Funtions for AsyncAPI Service](https://github.com/serverlessworkflow/specification/blob/main/specification.md#using-functions-for-async-api-service-invocations)
for more information.
@@ -56,7 +56,7 @@ See AsyncAPI detail in the [official site](https://www.asyncapi.com/docs/getting
In this example, we build the event-driven workflow of the Order management system above.
-First, we need to define AsyncAPI definitions for our microservice apps.
+First, we need to define AsyncAPI definitions for our microservice apps.
- Online Store App
@@ -209,17 +209,13 @@ The steps running the workflow is the followings:
1. Deploy the Publisher and Subscriber Apps in the environment.
Describe the App APIs using AsyncAPI, generate the asyncAPI yaml.
Register the Publisher and Subscriber Apps in EventMesh Catalog using AsyncAPI.
-
2. Register the Serverless Workflow DSL in EventMesh Workflow Engine.
-
3. EventMesh Workflow Engine query the EventMesh Catalog for Publisher and Subscribers required in Workflow DSL `function`
-
4. Event-driven Apps are publish events to EventMesh Runtime to trigger the Workflow. EventMesh Workflow Engine also publish and subscribe events for orchestrating the events.
-
### EventMesh Catalog Design
EventMesh Catalog store the Publisher, Subscriber and Channel metadata. consists of the following modules:
@@ -229,59 +225,52 @@ EventMesh Catalog store the Publisher, Subscriber and Channel metadata. consists
Using the SDK provided by AsyncAPI community (see [tool list](https://www.asyncapi.com/docs/community/tooling)),
parse and validated the AsyncAPI yaml inputs, and generate the AsyncAPI definition.
-
- Publisher, Channel, Subscriber Modules
-
- From the AsyncAPI definition store the Publisher, Subscriber and Channel information.
+ From the AsyncAPI definition store the Publisher, Subscriber and Channel information.
### EventMesh Workflow Engine Design
EventMesh Workflow Engine consists of the following modules:
- Workflow Parser
-
+
Using the SDK provided by Serverless Workflow community (see supported [SDKs](https://github.com/serverlessworkflow/specification#sdks)),
parse and validated the workflow DSL inputs, and generate workflow definition.
-
- Workflow Module
-
- It manages a workflow instance life cycle, from create, start, stop to destroy.
+ It manages a workflow instance life cycle, from create, start, stop to destroy.
- State Module
It manages workflow state life cycle. We support the event-related states, and the supported state list below is Work-in-Progress.
- | Workflow State | Description |
+ | Workflow State | Description |
| --- | --- |
| Operation | Execute the AsyncAPI functions defined in the Actions |
| Event | Check if the defined Event matched, if so execute the defined AsyncAPI functions |
| Switch | Check the event is matched with the event-conditions, and execute teh defined AsyncAPI functions |
| Parallel | Execute the defined AsyncAPI functions in parallel |
| ForEach | Iterate the inputCollection and execute the defined AsyncAPI functions |
-
-- Action Module
- It managed the functions inside the action.
+- Action Module
+ It managed the functions inside the action.
- Function Module
-
+
It manages the AsyncAPI functions by creating the publisher and/or subscriber in EventMesh Runtime, and manage the publisher/subscriber life cycle.
- | AsyncAPI Operation | EventMesh Runtime |
- | --- | --- |
- | Publish | Publisher |
+ | AsyncAPI Operation | EventMesh Runtime |
+ | --- | --- |
+ | Publish | Publisher |
| Subscribe | Subscriber |
-
- Event Module
It manages the CloudEvents data model, including event filter, correlation and transformation using the rules defined in the workflow DSL.
-
- Retry Module
It manages the retry logic of the event publishing into EventMesh Runtime.
diff --git a/docs/en/features/spi.md b/docs/en/features/spi.md
index af1d627..b229b52 100644
--- a/docs/en/features/spi.md
+++ b/docs/en/features/spi.md
@@ -27,6 +27,7 @@ public @interface EventMeshSPI {
}
```
+
Use annotation to declare the interface is an SPI extended interface can improve the readability of the code.
On the other hand, @EventMeshSPI contains a isSingleton attribute which used to declare whether the extension instance is a singleton.
If this attribute is true, that means the instance of this interface will be singleton.
diff --git a/docs/en/instructions/eventmesh-metrics-Prometheus-instruction.md b/docs/en/instructions/eventmesh-metrics-Prometheus-instruction.md
index ca32639..916e661 100644
--- a/docs/en/instructions/eventmesh-metrics-Prometheus-instruction.md
+++ b/docs/en/instructions/eventmesh-metrics-Prometheus-instruction.md
@@ -1,6 +1,7 @@
-## Observe metrics through Prometheus
+# Observe Metrics through Prometheus
+
+## Download Prometheus
-### 1、download Prometheus
Official website：https://prometheus.io/
Download Prometheus locally：https://prometheus.io/download/
@@ -9,7 +10,7 @@ Select the corresponding version of your computer, download and unzip it
-### 2、In Prometheus Add configuration in YML
+## Add YML configuration in Prometheus
If you are new to Prometheus, you can copy it directly： eventmesh-runtime/conf/prometheus.yml
@@ -21,8 +22,6 @@ Replace the file in the red box
If you know Prometheus well, you can configure it yourself. The default export port of eventmesh is 19090.
-
-
ps：If the port needs to be replaced, please modify:eventmesh-runtime/conf/eventmesh.properties中的
```properties
@@ -30,7 +29,7 @@ ps：If the port needs to be replaced, please modify:eventmesh-runtime/conf/even
eventMesh.metrics.prometheus.port=19090
```
-### 3、run Prometheus and eventmesh
+## Run Prometheus and EventMesh
Double click Prometheus.exe startup
@@ -40,10 +39,8 @@ run eventmesh-example(reference [eventmesh-sdk-java-quickstart](eventmesh-sdk-ja
Open browser access：http://localhost:9090/
-
-
-### 4、Enter the metrics you want to observe
+## Enter the metrics to be observed
input '**eventmesh_**' Relevant indicators will appear
-
\ No newline at end of file
+
diff --git a/docs/en/instructions/eventmesh-runtime-quickstart-with-docker.md b/docs/en/instructions/eventmesh-runtime-quickstart-with-docker.md
index deda6f4..599f870 100644
--- a/docs/en/instructions/eventmesh-runtime-quickstart-with-docker.md
+++ b/docs/en/instructions/eventmesh-runtime-quickstart-with-docker.md
@@ -1,47 +1,57 @@
# Quick Start Instruction
+
This quick start instruction is a detailed guide of setting up EventMesh via docker. It takes RocketMQ as connector for example.
Alternative languages: [English version](eventmesh-runtime-quickstart-with-docker.md), [Chinese version](../../cn/instructions/eventmesh-runtime-quickstart-with-docker.md).
## Prerequisites
+
1. 64bit Linux is recommended.
2. Docker Engine is assumed installed. The installation procedure could be found on [docker docs](https://docs.docker.com/engine/install/).
3. Basic [docker concepts and commands](https://docs.docker.com/get-started/) are highly recommended acquiring first, including registry, volume, etc. However, it's not a necessity for going through this instruction because every commands are listed.
4. [RocketMQ is running successfully](https://rocketmq.apache.org/docs/quick-start/) and could be routed to through IP address.
## Get EventMesh Image
+
First, you could open a terminal and use the following ```pull``` command to download [latest EventMesh](https://eventmesh.apache.org/events/release-notes/v1.3.0/) from [Docker Hub - the default docker registry](https://registry.hub.docker.com/r/eventmesh/eventmesh/tags).
+
```shell
sudo docker pull eventmesh/eventmesh:v1.3.0
```
+
During and After downloading, the terminal will show the status such as:
+
```shell
ubuntu@VM-16-4-ubuntu:~$ sudo docker pull eventmesh/eventmesh:v1.3.0
v1.3.0: Pulling from eventmesh/eventmesh
2d473b07cdd5: Downloading [======> ] 9.649MB/76.1MB
-2b97b2e51c1a: Pulling fs layer
-ccef593d4fe7: Pulling fs layer
-70beb7ae51cd: Waiting
-0a2cf32321af: Waiting
-5d764ea8950d: Waiting
-71d02dcd996d: Waiting
+2b97b2e51c1a: Pulling fs layer
+ccef593d4fe7: Pulling fs layer
+70beb7ae51cd: Waiting
+0a2cf32321af: Waiting
+5d764ea8950d: Waiting
+71d02dcd996d: Waiting
v1.3.0: Pulling from eventmesh/eventmesh
-2d473b07cdd5: Pull complete
-2b97b2e51c1a: Pull complete
-ccef593d4fe7: Pull complete
-70beb7ae51cd: Pull complete
-0a2cf32321af: Pull complete
-5d764ea8950d: Pull complete
-71d02dcd996d: Pull complete
+2d473b07cdd5: Pull complete
+2b97b2e51c1a: Pull complete
+ccef593d4fe7: Pull complete
+70beb7ae51cd: Pull complete
+0a2cf32321af: Pull complete
+5d764ea8950d: Pull complete
+71d02dcd996d: Pull complete
Digest: sha256:267a93a761e999790f8bd132b09541f0ffab551e8618097a4adce8e3e66bbe4e
Status: Downloaded newer image for eventmesh/eventmesh:v1.3.0
docker.io/eventmesh/eventmesh:v1.3.0
```
+
Next, you could list and check local images on your machine using command:
+
```shell
sudo docker images
```
+
And, the terminal will print all local images such as the following content. It could be found that EventMesh image has been successfully downloaded.
+
```shell
ubuntu@VM-16-4-ubuntu:~$ sudo docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
@@ -49,11 +59,13 @@ eventmesh/eventmesh v1.3.0 da0008c1d03b 7 days ago 922MB
```
## Prepare Configuration Files
+
Before running the EventMesh container from downloaded image, you need to configure some files.
Here this instruction takes RocketMQ as connector for example, so that two configuration files should be created: ```eventmesh.properties``` and ```rocketmq-client.properties```.
First, you may need to create such files, using following commands:
+
```shell
sudo mkdir -p /data/eventmesh/rocketmq/conf
cd /data/eventmesh/rocketmq/conf
@@ -66,10 +78,12 @@ sudo touch rocketmq-client.properties
It contains properties of EventMesh runtime env and integrated plugins.
Use ```vi``` command to edit ```eventmesh.properties```:
+
```shell
sudo vi eventmesh.properties
```
-In the quick start step, you could directly copy content in https://github.com/apache/incubator-eventmesh/blob/1.3.0/eventmesh-runtime/conf/eventmesh.properties .
+
+In the quick start step, you could directly copy content in <https://github.com/apache/incubator-eventmesh/blob/1.3.0/eventmesh-runtime/conf/eventmesh.properties> .
Some default key-values are listed below:
@@ -79,17 +93,17 @@ Some default key-values are listed below:
| eventMesh.server.tcp.port | 10000 | EventMesh tcp server port |
| eventMesh.server.grpc.port | 10205 | EventMesh grpc server port |
-
-
### rocketmq-client.properties
It contains properties of running RocketMQ nameserver.
Use ```vi``` command to edit ```rocketmq-client.properties```:
+
```shell
sudo vi rocketmq-client.properties
```
-In the quick start step, you could refer to https://github.com/apache/incubator-eventmesh/blob/1.3.0/eventmesh-runtime/conf/rocketmq-client.properties , and change the value to a running nameserver address.
+
+In the quick start step, you could refer to <https://github.com/apache/incubator-eventmesh/blob/1.3.0/eventmesh-runtime/conf/rocketmq-client.properties> , and change the value to a running nameserver address.
The default key-value is listed below:
@@ -97,15 +111,17 @@ The default key-value is listed below:
|---------------------------------------|-------------------------------|----------------------------------|
| eventMesh.server.rocketmq.namesrvAddr | 127.0.0.1:9876;127.0.0.1:9876 | RocketMQ namesrv default address |
-
## Make EventMesh Run
+
Now you are at the step of running an EventMesh container from downloaded docker image.
The main command is ```docker run```, and two things need to be noted.
+
1. binding the container port with host machine port: use ```-p``` option of ```docker run```.
2. mount the configuration files with host machine files: use ```-v``` option of ```docker run```.
So that the command for running EventMesh is:
+
```shell
sudo docker run -d \
> -p 10000:10000 -p 10105:10105 \
@@ -113,40 +129,49 @@ sudo docker run -d \
> -v /data/eventmesh/rocketmq/conf/rocketmq-client.properties:/data/app/eventmesh/conf/rocketmq-client.properties \
> eventmesh/eventmesh:v1.3.0
```
+
After you executing it and seeing a string below it, the container is running successfully.
Next, you could use below command to check the status of the EventMesh container:
+
```shell
sudo docker ps
```
Successfully, you could see the terminal presenting container status such as:
+
```shell
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
d1e1a335d4a9 eventmesh/eventmesh:v1.3.0 "/bin/sh -c 'sh star…" About a minute ago Up About a minute 0.0.0.0:10000->10000/tcp, :::10000->10000/tcp, 0.0.0.0:10105->10105/tcp, :::10105->10105/tcp focused_bartik
```
+
It tells you that ```container id``` is ```d1e1a335d4a9``` and random ```name``` is ```focused_bartik```. They are the identifier to this container when managing it. Note that they may be different in your machine.
## Manage EventMesh Container
+
After correctly running EventMesh container, you could manage such container by entering container, checking logs, remove container, and so on.
**enter container** command example:
+
```shell
sudo docker exec -it [your container id or name] /bin/bash
```
**checking logs** command example inside container:
+
```shell
cd ../logs
tail -f eventmesh.out
```
**remove container** command example:
+
```shell
sudo docker rm -f [your container id or name]
```
## Explore More
+
Since EventMesh is running, now you can write your own client code referring [```eventmesh-examples```](https://github.com/apache/incubator-eventmesh/tree/master/eventmesh-examples).
Hope you enjoy and explore more on EventMesh!
diff --git a/docs/en/instructions/eventmesh-runtime-quickstart.md b/docs/en/instructions/eventmesh-runtime-quickstart.md
index d888bd2..2c38bd2 100644
--- a/docs/en/instructions/eventmesh-runtime-quickstart.md
+++ b/docs/en/instructions/eventmesh-runtime-quickstart.md
@@ -2,7 +2,7 @@
## 1 Remote Deploy
-### 1.1 dependencies
+### 1.1 Dependencies
```
64bit OS, Linux/Unix is recommended;
@@ -12,7 +12,7 @@ Gradle at least 7.0, eg 7.0.*
### 1.2 download sources
-download source code from [https://github.com/apache/incubator-eventmesh](https://github.com/apache/incubator-eventmesh)
+download source code from [https://github.com/apache/incubator-eventmesh](https://github.com/apache/incubator-eventmesh)
You will get **EventMesh-master.zip**
### 1.3 build sources
@@ -23,7 +23,7 @@ cd /*YOUR DEPLOY PATH*/EventMesh-master
gradle clean dist
```
-You will get **EventMesh_1.3.0-release.tar.gz** in directory /* YOUR DEPLOY PATH */EventMesh-master/build
+You will get **EventMesh_1.3.0-release.tar.gz** in directory /*YOUR DEPLOY PATH*/EventMesh-master/build
### 1.4 Deployment
@@ -60,14 +60,17 @@ Same with 1.2
***2.3.1.1 Install Plugin***
There are two ways to install the plugin:
+
- Install from classpath: Local development can be done by declaring in the eventmesh-starter module build.gradle, for example
by declaring the use of rocketmq plugin
+
```java
implementation project(":eventmesh-connector-plugin:eventmesh-connector-rocketmq")
```
- Install from files: By installing the plugin into the plugin directory, EventMesh will automatically load the plugins in the plugin directory
according to the conditions when EventMesh running, you can install the plugins by executing the following command.
+
```shell
./gradlew clean jar dist && ./gradlew installPlugin
```
@@ -76,7 +79,7 @@ There are two ways to install the plugin:
EventMesh will default load plugins installed in `dist/plugin`, you can change the plugin directory by `-DeventMeshPluginDir=your_plugin_directory`.
The plugin instance to be used at runtime can be configured in the `eventmesh.properties` at the `confPath` directory.
-Example you can declare use rocketmq by following config.
+Example you can declare use rocketmq by following config.
```java
#connector plugin, default standalone, can be rocketmq
@@ -91,9 +94,11 @@ eventMesh.connector.plugin.type=rocketmq
-Deventmesh.home=eventmesh-runtime/dist
-DconfPath=eventmesh-runtime/conf
```
+
> ps: If you use Windows, you may need to replace the file separator to \
**2.3.3 Run**
+
```java
running `org.apache.eventmesh.starter.StartUp` main method in eventmesh-starter module.
@@ -102,4 +107,4 @@ EventMeshTCPServer[port=10000] started
HTTPServer[port=10105] started
EventMeshGrpcServer[port=10205] started
-```
\ No newline at end of file
+```
diff --git a/docs/en/instructions/eventmesh-sdk-java-quickstart.md b/docs/en/instructions/eventmesh-sdk-java-quickstart.md
index bf4ca45..ca73494 100644
--- a/docs/en/instructions/eventmesh-sdk-java-quickstart.md
+++ b/docs/en/instructions/eventmesh-sdk-java-quickstart.md
@@ -1,6 +1,7 @@
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.eventmesh/eventmesh-sdk-java)
# How to run eventmesh-sdk-java demo
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.eventmesh/eventmesh-sdk-java)
+
> EventMesh-sdk-java, as the client, communicated with eventmesh-runtime, used to complete the sending and receiving of message.
>
> Supports async msg and broadcast msg. Async msg means the producer just sends msg and does not care reply msg. Broadcast msg means the producer send msg once and all the consumer subscribed the broadcast topic will receive the msg.
@@ -14,7 +15,7 @@ TCP, HTTP and GRPC demos are both under the **eventmesh-example** module.
#### Async msg
- Create topic TEST-TOPIC-TCP-ASYNC on rocketmq-console
-
+
- Start consumer, subscribe topic in previous step.
```
@@ -37,7 +38,7 @@ Run the main method of org.apache.eventmesh.tcp.demo.pub.eventmeshmessage.AsyncP
Run the main method of org.apache.eventmesh.tcp.demo.sub.eventmeshmessage.AsyncSubscribeBroadcast
```
-* Start producer, send broadcast message
+- Start producer, send broadcast message
```
Run the main method of org.apache.eventmesh.tcp.demo.pub.eventmeshmessage.AsyncPublishBroadcast
diff --git a/docs/en/instructions/eventmesh-store-quickstart.md b/docs/en/instructions/eventmesh-store-quickstart.md
index 2c0df05..fbf4d77 100644
--- a/docs/en/instructions/eventmesh-store-quickstart.md
+++ b/docs/en/instructions/eventmesh-store-quickstart.md
@@ -1,26 +1,30 @@
# Eventmesh-store Quick start Instruction
-### dependencies
-
-```
-64bit OS, Linux/Unix is recommended;
-64bit JDK 1.8+;
-Gradle at least 5.6, eg 5.6.*
-4g+ free disk for eventmesh-store server
-```
+## Dependencies
+
+- 64bit OS, Linux/Unix is recommended;
+- 64bit JDK 1.8+;
+- Gradle at least 5.6, eg 5.6.*
+- 4g+ free disk for eventmesh-store server
+
### Standalone-connector
+
No need a third-party store.
### RocketMQ-connector
-you can reference https://rocketmq.apache.org/docs/quick-start/
+
+you can reference <https://rocketmq.apache.org/docs/quick-start/>
and "One-click" build script is on going.
### Kafka-connector
+
WIP
### Redis-connector
+
WIP
### DeFiBus-connector
+
WIP
diff --git a/docs/en/instructions/eventmesh-trace-Zipkin-instruction.md b/docs/en/instructions/eventmesh-trace-Zipkin-instruction.md
index 16b2c4c..ca42a9c 100644
--- a/docs/en/instructions/eventmesh-trace-Zipkin-instruction.md
+++ b/docs/en/instructions/eventmesh-trace-Zipkin-instruction.md
@@ -1,20 +1,16 @@
-## Observe trace through Zipkin
+# Observe trace through Zipkin
-### 1、Download and run Zipkin
+## Download and run Zipkin
-Reference:https://zipkin.io/pages/quickstart.html
+Reference:<https://zipkin.io/pages/quickstart.html>
-
-
-### 2、Run eventmesh
+## Run EventMesh
run eventmesh-starter(reference [eventmesh-runtime-quickstart](eventmesh-runtime-quickstart.md))
run eventmesh-example(reference [eventmesh-sdk-java-quickstart](eventmesh-sdk-java-quickstart.md))
-
-
-### 3、Related settings
+## Related settings
In eventmesh-runtime/conf/eventmesh.properties：
@@ -24,7 +20,9 @@ The default exporter is log, which needs to be manually changed to Zipkin
#trace exporter
eventmesh.trace.exporter.type=Zipkin
```
+
Here are various configurations of Zipkin
+
```properties
#set the maximum batch size to use
eventmesh.trace.exporter.max.export.size=512
@@ -42,8 +40,6 @@ eventmesh.trace.export.zipkin.port=9411
The above are related configurations. If you are familiar with Zipkin, you can modify it yourself.
+## Observe
-
-### 4、Observe
-
-Open browser access： **localhost:9411**
\ No newline at end of file
+Open browser access： **http://localhost:9411**
diff --git a/docs/en/intro.md b/docs/en/intro.md
index 4ffaef5..330bc00 100644
--- a/docs/en/intro.md
+++ b/docs/en/intro.md
@@ -1,4 +1,7 @@
+# Apache EventMesh (Incubating)
+
+
## Features
### [SPI](features/spi.md)
@@ -13,5 +16,4 @@
### [SchemaRegistry](features/eventmesh-schemaregistry-design.md)
-
### [Workflow](features/eventmesh-workflow-design.md)
diff --git a/docs/en/roadmap.md b/docs/en/roadmap.md
index d24b065..39f34ac 100644
--- a/docs/en/roadmap.md
+++ b/docs/en/roadmap.md
@@ -1,4 +1,3 @@
-
# EventMesh Roadmap
_Note: Items in tables for each milestone do not imply an order of implementation._
@@ -29,7 +28,7 @@ _Status description:_
| 🚩| Federated connector | [doc](https://github.com/apache/incubator-eventmesh/issues/577) |
| 🚩| Dashboard | [doc](https://github.com/apache/incubator-eventmesh/issues/700) |
| 🚩| Transaction event | [doc](https://github.com/apache/incubator-eventmesh/issues/697) |
-| 🚩| Event-query language(EQL)| [doc](https://github.com/apache/incubator-eventmesh/issues/778) |
+| 🚩| Event-query language(EQL)| [doc](https://github.com/apache/incubator-eventmesh/issues/778) |
| 🚩| Knative Eventing Infra| [doc](https://github.com/apache/incubator-eventmesh/issues/790) |
| 🚩| Metadata consistency persistent| [doc](https://github.com/apache/incubator-eventmesh/issues/817) |
| 🚩| Go sdk| [doc](https://github.com/apache/incubator-eventmesh/issues/762) |
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: commits-help@eventmesh.apache.org