Skip to content

Commit faf1fc1

Browse files
qqeasonchenqqeasonchen
committed
update some docs
Signed-off-by: qqeasonchen <[email protected]>
1 parent b946360 commit faf1fc1

File tree

7 files changed

+41
-232
lines changed

7 files changed

+41
-232
lines changed

‎README.md‎

Lines changed: 16 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -13,105 +13,36 @@
1313
## What is EventMesh?
1414
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.
1515

16-
![architecture1](docs/images/eventmesh-multi-runtime.png)
16+
**Multi-runtime:**
17+
![architecture1](docs/images/eventmesh-arch3.png)
1718

18-
**EventMesh Architecture:**
19+
**Orchestration:**
20+
![architecture1](docs/images/eventmesh-orchestration.png)
1921

20-
![architecture1](docs/images/eventmesh-runtime2.png)
22+
**Federation:**
23+
![architecture1](docs/images/eventmesh-federation.png)
2124

2225
**Components:**
2326

2427
* **eventmesh-runtime** : an middleware to transmit events between event producers and consumers, support cloud native apps and microservices.
2528
* **eventmesh-sdk-java** : currently supports HTTP and TCP protocols.
26-
* **eventmesh-connector-api** : an api layer based on OpenMessaging api and SPI pluggin, which can be implemented by popular EventStores such as IMDG, Messaging Engine and OSS etc.
27-
* **eventmesh-connector-plugin** : plugins for connector.
28-
* **eventmesh-connector-standalone** : an implementation of eventmesh-connector-api, pub event to or sub event from InMemory as EventStore.
29-
* **eventmesh-connector-rocketmq** : an implementation of eventmesh-connector-api, pub event to or sub event from RocketMQ as EventStore.
30-
* **eventmesh-connector-kafka(WIP)** : an implementation of eventmesh-connector-api, pub event to or sub event from Kafka as EventStore.
31-
* **eventmesh-connector-redis(WIP)** : an implementation of eventmesh-connector-api, pub event to or sub event from Redis as EventStore.
32-
* **eventmesh-connector-defibus(WIP)** : an implementation of eventmesh-connector-api, pub event to or sub event from [DeFiBus](https://github.com/webankfintech/defibus) as EventStore
29+
* **eventmesh-connector-plugin** : plugins for connect a middleware such as RocketMQ/Kafka/Redis/Pulsar etc.
30+
* **eventmesh-registry-plugin** : plugins for registry adapter, such as Nacos/Etcd.
31+
* **eventmesh-security-plugin** : plugins for security adpater, such as ACL/Authentication/Authorization.
32+
* **eventmesh-protocol-plugin** : plugins for protocol adapter, such as CloudEvents/MQTT.
3333
* **eventmesh-admin** : clients,topics,subscriptions and other management.
34-
* **eventmesh-registry-plugin** : plugins for registry adapter.
35-
* **eventmesh-security-plugin** : plugins for security adpater.
36-
* **eventmesh-protocol-plugin** : plugins for protocol adapter.
37-
38-
**Protocol:**
39-
40-
The protocol of eventmesh is easier and more convenient, you can read more [here](docs/en/instructions/eventmesh-runtime-protocol.md)
41-
42-
## Feature
43-
44-
Event & Service
45-
- [x] Pub/Sub
46-
- [x] Request/Reply
47-
- [ ] Event Streaming
48-
- [ ] Event transaction
49-
- [ ] At-least-once/at-most-once delivery guarantees
50-
51-
Store Connector
52-
- [x] RocketMQ
53-
- [x] InMemory
54-
- [ ] Federated
55-
- [ ] Kafka
56-
- [ ] Redis
57-
- [ ] Pulsar
58-
- [ ] RabbitMQ
59-
- [ ] DeFiBus
60-
- [ ] Cold storage (S3, Minio, SQL, key/value, etc...)
61-
62-
Protocol
63-
- [x] TCP
64-
- [x] Http
65-
- [ ] gRPC
66-
- [ ] CloudEvents
67-
- [ ] MQTT
68-
- [ ] WebSocket
69-
- [ ] AMQP
70-
- [ ] AsyncAPI
71-
72-
SDK
73-
- [x] Java
74-
- [ ] C
75-
- [ ] Go
76-
- [ ] Python
77-
78-
Deploy
79-
- [x] Sidecar
80-
- [x] Gateway
81-
- [x] Docker
82-
83-
Metrics
84-
- [x] OpenTelemetry
85-
- [x] Promethus exporter
86-
87-
Tracing
88-
- [x] OpenTelemetry
89-
- [x] Zipkin exporter
90-
- [ ] Skywalking
91-
92-
Governance
93-
- [x] Client management
94-
- [ ] Topic management
95-
- [ ] Metadata registry
96-
- [ ] Schema registry
97-
- [ ] Dynamic config
98-
99-
Choreography
100-
- [ ] Servelss workflow
101-
- [ ] Event function,triggers and bindings
102-
103-
Security
104-
- [ ] Auth
105-
- [ ] ACL
106-
107-
Runtime
108-
- [ ] WebAssembly runtime
10934

11035
## Quick Start
11136
1. [Store quickstart](docs/en/instructions/eventmesh-store-quickstart.md)
11237
2. [Runtime quickstart](docs/en/instructions/eventmesh-runtime-quickstart.md) or [Runtime quickstart with docker](docs/en/instructions/eventmesh-runtime-quickstart-with-docker.md).
11338
3. [Java SDK examples](docs/en/instructions/eventmesh-sdk-java-quickstart.md).
11439

40+
## Documentation
41+
See EventMesh [Documentation](docs/en/intro.md) for all documents.
42+
43+
## Roadmap
44+
See EventMesh [Roadmap](docs/en/roadmap.md) for details.
45+
11546
## Contributing
11647
Contributions are always welcomed! Please see [CONTRIBUTING](CONTRIBUTING.md) for detailed guidelines.
11748

‎README.zh-CN.md‎

Lines changed: 25 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -10,63 +10,34 @@
1010
## 什么是Event Mesh？
1111
EventMesh是一个动态的云原生事件驱动架构基础设施，用于分离应用程序和后端中间件层，它支持广泛的用例，包括复杂的混合云、使用了不同技术栈的分布式架构。
1212

13-
![architecture1](docs/images/eventmesh-multi-runtime.png)
13+
**多运行时:**
14+
![architecture1](docs/images/eventmesh-arch3.png)
1415

15-
**EventMesh生态:**
16-
![architecture1](docs/images/eventmesh-define.png)
16+
**编排:**
17+
![architecture1](docs/images/eventmesh-orchestration.png)
1718

18-
**EventMesh架构：**
19+
**联邦:**
20+
![architecture1](docs/images/eventmesh-federation.png)
1921

20-
![architecture1](docs/images/eventmesh-runtime.png)
22+
**组件:**
23+
* **eventmesh-runtime** : an middleware to transmit events between event producers and consumers, support cloud native apps and microservices.
24+
* **eventmesh-sdk-java** : currently supports HTTP and TCP protocols.
25+
* **eventmesh-connector-plugin** : plugins for connect a middleware such as RocketMQ/Kafka/Redis/Pulsar etc.
26+
* **eventmesh-registry-plugin** : plugins for registry adapter, such as Nacos/Etcd.
27+
* **eventmesh-security-plugin** : plugins for security adpater, such as ACL/Authentication/Authorization.
28+
* **eventmesh-protocol-plugin** : plugins for protocol adapter, such as CloudEvents/MQTT.
29+
* **eventmesh-admin** : clients,topics,subscriptions and other management.
2130

22-
**EventMesh云原生结构：**
23-
24-
![architecture2](docs/images/eventmesh-panels.png)
25-
26-
**支持连接的事件存储：**
27-
28-
* [RocketMQ](https://github.com/apache/rocketmq)：RocketMQ是一个分布式消息流平台，具有低延迟、高性能和可靠性、万亿级容量和灵活的可伸缩性。
29-
30-
**关键部件：**
31-
32-
* **eventmesh-runtime**：一种中间件，用于在事件产生者和使用者之间传输事件，支持云原生应用程序和微服务
33-
* **eventmesh-sdk-java**：当前支持HTTP和TCP协议，未来会支持gRPC等
34-
* **eventmesh-connector-api**：一个基于OpenMessaging api和SPI插件机制的接口层，可以有很多不同的事件存储的实现，比如IMDG，Messaging Engine和OSS等
35-
* **eventmesh-connector-rocketmq** : 一种基于eventmesh-connector-api的实现，该实现支持将RocketMQ作为事件存储，实现事件的发布与订阅
36-
37-
**通信协议：**
31+
## 快速开始
32+
1. [Store quickstart](docs/en/instructions/eventmesh-store-quickstart.md)
33+
2. [Runtime quickstart](docs/en/instructions/eventmesh-runtime-quickstart.md) or [Runtime quickstart with docker](docs/en/instructions/eventmesh-runtime-quickstart-with-docker.md).
34+
3. [Java SDK examples](docs/en/instructions/eventmesh-sdk-java-quickstart.md).
3835

39-
eventmesh的通信协议更加简洁方便，详细内容，阅读更多[这里](docs/cn/instructions/eventmesh-runtime-protocol.md)
36+
## 文档
37+
查看EventMesh [Documentation](docs/en/intro.md) 所有文档.
4038

41-
## RoadMap
42-
| version | feature |
43-
| ---- | ---- |
44-
| v1.0.0 |Support java-sdk , tcp pub/sub, http pub|
45-
| v1.1.0 |Support RocketMQ as eventstore|
46-
| v1.1.1 |Support https|
47-
| v1.2.0 |Support pluggable event store by OpenMessaging Pub/Sub API, http sub, docker|
48-
| V1.3.0 |Support CloudEvents, event streaming|
49-
| WIP |Support more pluggable event storage (Kafka, Pulsar, Redis, etc...)|
50-
| WIP |Support Event schema|
51-
| WIP |Support Event governance|
52-
| WIP |Support Event function,triggers and bindings|
53-
| WIP |Support Event orchestration, Servelss workflow|
54-
| WIP |Support in-memory event store|
55-
| WIP |Support Event transaction|
56-
| WIP |Support Event security|
57-
| WIP |Support multi language SDK(c\go\python\wasm)|
58-
| WIP |Support metrics exporter|
59-
| WIP |Support tracing exporter|
60-
| WIP |Support at-least-once/at-most-once delivery guarantees|
61-
| WIP |Support cold event storage (S3, Minio, SQL, key/value, etc...)|
62-
| WIP |Support gRPC protocol|
63-
| WIP |Support MQTT protocol|
64-
| WIP |Support AsyncAPI|
65-
66-
## 快速开始
67-
1. [event-store](https://rocketmq.apache.org/docs/quick-start/) (RocketMQ, ignore this step if use standalone).
68-
2. [runtime quickstart](docs/en/instructions/eventmesh-runtime-quickstart.md) or [runtime quickstart with docker](docs/en/instructions/eventmesh-runtime-quickstart-with-docker.md).
69-
3. [java examples ](docs/en/instructions/eventmesh-sdk-java-quickstart.md).
39+
## Roadmap
40+
查看EventMesh [Roadmap](docs/en/roadmap.md) 特性规划.
7041

7142
## 贡献
7243
永远欢迎参与共建, 请参阅[贡献](CONTRIBUTING.zh-CN.md)了解详细指南
@@ -86,9 +57,9 @@ EventMesh enriches the <a href="https://landscape.cncf.io/serverless?license=apa
8657
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) Copyright (C) Apache Software Foundation
8758

8859
## 开发社区
89-
微信群:
90-
91-
![wechat_qr](docs/images/mesh-helper.png)
60+
| 微信助手 | 微信公众号 | Slack |
61+
| :----------------------------------------------------: | :----------------------------------------------------: | :----------------------------------------------------: |
62+
| ![wechat_qr](docs/images/mesh-helper.jpg) | ![wechat_official_qr](docs/images/wechat-official.png) |[加入slack](https://join.slack.com/t/apacheeventmesh/shared_invite/zt-yx3n2ak7-HcVG98CDqb~7PwgoDzgfMA) |
9263

9364
Mailing Lists:
9465

‎docs/en/intro.md‎

Lines changed: 0 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +0,0 @@
1-
# Apache EventMesh (Incubating)
2-
[![CI status](https://github.com/apache/incubator-eventmesh/actions/workflows/ci.yml/badge.svg)](https://github.com/apache/incubator-eventmesh/actions/workflows/ci.yml)
3-
[![CodeCov](https://codecov.io/gh/apache/incubator-eventmesh/branch/develop/graph/badge.svg)](https://codecov.io/gh/apache/incubator-eventmesh)
4-
[![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/apache/incubator-eventmesh.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/apache/incubator-eventmesh/context:java)
5-
[![Total alerts](https://img.shields.io/lgtm/alerts/g/apache/incubator-eventmesh.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/apache/incubator-eventmesh/alerts/)
6-
[![GitHub release](https://img.shields.io/badge/release-download-orange.svg)](https://github.com/apache/incubator-eventmesh/releases)
7-
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
8-
9-
[点我查看中文版](../cn/README.md)
10-
11-
## What is Event Mesh?
12-
13-
This figure shows the positioning of the event mesh relative to other similar technologies (such as service mesh) in the
14-
application framework.
15-
16-
![architecture1](../images/eventmesh-define.png)
17-
18-
Event Mesh is a dynamic plug-in cloud-native basic service layer used to decouple the application and middleware layer.
19-
It provides flexible, reliable and fast event distribution, and can be managed.
20-
21-
![architecture1](../images/eventmesh-runtime.png)
22-
23-
Cloud Native Event Mesh:
24-
25-
![architecture2](../images/eventmesh-panels.png)
26-
27-
The event mesh allows events from one application to be dynamically routed to any other application. General functions
28-
of the event mesh:
29-
30-
* Event driven;
31-
* Event governance;
32-
* Dynamic routing;
33-
* Cloud native
34-
35-
Dependent components:
36-
37-
* DeFiBus : a distributed messaging platform with low latency, high performance and reliability, flexible
38-
scalability. [DeFiBus](https://github.com/WeBankFinTech/DeFiBus)
39-
* RocketMQ
40-
41-
Key components:
42-
43-
* eventmesh-runtime : an middleware to transmit events between event producers and consumers, support cloud native apps
44-
and microservices
45-
* eventmesh-sdk-java : currently supports HTTP and TCP protocols, and will support gRPC in the future
46-
47-
## RoadMap
48-
49-
| version | feature |
50-
| ---- | ---- |
51-
| v1.0.0 |Support DeFiBus as eventstore, support pub/sub, http api, java-sdk|
52-
| v1.1.0 |Support rocketmq as eventstore|
53-
| v1.2.0 |Support Plug-in architecture, support http sub|
54-
| v1.3.0 |Support cloud event protocal|
55-
| |Support transaction event|
56-
| |Support Event Sourcing|
57-
| |Support Event orchestration|
58-
| |Support Dashboard|
59-
| |Support Event governance|
60-
| |Support Nacos as an event router|
61-
| |Support Promethus|
62-
| |Support Skywalking|
63-
| |Support Spiffe|
64-
| |Support gRPC|
65-
| |Support c/go/python/nodejs SDK|
66-
67-
## Quick Start
68-
69-
1. Build and deploy event-store([DeFiBus](https://github.com/WeBankFinTech/DeFiBus)), see
70-
instruction ['event-store quickstart'](instructions/eventmesh-store-quickstart.md).
71-
2. Build and deploy eventmesh-runtime, see
72-
instruction ['eventmesh-runtime quickstart'](instructions/eventmesh-runtime-quickstart.md).
73-
3. Run eventmesh-sdk-java demo, see
74-
instruction ['eventmesh-sdk-java quickstart'](instructions/eventmesh-sdk-java-quickstart.md).
75-
76-
## Contributing
77-
78-
Contributions are always welcomed! Please see [CONTRIBUTING](../../CONTRIBUTING.md) for detailed guidelines
79-
80-
You can start with the issues labeled with good first issue.
81-
[GitHub Issues](https://github.com/apache/incubator-eventmesh/issues)
82-
83-
## License
84-
85-
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) Copyright (C) Apache Software Foundation
86-
87-
## Contacts
88-
89-
WeChat group：
90-
91-
![wechat_qr](../images/mesh-helper.png)
92-
93-

‎docs/en/roadmap.md‎

Whitespace-only changes.

‎docs/images/eventmesh-arch3.png‎

283 KB
Loading

‎docs/images/eventmesh-federation.png‎

65.7 KB
Loading

‎docs/images/eventmesh-orchestration.png‎

266 KB
Loading

0 commit comments

Comments
 (0)