This is an automated email from the ASF dual-hosted git repository.
xiaoyu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/shenyu-website.git
The following commit(s) were added to refs/heads/main by this push:
new 97e81b45efc [DOC]Add shenyu nginx download (#820)
97e81b45efc is described below
commit 97e81b45efc90cfe01fbbd1a5a48946b275844e4
Author: Sixh-PrFor <[email protected]>
AuthorDate: Fri Nov 4 14:18:16 2022 +0800
[DOC]Add shenyu nginx download (#820)
* 1. update shenyu nginx download
* 1. update shenyu nginx download
* 1. update shenyu nginx download
* 1. update shenyu nginx download
* 1. update shenyu nginx download
* 1. update shenyu nginx download
* 1. update shenyu nginx download
---
community/16-shenyu-nginx-release-guide.md | 5 +-
event/nginx-1.0.0-1-release.md | 17 ++++++
i18n/zh/code.json | 6 ++
.../current/16-shenyu-nginx-release-guide.md | 2 +-
.../current/nginx-1.0.0-1-release.md | 17 ++++++
shenyuNginx/index.md | 71 +++++++++++++++-------
src/components/DownloadCompoent.tsx | 17 +++++-
src/data/event.js | 6 ++
8 files changed, 113 insertions(+), 28 deletions(-)
diff --git a/community/16-shenyu-nginx-release-guide.md
b/community/16-shenyu-nginx-release-guide.md
index 14f8c001fc4..1c249869010 100644
--- a/community/16-shenyu-nginx-release-guide.md
+++ b/community/16-shenyu-nginx-release-guide.md
@@ -424,8 +424,7 @@ Content:
```
Hi,
-Apache ShenYu Team is glad to announce the new release of Apache ShenYu
- nginx ${PUBLISH.VERSION}.
+Apache ShenYu Team is glad to announce the new release of Apache ShenYu Nginx
${PUBLISH.VERSION}.
Apache ShenYu is an asynchronous, high-performance, cross-language, responsive
API gateway.
Support various languages (http protocol), support Dubbo, Spring-Cloud, Grpc,
Motan, Sofa, Tars and other protocols.
@@ -437,7 +436,7 @@ Support cluster deployment, A/B Test, blue-green release.
Download Links: https://shenyu.apache.org/download/
-Release Notes: https://github.com/apache/shenyu/blob/master/RELEASE-NOTES.md
+Release Notes:
https://github.com/apache/shenyu-nginx/blob/main/RELEASE-NOTES.md
Website: https://shenyu.apache.org/
diff --git a/event/nginx-1.0.0-1-release.md b/event/nginx-1.0.0-1-release.md
new file mode 100644
index 00000000000..7a7c176aca4
--- /dev/null
+++ b/event/nginx-1.0.0-1-release.md
@@ -0,0 +1,17 @@
+---
+title: shenyu nginx 1.0.0-1
+sidebar_position: 3
+keywords: ["release-notes"]
+description: release-notes
+---
+
+# shenyu nginx 1.0.0-1
+
+### New Features
+
+- Support for listening to Apache ShenYu node changes using Zookeeper
+- Support for listening to Apache ShenYu node changes using ETCD.
+- Support for listening to Apache ShenYu node changes using Nacos
+- Support for listening to Apache ShenYu node changes using Consul
+- Add demo code to add the above.
+- Add a description of the documentation for the above.
diff --git a/i18n/zh/code.json b/i18n/zh/code.json
index 0d9d3ec573c..da97d1aa635 100755
--- a/i18n/zh/code.json
+++ b/i18n/zh/code.json
@@ -455,6 +455,9 @@
"Release Apache Shenyu client .NET 1.0.0": {
"message": "Apache Shenyu .NET 语言客户端 1.0.0 发布"
},
+ "Release Apache Shenyu Nginx 1.0.0-1": {
+ "message": "Apache Shenyu Ningx 1.0.0-1 发布"
+ },
"Events": {
"message": "事件"
},
@@ -527,6 +530,9 @@
"ShenYu client .NET Source Codes": {
"message": ".NET 客户端源码"
},
+ "ShenYu Nginx Source Codes": {
+ "message": "ShenYu Nginx 源码"
+ },
"Document List": {
"message": "文档列表"
},
diff --git
a/i18n/zh/docusaurus-plugin-content-docs-community/current/16-shenyu-nginx-release-guide.md
b/i18n/zh/docusaurus-plugin-content-docs-community/current/16-shenyu-nginx-release-guide.md
index 82570ad27a8..4d412d19882 100755
---
a/i18n/zh/docusaurus-plugin-content-docs-community/current/16-shenyu-nginx-release-guide.md
+++
b/i18n/zh/docusaurus-plugin-content-docs-community/current/16-shenyu-nginx-release-guide.md
@@ -434,7 +434,7 @@ Support cluster deployment, A/B Test, blue-green release.
Download Links: https://shenyu.apache.org/download/
-Release Notes:
https://github.com/apache/shenyu/shenyu-nginx/blob/main/RELEASE-NOTES.md
+Release Notes:
https://github.com/apache/shenyu-nginx/blob/main/RELEASE-NOTES.md
Website: https://shenyu.apache.org/
diff --git
a/i18n/zh/docusaurus-plugin-content-docs-event/current/nginx-1.0.0-1-release.md
b/i18n/zh/docusaurus-plugin-content-docs-event/current/nginx-1.0.0-1-release.md
new file mode 100644
index 00000000000..bb928d4052d
--- /dev/null
+++
b/i18n/zh/docusaurus-plugin-content-docs-event/current/nginx-1.0.0-1-release.md
@@ -0,0 +1,17 @@
+---
+title: shenyu nginx 1.0.0-1
+sidebar_position: 3
+keywords: ["release-notes"]
+description: release-notes
+---
+
+# shenyu nginx 1.0.0-1
+
+### New Features
+
+- 支持使用Zookeeper监听Apache ShenYu节点变化.
+- 支持使用ETCD监听Apache ShenYu节点变化.
+- 支持使用Nacos监听Apache ShenYu节点变化.
+- 支持使用Consul监听Apache ShenYu节点变化.
+- 增加以上实现的示例代码与测试.
+- 增加以上实现的文件描述.
diff --git a/shenyuNginx/index.md b/shenyuNginx/index.md
index b3054b33de0..e4da810e8eb 100644
--- a/shenyuNginx/index.md
+++ b/shenyuNginx/index.md
@@ -4,13 +4,25 @@ Apache ShenYu Nginx Module
This module provided SDK to watch available ShenYu instance list as upstream
nodes by Service Register Center for OpenResty.
1. [ETCD](#greeting-etcd) (Supported)
2. [Nacos](#greeting-nacos) (Supported)
-3. [Zookeeper](#greeting-zookeeper) (Supported)
-4. Consul (TODO)
+3. [Zookeeper](#greeting-zookeeper) (Supported)k
+4. [Consul](#greeting-consul) (Supported)
In the cluster mode, Apache ShenYu supports the deployment of multiple ShenYu
instances, which may have new instances joining or leaving at any time.
Hence, Apache ShenYu introduces Service Discovery modules to help client to
detect the available instances.
Currently, Apache ShenYu Bootstrap already supports Apache Zookeeper, Nacos,
Etcd, and consul. Client or LoadBalancer can get the available ShenYu instances
by those Service register center.
+Here provides a completed
[examples](https://github.com/apache/shenyu-nginx/tree/main/example).
+
+=======
+
+Here is a completed
[example](https://github.com/apache/shenyu-nginx/blob/main/example/etcd/nginx.conf)
working with ETCD.
+
+Here is a completed
[example](https://github.com/apache/shenyu-nginx/blob/main/example/nacos/nginx.conf)
working with Nacos.
+
+Here is a completed
[example](https://github.com/apache/shenyu-nginx/blob/main/example/consul/nginx.conf)
working with Consul.
+
+Here is a completed
[example](https://github.com/apache/shenyu-nginx/blob/main/example/zookeeper/nginx.conf)
working with Zookeeper.
+
## Getting Started
- Prerequisite:
@@ -66,17 +78,6 @@ upstream shenyu {
}
```
-Finally, restart OpenResty.
-
-```shell
-openresty -s reload
-```
-
-Here provides a completed
[examples](https://github.com/apache/shenyu-nginx/tree/main/example).
-
-=======
-
-Here is a completed
[example](https://github.com/apache/shenyu-nginx/blob/main/example/etcd/nginx.conf)
working with ETCD.
### Greeting Nacos
@@ -113,14 +114,6 @@ upstream shenyu {
}
```
-Finally, restart OpenResty.
-
-```shell
-openresty -s reload
-```
-
-Here is a completed
[example](https://github.com/apache/shenyu-nginx/blob/main/example/nacos/nginx.conf)
working with Nacos.
-
## Greeting Zookeeper
Modify the Nginx configure, create and initialize the ShenYu register to
connect to target register center.
@@ -151,13 +144,47 @@ Modify the upstream to enable to update upstream servers
dynamically. This case
}
```
+### Greeting Consul
+
+Modify the Nginx configure, create and initialize the ShenYu register to
connect to target register center.
+Listen for changes to the node via the consul watch event. Here is an example
of the consul configuration.
+
+```shell
+init_worker_by_lua_block {
+ local register = require "shenyu.register.consul";
+ register.init({
+ uri = "http://127.0.0.1:8500";,
+ path = "/v1/catalog/service/demo",
+ shenyu_storage = ngx.shared.shenyu_storage,
+ balancer_type = "chash",
+ })
+}
+```
+
+1. ``balancer_type`` specify the balancer. It has supported `chash` and `round
robin`.
+2. `uri` consul server address.
+3. `path` path of service.
+
+Modify the upstream to enable to update upstream servers dynamically. This
case will synchronize the ShenYu instance list with register center. And then
pick one up for handling the request.
+
+```shell
+
+ upstream shenyu {
+ server 0.0.0.1;
+ balancer_by_lua_block {
+ require("shenyu.register.consul").pick_and_set_peer()
+ }
+ }
+```
+
+## Finally
+
Finally, restart OpenResty.
```shell
openresty -s reload
```
-Here is a completed
[example](https://github.com/apache/shenyu-nginx/blob/main/example/zookeeper/nginx.conf)
working with Zookeeper.
## Contributor and Support
diff --git a/src/components/DownloadCompoent.tsx
b/src/components/DownloadCompoent.tsx
index 97b14ffe2cd..85cac083ca4 100644
--- a/src/components/DownloadCompoent.tsx
+++ b/src/components/DownloadCompoent.tsx
@@ -116,11 +116,24 @@ const data = [
}
}
],
+ },
+ {
+ title: translate({ message: 'ShenYu Nginx Source Codes' }),
+ versions: [
+ {
+ versionTitle: '1.0.0-1',
+ targets: {
+ 'tar':
'https://www.apache.org/dyn/closer.lua/shenyu/shenyu-nginx/1.0.0-1/shenyu-nginx-1.0.0-1-src.tar.gz',
+ 'asc':
'https://downloads.apache.org/shenyu/shenyu-nginx/1.0.0-1/shenyu-nginx-1.0.0-1-src.tar.gz.asc',
+ 'sha512':
'https://downloads.apache.org/shenyu/shenyu-nginx/1.0.0-1/shenyu-nginx-1.0.0-1-src.tar.gz.sha512',
+ }
+ }
+ ],
}
]
function DownloadCompoent() {
- const [showItem, setShowItem] = useState([false, false, false, false,
false]);
+ const [showItem, setShowItem] = useState([false, false, false, false,
false,false]);
const closeList = useCallback((e) => {
const { target } = e;
@@ -194,4 +207,4 @@ function DownloadCompoent() {
)
};
-export default DownloadCompoent;
\ No newline at end of file
+export default DownloadCompoent;
diff --git a/src/data/event.js b/src/data/event.js
index f8e30b697f8..7b6a4fe8c95 100644
--- a/src/data/event.js
+++ b/src/data/event.js
@@ -3,6 +3,12 @@ import Translate from "@docusaurus/Translate";
export default [
{
+ title: <Translate>Release Apache Shenyu Nginx 1.0.0-1</Translate>,
+ description:
+ "New Features \n 1. Support for listening to Apache ShenYu node
changes using Zookeeper. \n 2. Support for listening to Apache ShenYu node
changes using ETCD. \n 3. Support for listening to Apache ShenYu node changes
using Nacos. \n ......",
+ src: "nginx-1.0.0-1-release",
+ },
+ {
title: <Translate>Release Apache Shenyu client .NET 1.0.0</Translate>,
description:
"New Features \n 1. Support ShenYu Admin with http type Register to
ShenYu. \n 2. Support use Nacos type Register to ShenYu. \n 3. Support use
Consul type Register to ShenYu. \n ......",
