Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: improve quick start document #213

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

Merged
merged 1 commit into from
Nov 9, 2022
Merged

docs: improve quick start document #213

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 15 additions & 10 deletions docs/zh/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,10 @@ public class CheckTokenFilter implements PluginFilter {
}

@Override
public Mono<Void> filter(HttpRequest request, HttpResponse response, PluginFilterChain chain) {
public void filter(HttpRequest request, HttpResponse response, PluginFilterChain chain) {
/*
* todo your business here
*/


return chain.filter(request, response);
}
}
```
Expand All @@ -48,18 +45,17 @@ apisix-java-plugin-runner 与 APISIX 用 `Unix Domain Socket` 进行进程间通
构建完成，你会在 `dist` 目录看见构建产物

```
apache-apisix-java-plugin-runner-0.1.0-bin.tar.gz
apache-apisix-java-plugin-runner-${your_plugin_version}-bin.tar.gz
```

在`dist`目录添加`Dockerfile`文件

```dockerfile
FROM apache/apisix:${version}-alpine

RUN sed -i "s/dl-cdn.alpinelinux.org/mirrors.aliyun.com/g" /etc/apk/repositories && apk add --no-cache openjdk8-jre
FROM apache/apisix:${version}-debian

ADD apache-apisix-java-plugin-runner-0.1.0-bin.tar.gz /usr/local/
RUN apt -y install openjdk-11-jdk
Copy link
Member

@tzssangglass tzssangglass Nov 8, 2022

Choose a reason for hiding this comment

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

could we use the base image with jdk 11?

Copy link
Contributor Author

@OrezzerO OrezzerO Nov 9, 2022

Choose a reason for hiding this comment

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

I use the image of apisix , and jdk should in the same image. If i use the base image with jdk , I have to install apisix .


ADD apache-apisix-java-plugin-runner-${your_plugin_version}-SNAPSHOT-bin.tar.gz /usr/local/
```

然后构建容器镜像
Expand All @@ -73,11 +69,20 @@ ADD apache-apisix-java-plugin-runner-0.1.0-bin.tar.gz /usr/local/

```yaml
ext-plugin:
cmd: ['java', '-jar', '-Xmx4g', '-Xms4g', '/path/to/apisix-runner-bin/apisix-java-plugin-runner.jar']
cmd: ['java', '-jar', '-Xmx4g', '-Xms4g', '/usr/local/apisix-runner-bin/apisix-java-plugin-runner.jar']
```

构建完成的 `apache/apisix:${version}-alpine-with-java-plugin` 镜像内即包含 APISIX 与 apisix-java-plugun-runner。

### 调试
如果需要调试插件, 可以将上述 ext-plugin 配置中添加调试参数:
```yaml
ext-plugin:
cmd: ['java', '-jar', '-Xmx4g', '-Xms4g','-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005', '/usr/local/apisix-runner-bin/apisix-java-plugin-runner.jar']
```

就可以通过 Docker 的 5005 端口远程调试插件。

### 使用插件

配置路由
Expand Down