This is an automated email from the ASF dual-hosted git repository.
mikexue pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/eventmesh-site.git
The following commit(s) were added to refs/heads/master by this push:
new 4f152354 [ISSUE #127] Fix parallel development merge conflict and
optimize documents (#128)
4f152354 is described below
commit 4f15235459a724211ace2476c8cb3b74781474ac
Author: Pil0tXia <[email protected]>
AuthorDate: Mon Aug 28 15:20:17 2023 +0800
[ISSUE #127] Fix parallel development merge conflict and optimize documents
(#128)
* Fix failed task and image duplicate references (zh-cn)
* Fix image relative link references (en)
* sync versioned doc change
* resolve confict: remove mis-recognized as moved file
* resolve conflict: translate a doc to manually make git change
* feat: translate HTTPS doc
* sync image relative link
* unify 1.9.0 version label
* Fix mandatory values were labeled as optional in webhook docs
---
docs/design-document/14-https.md | 28 +--
docs/design-document/15-webhook.md | 27 +--
.../current/design-document/15-webhook.md | 30 +--
.../version-v1.9.0.json | 2 +-
.../version-v1.9.0/design-document/14-https.md | 18 +-
.../version-v1.9.0/design-document/https.md | 32 ---
.../version-v1.9.0/design-document/webhook.md | 268 ---------------------
.../version-v1.9.0/design-document/14-https.md | 30 +++
.../{14-webhook.md => 15-webhook.md} | 202 ++++++++++------
9 files changed, 206 insertions(+), 431 deletions(-)
diff --git a/docs/design-document/14-https.md b/docs/design-document/14-https.md
index a100ba39..b7141bb9 100644
--- a/docs/design-document/14-https.md
+++ b/docs/design-document/14-https.md
@@ -1,32 +1,30 @@
# HTTPS
-1.在eventmesh-runtime 中配置
+1. Configuration in eventmesh-runtime
```
-eventMesh.properties(添加如下配置)
-eventMesh.server.useTls.enabled=true //默认值 false
+eventMesh.properties (add the following configurations)
+eventMesh.server.useTls.enabled=true // Default value: false
-
-config env varible
--Dssl.server.protocol=TLSv1.1 //默认值 TLSv1.1
--Dssl.server.cer=sChat2.jks //把文件放到启动脚本start.sh 指定的conPath目录下
+Configuring environment variable
+-Dssl.server.protocol=TLSv1.1 // Default value: TLSv1.1
+-Dssl.server.cer=sChat2.jks // Place the file in the conPath directory
specified by the startup script start.sh
-Dssl.server.pass=sNetty
```
-2.在eventmesh-sdk-java 中配置
+2. Configuration in eventmesh-sdk-java
```
-//创建producer
-LiteClientConfig eventMeshHttpClientConfig = new eventMeshHttpClientConfig();
+// Create a producer
+LiteClientConfig eventMeshHttpClientConfig = new LiteClientConfig();
...
-//设置开启TLS
+// Enable TLS
eventMeshHttpClientConfig.setUseTls(true);
LiteProducer producer = new LiteProducer(eventMeshHttpClientConfig);
-
-//配置环境变量
--Dssl.client.protocol=TLSv1.1 //默认值 TLSv1.1
--Dssl.client.cer=sChat2.jks //把文件放到应用指定的conPath目录下
+// Configure environment variables
+-Dssl.client.protocol=TLSv1.1 // Default value: TLSv1.1
+-Dssl.client.cer=sChat2.jks // Place the file in the conPath directory
specified by the application
-Dssl.client.pass=sNetty
```
diff --git a/docs/design-document/15-webhook.md
b/docs/design-document/15-webhook.md
index 807b1a8a..bebeec72 100644
--- a/docs/design-document/15-webhook.md
+++ b/docs/design-document/15-webhook.md
@@ -113,7 +113,7 @@ input params:
| manufacturerEventName | manufacturer event name | string | Y | null |
| contentType | http connettype | string | N | application/json |
| description | configuration instructions | string | N | null |
-| secret | signature string | string | N | null |
+| secret | signature string | string | Y | null |
| userName | username | string | N | null |
| password | password | string | N | null |
| cloudEventName | cloudEvent name | string | Y | null |
@@ -127,7 +127,8 @@ E.g:
"manufacturerName":"github",
"manufacturerDomain":"www.github.com",
"manufacturerEventName":"all",
- "cloudEventName":"github-eventmesh"
+ "cloudEventName":"github-eventmesh",
+ "secret": "testSecret"
}
```
@@ -167,7 +168,7 @@ Output params:
| manufacturerEventName | manufacturer event name | string | Y | null |
| contentType | http connettype | string | N | application/json |
| description | configuration instructions | string | N | null |
-| secret | signature key | string | N | null |
+| secret | signature key | string | Y | null |
| userName | user name | string | N | null |
| password | password | string | N | null |
| cloudEventName | cloudEvent name | string | Y | null |
@@ -209,7 +210,7 @@ Output params:
| manufacturerEventName | manufacturer event name | string | Y | null |
| contentType | http connettype | string | N | application/json |
| description | configuration instructions | string | N | null |
-| secret | signature key | string | N | null |
+| secret | signature key | string | Y | null |
| userName | user name | string | N | null |
| password | password | string | N | null |
| cloudEventName | cloudEvent name | string | Y | null |
@@ -233,7 +234,7 @@ input params:
| manufacturerEventName | manufacturer event name
| string | Y | null |
| contentType | http connettype
| string | N | application/json |
| description | configuration instructions
| string | N | null |
-| secret | signature string
| string | N | null |
+| secret | signature string
| string | Y | null |
| userName | username
| string | N | null |
| password | password
| string | N | null |
| cloudEventName | cloudEvent name
| string | Y | null |
@@ -247,7 +248,8 @@ E.g:
"manufacturerName":"github",
"manufacturerDomain":"www.github.com",
"manufacturerEventName":"all",
- "cloudEventName":"github-eventmesh"
+ "cloudEventName":"github-eventmesh",
+ "secret": "testSecret"
}
```
@@ -292,25 +294,25 @@ Output params: 1 for success, 0 for failure
## Manufacturer's Webhook operation instructions
-### github sign up
+### GitHub sign up
#### The first step: Enter the corresponding project
#### The second step: click setting
-
+
#### The third step: click Webhooks
-
+
#### The fourth step: Click on Add Webhook
-
+
#### The fifth step: Fill in the Webhook information
-
+
Payload URL: EventMesh service address and callbackPath, which must include
the protocol header. For example, when the callback address `callbackPath` is
`/webhook/github/eventmesh/all`, the Payload URL is
`http://www.example.com:10105/webhook/github/eventmesh/all`.
@@ -319,6 +321,3 @@ Payload URL: EventMesh service address and callbackPath,
which must include the
Content type: http header content type
Secret: signature string
-
-
-
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/15-webhook.md
b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/15-webhook.md
index 6d94efdf..a5d2a207 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/15-webhook.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/15-webhook.md
@@ -124,7 +124,7 @@ contentType： application/json
| manufacturerEventName | 厂商事件名 | string | 是 | null |
| contentType | http connettype | string | 否 | application/json |
| description | 配置说明 | string | 否 | null |
-| secret | 验签密钥 | string | 否 | null |
+| secret | 验签密钥 | string | 是 | null |
| userName | 用户名 | string | 否 | null |
| password | 用户密码 | string | 否 | null |
| cloudEventName | 事件名 | string | 是 | null |
@@ -138,7 +138,8 @@ contentType： application/json
"manufacturerName":"github",
"manufacturerDomain":"www.github.com",
"manufacturerEventName":"all",
- "cloudEventName":"github-eventmesh"
+ "cloudEventName":"github-eventmesh",
+ "secret": "testSecret"
}
```
@@ -177,7 +178,7 @@ contentType： application/json
| manufacturerEventName | 厂商事件名 | string | 是 | null |
| contentType | http connettype | string | 否 | application/json |
| description | 配置说明 | string | 否 | null |
-| secret | 验签密钥 | string | 否 | null |
+| secret | 验签密钥 | string | 是 | null |
| userName | 用户名 | string | 否 | null |
| password | 用户密码 | string | 否 | null |
| cloudEventName | 事件名（） | string | 是 | null |
@@ -219,7 +220,7 @@ contentType： application/json
| manufacturerEventName | 厂商事件名 | string | 是 | null |
| contentType | http connettype | string | 否 | application/json |
| description | 配置说明 | string | 否 | null |
-| secret | 验签密钥 | string | 否 | null |
+| secret | 验签密钥 | string | 是 | null |
| userName | 用户名 | string | 否 | null |
| password | 用户密码 | string | 否 | null |
| cloudEventName | 事件名（） | string | 是 | null |
@@ -243,7 +244,7 @@ contentType： application/json
| manufacturerEventName | 厂商事件名
| string | 是 | null |
| contentType | http connettype
| string | 否 | application/json |
| description | 配置说明
| string | 否 | null |
-| secret | 验签密钥
| string | 否 | null |
+| secret | 验签密钥
| string | 是 | null |
| userName | 用户名
| string | 否 | null |
| password | 用户密码
| string | 否 | null |
| cloudEventName | 事件名
| string | 是 | null |
@@ -257,7 +258,8 @@ contentType： application/json
"manufacturerName":"github",
"manufacturerDomain":"www.github.com",
"manufacturerEventName":"all",
- "cloudEventName":"github-eventmesh"
+ "cloudEventName":"github-eventmesh",
+ "secret": "testSecret"
}
```
@@ -307,21 +309,21 @@ contentType： application/json
#### 第一步：进入对应的项目
-#### 第二步：点击 setting
+#### 第二步：点击setting
-
+
-#### 第三步：点击 Webhooks
+#### 第三步：点击Webhooks
-
+
-#### 第四步：点击 Add Webhook
+#### 第四步：点击 Add webhook
-
+
-#### 第五步: 填写 Webhook 信息
+#### 第五步: 填写webhook信息
-
+
Payload URL: EventMesh 服务地址和调用地址，需包含协议头。例如，当调用地址 `callbackPath` 为
`/webhook/github/eventmesh/all` 时，Payload URL 为
`http://www.example.com:10105/webhook/github/eventmesh/all`
diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.9.0.json
b/i18n/zh/docusaurus-plugin-content-docs/version-v1.9.0.json
index 913eb8be..c8b2b3cf 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/version-v1.9.0.json
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.9.0.json
@@ -1,6 +1,6 @@
{
"version.label": {
- "message": "1.9.0",
+ "message": "v1.9.0",
"description": "The label for current version"
},
"sidebar.tutorialSidebar.category.Installation and Deployment": {
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-v1.9.0/design-document/14-https.md
b/i18n/zh/docusaurus-plugin-content-docs/version-v1.9.0/design-document/14-https.md
index a100ba39..237ef8f2 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-v1.9.0/design-document/14-https.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-v1.9.0/design-document/14-https.md
@@ -3,30 +3,30 @@
1.在eventmesh-runtime 中配置
```
-eventMesh.properties(添加如下配置)
-eventMesh.server.useTls.enabled=true //默认值 false
+eventMesh.properties (添加如下配置)
+eventMesh.server.useTls.enabled=true // 默认值 false
config env varible
--Dssl.server.protocol=TLSv1.1 //默认值 TLSv1.1
--Dssl.server.cer=sChat2.jks //把文件放到启动脚本start.sh 指定的conPath目录下
+-Dssl.server.protocol=TLSv1.1 // 默认值 TLSv1.1
+-Dssl.server.cer=sChat2.jks // 把文件放到启动脚本start.sh 指定的conPath目录下
-Dssl.server.pass=sNetty
```
2.在eventmesh-sdk-java 中配置
```
-//创建producer
+// 创建producer
LiteClientConfig eventMeshHttpClientConfig = new eventMeshHttpClientConfig();
...
-//设置开启TLS
+// 设置开启TLS
eventMeshHttpClientConfig.setUseTls(true);
LiteProducer producer = new LiteProducer(eventMeshHttpClientConfig);
-//配置环境变量
--Dssl.client.protocol=TLSv1.1 //默认值 TLSv1.1
--Dssl.client.cer=sChat2.jks //把文件放到应用指定的conPath目录下
+// 配置环境变量
+-Dssl.client.protocol=TLSv1.1 // 默认值 TLSv1.1
+-Dssl.client.cer=sChat2.jks // 把文件放到应用指定的conPath目录下
-Dssl.client.pass=sNetty
```
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-v1.9.0/design-document/https.md
b/i18n/zh/docusaurus-plugin-content-docs/version-v1.9.0/design-document/https.md
deleted file mode 100644
index a100ba39..00000000
---
a/i18n/zh/docusaurus-plugin-content-docs/version-v1.9.0/design-document/https.md
+++ /dev/null
@@ -1,32 +0,0 @@
-# HTTPS
-
-1.在eventmesh-runtime 中配置
-
-```
-eventMesh.properties(添加如下配置)
-eventMesh.server.useTls.enabled=true //默认值 false
-
-
-config env varible
--Dssl.server.protocol=TLSv1.1 //默认值 TLSv1.1
--Dssl.server.cer=sChat2.jks //把文件放到启动脚本start.sh 指定的conPath目录下
--Dssl.server.pass=sNetty
-```
-
-2.在eventmesh-sdk-java 中配置
-
-```
-//创建producer
-LiteClientConfig eventMeshHttpClientConfig = new eventMeshHttpClientConfig();
-...
-
-//设置开启TLS
-eventMeshHttpClientConfig.setUseTls(true);
-LiteProducer producer = new LiteProducer(eventMeshHttpClientConfig);
-
-
-//配置环境变量
--Dssl.client.protocol=TLSv1.1 //默认值 TLSv1.1
--Dssl.client.cer=sChat2.jks //把文件放到应用指定的conPath目录下
--Dssl.client.pass=sNetty
-```
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-v1.9.0/design-document/webhook.md
b/i18n/zh/docusaurus-plugin-content-docs/version-v1.9.0/design-document/webhook.md
deleted file mode 100644
index d526177c..00000000
---
a/i18n/zh/docusaurus-plugin-content-docs/version-v1.9.0/design-document/webhook.md
+++ /dev/null
@@ -1,268 +0,0 @@
-
-
-## webhook使用流程
-#### 第一步：在eventmesh配置webhook相关信息并且启动
-
-##### 配置说明
-```
-# 是否启动webhook admin服务
-eventMesh.webHook.admin.start=true
-
-# webhook事件配置存储模式。目前只支持file与nacos
-eventMesh.webHook.operationMode=file
-# 文件存储模式的文件存放路径，如果写上#{eventMeshHome}，在eventMesh根目录
-eventMesh.webHook.fileMode.filePath= #{eventMeshHome}/webhook
-
-# nacos存储模式，配置命名规则是eventMesh.webHook.nacosMode.{nacos 原生配置key} 具体的配置请看 [nacos
github
api](https://github.com/alibaba/nacos/blob/develop/api/src/main/java/com/alibaba/nacos/api/SystemPropertyKeyConst.java)
-## nacos的地址
-eventMesh.webHook.nacosMode.serverAddr=127.0.0.1:8848
-
-# webhook eventcloud 发送模式。与eventMesh.connector.plugin.type 配置一样
-eventMesh.webHook.producer.connector=standalone
-```
-
-#### 第二步：添加webhook配置信息
-配置信息说明
-```java
- /**
- * 厂商调用的path。厂商事件调用地址、 [http or https ]://[域名 or IP
【厂商可以被调用】]:[端口]/webhook/[callbackPath]
- * 比如：http://127.0.0.1:10504/webhook/test/event 需要把全完url填入厂商调用输入中
- * callbackPath 是唯一
- * manufacturer callback path
- */
- private String callbackPath;
-
- /**
- * 厂商的名字
- * manufacturer name ,like github
- */
- private String manufacturerName;
-
- /**
- * 厂商的事件名
- * webhook event name ,like rep-push
- */
- private String manufacturerEventName;
-
- /**
- *
- * http header content type
- */
- private String contentType = "application/json";
-
- /**
- * 说明
- * description of this WebHookConfig
- */
- private String description;
-
- /**
- * 有一些厂商使用验签方式，
- * secret key ,for authentication
- */
- private String secret;
-
- /**
- * 有一些厂商使用验签方式，使用账户密码方式
- * userName ,for HTTP authentication
- */
- private String userName;
-
- /**
- * 有一些厂商使用验签方式，使用账户密码方式
- * password ,for HTTP authentication
- */
- private String password;
-
-
-
- /**
- * 事件发送到那个topic
- * roll out event name ,like topic to mq
- */
- private String cloudEventName;
-
- /**
- * roll out data format -> CloudEvent serialization mode
- * If HTTP protocol is used, the request header contentType needs to be
marked
- */
- private String dataContentType = "application/json";;
-
- /**
- * source of event
- */
- private String cloudEventSource;
-
- /**
- * cloudEvent事件对象唯一标识符识别方式，uuid或者manufacturerEventId(厂商id)
- * id of cloudEvent ,like uuid/manufacturerEventId
- */
- private String cloudEventIdGenerateMode;
-
-```
-
-##### 添加接口
-路径： /webhook/insertWebHookConfig
-方法： POST
-contentType： application/json
-
-输入参数：
-| 字段 | 说明 | 类型 | 必须 | 默认值 |
-| -- | -- | -- | -- | -- |
-| callbackPath | 调用地址，唯一地址 | string | 是 | null |
-| manufacturerName | 厂商名 | string | 是 | null |
-| manufacturerEventName | 厂商事件名 | string | 是 | null |
-| contentType | http connettype | string | 否 | application/json |
-| description | 配置说明 | string | 否 | null |
-| secret | 验签密钥 | string | 否 | null |
-| userName | 用户名 | string | 否 | null |
-| password | 用户密码 | string | 否 | null |
-| cloudEventName | 事件名（） | string | 是 | null |
-| cloudEventSource | 事件来源可以填写 | string | 是 | null |
-| cloudEventIdGenerateMode |
cloudEvent事件对象唯一标识符识别方式，uuid或者manufacturerEventId(厂商id) | string | 否 |
manufacturerEventId |
-
-列子：
-```json
-
-{
- "callbackPath":"/webhook/github/eventmesh/all",
- "manufacturerName":"github",
- "manufacturerEventName":"all",
- "secret":"eventmesh",
- "cloudEventName":"github-eventmesh",
- "cloudEventSource":"github"
-}
-
-```
-输出参数：１ 成功，０失败
-
-##### 删除接口
-路径： /webhook/deleteWebHookConfig
-方法： POST
-contentType： application/json
-
-输入参数：
-| 字段 | 说明 | 类型 | 必须 | 默认值 |
-| -- | -- | -- | -- | -- |
-| callbackPath | 调用地址，唯一地址 | string | 是 | null |
-
-
-列子：
-
-```json
-
-{
- "callbackPath":"/webhook/github/eventmesh/all"
-}
-
-```
-
-
-输出参数：１ 成功，０失败
-
-##### 通过callbackPath查询WebHookConfig
-路径： /webhook/queryWebHookConfigById
-方法： POST
-contentType： application/json
-
-输入参数：
-| 字段 | 说明 | 类型 | 必须 | 默认值 |
-| -- | -- | -- | -- | -- |
-| callbackPath | 调用地址，唯一地址 | string | 是 | null |
-
-
-列子：
-
-```json
-
-{
- "callbackPath":"/webhook/github/eventmesh/all"
-}
-
-```
-
-
-输出参数：
-| 字段 | 说明 | 类型 | 必须 | 默认值 |
-| -- | -- | -- | -- | -- |
-| callbackPath | 调用地址，唯一地址 | string | 是 | null |
-| manufacturerName | 厂商名 | string | 是 | null |
-| manufacturerEventName | 厂商事件名 | string | 是 | null |
-| contentType | http connettype | string | 否 | application/json |
-| description | 配置说明 | string | 否 | null |
-| secret | 验签密钥 | string | 否 | null |
-| userName | 用户名 | string | 否 | null |
-| password | 用户密码 | string | 否 | null |
-| cloudEventName | 事件名（） | string | 是 | null |
-| cloudEventSource | 事件来源可以填写 | string | 是 | null |
-| cloudEventIdGenerateMode |
cloudEvent事件对象唯一标识符识别方式，uuid或者manufacturerEventId(厂商id) | string | 否 |
manufacturerEventId |
-
-
-##### 通过manufacturer查询WebHookConfig列表
-路径： /webhook/queryWebHookConfigByManufacturer
-方法： POST
-contentType： application/json
-
-输入参数：
-| 字段 | 说明 | 类型 | 必须 | 默认值 |
-| -- | -- | -- | -- | -- |
-| manufacturerName | 厂商名 | string | 是 | null |
-
-
-列子：
-
-```json
-
-{
- "manufacturerName":"github"
-}
-
-```
-
-
-输出参数：
-| 字段 | 说明 | 类型 | 必须 | 默认值 |
-| -- | -- | -- | -- | -- |
-| callbackPath | 调用地址，唯一地址 | string | 是 | null |
-| manufacturerName | 厂商名 | string | 是 | null |
-| manufacturerEventName | 厂商事件名 | string | 是 | null |
-| contentType | http connettype | string | 否 | application/json |
-| description | 配置说明 | string | 否 | null |
-| secret | 验签密钥 | string | 否 | null |
-| userName | 用户名 | string | 否 | null |
-| password | 用户密码 | string | 否 | null |
-| cloudEventName | 事件名（） | string | 是 | null |
-| cloudEventSource | 事件来源可以填写 | string | 是 | null |
-| cloudEventIdGenerateMode |
cloudEvent事件对象唯一标识符识别方式，uuid或者manufacturerEventId(厂商id) | string | 否 |
manufacturerEventId |
-
-
-#### 第三步：查看配置是否成功
-1. file存储模式。请到eventMesh.webHook.fileMode.filePath 目录下查看。文件名为callbackPath转移后的
-2. nacos存储模式。请到eventMesh.webHook.nacosMode.serverAddr 配置的nacos服务去看
-
-#### 第四步：配置cloudevent的消费者
-
-
-#### 第五步：在厂商配置webhook相关信息
-> 厂商操作请看【厂商webhook操作说明】
-
-
-## 厂商webhook操作说明
-### github 注册
-#### 第一步：进入对应的项目
-#### 第二步：点击setting
-
-#### 第三步：点击Webhooks
-
-#### 第四步：点击 Add webhook
-
-#### 第五步: 填写webhook信息
-
-
-Payload URL: 服务地址以及pahts。[http or https ]://[域名 or IP
【厂商可以被调用】]:[端口]/webhook/[callbackPath]
-Content type：http header content type
-secret: 验签字符串
-
-
-
-
diff --git a/versioned_docs/version-v1.9.0/design-document/14-https.md
b/versioned_docs/version-v1.9.0/design-document/14-https.md
new file mode 100644
index 00000000..b7141bb9
--- /dev/null
+++ b/versioned_docs/version-v1.9.0/design-document/14-https.md
@@ -0,0 +1,30 @@
+# HTTPS
+
+1. Configuration in eventmesh-runtime
+
+```
+eventMesh.properties (add the following configurations)
+eventMesh.server.useTls.enabled=true // Default value: false
+
+Configuring environment variable
+-Dssl.server.protocol=TLSv1.1 // Default value: TLSv1.1
+-Dssl.server.cer=sChat2.jks // Place the file in the conPath directory
specified by the startup script start.sh
+-Dssl.server.pass=sNetty
+```
+
+2. Configuration in eventmesh-sdk-java
+
+```
+// Create a producer
+LiteClientConfig eventMeshHttpClientConfig = new LiteClientConfig();
+...
+
+// Enable TLS
+eventMeshHttpClientConfig.setUseTls(true);
+LiteProducer producer = new LiteProducer(eventMeshHttpClientConfig);
+
+// Configure environment variables
+-Dssl.client.protocol=TLSv1.1 // Default value: TLSv1.1
+-Dssl.client.cer=sChat2.jks // Place the file in the conPath directory
specified by the application
+-Dssl.client.pass=sNetty
+```
diff --git a/versioned_docs/version-v1.9.0/design-document/14-webhook.md
b/versioned_docs/version-v1.9.0/design-document/15-webhook.md
similarity index 50%
rename from versioned_docs/version-v1.9.0/design-document/14-webhook.md
rename to versioned_docs/version-v1.9.0/design-document/15-webhook.md
index 9c8a1634..468741e5 100644
--- a/versioned_docs/version-v1.9.0/design-document/14-webhook.md
+++ b/versioned_docs/version-v1.9.0/design-document/15-webhook.md
@@ -1,13 +1,16 @@
+# Use Webhook to subscribe events
## Webhook usage process
-#### The first step: Configure webhook related information in eventmesh and
start
-##### Configuration
+### The first step: Configure Webhook related information in eventmesh and
start
+
+Configuration:
+
```
-# Whether to start the webhook admin service
+# Whether to start the Webhook admin service
eventMesh.webHook.admin.start=true
-# webhook event configuration storage mode. But currently only supports file
and nacos
+# Webhook event configuration storage mode. But currently only supports file
and nacos
eventMesh.webHook.operationMode=file
# The file path of fileMode. If you write #{eventMeshHome}, in the eventMesh
root directory
@@ -17,13 +20,13 @@ eventMesh.webHook.fileMode.filePath=
#{eventMeshHome}/webhook
## address of nacos
eventMesh.webHook.nacosMode.serverAddr=127.0.0.1:8848
-# webhook eventcloud send mode. Same as eventMesh.connector.plugin.type
configuration
+# Webhook CloudEvent sending mode. This property is the same as the
eventMesh.storage.plugin.type configuration.
eventMesh.webHook.producer.connector=standalone
```
-#### The second step: Add webhook configuration information
+### The second step: Add Webhook configuration information
-Configuration information description
+Configuration information description:
```java
/**
@@ -39,7 +42,12 @@ Configuration information description
private String manufacturerName;
/**
- * webhook event name, like rep-push
+ * manufacturer domain name, like www.github.com
+ */
+ private String manufacturerDomain;
+
+ /**
+ * Webhook event name, like rep-push
*/
private String manufacturerEventName;
@@ -78,12 +86,7 @@ Configuration information description
* roll out data format -> CloudEvent serialization mode
* If HTTP protocol is used, the request header contentType needs to be
marked
*/
- private String dataContentType = "application/json";;
-
- /**
- * source of event
- */
- private String cloudEventSource;
+ private String dataContentType = "application/json";
/**
* id of cloudEvent, like uuid/manufacturerEventId
@@ -92,10 +95,12 @@ Configuration information description
```
-##### Add webhook config
+#### Add WebHook config
path: /webhook/insertWebHookConfig
+
method: POST
+
contentType: application/json
input params:
@@ -104,60 +109,36 @@ input params:
| -- | -- | -- | -- | -- |
| callbackPath | call address, unique address | string | Y | null |
| manufacturerName | manufacturer name | string | Y | null |
-| manufacturerEventName | manufacturer EventName | string | Y | null |
+| manufacturerDomain | manufacturer domain name | string | Y | null |
+| manufacturerEventName | manufacturer event name | string | Y | null |
| contentType | http connettype | string | N | application/json |
| description | configuration instructions | string | N | null |
| secret | signature string | string | N | null |
| userName | username | string | N | null |
| password | password | string | N | null |
| cloudEventName | cloudEvent name | string | Y | null |
-| cloudEventSource | cloudEvent source | string | Y | null |
-| cloudEventIdGenerateMode | cloudEvent event object identification method,
uuid or event id | string | N manufacturerEventId |
+| cloudEventIdGenerateMode | cloudEvent event object identification method,
uuid or event id | string | N |manufacturerEventId|
E.g:
```json
-
{
- "callbackPath":"/webhook/github/eventmesh/all",
- "manufacturerName":"github",
- "manufacturerEventName":"all",
- "secret":"eventmesh",
- "cloudEventName":"github-eventmesh",
- "cloudEventSource":"github"
+ "callbackPath":"/webhook/github/eventmesh/all",
+ "manufacturerName":"github",
+ "manufacturerDomain":"www.github.com",
+ "manufacturerEventName":"all",
+ "cloudEventName":"github-eventmesh"
}
-
```
Output params: 1 for success, 0 for failure
-##### delete webhook config
-path: /webhook/deleteWebHookConfig
-method: POST
-contentType： application/json
-
-input params:
+#### Query WebHook config by callback path
-| field | desc | type | necessary | default |
-| -- | -- | -- | -- | -- |
-| callbackPath | call address, unique address | string | Y | null |
-
-
-E.g:
-
-```json
-
-{
- "callbackPath":"/webhook/github/eventmesh/all"
-}
-
-```
-
-Output params: 1 for success, 0 for failure
-
-##### select WebHookConfig by callbackPath
path: /webhook/queryWebHookConfigById
+
method: POST
+
contentType： application/json
input params:
@@ -165,15 +146,15 @@ input params:
| field | desc | type | necessary | default |
| -- | -- | -- | -- | -- |
| callbackPath | call address, unique address | string | Y | null |
+| manufacturerName | the caller of this callbackPath belongs to | string | Y |
null |
E.g:
```json
-
{
- "callbackPath":"/webhook/github/eventmesh/all"
+ "callbackPath":"/webhook/github/eventmesh/all",
+ "manufacturerName":"github"
}
-
```
Output params:
@@ -182,6 +163,7 @@ Output params:
| -- | -- | -- | -- | -- |
| callbackPath | call address, unique address | string | Y | null |
| manufacturerName | manufacturer name | string | Y | null |
+| manufacturerDomain | manufacturer domain name | string | Y | null |
| manufacturerEventName | manufacturer event name | string | Y | null |
| contentType | http connettype | string | N | application/json |
| description | configuration instructions | string | N | null |
@@ -189,13 +171,14 @@ Output params:
| userName | user name | string | N | null |
| password | password | string | N | null |
| cloudEventName | cloudEvent name | string | Y | null |
-| cloudEventSource | cloudEvent source | string | Y | null |
| cloudEventIdGenerateMode | cloudEvent event object identification method,
uuid or event id | string | N | manufacturerEventId |
+#### Query WebHook config by manufacturer
-##### 通过manufacturer查询WebHookConfig列表
path: /webhook/queryWebHookConfigByManufacturer
+
method: POST
+
contentType： application/json
input params:
@@ -203,16 +186,17 @@ input params:
| field | desc | type | necessary | default |
| -- | -- | -- | -- | -- |
| manufacturerName | manufacturer name | string | Y | null |
-
+| pageNum | page number of paging query | string | Y | null |
+| pageSize | page size of each page | string | Y | null |
E.g:
```json
-
{
- "manufacturerName":"github"
+ "manufacturerName":"github",
+ "pageNum":1,
+ "pageSize":2
}
-
```
Output params:
@@ -221,6 +205,7 @@ Output params:
| -- | -- | -- | -- | -- |
| callbackPath | call address, unique address | string | Y | null |
| manufacturerName | manufacturer name | string | Y | null |
+| manufacturerDomain | manufacturer domain name | string | Y | null |
| manufacturerEventName | manufacturer event name | string | Y | null |
| contentType | http connettype | string | N | application/json |
| description | configuration instructions | string | N | null |
@@ -228,48 +213,109 @@ Output params:
| userName | user name | string | N | null |
| password | password | string | N | null |
| cloudEventName | cloudEvent name | string | Y | null |
-| cloudEventSource | cloudEvent source | string | Y | null |
| cloudEventIdGenerateMode | cloudEvent event object identification method,
uuid or event id | string | N | manufacturerEventId |
+#### Update WebHook config
+
+path: /webhook/updateWebHookConfig
+
+method: POST
+
+contentType: application/json
+
+input params:
+
+| field | desc
| type | necessary | default |
+| ------------------------ |
------------------------------------------------------------ | ------ |
--------- | ------------------- |
+| callbackPath | call address, unique address
| string | Y | null |
+| manufacturerName | manufacturer name
| string | Y | null |
+| manufacturerDomain | manufacturer domain name
| string | Y | null |
+| manufacturerEventName | manufacturer event name
| string | Y | null |
+| contentType | http connettype
| string | N | application/json |
+| description | configuration instructions
| string | N | null |
+| secret | signature string
| string | N | null |
+| userName | username
| string | N | null |
+| password | password
| string | N | null |
+| cloudEventName | cloudEvent name
| string | Y | null |
+| cloudEventIdGenerateMode | cloudEvent event object identification method,
uuid or event id | string | N | manufacturerEventId |
+
+E.g:
+
+```json
+{
+ "callbackPath":"/webhook/github/eventmesh/all",
+ "manufacturerName":"github",
+ "manufacturerDomain":"www.github.com",
+ "manufacturerEventName":"all",
+ "cloudEventName":"github-eventmesh"
+}
+```
+
+Output params: 1 for success, 0 for failure
+
+#### Delete WebHook config
-#### The third step: Check if the configuration is successful
+path: /webhook/deleteWebHookConfig
+
+method: POST
+
+contentType： application/json
+
+input params:
+
+| field | desc | type |
necessary | default |
+| ---------------- | ------------------------------------------ | ------ |
--------- | ------- |
+| callbackPath | call address, unique address | string | Y
| null |
+| manufacturerName | the caller of this callbackPath belongs to | string | Y
| null |
+
+E.g:
-1. file storage mode. Please go to the eventMesh.webHook.fileMode.filePath
directory to view. filename callbackPath.
+```json
+{
+ "callbackPath":"/webhook/github/eventmesh/all",
+ "manufacturerName":"github"
+}
+```
+
+Output params: 1 for success, 0 for failure
+
+### The third step: Check if the configuration is successful
-2. nacos storage mode. Please go to the nacos service configured by
eventMesh.webHook.nacosMode.serverAddr to see.
+1. file storage mode. Please go to the eventMesh.webHook.fileMode.filePath
directory to view. The Filename is callbackPath.
+2. nacos storage mode. Please go to the nacos service configured by
eventMesh.webHook.nacosMode.serverAddr to see this.
-#### The fourth step: Configure the consumer of cloudevent
+### The fourth step: Configure the consumer of cloudevent
-#### The fifth step: Configure webhook related information in the manufacturer
+### The fifth step: Configure Webhook related information in the manufacturer
-> For manufacturer's operation, please refer to [Manufacturer's webhook
operation instructions] .
+> For manufacturer's operation, please refer to [Manufacturer's Webhook
operation instructions](#Manufacturer's-Webhook-operation-instructions).
-## Manufacturer's webhook operation instructions
+## Manufacturer's Webhook operation instructions
-### github sign up
+### GitHub sign up
#### The first step: Enter the corresponding project
#### The second step: click setting
-
+
#### The third step: click Webhooks
-
+
-#### The fourth step: Click on Add webhook
+#### The fourth step: Click on Add Webhook
-
+
-#### The fifth step: Fill in the webhook information
+#### The fifth step: Fill in the Webhook information
-
-
-Payload URL: Service address and pahts. [http or https]://[domain or
IP]:[port]/webhook/[callbackPath]
-Content type: http header content type
-secret: signature string
+
+Payload URL: EventMesh service address and callbackPath, which must include
the protocol header. For example, when the callback address `callbackPath` is
`/webhook/github/eventmesh/all`, the Payload URL is
`http://www.example.com:10105/webhook/github/eventmesh/all`.
+[http or https]://[domain or IP]:[port]/webhook/[callbackPath]
+Content type: http header content type
+Secret: signature string
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
