From af78e1f8d269068ad0cd563cabd555db8ec29f98 Mon Sep 17 00:00:00 2001 From: qqeasonchen Date: Wed, 16 Sep 2026 15:06:51 +0800 Subject: [PATCH 1/2] docs(v2.0.0): full resync from repo develop @ 2422e1387 (review excluded) Complete refresh of version-v2.0.0 from the repository docs/ tree: - getting-started: quick-start curl examples fixed to the real HTTP contract (poll clientId/max/timeoutMs, single-field ack), memory-storage default path from the docker zero-env flow - a2a.md: English title/TOC/headings; a2a-readiness.md removed (internal decision log) - links cleaned from a2a.md / documentation-map - configuration.md: memory backend section + defaults; deployment.md, protocols/storage-spi, architecture pages: post-restructure state - review/ pages intentionally excluded (repo-internal archives) Conventions unchanged from PR #260: index.md -> documentation-map.md, connectors/README.md -> connectors/connectors.md, site _category_.json kept. --- .../version-v2.0.0/architecture/overview.md | 8 +- .../version-v2.0.0/architecture/redesign.md | 14 +-- .../version-v2.0.0/architecture/security.md | 4 - .../version-v2.0.0/documentation-map.md | 16 +-- .../version-v2.0.0/feature/a2a-readiness.md | 118 ------------------ versioned_docs/version-v2.0.0/feature/a2a.md | 23 ++-- .../version-v2.0.0/feature/admin-api.md | 4 - .../feature/architecture-guard.md | 4 - .../version-v2.0.0/feature/client-java.md | 6 +- .../feature/connector-api-split.md | 4 - .../feature/connectors/_category_.json | 2 +- .../feature/connectors/canal.md | 4 - .../feature/connectors/chatgpt.md | 4 - .../feature/connectors/connectors.md | 4 - .../feature/connectors/dingtalk.md | 4 - .../version-v2.0.0/feature/connectors/file.md | 4 - .../version-v2.0.0/feature/connectors/http.md | 4 - .../version-v2.0.0/feature/connectors/jdbc.md | 4 - .../feature/connectors/kafka.md | 4 - .../feature/connectors/knative.md | 4 - .../version-v2.0.0/feature/connectors/lark.md | 4 - .../version-v2.0.0/feature/connectors/mcp.md | 4 - .../feature/connectors/mongodb.md | 4 - .../feature/connectors/openfunction.md | 4 - .../feature/connectors/pravega.md | 4 - .../feature/connectors/prometheus.md | 4 - .../feature/connectors/pulsar.md | 4 - .../feature/connectors/rabbitmq.md | 4 - .../feature/connectors/redis.md | 4 - .../feature/connectors/rocketmq.md | 4 - .../version-v2.0.0/feature/connectors/s3.md | 4 - .../feature/connectors/slack.md | 4 - .../feature/connectors/spring.md | 4 - .../feature/connectors/wechat.md | 4 - .../feature/connectors/wecom.md | 4 - .../version-v2.0.0/feature/control-plane.md | 4 - .../feature/delivery-reliability.md | 4 - .../version-v2.0.0/feature/deployment.md | 21 +++- .../version-v2.0.0/feature/frame-protocol.md | 4 - .../version-v2.0.0/feature/http-api.md | 4 - .../version-v2.0.0/feature/lite-topic.md | 4 - .../version-v2.0.0/feature/load-balancing.md | 4 - .../version-v2.0.0/feature/observability.md | 6 +- .../feature/offset-management.md | 6 +- .../version-v2.0.0/feature/protocols.md | 4 - .../version-v2.0.0/feature/pubsub.md | 4 - .../version-v2.0.0/feature/storage-spi.md | 22 ++-- .../version-v2.0.0/feature/streaming.md | 4 - versioned_docs/version-v2.0.0/introduction.md | 6 +- .../quickstart/configuration.md | 19 +-- .../quickstart/getting-started.md | 37 +++--- 51 files changed, 84 insertions(+), 368 deletions(-) delete mode 100644 versioned_docs/version-v2.0.0/feature/a2a-readiness.md diff --git a/versioned_docs/version-v2.0.0/architecture/overview.md b/versioned_docs/version-v2.0.0/architecture/overview.md index 590439cca..16a01288e 100644 --- a/versioned_docs/version-v2.0.0/architecture/overview.md +++ b/versioned_docs/version-v2.0.0/architecture/overview.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 1 ---- - # Apache EventMesh Architecture > **Audience:** anyone who wants the structural view — the three planes, @@ -437,7 +433,7 @@ ingress path does not import legacy wire types. ## Documentation -The [documentation map](../documentation-map.md) organizes everything by audience. Highlights: +The [documentation map](../index.md) organizes everything by audience. Highlights: | Page | What it covers | | --- | --- | @@ -454,4 +450,4 @@ The [documentation map](../documentation-map.md) organizes everything by audienc | [Protocols & SDKs](../feature/protocols.md) | Wire protocol inventory and per-language SDK status | | [Storage SPI](../feature/storage-spi.md) | `MeshStoragePlugin` contract and capability matrix | | [Deployment](../feature/deployment.md) | Modes, Docker, multi-instance, runbooks | -| [Design records](../documentation-map.md#design-records-contributors) | Redesign rationale, evidence, plans | +| [Design records](../index.md#design-records-contributors) | Redesign rationale, evidence, plans | diff --git a/versioned_docs/version-v2.0.0/architecture/redesign.md b/versioned_docs/version-v2.0.0/architecture/redesign.md index a07413ef8..35866bde4 100644 --- a/versioned_docs/version-v2.0.0/architecture/redesign.md +++ b/versioned_docs/version-v2.0.0/architecture/redesign.md @@ -1,16 +1,12 @@ ---- -sidebar_position: 3 ---- - # EventMesh Architecture Simplification Redesign > **Status note:** this is the historical design document for the > architecture rewrite (a design record, not a living guide). The current > implementation status and maturity of each capability are governed by the -> [capability status table](https://github.com/apache/eventmesh#capability-status) in the main +> [capability status table](../../README.md#capability-status) in the main > README. For the user-facing views see > [Architecture overview](overview.md) and the -> [feature guides](../feature/pubsub.md). +> [feature guides](../feature/). > Branch: `refactor/unified-runtime-pipeline` — based on the direction > defined in this document. @@ -250,7 +246,7 @@ A single launcher (`EventMeshApplication`) starts traffic HTTP + admin (+ opt-in WebSocket). The deletion list removed the TCP/gRPC server paths, `eventmesh-registry`, and dead modules (~59% of the tree). The phased plan tracked the migration; the evidence trail lives in -[architecture review evidence](redesign.md). +[architecture review evidence](review/evidence.md). --- @@ -401,7 +397,7 @@ routing was later covered by the sticky-instance model.)* The end-to-end test-case design (§18) mapped every guarantee above to a named test; the current test inventory and per-PR evidence live in -[review evidence](redesign.md). +[review evidence](review/evidence.md). The streaming design (§20–21, integrated from the streaming-session, sdk-streaming-call, and lite-streaming-call designs) defines the two @@ -428,7 +424,7 @@ still-current content from those appendices lives in the feature and reference pages of this documentation tree (configuration, protocols, offset management, load balancing, frame protocol); the point-in-time gap/migration tables are superseded by the -[architecture review evidence](redesign.md) and are intentionally +[architecture review evidence](review/evidence.md) and are intentionally not reproduced. *Document version: v2.0 (English rewrite of the Chinese original) · diff --git a/versioned_docs/version-v2.0.0/architecture/security.md b/versioned_docs/version-v2.0.0/architecture/security.md index 52c2a1648..33ffbd32a 100644 --- a/versioned_docs/version-v2.0.0/architecture/security.md +++ b/versioned_docs/version-v2.0.0/architecture/security.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 2 ---- - # Security **Audience:** operators and embedders securing an EventMesh deployment — diff --git a/versioned_docs/version-v2.0.0/documentation-map.md b/versioned_docs/version-v2.0.0/documentation-map.md index 3628c8748..64199f8b6 100644 --- a/versioned_docs/version-v2.0.0/documentation-map.md +++ b/versioned_docs/version-v2.0.0/documentation-map.md @@ -1,8 +1,4 @@ ---- -sidebar_position: 0.5 ---- - -# Documentation Map +# Apache EventMesh Documentation Welcome to the Apache EventMesh documentation. EventMesh is a **stateless application-layer event mesh** for cloud-native, serverless, and AI-agent @@ -12,7 +8,7 @@ subscription, offset, and delivery semantics itself — the broker is used purely as a write-ahead log. > Maturity tags (**GA / Beta / Experimental / Legacy**) for every capability -> live in the [capability status table](https://github.com/apache/eventmesh#capability-status) in the +> live in the [capability status table](../README.md#capability-status) in the > project README — that table is the single source of truth. ## Where to start @@ -52,9 +48,9 @@ too. inside a parent topic; publish/poll semantics and checkpoints. - [A2A — Agent-to-Agent](feature/a2a.md) — the agent collaboration protocol: task lifecycle, JSON-RPC/MCP bridge, REST + SDK usage - *(Experimental)*; [readiness decision](feature/a2a-readiness.md). + *(Experimental)*. -- [Connectors](feature/connectors/connectors.md) — bridge EventMesh with external +- [Connectors](feature/connectors/README.md) — bridge EventMesh with external systems (Kafka, RocketMQ, RabbitMQ, databases, chat platforms): the connector model, running a worker, and a per-plugin guide for all 23 shipped plugins. @@ -103,9 +99,9 @@ too. - [Unified architecture redesign](architecture/redesign.md) — the original rewrite design record (English rewrite): iron rules, target architecture, decision log, semantics boundaries. -- [Architecture review evidence](architecture/redesign.md) — +- [Architecture review evidence](architecture/review/evidence.md) — PR/test evidence behind every closed review issue. -- [Production HA acceptance plan](architecture/redesign.md) +- [Production HA acceptance plan](architecture/review/production-ha-plan.md) ## Conventions diff --git a/versioned_docs/version-v2.0.0/feature/a2a-readiness.md b/versioned_docs/version-v2.0.0/feature/a2a-readiness.md deleted file mode 100644 index 80da36f5a..000000000 --- a/versioned_docs/version-v2.0.0/feature/a2a-readiness.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -sidebar_position: 6 ---- - -# A2A readiness decision (issue #5340) - -> **Status:** Decided. Keep A2A **Experimental** for the next release cycle. Promotion -> to Beta is gated on the Testcontainers E2E suite (`eventmesh-a2a-e2e`) being -> green for at least one release. Tracked by #5340. - -This page documents the readiness check called out in the architecture review (issue -#5296, question Q4, 2026-09-07): are task expiry / reaping, Meta-backed AgentCard -persistence, Runtime-dispatch integration, and real Meta / Runtime failure testing -complete? Until they are, A2A remains explicitly Experimental. The current -`docs/a2a-protocol/README.md` carries the EXPERIMENTAL banner; this page is the -decision log. - -## 1. Acceptance status (issue #5340) - -| # | Item | Status | Reference | -| --- | --- | --- | --- | -| 1 | `TaskExpirer` reaper (configurable TTL + scan interval, opt-in to gateway) | **Done (D2a)** | `eventmesh-runtime/.../a2a/TaskExpirer.java` + `TaskExpirerTest.java` | -| 2 | `MetaAgentCardRegistry` (cluster-shared, prefix-watch) | **Done (D2a)** | `eventmesh-runtime/.../a2a/MetaAgentCardRegistry.java` + `MetaAgentCardRegistryTest.java` | -| 3 | Testcontainers E2E `eventmesh-a2a-e2e` (Nacos + 2-3 EM instances + broker) | **Open (D2b)** | follow-up issue (will be filed) | -| 4 | Failure-mode test (Meta down -> A2A surfaces error) | **Done (D2a)** | `eventmesh-runtime/.../a2a/A2AGatewayFailureModeTest.java` | -| 5 | Decision: keep A2A Experimental, or promote to Beta | **Decided: keep Experimental** | this document | - -Items 1, 2, 4 land in PR #5346 (Sub-PR D2a, this PR). Item 3 (D2b) is a follow-up -Testcontainers-based E2E suite that requires live Nacos + broker containers and a -2-3 instance EM cluster; it is intentionally out of scope for D2a because the -in-process unit + integration tests in D2a already cover the gateway's failure -semantics at the API boundary. D2b will exercise the same scenarios end-to-end -against real Meta + broker + multi-instance EM. - -## 2. Why keep A2A Experimental - -A2A is the only protocol in EventMesh that: - -* Crosses a trust boundary (a client invokes an agent that lives behind a - gateway; the gateway must reject tasks for unregistered agents). -* Has a multi-step lifecycle (PENDING -> RUNNING -> COMPLETED/FAILED/CANCELED) - with strong per-step consistency requirements (epoch fencing, status - convergence on cancel-vs-complete races). -* Was redesigned end-to-end in the uni-architecture work (#5302) and has not - yet been validated against a live Meta + broker + multi-instance EM - deployment. - -Production users who adopt A2A before the readiness checks land will get a -correct runtime (the unit + integration tests cover the contract), but the -operational story is still incomplete: there is no runbook for "the Meta -went down, here is what to do", no SLO from a sustained production -deployment, and no Testcontainers E2E that catches a future regression. Marking -the protocol Experimental is the honest signal. - -## 3. Promotion criteria (Experimental -> Beta) - -All of the following must be true before A2A is promoted to Beta: - -1. **D2b lands and is green in CI for at least one full release cycle.** The - Testcontainers suite must cover: 3 EM instances behind a shared Nacos - Meta, an A2A client submitting a task to agent-A, agent-A completing the - task, and the client receiving the response. Killing the Meta mid-task - must surface the failure to the client (the A2A layer must not hang). -2. **At least one production-style deployment has run for 30+ days with A2A - traffic** and the operational metrics are within the SLOs (latency p99, - error rate, Meta outage behavior). Until then, the SLOs are aspirational. -3. **The `eventmesh-a2a-protocol.md` document is updated** with the - post-D2b wire contract, a worked example, and the SLOs from item 2. -4. **A deprecation note for the legacy A2A path (if any)** is added to the - changelog and to `docs/feature/protocols.md` (see #5341). - -When all four are true, this page is updated, the EXPERIMENTAL banner in -`docs/a2a-protocol/README.md` is changed to **BETA**, and the tracking issue -#5340 is closed. - -## 4. Test inventory (D2a) - -Three new test classes, all in `eventmesh-runtime` and run in the default -`test` task (no Testcontainers, no live broker): - -* `TaskExpirerTest` (6 cases): idle eviction, fresh-not-evicted, listener - notification, idempotent start/shutdown, background scan fires on schedule, - invalid TTL/interval throws. -* `MetaAgentCardRegistryTest` (5 cases): register/lookup/remove, wrapper - restart, two-instance shared Meta, malformed JSON is logged + ignored, - null args are rejected. -* `A2AGatewayFailureModeTest` (2 cases): submitTask surfaces Meta failure to - the caller (not hung, not silently dropped); submitTask succeeds after - Meta heals. - -Plus the existing `A2AGatewayServiceTest` (in -`eventmesh-runtime/src/test/.../a2a/`) which covers the happy path. - -## 5. Out of scope (D2a explicitly does NOT do) - -* Testcontainers E2E (D2b follow-up). -* A2A load-testing (separate concern; not part of #5340). -* Multi-region A2A (cross-data-center agent discovery; separate concern). -* A2A auth / RBAC (the gateway currently has no auth filter; this is a - separate concern tracked outside the #5296 review). - -## 6. References - -* Parent: #5296 (Architecture Review, Q4 / 2026-09-07) -* Tracking: #5340 -* Sub-PRs: - - #5302 Sub-PR D1 (PR #5313 merged) - TaskStore + InMemoryAgentCardRegistry - on Runtime - - #5302 Sub-PR D2a (PR #5346) - TaskExpirer + MetaAgentCardRegistry + - failure-mode test + this decision doc - - #5302 Sub-PR D2b (follow-up) - Testcontainers E2E -* Sibling issues: #5296 (parent), #5337 (evidence table), #5339 (state store - durability), #5341 (protocol/SDK boundary) -* Docs: - - `docs/a2a-protocol/README.md` (carries the EXPERIMENTAL banner) - - `docs/architecture/overview.md` (A2A section) - - `docs/feature/control-plane.md` (DeliveryTopology / SecurityGate) - - `docs/feature/control-plane.md` (per-backend failure mode) diff --git a/versioned_docs/version-v2.0.0/feature/a2a.md b/versioned_docs/version-v2.0.0/feature/a2a.md index c12cefd01..5706ec80b 100644 --- a/versioned_docs/version-v2.0.0/feature/a2a.md +++ b/versioned_docs/version-v2.0.0/feature/a2a.md @@ -1,26 +1,21 @@ ---- -sidebar_position: 5 ---- - -# EventMesh A2A 协议(Agent-to-Agent Communication Protocol) +# EventMesh A2A Protocol (Agent-to-Agent Communication) > **Audience:** builders of agent systems. The A2A wire contract, task -> lifecycle, and usage via REST / SDK. **Experimental** — see -> [readiness decision](a2a-readiness.md) for the promotion gates. +> lifecycle, and usage via REST / SDK. **Experimental** --- --- -## 目录 +## Table of Contents - [1. Overview](#1-overview) - [2. Core Philosophy](#2-core-philosophy) - [3. Architecture](#3-architecture) - [4. Protocol Specification](#4-protocol-specification) -- [5. Implementation Summary](#实现总结eventmesh-a2a-协议-v20-mcp-版) +- [5. Implementation Summary](#5-implementation-summary) - [6. Test Results](#test-results-eventmesh-a2a-protocol-v20) -- [7. 中文使用指南](#中文使用指南整合自-readmemd) +- [7. Usage Guide](#7-usage-guide-integrated-from-readmemd) --- @@ -220,8 +215,8 @@ To support MCP on an Event Bus, synchronous RPC concepts are mapped to asynchron | Concept | MCP / JSON-RPC | CloudEvent Mapping | | :--- | :--- | :--- | -| **Action** | `method` (e.g., `tools/call`) | **Type**: `org.apache.eventmesh.a2a.tools.call.req`
**Extension**: `a2amethod` | -| **Correlation** | `id` (e.g., `req-123`) | **Extension**: `collaborationid` (on Response)
**ID**: Preserved on Request | +| **Action** | `method` (e.g., `tools/call`) | **Type**: `org.apache.eventmesh.a2a.tools.call.req`
**Extension**: `a2amethod` | +| **Correlation** | `id` (e.g., `req-123`) | **Extension**: `collaborationid` (on Response)
**ID**: Preserved on Request | | **Direction** | Implicit (Request vs Result) | **Extension**: `mcptype` (`request` or `response`) | | **P2P Routing** | `params._agentId` | **Extension**: `targetagent` | | **Pub/Sub Topic** | `params._topic` | **Subject**: The topic value (e.g. `market.btc`) | @@ -501,7 +496,7 @@ client.shutdown(); --- -## 核心成果 +## 5. Implementation Summary A2A 协议已成功重构为采用 **MCP (Model Context Protocol)** 架构,将 EventMesh 定位为现代化的 **智能体协作总线 (Agent Collaboration Bus)**。 @@ -719,7 +714,7 @@ The A2A Protocol v2.0 implementation is stable, functionally complete, and ready --- -## 中文使用指南(整合自 README.md) +## 7. Usage Guide (integrated from README.md) ## 使用指南 diff --git a/versioned_docs/version-v2.0.0/feature/admin-api.md b/versioned_docs/version-v2.0.0/feature/admin-api.md index 671a61444..987bfe587 100644 --- a/versioned_docs/version-v2.0.0/feature/admin-api.md +++ b/versioned_docs/version-v2.0.0/feature/admin-api.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 15 ---- - # Admin API Reference **Audience:** operators and dashboards. Every endpoint below lives on the diff --git a/versioned_docs/version-v2.0.0/feature/architecture-guard.md b/versioned_docs/version-v2.0.0/feature/architecture-guard.md index b60875201..d643ae300 100644 --- a/versioned_docs/version-v2.0.0/feature/architecture-guard.md +++ b/versioned_docs/version-v2.0.0/feature/architecture-guard.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 11 ---- - # EventMesh Architecture Guard > Issue: #5305 (P0), #5322 (fail-mode), #5342 (Q7 expansion) diff --git a/versioned_docs/version-v2.0.0/feature/client-java.md b/versioned_docs/version-v2.0.0/feature/client-java.md index 580a9c965..a57573fe1 100644 --- a/versioned_docs/version-v2.0.0/feature/client-java.md +++ b/versioned_docs/version-v2.0.0/feature/client-java.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 13 ---- - # Apache EventMesh Client Guide > **Audience:** Java application developers using `eventmesh-sdk-java` @@ -676,7 +672,7 @@ See also: * [docs/architecture/overview.md](../architecture/overview.md) — system architecture, control / data / agent planes -* [docs/index.md](../documentation-map.md) — feature-by-feature +* [docs/index.md](../index.md) — feature-by-feature guide * [docs/quickstart/configuration.md](../quickstart/configuration.md) — every runtime key diff --git a/versioned_docs/version-v2.0.0/feature/connector-api-split.md b/versioned_docs/version-v2.0.0/feature/connector-api-split.md index 7afb7a972..7243108db 100644 --- a/versioned_docs/version-v2.0.0/feature/connector-api-split.md +++ b/versioned_docs/version-v2.0.0/feature/connector-api-split.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 12 ---- - # Connector API split — design plan (P1) **Status:** Plan only. No code in this PR. Implementation should land in a follow-up PR after diff --git a/versioned_docs/version-v2.0.0/feature/connectors/_category_.json b/versioned_docs/version-v2.0.0/feature/connectors/_category_.json index 8776b3d90..e75d7f89d 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/_category_.json +++ b/versioned_docs/version-v2.0.0/feature/connectors/_category_.json @@ -1,5 +1,5 @@ { "label": "Connectors", - "position": 6.5, + "position": 9, "collapsed": true } diff --git a/versioned_docs/version-v2.0.0/feature/connectors/canal.md b/versioned_docs/version-v2.0.0/feature/connectors/canal.md index be979d8a9..cd18a9bf6 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/canal.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/canal.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 9 ---- - # Canal (MySQL CDC) connector **Audience:** operators bridging EventMesh with Canal (MySQL CDC). MySQL change-data-capture via a deployed canal server. Source consumes binlog entries over the canal TCP protocol (batch ack only after EventMesh accepted the publish); sink replays row-change CloudEvents into a target MySQL as one all-or-nothing JDBC batch. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/chatgpt.md b/versioned_docs/version-v2.0.0/feature/connectors/chatgpt.md index 2673b6c33..ac325c66d 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/chatgpt.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/chatgpt.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 23 ---- - # ChatGPT (OpenAI) connector **Audience:** operators bridging EventMesh with ChatGPT (OpenAI). OpenAI bridge. Source exposes an HTTP prompt endpoint: a client POSTs a prompt, the connector optionally completes it through the OpenAI REST API and emits both as a CloudEvent. Sink forwards events to a webhook (generic). diff --git a/versioned_docs/version-v2.0.0/feature/connectors/connectors.md b/versioned_docs/version-v2.0.0/feature/connectors/connectors.md index d4e25bb87..7f7e4d760 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/connectors.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/connectors.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 1 ---- - # Connectors **Audience:** operators and developers wiring EventMesh to external systems — diff --git a/versioned_docs/version-v2.0.0/feature/connectors/dingtalk.md b/versioned_docs/version-v2.0.0/feature/connectors/dingtalk.md index c407bedeb..9e2ba5a33 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/dingtalk.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/dingtalk.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 18 ---- - # DingTalk connector **Audience:** operators bridging EventMesh with DingTalk. DingTalk bridge. Source receives robot outgoing-callback messages (with HMAC signature verification); sink posts events to a DingTalk group-robot webhook. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/file.md b/versioned_docs/version-v2.0.0/feature/connectors/file.md index d069077f4..da7aab162 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/file.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/file.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 12 ---- - # File connector **Audience:** operators bridging EventMesh with File. Local file bridge — the simplest way to try connectors. Source reads a text file line by line; sink appends each CloudEvent as a line to a file. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/http.md b/versioned_docs/version-v2.0.0/feature/connectors/http.md index bb873be54..8dd804559 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/http.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/http.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 16 ---- - # HTTP connector **Audience:** operators bridging EventMesh with HTTP. Generic HTTP bridge. Source is a webhook receiver: any system can POST events into EventMesh without an SDK. Sink forwards each CloudEvent to an HTTP endpoint. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/jdbc.md b/versioned_docs/version-v2.0.0/feature/connectors/jdbc.md index 508317f58..32705cbb9 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/jdbc.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/jdbc.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 10 ---- - # JDBC connector **Audience:** operators bridging EventMesh with JDBC. Database bridge over plain JDBC. Source tails a table by a monotonically increasing id column; sink inserts each CloudEvent into a table via a parameterized INSERT. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/kafka.md b/versioned_docs/version-v2.0.0/feature/connectors/kafka.md index 5fe82b006..2dc8cca03 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/kafka.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/kafka.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 2 ---- - # Kafka connector **Audience:** operators bridging EventMesh with Kafka. Move events between EventMesh topics and an Apache Kafka cluster. The source consumes a Kafka topic with a consumer group and commits offsets only after EventMesh accepted the publish; the sink writes CloudEvent payloads to a target topic. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/knative.md b/versioned_docs/version-v2.0.0/feature/connectors/knative.md index 7fc244ca2..6706ed82e 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/knative.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/knative.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 13 ---- - # Knative connector **Audience:** operators bridging EventMesh with Knative. Knative eventing bridge. Source receives CloudEvents pushed by a Knative broker (the source acts as the Knative subscriber); sink forwards events to a Knative service/endpoint. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/lark.md b/versioned_docs/version-v2.0.0/feature/connectors/lark.md index 4707d9866..55bece06a 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/lark.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/lark.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 19 ---- - # Lark / Feishu connector **Audience:** operators bridging EventMesh with Lark / Feishu. Lark (Feishu) bridge. Source receives event-subscription callbacks (answering the `url_verification` challenge automatically); sink posts events to a Lark custom-bot webhook. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/mcp.md b/versioned_docs/version-v2.0.0/feature/connectors/mcp.md index 655acd1b7..a17880bff 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/mcp.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/mcp.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 24 ---- - # MCP (Model Context Protocol) connector **Audience:** operators bridging EventMesh with MCP (Model Context Protocol). MCP server bridge over JSON-RPC 2.0. Source receives server-initiated notifications (e.g. resource updates) on an HTTP endpoint; sink forwards each CloudEvent to an MCP server as a JSON-RPC request. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/mongodb.md b/versioned_docs/version-v2.0.0/feature/connectors/mongodb.md index b73519d97..47761c98b 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/mongodb.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/mongodb.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 7 ---- - # MongoDB connector **Audience:** operators bridging EventMesh with MongoDB. MongoDB bridge. Source tails a collection's insert stream; sink inserts each CloudEvent as a document. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/openfunction.md b/versioned_docs/version-v2.0.0/feature/connectors/openfunction.md index cf4e47a74..29cb24689 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/openfunction.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/openfunction.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 14 ---- - # OpenFunction connector **Audience:** operators bridging EventMesh with OpenFunction. OpenFunction bridge. Source receives function output pushes (the function runtime POSTs its result to the connector endpoint); sink invokes a function's HTTP trigger with CloudEvent headers (`Ce-Id`/`Ce-Type`/`Ce-Source`). diff --git a/versioned_docs/version-v2.0.0/feature/connectors/pravega.md b/versioned_docs/version-v2.0.0/feature/connectors/pravega.md index 09f5b2591..e86fcbc87 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/pravega.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/pravega.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 6 ---- - # Pravega connector **Audience:** operators bridging EventMesh with Pravega. Move events between EventMesh and a Pravega stream. The source reads through a reader group (offsets managed natively by Pravega); the sink appends events to a stream, creating the scope/stream on first start. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/prometheus.md b/versioned_docs/version-v2.0.0/feature/connectors/prometheus.md index db277a722..29690b5a8 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/prometheus.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/prometheus.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 17 ---- - # Prometheus connector **Audience:** operators bridging EventMesh with Prometheus. Metrics bridge. Source scrapes a Prometheus `/metrics` endpoint on each poll and emits the exposition text as a CloudEvent; sink pushes metric samples (text exposition format) to a Pushgateway. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/pulsar.md b/versioned_docs/version-v2.0.0/feature/connectors/pulsar.md index 0bd94cc92..15af19db8 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/pulsar.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/pulsar.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 5 ---- - # Pulsar connector **Audience:** operators bridging EventMesh with Pulsar. Bridge EventMesh topics with an Apache Pulsar cluster. Source subscribes to a topic; sink produces to a persistent topic. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/rabbitmq.md b/versioned_docs/version-v2.0.0/feature/connectors/rabbitmq.md index 92209fdf3..ea91cddaa 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/rabbitmq.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/rabbitmq.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 4 ---- - # RabbitMQ connector **Audience:** operators bridging EventMesh with RabbitMQ. Move events between EventMesh and a RabbitMQ broker over AMQP 0-9-1. Source consumes a queue; sink publishes to an exchange with an optional routing key. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/redis.md b/versioned_docs/version-v2.0.0/feature/connectors/redis.md index 37b2fd297..27fbbcd3f 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/redis.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/redis.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 8 ---- - # Redis connector **Audience:** operators bridging EventMesh with Redis. Redis pub/sub bridge over Redisson. Source listens on a channel; sink publishes each CloudEvent to a channel. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/rocketmq.md b/versioned_docs/version-v2.0.0/feature/connectors/rocketmq.md index e4f8f2949..94bb71b8c 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/rocketmq.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/rocketmq.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 3 ---- - # RocketMQ 4.x connector **Audience:** operators bridging EventMesh with RocketMQ 4.x. Bridge EventMesh topics with an Apache RocketMQ 4.x cluster (nameserver-based). Source pulls from a consumer group; sink produces with a producer group. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/s3.md b/versioned_docs/version-v2.0.0/feature/connectors/s3.md index 053503eb8..63ec22d37 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/s3.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/s3.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 11 ---- - # Amazon S3 connector **Audience:** operators bridging EventMesh with Amazon S3. S3 object bridge. Source lists new objects in a bucket (cursor = last key); sink writes each CloudEvent as an object keyed by the event id. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/slack.md b/versioned_docs/version-v2.0.0/feature/connectors/slack.md index 741009cf3..98fdce331 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/slack.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/slack.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 20 ---- - # Slack connector **Audience:** operators bridging EventMesh with Slack. Slack bridge. Source receives Events API callbacks (verifying the v0 HMAC request signature and answering the challenge); sink posts events to a Slack incoming webhook. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/spring.md b/versioned_docs/version-v2.0.0/feature/connectors/spring.md index 962c976af..9b9d8c387 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/spring.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/spring.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 15 ---- - # Spring connector **Audience:** operators bridging EventMesh with Spring. Spring application bridge. Source buffers events published by Spring code (register a producer that feeds the buffer); sink exposes an injectable `EventForwarder` so the hosting Spring context receives EventMesh deliveries as native events. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/wechat.md b/versioned_docs/version-v2.0.0/feature/connectors/wechat.md index 72c00cdde..64a772100 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/wechat.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/wechat.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 21 ---- - # WeChat Official Account connector **Audience:** operators bridging EventMesh with WeChat Official Account. WeChat Official Account bridge. Source handles the platform's server-to-server callback — the GET echostr verification (SHA-1 of token/timestamp/nonce) and POST XML message pushes; sink posts events to a webhook. diff --git a/versioned_docs/version-v2.0.0/feature/connectors/wecom.md b/versioned_docs/version-v2.0.0/feature/connectors/wecom.md index 200c79ec2..dd2deda84 100644 --- a/versioned_docs/version-v2.0.0/feature/connectors/wecom.md +++ b/versioned_docs/version-v2.0.0/feature/connectors/wecom.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 22 ---- - # WeCom (WeChat Work) connector **Audience:** operators bridging EventMesh with WeCom (WeChat Work). WeCom bridge. Source receives WeCom callback events (plain-token verification mode: answers the GET echostr challenge, accepts POST JSON events); sink posts events to a WeCom group-robot webhook. diff --git a/versioned_docs/version-v2.0.0/feature/control-plane.md b/versioned_docs/version-v2.0.0/feature/control-plane.md index 394da6830..3af13a19d 100644 --- a/versioned_docs/version-v2.0.0/feature/control-plane.md +++ b/versioned_docs/version-v2.0.0/feature/control-plane.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 10 ---- - # EventMesh control plane > **Audience:** operators and contributors. What the runtime boot path diff --git a/versioned_docs/version-v2.0.0/feature/delivery-reliability.md b/versioned_docs/version-v2.0.0/feature/delivery-reliability.md index 5ed2a121f..effbcfa63 100644 --- a/versioned_docs/version-v2.0.0/feature/delivery-reliability.md +++ b/versioned_docs/version-v2.0.0/feature/delivery-reliability.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 2 ---- - # Reliable Delivery **Audience:** application developers and operators who need to know exactly diff --git a/versioned_docs/version-v2.0.0/feature/deployment.md b/versioned_docs/version-v2.0.0/feature/deployment.md index 67886c513..6783d0a61 100644 --- a/versioned_docs/version-v2.0.0/feature/deployment.md +++ b/versioned_docs/version-v2.0.0/feature/deployment.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 17 ---- - # Deployment & Operations **Audience:** operators deploying EventMesh — images and ports, single- vs @@ -69,6 +65,21 @@ onto `-D` system properties. curl http://localhost:8081/admin/health # {"status":"UP"} ``` +## Kubernetes + +Plain manifests live in [`deploy/kubernetes/`](../../deploy/kubernetes/) — +runtime **StatefulSet** (PVC-backed RocksDB offsets, `/admin/health` probes, +non-root) + connector-runtime **Deployment**, kustomize-ready: + +```shell +kubectl apply -k deploy/kubernetes +``` + +Edit `runtime-configmap.yaml` (storage endpoints) and `runtime-secret.yaml` +(admin token) first. Scaling to `PARTITION_OWNED_PULL` requires the meta keys +in `JAVA_OPTS` — see the manifests README. A Helm chart and a decision on the +legacy operator path (#3327) are planned follow-ups. + ## Single-instance vs multi-instance The delivery topology (`-Deventmesh.delivery.topology`, see @@ -154,7 +165,7 @@ tests today. - **Container-dependent test suites** (Testcontainers E2E, broker-failover chaos, rolling-upgrade drills) require a Docker environment; they are tracked as deferred coverage, not as passing guarantees - ([HA plan](../architecture/redesign.md)). + ([HA plan](../architecture/review/production-ha-plan.md)). - Nacos watch timing can fluctuate under churn; multi-instance watch-suite runs are occasionally flaky (timing, not correctness). - A2A gateway and v2 streaming sessions need a dedicated launcher (see diff --git a/versioned_docs/version-v2.0.0/feature/frame-protocol.md b/versioned_docs/version-v2.0.0/feature/frame-protocol.md index 32b575ee8..9c3b75c08 100644 --- a/versioned_docs/version-v2.0.0/feature/frame-protocol.md +++ b/versioned_docs/version-v2.0.0/feature/frame-protocol.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 9 ---- - # Frame Protocol Conversion **Audience:** contributors adding a protocol or understanding the internal diff --git a/versioned_docs/version-v2.0.0/feature/http-api.md b/versioned_docs/version-v2.0.0/feature/http-api.md index 82dc7da55..dcdaeab73 100644 --- a/versioned_docs/version-v2.0.0/feature/http-api.md +++ b/versioned_docs/version-v2.0.0/feature/http-api.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 14 ---- - # HTTP API Reference **Audience:** application developers integrating with the EventMesh traffic diff --git a/versioned_docs/version-v2.0.0/feature/lite-topic.md b/versioned_docs/version-v2.0.0/feature/lite-topic.md index 4d3ecb245..0c0825b9c 100644 --- a/versioned_docs/version-v2.0.0/feature/lite-topic.md +++ b/versioned_docs/version-v2.0.0/feature/lite-topic.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 4 ---- - # Lite Topic (RocketMQ 5.x) **Audience:** RocketMQ 5.x users who need lightweight, hierarchical diff --git a/versioned_docs/version-v2.0.0/feature/load-balancing.md b/versioned_docs/version-v2.0.0/feature/load-balancing.md index e126def7d..df3597b41 100644 --- a/versioned_docs/version-v2.0.0/feature/load-balancing.md +++ b/versioned_docs/version-v2.0.0/feature/load-balancing.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 8 ---- - # Load Balancing **Audience:** operators running multiple EventMesh instances, and anyone diff --git a/versioned_docs/version-v2.0.0/feature/observability.md b/versioned_docs/version-v2.0.0/feature/observability.md index 18226d48e..fe3b2470b 100644 --- a/versioned_docs/version-v2.0.0/feature/observability.md +++ b/versioned_docs/version-v2.0.0/feature/observability.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 16 ---- - # Observability **Audience:** operators pointing monitoring at EventMesh. Covers the metric @@ -91,4 +87,4 @@ classes, including: multi-instance exactly-once-per-partition consumption (`RateLimitIntegrationTest`), TLS end-to-end (`TlsIntegrationTest`), and throughput/loss runs against real multi-broker clusters (`LoadThroughputIntegrationTest`). Full list: -[architecture review evidence](../architecture/redesign.md). +[architecture review evidence](../architecture/review/evidence.md). diff --git a/versioned_docs/version-v2.0.0/feature/offset-management.md b/versioned_docs/version-v2.0.0/feature/offset-management.md index 53cc283ff..dcbe3a9bf 100644 --- a/versioned_docs/version-v2.0.0/feature/offset-management.md +++ b/versioned_docs/version-v2.0.0/feature/offset-management.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 7 ---- - # Offset Management **Audience:** operators and contributors who need to know exactly how @@ -19,7 +15,7 @@ offset / load-balancing / frame design trio; see also The MQ (RocketMQ / Kafka) is used only as a durable FIFO log; its Consumer Group semantics are never used. The current implementation status of each capability is governed by the -[capability status table](https://github.com/apache/eventmesh#capability-status). +[capability status table](../../README.md#capability-status). ## The two offset layers diff --git a/versioned_docs/version-v2.0.0/feature/protocols.md b/versioned_docs/version-v2.0.0/feature/protocols.md index 7206bcd33..20fb1c7a4 100644 --- a/versioned_docs/version-v2.0.0/feature/protocols.md +++ b/versioned_docs/version-v2.0.0/feature/protocols.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 18 ---- - # EventMesh protocols and SDKs > **Audience:** anyone choosing a wire protocol or SDK. The canonical diff --git a/versioned_docs/version-v2.0.0/feature/pubsub.md b/versioned_docs/version-v2.0.0/feature/pubsub.md index 6d205fd38..5ebafbf1b 100644 --- a/versioned_docs/version-v2.0.0/feature/pubsub.md +++ b/versioned_docs/version-v2.0.0/feature/pubsub.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 1 ---- - # Publish & Subscribe **Audience:** application developers publishing or subscribing via the HTTP diff --git a/versioned_docs/version-v2.0.0/feature/storage-spi.md b/versioned_docs/version-v2.0.0/feature/storage-spi.md index 4a46dcd98..ee95b357c 100644 --- a/versioned_docs/version-v2.0.0/feature/storage-spi.md +++ b/versioned_docs/version-v2.0.0/feature/storage-spi.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 19 ---- - # EventMesh Storage SPI > **Audience:** storage-plugin authors and reviewers. The capability @@ -39,15 +35,15 @@ actually implement them. ## Capability matrix -| Capability | Universal? | Kafka | RocketMQ 4.x | RocketMQ 5.x | Why | -|-------------------------|-------------|-------|--------------|--------------|-----------------------------------------------------------------------| -| TopicManagement | yes (U) | Y | Y | Y | All 3 MQs expose `createTopic` (Kafka Admin / RocketMQ Admin). | -| PartitionAssignment | yes (U) | Y | Y | Y | All 3 MQs treat the topic as a partitionable stream. | -| ExplicitOffsetCommit | yes (U) | Y | Y | Y | All 3 MQs persist an explicit commitOffset on demand. | -| EndOffsetQuery | no (Kafka) | Y | N | N | Only Kafka exposes a high-watermark via `endOffsets`. | -| AlignPullOffset | mixed | Y | Y | N | Kafka + RocketMQ 4.x manage a client-side pull cursor; R5 POP is broker-managed. | -| DeferredPopAck | R5 only | N | N | Y | R5 POP holds messages invisible until client ACK. | -| LiteTopic | R5 only | N | N | Y | R5 RIP-83 lite sub-topics; not in Kafka or R4. | +| Capability | Universal? | Kafka | RocketMQ 4.x | RocketMQ 5.x | Memory | Why | +|-------------------------|-------------|-------|--------------|--------------|-------|-----------------------------------------------------------------------| +| TopicManagement | yes (U) | Y | Y | Y | Y | All 3 MQs expose `createTopic` (Kafka Admin / RocketMQ Admin). | +| PartitionAssignment | yes (U) | Y | Y | Y | Y | All 3 MQs treat the topic as a partitionable stream. | +| ExplicitOffsetCommit | yes (U) | Y | Y | Y | Y | All 3 MQs persist an explicit commitOffset on demand. | +| EndOffsetQuery | no (Kafka) | Y | N | N | Y | Only Kafka exposes a high-watermark via `endOffsets`. | +| AlignPullOffset | mixed | Y | Y | N | Y | Kafka + RocketMQ 4.x manage a client-side pull cursor; R5 POP is broker-managed. | +| DeferredPopAck | R5 only | N | N | Y | Y | R5 POP holds messages invisible until client ACK. | +| LiteTopic | R5 only | N | N | Y | Y | R5 RIP-83 lite sub-topics; not in Kafka or R4. | U = Universal (every backend MUST implement). diff --git a/versioned_docs/version-v2.0.0/feature/streaming.md b/versioned_docs/version-v2.0.0/feature/streaming.md index 2618b1e50..d049be998 100644 --- a/versioned_docs/version-v2.0.0/feature/streaming.md +++ b/versioned_docs/version-v2.0.0/feature/streaming.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 3 ---- - # Streaming & Push Transports **Audience:** application developers choosing how subscribers receive events diff --git a/versioned_docs/version-v2.0.0/introduction.md b/versioned_docs/version-v2.0.0/introduction.md index 6a59b02c6..601e5855d 100644 --- a/versioned_docs/version-v2.0.0/introduction.md +++ b/versioned_docs/version-v2.0.0/introduction.md @@ -1,12 +1,8 @@ ---- -sidebar_position: 1 ---- - # Introduction **Audience:** anyone evaluating EventMesh — what it is, what problems it solves, and how its pieces fit together. Everything here is elaborated in the -[documentation map](documentation-map.md). +[documentation map](index.md). --- diff --git a/versioned_docs/version-v2.0.0/quickstart/configuration.md b/versioned_docs/version-v2.0.0/quickstart/configuration.md index ff751f586..a0705ff1e 100644 --- a/versioned_docs/version-v2.0.0/quickstart/configuration.md +++ b/versioned_docs/version-v2.0.0/quickstart/configuration.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 2 ---- - # EventMesh Configuration Reference > **Audience:** operators and embedders. Every EventMesh Runtime @@ -12,11 +8,11 @@ sidebar_position: 2 --- Every configuration key for the EventMesh Runtime, in one place. Defaults live in -[`eventmesh-runtime/conf/eventmesh.properties`](https://github.com/apache/eventmesh/blob/develop/eventmesh-runtime/conf/eventmesh.properties); +[`eventmesh-runtime/conf/eventmesh.properties`](../../eventmesh-runtime/conf/eventmesh.properties); precedence is **system property (`-D`) > environment variable > properties file**. > Status of each capability (GA / Beta / Experimental / Legacy): see the -> [capability status table](https://github.com/apache/eventmesh#capability-status). +> [capability status table](../../README.md#capability-status). --- @@ -24,12 +20,21 @@ precedence is **system property (`-D`) > environment variable > properties file* | Key | Env override | Values | Default | |---|---|---|---| -| `eventmesh.storage.type` | `EVENTMESH_STORAGE_TYPE` | `rocketmq` / `rocketmq5` / `kafka` | `kafka` | +| `eventmesh.storage.type` | `EVENTMESH_STORAGE_TYPE` | `memory` / `rocketmq` / `rocketmq5` / `kafka` | `memory` | ## 2. Storage backends +### Memory (`memory`, default) + +In-process WAL with zero external dependency - the default for dev / CI / quick start. +State is process-local and lost on restart; not for production. + +| Key | Default | Description | +|---|---|---| +| (none) | - | No keys required - no broker address | + ### RocketMQ 4.x (`rocketmq`) | Key | Default | Description | diff --git a/versioned_docs/version-v2.0.0/quickstart/getting-started.md b/versioned_docs/version-v2.0.0/quickstart/getting-started.md index 3a8e046be..ea1de2886 100644 --- a/versioned_docs/version-v2.0.0/quickstart/getting-started.md +++ b/versioned_docs/version-v2.0.0/quickstart/getting-started.md @@ -1,7 +1,3 @@ ---- -sidebar_position: 1 ---- - # EventMesh Getting Started > **Audience:** first-time users. Zero to a running runtime (Docker or @@ -15,14 +11,15 @@ subscriber, using the recommended **HTTP + CloudEvents** path. Configuration ref [`eventmesh-client-guide.md`](../feature/client-java.md). > Capability maturity levels (GA / Beta / Experimental / Legacy) are defined in the -> [capability status table](https://github.com/apache/eventmesh#capability-status) in the main README. +> [capability status table](../../README.md#capability-status) in the main README. --- ## 1. Prerequisites - JDK 21+ (Temurin recommended) -- Docker (for the container path), or a local install of one storage backend: +- Docker (for the container path - the default `memory` backend needs no broker), or a + local install of one storage backend for production-like runs: - [Apache RocketMQ](https://rocketmq.apache.org) 4.x or 5.x, **or** - [Apache Kafka](https://kafka.apache.org) 2.8+ (3.x recommended) - (SDK only) Java 11+ application with `eventmesh-sdk-java` on the classpath @@ -35,6 +32,7 @@ changes. | Backend | Type value | Notes | |---|---|---| +| Memory (default) | `memory` | in-process WAL, zero dependency - dev/CI/quick start only | | RocketMQ 4.x | `rocketmq` | classic PULL over remoting | | RocketMQ 5.x | `rocketmq5` | 5.x POP + Lite Topic support | | Kafka | `kafka` | assign+seek+poll (no consumer groups), SASL/SSL supported | @@ -46,12 +44,15 @@ changes. ```shell sudo docker pull apache/eventmesh:latest sudo docker run -d --name eventmesh \ - -e EVENTMESH_STORAGE_TYPE=kafka \ - -e EVENTMESH_KAFKA_NAMESRV=YOUR_KAFKA:9092 \ -p 8080:8080 -p 8081:8081 \ apache/eventmesh:latest ``` +The image defaults to the `memory` storage backend - zero external +dependency, ready for a smoke test as-is. For a real broker add +`-e EVENTMESH_STORAGE_TYPE=kafka` (or `rocketmq` / `rocketmq5`) and the +backend address keys shown below. + Ports: `8080` = traffic HTTP (`/events/*`), `8081` = admin HTTP (`/admin/*`). The WebSocket push port (`8082`) is opt-in. @@ -61,9 +62,9 @@ push port (`8082`) is opt-in. git clone https://github.com/apache/eventmesh.git cd eventmesh -# pick your backend via EVENTMESH_STORAGE_TYPE (rocketmq | rocketmq5 | kafka) -export EVENTMESH_STORAGE_TYPE=kafka -export EVENTMESH_KAFKA_NAMESRV=localhost:9092 +# the memory backend is the default - no env needed. For a real broker: +# export EVENTMESH_STORAGE_TYPE=kafka (or rocketmq | rocketmq5) +# export EVENTMESH_KAFKA_NAMESRV=localhost:9092 ./gradlew :eventmesh-runtime:clean :eventmesh-runtime:dist cd eventmesh-runtime/dist && bash bin/start.sh @@ -108,13 +109,15 @@ curl -X POST http://localhost:8080/events/subscribe \ -H "Content-Type: application/json" \ -d '{"clientId":"order-svc","topic":"orders","mode":"LOAD_BALANCE"}' -# 2a. HTTP long-polling -curl "http://localhost:8080/events/poll?clientId=order-svc&topics=orders&timeout=30000" +# 2a. HTTP long-polling (params: clientId, max, timeoutMs) +curl "http://localhost:8080/events/poll?clientId=order-svc&max=100&timeoutMs=30000" +# → [{"deliveryId":"d-...","event":{...CloudEvent...}}, ...] -# 2b. after processing, acknowledge so the offset advances (at-least-once) +# 2b. after processing, acknowledge so the offset advances (at-least-once). +# One deliveryId per call - take it from the poll response above. curl -X POST http://localhost:8080/events/ack \ -H "Content-Type: application/json" \ - -d '{"clientId":"order-svc","deliveryIds":["..."]}' + -d '{"deliveryId":"d-..."}' ``` Distribution modes: @@ -129,7 +132,7 @@ SSE and WebSocket push are also available; the raw HTTP forms are: ```shell # SSE — server push over a long-lived HTTP connection -curl -N "http://localhost:8080/events/stream?clientId=order-svc&topics=orders" \r +curl -N "http://localhost:8080/events/stream?clientId=order-svc" \r -H "Accept: text/event-stream" # WebSocket — full-duplex server push over the dedicated WS port @@ -137,7 +140,7 @@ curl -N "http://localhost:8080/events/stream?clientId=order-svc&topics=orders" \ curl --include --no-buffer \r -H "Connection: Upgrade" -H "Upgrade: websocket" \r -H "Sec-WebSocket-Version: 13" -H "Sec-WebSocket-Key: dGVzdA==" \r - "http://localhost:8082/events/stream?clientId=order-svc&topics=orders" + "http://localhost:8082/events/stream?clientId=order-svc" ``` The `CloudEventsClient` Java SDK wraps all three transports — From 56d46c30ebd5147b21ebf817628c2599132fcf04 Mon Sep 17 00:00:00 2001 From: qqeasonchen Date: Wed, 16 Sep 2026 16:34:17 +0800 Subject: [PATCH 2/2] docs(v2.0.0): self-close
in a2a.md (fix MDX build break, PR #263) --- versioned_docs/version-v2.0.0/feature/a2a.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/versioned_docs/version-v2.0.0/feature/a2a.md b/versioned_docs/version-v2.0.0/feature/a2a.md index 5706ec80b..09c940431 100644 --- a/versioned_docs/version-v2.0.0/feature/a2a.md +++ b/versioned_docs/version-v2.0.0/feature/a2a.md @@ -215,8 +215,8 @@ To support MCP on an Event Bus, synchronous RPC concepts are mapped to asynchron | Concept | MCP / JSON-RPC | CloudEvent Mapping | | :--- | :--- | :--- | -| **Action** | `method` (e.g., `tools/call`) | **Type**: `org.apache.eventmesh.a2a.tools.call.req`
**Extension**: `a2amethod` | -| **Correlation** | `id` (e.g., `req-123`) | **Extension**: `collaborationid` (on Response)
**ID**: Preserved on Request | +| **Action** | `method` (e.g., `tools/call`) | **Type**: `org.apache.eventmesh.a2a.tools.call.req`
**Extension**: `a2amethod` | +| **Correlation** | `id` (e.g., `req-123`) | **Extension**: `collaborationid` (on Response)
**ID**: Preserved on Request | | **Direction** | Implicit (Request vs Result) | **Extension**: `mcptype` (`request` or `response`) | | **P2P Routing** | `params._agentId` | **Extension**: `targetagent` | | **Pub/Sub Topic** | `params._topic` | **Subject**: The topic value (e.g. `market.btc`) |