[GitHub] [apisix-java-plugin-runner] tzssangglass commented on a change in pull request #95: docs: add zh Quick Start doc

2021-12-12 Thread GitBox 


tzssangglass commented on a change in pull request #95:
URL: 
https://github.com/apache/apisix-java-plugin-runner/pull/95#discussion_r767388124



##
File path: docs/zh/Quick Start.md
##
@@ -0,0 +1,110 @@
+### Quick Start
+
+ 一、准备工作
+
+* JDK 8
+
+* Clone the 
[apisix-java-plugin-runner](https://github.com/apache/apisix-java-plugin-runner)
 project.
+
+ 二、开发扩展插件过滤器
+
+在`runner-plugin` 模块 `org.apache.apisix.plugin.runner.filter` 
包下编写过滤器处理请求，过滤器要实现`PluginFilter` 接口，可以参考 `apisix-runner-sample` 
模块下的样例，官方提供了两个样例还是很全面的，一个是请求重写[RewriteRequestDemoFilter](https://github.com/apache/apisix-java-plugin-runner/blob/main/sample/src/main/java/org/apache/apisix/plugin/runner/filter/RewriteRequestDemoFilter.java)，一个是请求拦截[StopRequestDemoFilter](https://github.com/apache/apisix-java-plugin-runner/blob/main/sample/src/main/java/org/apache/apisix/plugin/runner/filter/StopRequestDemoFilter.java)。
+
+```java
+@Component
+public class CheckTokenFilter implements PluginFilter {
+@Override
+public String name() {
+return "CheckTokenFilter";
+}
+
+@Override
+public Mono filter(HttpRequest request, HttpResponse response, 
PluginFilterChain chain) {
+/*
+ * todo your business here
+ */
+
+
+return chain.filter(request, response);
+}
+}
+```
+
+ 三、部署
+
+插件写好后怎么部署是关键，apisix-java-plugin-runner 与 APISIX 用 Unix Domain Socket 进行进程内通讯，
+所以他们要部署在一个服务实例，并且APISIX启动的过程中会带着apisix-java-plugin-runner一起启动，如果是容器化部署就必须在一个容器里运行。
+
+所以如果是容器部署就需要把apisix-java-plugin-runner 与 APISIX 生成在一个docker image里。

Review comment:
   @cws1981 




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

[GitHub] [apisix-java-plugin-runner] tzssangglass commented on a change in pull request #95: docs: add zh Quick Start doc

2021-12-12 Thread GitBox 


tzssangglass commented on a change in pull request #95:
URL: 
https://github.com/apache/apisix-java-plugin-runner/pull/95#discussion_r767387952



##
File path: docs/zh/Quick Start.md
##
@@ -0,0 +1,110 @@
+### Quick Start
+
+ 一、准备工作
+
+* JDK 8
+
+* Clone the 
[apisix-java-plugin-runner](https://github.com/apache/apisix-java-plugin-runner)
 project.
+
+ 二、开发扩展插件过滤器
+
+在`runner-plugin` 模块 `org.apache.apisix.plugin.runner.filter` 
包下编写过滤器处理请求，过滤器要实现`PluginFilter` 接口，可以参考 `apisix-runner-sample` 
模块下的样例，官方提供了两个样例还是很全面的，一个是请求重写[RewriteRequestDemoFilter](https://github.com/apache/apisix-java-plugin-runner/blob/main/sample/src/main/java/org/apache/apisix/plugin/runner/filter/RewriteRequestDemoFilter.java)，一个是请求拦截[StopRequestDemoFilter](https://github.com/apache/apisix-java-plugin-runner/blob/main/sample/src/main/java/org/apache/apisix/plugin/runner/filter/StopRequestDemoFilter.java)。
+
+```java
+@Component
+public class CheckTokenFilter implements PluginFilter {
+@Override
+public String name() {
+return "CheckTokenFilter";
+}
+
+@Override
+public Mono filter(HttpRequest request, HttpResponse response, 
PluginFilterChain chain) {
+/*
+ * todo your business here
+ */
+
+
+return chain.filter(request, response);
+}
+}
+```
+
+ 三、部署
+
+插件写好后怎么部署是关键，apisix-java-plugin-runner 与 APISIX 用 Unix Domain Socket 进行进程内通讯，
+所以他们要部署在一个服务实例，并且APISIX启动的过程中会带着apisix-java-plugin-runner一起启动，如果是容器化部署就必须在一个容器里运行。
+
+所以如果是容器部署就需要把apisix-java-plugin-runner 与 APISIX 生成在一个docker image里。

Review comment:
   can you see this: 
   
![image](https://user-images.githubusercontent.com/30819887/145746798-c925ed46-125a-4b84-a1d4-167032c391af.png)
   I suspect that github has eaten this




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

[GitHub] [apisix-java-plugin-runner] tzssangglass commented on a change in pull request #95: docs: add zh Quick Start doc

2021-12-12 Thread GitBox 


tzssangglass commented on a change in pull request #95:
URL: 
https://github.com/apache/apisix-java-plugin-runner/pull/95#discussion_r767292344



##
File path: docs/zh/Quick Start.md
##
@@ -0,0 +1,114 @@
+## 快速开始
+
+### 准备工作
+
+* JDK 8
+* APISIX 2.10.0
+* Clone the 
[apisix-java-plugin-runner](https://github.com/apache/apisix-java-plugin-runner)
 project.
+
+### 开发扩展插件过滤器
+
+在 
[runner-plugin](https://github.com/apache/apisix-java-plugin-runner/tree/main/runner-plugin/src/main/java/org/apache/apisix/plugin/runner/filter)
 模块的 `org.apache.apisix.plugin.runner.filter` 包下编写过滤器处理请求，过滤器要实现 `PluginFilter` 
接口，参考 `apisix-runner-sample` 模块下的样例：
+* 
请求重写[RewriteRequestDemoFilter](https://github.com/apache/apisix-java-plugin-runner/blob/main/sample/src/main/java/org/apache/apisix/plugin/runner/filter/RewriteRequestDemoFilter.java)
+* 
请求拦截[StopRequestDemoFilter](https://github.com/apache/apisix-java-plugin-runner/blob/main/sample/src/main/java/org/apache/apisix/plugin/runner/filter/StopRequestDemoFilter.java)。

Review comment:
   ```suggestion
   * 
请求拦截[StopRequestDemoFilter](https://github.com/apache/apisix-java-plugin-runner/blob/main/sample/src/main/java/org/apache/apisix/plugin/runner/filter/StopRequestDemoFilter.java)
   ```

##
File path: docs/zh/Quick Start.md
##
@@ -0,0 +1,114 @@
+## 快速开始
+
+### 准备工作
+
+* JDK 8
+* APISIX 2.10.0
+* Clone the 
[apisix-java-plugin-runner](https://github.com/apache/apisix-java-plugin-runner)
 project.
+
+### 开发扩展插件过滤器
+
+在 
[runner-plugin](https://github.com/apache/apisix-java-plugin-runner/tree/main/runner-plugin/src/main/java/org/apache/apisix/plugin/runner/filter)
 模块的 `org.apache.apisix.plugin.runner.filter` 包下编写过滤器处理请求，过滤器要实现 `PluginFilter` 
接口，参考 `apisix-runner-sample` 模块下的样例：
+* 
请求重写[RewriteRequestDemoFilter](https://github.com/apache/apisix-java-plugin-runner/blob/main/sample/src/main/java/org/apache/apisix/plugin/runner/filter/RewriteRequestDemoFilter.java)
+* 
请求拦截[StopRequestDemoFilter](https://github.com/apache/apisix-java-plugin-runner/blob/main/sample/src/main/java/org/apache/apisix/plugin/runner/filter/StopRequestDemoFilter.java)。
+
+
+```java
+@Component
+public class CheckTokenFilter implements PluginFilter {
+@Override
+public String name() {
+return "CheckTokenFilter";
+}
+
+@Override
+public Mono filter(HttpRequest request, HttpResponse response, 
PluginFilterChain chain) {
+/*
+ * todo your business here
+ */
+
+
+return chain.filter(request, response);
+}
+}
+```
+
+### 部署
+
+apisix-java-plugin-runner 与 APISIX 用 `Unix Domain Socket` 
进行进程间通讯，需要部署在同一个宿主环境。apisix-java-plugin-runner 的生命周期由 APISIX 
管理，如果是容器化部署，apisix-java-plugin-runner 与 APISIX 必须部署在同一个容器中。
+
+所以如果是容器部署就需要把apisix-java-plugin-runner 与 APISIX 生成在一个docker image里。
+下面是如何构建包含 apisix-java-plugin-runner 与 APISIX 的容器镜像的步骤：
+
+先构建 `apisix-java-plugin-runner` 的可执行 jar
+
+```bash
+./mvnw package
+```
+
+构建完成，你会在 `dist` 目录看见构建产物
+
+```
+apache-apisix-java-plugin-runner-0.1.0-bin.tar.gz
+```
+
+在`dist`目录添加`Dockerfile`文件
+
+```dockerfile
+FROM apache/apisix:2.10.0-alpine
+
+RUN sed -i "s/dl-cdn.alpinelinux.org/mirrors.aliyun.com/g" 
/etc/apk/repositories && apk add --no-cache openjdk8-jre
+
+ADD aapache-apisix-java-plugin-runner-0.1.0-bin.tar.gz /usr/local/
+
+```
+
+然后构建容器镜像
+
+```shell
+ cd dist
+ docker build -t apache/apisix:2.10.0-alpine-with-java-plugin .
+```
+
+最后在 APISIX 的 `config.yaml` 文件中增加配置，如下
+
+```yaml
+ext-plugin:
+  cmd: ['java', '-jar', '-Xmx4g', '-Xms4g', 
'/usr/local/apisix-runner-bin/apisix-java-plugin-runner.jar']

Review comment:
   ```suggestion
 cmd: ['java', '-jar', '-Xmx4g', '-Xms4g', 
'/path/to/apisix-runner-bin/apisix-java-plugin-runner.jar']
   ```

##
File path: docs/zh/Quick Start.md
##
@@ -0,0 +1,114 @@
+## 快速开始
+
+### 准备工作
+
+* JDK 8
+* APISIX 2.10.0
+* Clone the 
[apisix-java-plugin-runner](https://github.com/apache/apisix-java-plugin-runner)
 project.

Review comment:
   ```suggestion
   * Clone the 
[apisix-java-plugin-runner](https://github.com/apache/apisix-java-plugin-runner)
 project。
   ```

##
File path: docs/zh/Quick Start.md
##
@@ -0,0 +1,114 @@
+## 快速开始
+
+### 准备工作
+
+* JDK 8
+* APISIX 2.10.0
+* Clone the 
[apisix-java-plugin-runner](https://github.com/apache/apisix-java-plugin-runner)
 project.
+
+### 开发扩展插件过滤器
+
+在 
[runner-plugin](https://github.com/apache/apisix-java-plugin-runner/tree/main/runner-plugin/src/main/java/org/apache/apisix/plugin/runner/filter)
 模块的 `org.apache.apisix.plugin.runner.filter` 包下编写过滤器处理请求，过滤器要实现 `PluginFilter` 
接口，参考 `apisix-runner-sample` 模块下的样例：
+* 
请求重写[RewriteRequestDemoFilter](https://github.com/apache/apisix-java-plugin-runner/blob/main/sample/src/main/java/org/apache/apisix/plugin/runner/filter/RewriteRequestDemoFilter.java)
+*

[GitHub] [apisix-java-plugin-runner] tzssangglass commented on a change in pull request #95: docs: add zh Quick Start doc

2021-12-09 Thread GitBox 


tzssangglass commented on a change in pull request #95:
URL: 
https://github.com/apache/apisix-java-plugin-runner/pull/95#discussion_r765800772



##
File path: docs/zh/Quick Start.md
##
@@ -0,0 +1,110 @@
+### Quick Start
+
+ 一、准备工作

Review comment:
   ```suggestion
   ### 准备工作
   ```

##
File path: docs/zh/Quick Start.md
##
@@ -0,0 +1,110 @@
+### Quick Start
+
+ 一、准备工作
+
+* JDK 8
+
+* Clone the 
[apisix-java-plugin-runner](https://github.com/apache/apisix-java-plugin-runner)
 project.
+
+ 二、开发扩展插件过滤器
+
+在`runner-plugin` 模块 `org.apache.apisix.plugin.runner.filter` 
包下编写过滤器处理请求，过滤器要实现`PluginFilter` 接口，可以参考 `apisix-runner-sample` 
模块下的样例，官方提供了两个样例还是很全面的，一个是请求重写[RewriteRequestDemoFilter](https://github.com/apache/apisix-java-plugin-runner/blob/main/sample/src/main/java/org/apache/apisix/plugin/runner/filter/RewriteRequestDemoFilter.java)，一个是请求拦截[StopRequestDemoFilter](https://github.com/apache/apisix-java-plugin-runner/blob/main/sample/src/main/java/org/apache/apisix/plugin/runner/filter/StopRequestDemoFilter.java)。
+
+```java
+@Component
+public class CheckTokenFilter implements PluginFilter {
+@Override
+public String name() {
+return "CheckTokenFilter";
+}
+
+@Override
+public Mono filter(HttpRequest request, HttpResponse response, 
PluginFilterChain chain) {
+/*
+ * todo your business here
+ */
+
+
+return chain.filter(request, response);
+}
+}
+```
+
+ 三、部署
+
+插件写好后怎么部署是关键，apisix-java-plugin-runner 与 APISIX 用 Unix Domain Socket 进行进程内通讯，
+所以他们要部署在一个服务实例，并且APISIX启动的过程中会带着apisix-java-plugin-runner一起启动，如果是容器化部署就必须在一个容器里运行。
+
+所以如果是容器部署就需要把apisix-java-plugin-runner 与 APISIX 生成在一个docker image里。
+
+先打包`apisix-java-plugin-runner`

Review comment:
   ```suggestion
   先构建 `apisix-java-plugin-runner` 的可执行 jar
   ```

##
File path: docs/zh/Quick Start.md
##
@@ -0,0 +1,110 @@
+### Quick Start
+
+ 一、准备工作
+
+* JDK 8
+
+* Clone the 
[apisix-java-plugin-runner](https://github.com/apache/apisix-java-plugin-runner)
 project.
+
+ 二、开发扩展插件过滤器
+
+在`runner-plugin` 模块 `org.apache.apisix.plugin.runner.filter` 
包下编写过滤器处理请求，过滤器要实现`PluginFilter` 接口，可以参考 `apisix-runner-sample` 
模块下的样例，官方提供了两个样例还是很全面的，一个是请求重写[RewriteRequestDemoFilter](https://github.com/apache/apisix-java-plugin-runner/blob/main/sample/src/main/java/org/apache/apisix/plugin/runner/filter/RewriteRequestDemoFilter.java)，一个是请求拦截[StopRequestDemoFilter](https://github.com/apache/apisix-java-plugin-runner/blob/main/sample/src/main/java/org/apache/apisix/plugin/runner/filter/StopRequestDemoFilter.java)。
+
+```java
+@Component
+public class CheckTokenFilter implements PluginFilter {
+@Override
+public String name() {
+return "CheckTokenFilter";
+}
+
+@Override
+public Mono filter(HttpRequest request, HttpResponse response, 
PluginFilterChain chain) {
+/*
+ * todo your business here
+ */
+
+
+return chain.filter(request, response);
+}
+}
+```
+
+ 三、部署
+
+插件写好后怎么部署是关键，apisix-java-plugin-runner 与 APISIX 用 Unix Domain Socket 进行进程内通讯，
+所以他们要部署在一个服务实例，并且APISIX启动的过程中会带着apisix-java-plugin-runner一起启动，如果是容器化部署就必须在一个容器里运行。

Review comment:
   ```suggestion
   apisix-java-plugin-runner 与 APISIX 用 `Unix Domain Socket` 
进行进程间通讯，需要部署在同一个宿主环境。apisix-java-plugin-runner 的生命周期由 APISIX 
管理，如果是容器化部署，apisix-java-plugin-runner 与 APISIX 必须部署在同一个容器中。
   ```

##
File path: docs/zh/Quick Start.md
##
@@ -0,0 +1,110 @@
+### Quick Start
+
+ 一、准备工作

Review comment:
   other headings also need to be changed

##
File path: docs/zh/Quick Start.md
##
@@ -0,0 +1,110 @@
+### Quick Start
+
+ 一、准备工作
+
+* JDK 8
+
+* Clone the 
[apisix-java-plugin-runner](https://github.com/apache/apisix-java-plugin-runner)
 project.
+
+ 二、开发扩展插件过滤器
+
+在`runner-plugin` 模块 `org.apache.apisix.plugin.runner.filter` 
包下编写过滤器处理请求，过滤器要实现`PluginFilter` 接口，可以参考 `apisix-runner-sample` 
模块下的样例，官方提供了两个样例还是很全面的，一个是请求重写[RewriteRequestDemoFilter](https://github.com/apache/apisix-java-plugin-runner/blob/main/sample/src/main/java/org/apache/apisix/plugin/runner/filter/RewriteRequestDemoFilter.java)，一个是请求拦截[StopRequestDemoFilter](https://github.com/apache/apisix-java-plugin-runner/blob/main/sample/src/main/java/org/apache/apisix/plugin/runner/filter/StopRequestDemoFilter.java)。
+
+```java
+@Component
+public class CheckTokenFilter implements PluginFilter {
+@Override
+public String name() {
+return "CheckTokenFilter";
+}
+
+@Override
+public Mono filter(HttpRequest request, HttpResponse response, 
PluginFilterChain chain) {
+/*
+ * todo your business here
+ */
+
+
+return chain.filter(request, response);
+}
+}
+```
+
+ 三、部署
+
+插件写好后怎么部署是关键，apisix-java-plugin-runner 与 APISIX 用 Unix Domain Socket 进行进程内通讯，
+所以他们要部署在一个服务实例，并且APISIX启动的过程中会带着apisix-java-plugin-runner一起启动，如果是容器化部署就必须在一个容器里运行。
+