Skip to content
38 changes: 36 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,48 @@ Apache EventMesh is packed with features that help users build event-driven appl

**Extensibility & ecosystem**

- **Agent-to-Agent (A2A) collaboration** — a built-in [A2A protocol](docs/a2a-protocol/README_EN.md) turns EventMesh into an agent collaboration bus, bridging synchronous MCP / JSON-RPC 2.0 tool calls and asynchronous event-driven pub/sub for LLM and multi-agent systems.
- **Agent-to-Agent (A2A) collaboration** — a built-in [A2A protocol](docs/eventmesh-a2a-protocol.md) turns EventMesh into an agent collaboration bus, bridging synchronous MCP / JSON-RPC 2.0 tool calls and asynchronous event-driven pub/sub for LLM and multi-agent systems.
- **Pluggable storage layer** — [Apache RocketMQ](https://rocketmq.apache.org), [Apache Kafka](https://kafka.apache.org), [Apache Pulsar](https://pulsar.apache.org), [RabbitMQ](https://rabbitmq.com), [Redis](https://redis.io), and more.
- **Pluggable interconnector layer** — [connectors](https://github.com/apache/eventmesh/tree/develop/eventmesh-connector-plugin) run as standalone processes acting as the source or sink of SaaS, CloudService, Database, etc.
- **Pluggable meta service** — [Consul](https://consulproject.org/en/), [Nacos](https://nacos.io), [ETCD](https://etcd.io), and [Zookeeper](https://zookeeper.apache.org/).
- **Event schema management** via catalog service.
- **Powerful event orchestration** through the [Serverless workflow](https://serverlessworkflow.io/) engine.
- **Powerful event filtering and transformation.**

## Capability status

Each EventMesh surface carries an explicit maturity status. The table below is the
**single source of truth** — module-level docs link here instead of restating their
status. See [docs](docs/) for the per-capability guides.

| Capability | Status | Recommendation | Migration target |
| --- | :---: | --- | --- |
| [HTTP + CloudEvents](docs/eventmesh-client-guide.md) | **GA target** | Recommended — the primary user path (`CloudEventsClient` + `/events/*`) | Primary path |
| [Kafka / RocketMQ storage](eventmesh-storage-plugin/) (4.x, 5.x) | **GA target** | Recommended — pluggable WAL backends, TCK-covered (`MeshStoragePluginTCK`) | Primary path |
| SSE / WebSocket push | **Beta** | Usable — integration-tested; unified ACK/redelivery semantics still landing | Unified push transports |
| Connector Runtime | **Beta** | Usable — 24 connector plugins on the standalone runtime | New connector SPI migration |
| [A2A / Agent Gateway](docs/eventmesh-a2a-protocol.md) | **Experimental** | Evaluate — task store + runtime bridge landed (#5302/#5304); reaper & Meta-backed agent cards pending | Unified Runtime A2A |
| TCP / gRPC / OpenMessaging SDKs | **Legacy-compatible** | Existing users only — kept so old clients run unmodified; not extended | [HTTP + CloudEvents](docs/eventmesh-client-guide.md) |

Status meanings:

- **GA target** — feature-complete for the current architecture, integration-tested against real brokers; safe for production.
- **Beta** — functional and tested, but semantics or deployment shape may still shift in a minor release.
- **Experimental** — under active development; APIs and storage layouts may break; wire it up on dev clusters first.
- **Legacy-compatible** — maintained for zero-change compatibility with existing clients; receives fixes but no new features. New integrations should not start here.

> Migrating off TCP / gRPC SDKs? The legacy clients keep working against the current
> runtime; see the [client guide](docs/eventmesh-client-guide.md) for the
> HTTP + CloudEvents replacement (`CloudEventsClient`).

### Documentation

- [Getting started](docs/eventmesh-getting-started.md) — zero to running runtime in minutes
- [Configuration reference](docs/eventmesh-configuration.md) — every runtime key, per-backend settings, security & quota
- [Client guide](docs/eventmesh-client-guide.md) — complete `CloudEventsClient` walkthrough (pub/sub, request-reply, streaming, lite topics)
- [Architecture](docs/eventmesh-architecture.md) — control / data / agent planes; storage SPI; security gate; A2A stack
- [Features](docs/eventmesh-features.md) — feature-by-feature guide (pub/sub, A2A, connectors, security, reliability)

## Subprojects

- [EventMesh-site](https://github.com/apache/eventmesh-site): Apache official website resources for EventMesh.
Expand Down Expand Up @@ -167,7 +201,7 @@ Upgrade: websocket
Connection: Upgrade
```

> Long-polling, SSE, and WebSocket are interchangeable delivery transports — a subscriber chooses one. SSE and WebSocket are pushed by the server (no polling loop), while long-polling is client-driven. Request-reply (`POST /events/request` + `POST /events/reply`) is also supported. The `CloudEventsClient` Java SDK wraps all of these (`subscribe` / `subscribeSse` / `subscribeWs`); see the [CloudEvents client guide](docs/eventmesh-cloudevents-client-guide.md).
> Long-polling, SSE, and WebSocket are interchangeable delivery transports — a subscriber chooses one. SSE and WebSocket are pushed by the server (no polling loop), while long-polling is client-driven. Request-reply (`POST /events/request` + `POST /events/reply`) is also supported. The `CloudEventsClient` Java SDK wraps all of these (`subscribe` / `subscribeSse` / `subscribeWs`); see the [CloudEvents client guide](docs/eventmesh-client-guide.md).

#### 6. Unsubscribing

Expand Down
36 changes: 34 additions & 2 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,46 @@ Apache EventMesh 提供了丰富的能力,帮助用户轻松构建事件驱动

**扩展性与生态**

- **智能体协作(A2A)** —— 内置的 [A2A 协议](docs/a2a-protocol/README.md) 将 EventMesh 打造成智能体协作总线,打通同步的 MCP / JSON-RPC 2.0 工具调用与异步的事件驱动发布订阅,原生支撑大模型(LLM)与多智能体(Multi-Agent)场景。
- **智能体协作(A2A)** —— 内置的 [A2A 协议](docs/eventmesh-a2a-protocol.md) 将 EventMesh 打造成智能体协作总线,打通同步的 MCP / JSON-RPC 2.0 工具调用与异步的事件驱动发布订阅,原生支撑大模型(LLM)与多智能体(Multi-Agent)场景。
- **可插拔存储层** —— [Apache RocketMQ](https://rocketmq.apache.org)、[Apache Kafka](https://kafka.apache.org)、[Apache Pulsar](https://pulsar.apache.org)、[RabbitMQ](https://rabbitmq.com)、[Redis](https://redis.io) 等。
- **可插拔互联层(Connector)** —— [connectors](https://github.com/apache/eventmesh/tree/develop/eventmesh-connector-plugin) 作为独立进程运行,可充当 SaaS、CloudService、数据库等的 source 或 sink。
- **可插拔元数据服务** —— [Consul](https://consulproject.org/en/)、[Nacos](https://nacos.io)、[ETCD](https://etcd.io) 和 [Zookeeper](https://zookeeper.apache.org/)。
- **事件模式管理** —— 通过目录(catalog)服务实现。
- **强大的事件编排** —— 基于 [Serverless workflow](https://serverlessworkflow.io/) 引擎。
- **强大的事件过滤与转换能力。**

## 能力状态(Capability Status)

每个 EventMesh 对外能力都有明确的状态定级。下表是**唯一的状态事实来源**——各模块文档链接到这里,
不再各自重复描述。各能力的详细指南见 [docs](docs/)。

| 能力 | 状态 | 建议 | 迁移目标 |
| --- | :---: | --- | --- |
| [HTTP + CloudEvents](docs/eventmesh-client-guide.md) | **GA 目标** | 推荐——主用户路径(`CloudEventsClient` + `/events/*`) | 主路径 |
| [Kafka / RocketMQ 存储](eventmesh-storage-plugin/)(4.x、5.x) | **GA 目标** | 推荐——可插拔 WAL 后端,TCK 覆盖(`MeshStoragePluginTCK`) | 主路径 |
| SSE / WebSocket 推送 | **Beta** | 可用——已有集成测试;统一 ACK/重投递语义仍在收敛 | 统一推送传输 |
| Connector Runtime | **Beta** | 可用——独立运行时上的 24 个连接器插件 | 新连接器 SPI 迁移 |
| [A2A / Agent 网关](docs/eventmesh-a2a-protocol.md) | **实验性** | 评估——TaskStore + Runtime 桥已落地(#5302/#5304);reaper 与 Meta 化 AgentCard 待做 | 统一 Runtime A2A |
| TCP / gRPC / OpenMessaging SDK | **Legacy 兼容** | 仅存量用户——保持老客户端零改动运行;不再扩展 | [HTTP + CloudEvents](docs/eventmesh-client-guide.md) |

状态含义:

- **GA 目标** —— 当前架构下功能完整,已对真实 broker 做集成测试;可安全用于生产。
- **Beta** —— 功能可用且有测试,但语义或部署形态在次版本仍可能调整。
- **实验性** —— 迭代开发中;API 与存储布局可能破坏性变更;请先在开发集群试用。
- **Legacy 兼容** —— 仅为存量客户端零改动兼容而维护;只修缺陷、不加功能。新接入不要选这里。

> 正在从 TCP / gRPC SDK 迁移?Legacy 客户端在当前 Runtime 上继续可用;替代方案(HTTP +
> CloudEvents 的 `CloudEventsClient`)见[客户端指引](docs/eventmesh-client-guide.md)。

### 文档导航

- [快速上手(英文)](docs/eventmesh-getting-started.md) —— 零到运行
- [配置参考(英文)](docs/eventmesh-configuration.md) —— 每个运行时键、后端设置、安全 & 配额
- [客户端指引(中文)](docs/eventmesh-client-guide.md) —— `CloudEventsClient` 完整用法
- [架构(英文)](docs/eventmesh-architecture.md) —— 控制面 / 数据面 / 智能体面;存储 SPI;安全闸门;A2A 协议栈
- [特性(英文)](docs/eventmesh-features.md) —— 逐特性说明(发布订阅、A2A、连接器、安全、可靠性)

## 子项目

- [EventMesh-site](https://github.com/apache/eventmesh-site): Apache EventMesh 的官方网站资源。
Expand Down Expand Up @@ -267,7 +299,7 @@ Upgrade: websocket
Connection: Upgrade
```

> 长轮询、SSE、WebSocket 是可互换的下发传输——订阅者任选其一。SSE 与 WebSocket 由服务端推送(无需轮询循环),长轮询则由客户端驱动。此外还支持请求-应答(`POST /events/request` + `POST /events/reply`)。`CloudEventsClient` Java SDK 封装了以上全部方式(`subscribe` / `subscribeSse` / `subscribeWs`),用法见[CloudEvents 客户端使用指引](docs/eventmesh-cloudevents-client-guide.md)。
> 长轮询、SSE、WebSocket 是可互换的下发传输——订阅者任选其一。SSE 与 WebSocket 由服务端推送(无需轮询循环),长轮询则由客户端驱动。此外还支持请求-应答(`POST /events/request` + `POST /events/reply`)。`CloudEventsClient` Java SDK 封装了以上全部方式(`subscribe` / `subscribeSse` / `subscribeWs`),用法见[CloudEvents 客户端使用指引](docs/eventmesh-client-guide.md)。

#### 4. 取消订阅

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
>
> Until all three land, treat the gateway as Experimental — wire it up against the
> `MetaBackedTaskStore` only on dev clusters.
>
> Canonical maturity level: **Experimental** — see the [capability status table](../README.md#capability-status).

---

Expand Down
Loading
Loading