Skip to content

[ISSUE #159] [Doc] The introductions of EventMesh Connector and EventMesh Storage are incorrect #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Whitegabriella789 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

[ISSUE #159] [Doc] The introductions of EventMesh Connector and EventMesh Storage are incorrect #232

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c3e6b8
Update 03-runtime.md
Whitegabriella789 Jul 4, 2024
e2dcacd
Update 03-runtime.md
Whitegabriella789 Jul 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions docs/instruction/03-runtime.md
View file
Open in desktop
Copy link
Member

@Pil0tXia Pil0tXia Jul 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Updated all references from "EventMesh Connector" to "EventMesh Storage""Event Store" where applicable.

  • Checked the image path to make sure it started with /static/images/ so images are correctly displayed.

  • Revised configuration instructions to specify eventMesh.storage.plugin.type=rocketmq instead of eventMesh.connector.plugin.type.

I haven't seen any modifications regarding these points. Could you please check if they have been pushed onto git? Thank you.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EventMesh Runtime Quick Start

EventMesh Runtime is a stateful Mesh node in the EventMesh cluster, responsible for event transmission between Source Connectors and Sink Connectors. It uses Event Store as a storage queue for events.
EventMesh Runtime is a stateful Mesh node in the EventMesh cluster, responsible for event transmission between Source Connectors and Sink Connectors. It uses EventMesh Storage as a storage queue for events.

![EventMesh Runtime](../../static/images/design-document/runtime.png)
Comment on lines +3 to 5
Copy link
Member

@Pil0tXia Pil0tXia Jul 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The term "Event Store" has been uniformly used in the Eventmesh-site documentation and architecture diagrams, which you can discover by reading the git history.

The main purpose of the issue is to correct the deployment and use of the connector and storage-plugin. You can try deploying a pair of connectors yourself and fix any outdated or incorrect parts in the documentation.


Expand All @@ -23,7 +23,7 @@ cd apache-eventmesh-1.10.0

### 1.3 Configuration

This document provides an example of deploying it with RocketMQ as Event Store, but you can also choose another [Event Store supported by EventMesh](../roadmap.md#event-store-implementation-status). If you choose a non-standalone mode, ensure that [RocketMQ is successfully started](https://rocketmq.apache.org/docs/quick-start/) and accessible via IP address. If you stick to the default standalone mode, RocketMQ doesn't need to be started.
This document provides an example of deploying it with RocketMQ as EventMesh Storage, but you can also choose another [EventMesh Storage supported by EventMesh](../roadmap.md#event-store-implementation-status). If you choose a non-standalone mode, ensure that [RocketMQ is successfully started](https://rocketmq.apache.org/docs/quick-start/) and accessible via IP address. If you stick to the default standalone mode, RocketMQ doesn't need to be started.

#### 1.3.1 EventMesh Runtime Configuration

Expand All @@ -33,7 +33,7 @@ This configuration file includes settings for the EventMesh Runtime environment
vim conf/eventmesh.properties
```

Specify RocketMQ as Event Store:
Specify RocketMQ as EventMesh Storage:

```properties
# storage plugin
Expand All @@ -49,7 +49,7 @@ Check if the default ports in the configuration file are occupied. If occupied,
| eventMesh.server.grpc.port | 10205 | gRPC listening port |
| eventMesh.server.admin.http.port | 10106 | HTTP management port |

#### 1.3.2 Event Store Configuration
#### 1.3.2 EventMesh Storage Configuration

In the case of RocketMQ, the configuration file includes parameters required to connect to the RocketMQ namesrv.

Expand Down Expand Up @@ -203,7 +203,7 @@ cd apache-eventmesh-1.10.0-src/
| eventmesh-starter | Entry point for running EventMesh locally |
| eventmesh-runtime | EventMesh Runtime, the runtime module |
| eventmesh-connectors | [Connectors](../design-document/03-connect/00-connectors.md) for connecting event sources and sinks, supporting [various services and platforms](../roadmap.md#connector-implementation-status) |
| eventmesh-storage-plugin | [Event Store](../roadmap.md#event-store-implementation-status) plugin for EventMesh Runtime |
| eventmesh-storage-plugin | [EventMesh Storage](../roadmap.md#event-store-implementation-status) plugin for EventMesh Runtime |
| eventmesh-sdks | Multi-language client SDKs for EventMesh, including Java, Go, C and Rust |
| eventmesh-examples | Examples of SDK usage |
| eventmesh-spi | Module for loading EventMesh SPI |
Expand Down Expand Up @@ -241,7 +241,7 @@ dependencies {

#### 3.4.2 Use Plugins

EventMesh will load the plugins by default from the `dist/plugin` directory. You can change the plugin directory using `-DeventMeshPluginDir=your_plugin_directory`. The plugin instances needed at runtime can be configured in the `confPath` directory in the `eventmesh.properties` file. For example, by setting the following, you declare the use of the RocketMQ as Event Store:
EventMesh will load the plugins by default from the `dist/plugin` directory. You can change the plugin directory using `-DeventMeshPluginDir=your_plugin_directory`. The plugin instances needed at runtime can be configured in the `confPath` directory in the `eventmesh.properties` file. For example, by setting the following, you declare the use of the RocketMQ as EventMesh Storage:

```properties
# storage plugin
Expand Down Expand Up @@ -270,4 +270,6 @@ When the following logs are printed to the console, EventMesh Runtime has stoppe
```log
DEBUG StatusConsoleListener Shutdown hook enabled. Registering a new one.
WARN StatusConsoleListener Unable to register Log4j shutdown hook because JVM is shutting down. Using SimpleLogger
```
```

**Note on Connectors:** EventMesh Connectors, such as the eventmesh-connector-rocketmq, can be deployed on any machine and are used to integrate with different data sources and sinks. They are separate from the EventMesh Runtime but can be configured to work alongside it.