Skip to content

Commit

Permalink
[ISSUE #136] Fix typos in Knative connector docs and some optimization (
Browse files Browse the repository at this point in the history
#137)

* remove empty draw.io projects

* Fix typo and optimize format

* Fix 'stateless' typo to 'stateful'

* unify the code block markdown usage

* unify the code block markdown usage - en
  • Loading branch information
Pil0tXia committed Oct 27, 2023
1 parent 759011f commit c981348
Show file tree
Hide file tree
Showing 26 changed files with 66 additions and 45 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ application {
mainClass = project.hasProperty("mainClass") ? project.getProperty("mainClass") : 'NULL'
}
```
- Set ```eventMesh.connector.plugin.type=knative``` in [eventmesh-runtime/conf/eventmesh.properties](https://github.com/apache/eventmesh/blob/master/eventmesh-runtime/conf/eventmesh.properties) file.
- Set `eventMesh.connector.plugin.type=knative` in [eventmesh-runtime/conf/eventmesh.properties](https://github.com/apache/eventmesh/blob/master/eventmesh-runtime/conf/eventmesh.properties) file.

## Demo
### Publish an Event Message from Knative and Subscribe from EventMesh
Expand All @@ -50,14 +50,14 @@ $ curl -i http://cloudevents-player.default.127.0.0.1.sslip.io -H "Content-Type:
```

#### Step 3: Subscribe from an EventMesh
- Set ```public static final String EVENTMESH_HTTP_ASYNC_TEST_TOPIC = "messages";``` in [ExampleConstants.java](https://github.com/apache/eventmesh/blob/master/eventmesh-examples/src/main/java/org/apache/eventmesh/common/ExampleConstants.java) file.
- Set `public static final String EVENTMESH_HTTP_ASYNC_TEST_TOPIC = "messages";` in [ExampleConstants.java](https://github.com/apache/eventmesh/blob/master/eventmesh-examples/src/main/java/org/apache/eventmesh/common/ExampleConstants.java) file.
```bash
$ cd eventmesh-examples
$ ../gradlew -PmainClass=org.apache.eventmesh.http.demo.sub.SpringBootDemoApplication run
```

#### Expected Result
The following message with ```data``` field as ```Hello CloudEvents!``` will be printed on the console of EventMesh server.
The following message with `data` field as `Hello CloudEvents!` will be printed on the console of EventMesh server.
```bash
2022-09-05 16:37:58,237 INFO [eventMesh-clientManage-] DefaultConsumer(DefaultConsumer.java:60) - \
[{"event":{"attributes":{"datacontenttype":"application/json","id":"123456789","mediaType":"application/json",\
Expand Down Expand Up @@ -85,7 +85,7 @@ $ curl http://cloudevents-player.default.127.0.0.1.sslip.io/messages
```

#### Expected Result
The following message with ```data``` field as ```Hello Knative from EventMesh!``` will be printed on the console of EventMesh server.
The following message with `data` field as `Hello Knative from EventMesh!` will be printed on the console of EventMesh server.
```bash
2022-09-05 16:52:41,633 INFO [eventMesh-clientManage-] DefaultConsumer(DefaultConsumer.java:60) - \
[{"event":{"attributes":{"datacontenttype":"application/json","id":"1234","mediaType":"application/json",\
Expand Down
2 changes: 1 addition & 1 deletion docs/instruction/03-runtime.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EventMesh Runtime

The EventMesh Runtime is a stateless mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.
The EventMesh Runtime is a stateful mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.

![EventMesh Runtime](/images/design-document/runtime.png)

Expand Down
1 change: 0 additions & 1 deletion eventmesh.drawio

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# Knative Connector插件
# Knative Connector 插件

## 准备
### 创建Knative Source和Sink
我们使用 *cloudevents-player* [Knative服务](https://knative.dev/docs/serving/)作为例子。如果您不知道如何创建 *cloudevents-player* Knative服务作为source和sink,请按照这个[链接](https://knative.dev/docs/getting-started/first-source/#creating-your-first-source)的步骤进行创建。

### EventMesh配置文件
### 创建 Knative Source 和 Sink

我们使用 *cloudevents-player* [Knative 服务](https://knative.dev/docs/serving/)作为例子。如果您不知道如何创建 *cloudevents-player* Knative 服务作为 source 和 sink,请按照这个[链接](https://knative.dev/docs/getting-started/first-source/#creating-your-first-source)的步骤进行创建。

### EventMesh 配置文件

- 将以下配置加入 [eventmesh-starter/build.gradle](https://github.com/apache/eventmesh/blob/master/eventmesh-starter/build.gradle) 文件

```bash
plugins {
id 'application'
Expand All @@ -23,7 +27,9 @@ dependencies {
implementation project(":eventmesh-runtime")
}
```

- 将以下配置加入 [eventmesh-examples/build.gradle](https://github.com/apache/eventmesh/blob/master/eventmesh-examples/build.gradle)文件

```bash
plugins {
id 'application'
Expand All @@ -33,57 +39,74 @@ application {
mainClass = project.hasProperty("mainClass") ? project.getProperty("mainClass") : 'NULL'
}
```
-[eventmesh-runtime/conf/eventmesh.properties](https://github.com/apache/eventmesh/blob/master/eventmesh-runtime/conf/eventmesh.properties) 文件中设置```eventMesh.connector.plugin.type=knative```变量

-[eventmesh-runtime/conf/eventmesh.properties](https://github.com/apache/eventmesh/blob/master/eventmesh-runtime/conf/eventmesh.properties) 文件中设置`eventMesh.connector.plugin.type=knative`变量

## 演示
### Knative发布事件消息/EventMesh订阅
#### 步骤1:启动一台EventMesh服务器

### Knative 发布事件消息 / EventMesh 订阅

#### 步骤 1:启动一台 EventMesh 服务器

```bash
$ cd eventmesh-starter
$ ../gradlew -PmainClass=org.apache.eventmesh.starter.StartUp run
```

#### 步骤2:从Knative Source发布一条消息
#### 步骤 2:从 Knative Source 发布一条消息

```bash
$ curl -i http://cloudevents-player.default.127.0.0.1.sslip.io -H "Content-Type: application/json" -H "Ce-Id: 123456789" -H "Ce-Specversion: 1.0" -H "Ce-Type: some-type" -H "Ce-Source: command-line" -d '{"msg":"Hello CloudEvents!"}'
```

#### 步骤3:从EventMesh订阅
-[ExampleConstants.java](https://github.com/apache/eventmesh/blob/master/eventmesh-examples/src/main/java/org/apache/eventmesh/common/ExampleConstants.java) 文件中设置 ```public static final String EVENTMESH_HTTP_ASYNC_TEST_TOPIC = "messages";```变量
#### 步骤 3:从 EventMesh 订阅

-[ExampleConstants.java](https://github.com/apache/eventmesh/blob/master/eventmesh-examples/src/main/java/org/apache/eventmesh/common/ExampleConstants.java) 文件中设置 `public static final String EVENTMESH_HTTP_ASYNC_TEST_TOPIC = "messages";`变量

```bash
$ cd eventmesh-examples
$ ../gradlew -PmainClass=org.apache.eventmesh.http.demo.sub.SpringBootDemoApplication run
```

#### 预期结果
以下```data``````Hello CloudEvents!```的消息将会打印在EventMesh服务器的控制台上。

以下`data``Hello CloudEvents!`的消息将会打印在 EventMesh 服务器的控制台上。

```bash
2022-09-05 16:37:58,237 INFO [eventMesh-clientManage-] DefaultConsumer(DefaultConsumer.java:60) - \
[{"event":{"attributes":{"datacontenttype":"application/json","id":"123456789","mediaType":"application/json",\
"source":"command-line","specversion":"1.0","type":"some-type"},"data":{"msg":"Hello CloudEvents!"},"extensions":{}},\
"id":"123456789","receivedAt":"2022-09-05T10:37:49.537658+02:00[Europe/Madrid]","type":"RECEIVED"}]
```

### EventMessh发布事件消息/Knative订阅
#### 步骤1:启动一台EventMesh服务器
### EventMesh 发布事件消息 / Knative 订阅

#### 步骤 1:启动一台 EventMesh 服务器

```bash
$ cd eventmesh-starter
$ ../gradlew -PmainClass=org.apache.eventmesh.starter.StartUp run
```

#### 步骤2:从EventMesh发布一条消息
我们用Knative Connector的测试程序来演示这个功能。
#### 步骤 2:从 EventMesh 发布一条消息

我们用 Knative Connector 的测试程序来演示这个功能。

```bash
$ cd eventmesh-connector-plugin/eventmesh-connector-knative
$ ../../gradlew clean test --tests KnativeProducerImplTest.testPublish
```

#### 步骤3:从Knative订阅
#### 步骤 3:从 Knative 订阅

```bash
$ curl http://cloudevents-player.default.127.0.0.1.sslip.io/messages
```

#### 预期结果
以下```data``````Hello Knative from EventMesh!```的消息将会打印在EventMesh服务器的控制台上。

以下`data``Hello Knative from EventMesh!`的消息将会打印在 EventMesh 服务器的控制台上。

```bash
2022-09-05 16:52:41,633 INFO [eventMesh-clientManage-] DefaultConsumer(DefaultConsumer.java:60) - \
[{"event":{"attributes":{"datacontenttype":"application/json","id":"1234","mediaType":"application/json",\
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Eventmesh-runtime 快速入门说明

EventMesh Runtime 是 EventMesh 集群中无状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。
EventMesh Runtime 是 EventMesh 集群中有状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。

![EventMesh Runtime](/images/design-document/runtime.png)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Eventmesh-runtime 快速入门说明

EventMesh Runtime 是 EventMesh 集群中无状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。
EventMesh Runtime 是 EventMesh 集群中有状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。

## 1 本地构建运行

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Eventmesh-runtime 快速入门说明

EventMesh Runtime 是 EventMesh 集群中无状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。
EventMesh Runtime 是 EventMesh 集群中有状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。

## 1 本地构建运行

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Eventmesh-runtime 快速入门说明

EventMesh Runtime 是 EventMesh 集群中无状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。
EventMesh Runtime 是 EventMesh 集群中有状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。

## 1 本地构建运行

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Eventmesh-runtime 快速入门说明

EventMesh Runtime 是 EventMesh 集群中无状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。
EventMesh Runtime 是 EventMesh 集群中有状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。

## 1 本地构建运行

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Eventmesh-runtime 快速入门说明

EventMesh Runtime 是 EventMesh 集群中无状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。
EventMesh Runtime 是 EventMesh 集群中有状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。

## 1 本地构建运行

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Eventmesh-runtime 快速入门说明

EventMesh Runtime 是 EventMesh 集群中无状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。
EventMesh Runtime 是 EventMesh 集群中有状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。

## 1 本地构建运行

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Eventmesh-runtime 快速入门说明

EventMesh Runtime 是 EventMesh 集群中无状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。
EventMesh Runtime 是 EventMesh 集群中有状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。

## 1 本地构建运行

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Eventmesh-runtime 快速入门说明

EventMesh Runtime 是 EventMesh 集群中无状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。
EventMesh Runtime 是 EventMesh 集群中有状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。

## 1 本地构建运行

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Eventmesh-runtime 快速入门说明

EventMesh Runtime 是 EventMesh 集群中无状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。
EventMesh Runtime 是 EventMesh 集群中有状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。

## 1 本地构建运行

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Eventmesh-runtime 快速入门说明

EventMesh Runtime 是 EventMesh 集群中无状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。
EventMesh Runtime 是 EventMesh 集群中有状态的 Mesh 节点,负责 Source Connector 与 Sink Connector 之间的事件传输,并可以使用 EventMesh Storage 作为事件的存储队列。

## 1 本地构建运行

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-v1.0.0/instruction/03-runtime.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EventMesh Runtime

The EventMesh Runtime is a stateless mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.
The EventMesh Runtime is a stateful mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.

## 1 Run on your local machine

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-v1.1.1/instruction/03-runtime.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EventMesh Runtime

The EventMesh Runtime is a stateless mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.
The EventMesh Runtime is a stateful mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.

## 1 Run on your local machine

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-v1.2.0/instruction/03-runtime.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EventMesh Runtime

The EventMesh Runtime is a stateless mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.
The EventMesh Runtime is a stateful mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.

## 1 Run on your local machine

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-v1.3.0/instruction/03-runtime.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EventMesh Runtime

The EventMesh Runtime is a stateless mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.
The EventMesh Runtime is a stateful mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.

## 1 Run on your local machine

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-v1.4.0/instruction/03-runtime.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EventMesh Runtime

The EventMesh Runtime is a stateless mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.
The EventMesh Runtime is a stateful mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.

## 1 Run on your local machine

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-v1.5.0/instruction/03-runtime.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EventMesh Runtime

The EventMesh Runtime is a stateless mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.
The EventMesh Runtime is a stateful mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.

## 1 Run on your local machine

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-v1.6.0/instruction/03-runtime.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EventMesh Runtime

The EventMesh Runtime is a stateless mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.
The EventMesh Runtime is a stateful mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.

## 1 Run on your local machine

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-v1.7.0/instruction/03-runtime.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EventMesh Runtime

The EventMesh Runtime is a stateless mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.
The EventMesh Runtime is a stateful mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.

## 1 Run on your local machine

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-v1.8.0/instruction/03-runtime.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EventMesh Runtime

The EventMesh Runtime is a stateless mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.
The EventMesh Runtime is a stateful mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.

## 1 Run on your local machine

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-v1.9.0/instruction/03-runtime.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EventMesh Runtime

The EventMesh Runtime is a stateless mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.
The EventMesh Runtime is a stateful mesh node in an EventMesh cluster that is responsible for event transfer between the Source Connector and the Sink Connector, and can use EventMesh Storage as a storage queue for events.

## 1 Run on your local machine

Expand Down
1 change: 0 additions & 1 deletion 未命名绘图.drawio

This file was deleted.

0 comments on commit c981348

Please sign in to comment.