-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: spacewander <spacewanderlzx@gmail.com>
- Loading branch information
1 parent
4d60170
commit 11b5ec7
Showing
6 changed files
with
230 additions
and
1 deletion.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
--- | ||
title: External Plugin | ||
--- | ||
|
||
<!-- | ||
# | ||
# Licensed to the Apache Software Foundation (ASF) under one or more | ||
# contributor license agreements. See the NOTICE file distributed with | ||
# this work for additional information regarding copyright ownership. | ||
# The ASF licenses this file to You under the Apache License, Version 2.0 | ||
# (the "License"); you may not use this file except in compliance with | ||
# the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
# | ||
--> | ||
|
||
## What are external plugin and plugin runner | ||
|
||
APISIX supports writing plugins in Lua. This type of plugins will be executed | ||
inside APISIX. Sometimes you want to develop plugin in other languages, so APISIX | ||
provides sidecars that loading your plugins and run them when the requests hit | ||
APISIX. These sidecars are called plugin runners and your plugins are called | ||
external plugins. | ||
|
||
## How does it work | ||
|
||
![external-plugin](../../../assets/images/external-plugin.png) | ||
|
||
When you configure a plugin runner in APISIX, APISIX will run the plugin runner | ||
as a subprocess. The process will belong to the same user of the APISIX | ||
process. When we restart or reload APISIX, the plugin runner will be restarted too. | ||
|
||
Once you have configured `ext-plugin-*` plugins for a given route, the requests | ||
which hit the route will trigger RPC call from APISIX to the plugin runner via | ||
unix socket. | ||
|
||
The plugin runner will handle the RPC call, create a fake request at its side, | ||
run external plugins and return the result back to APISIX. | ||
|
||
The target external plugins and the execution order are configured in the `ext-plugin-*` | ||
plugins. Like other plugins, they can be enabled and reconfigured on the fly. | ||
|
||
## Supported plugin runners | ||
|
||
Java: https://github.com/apache/apisix-java-plugin-runner | ||
Go: https://github.com/apache/apisix-go-plugin-runner | ||
|
||
## Configuration for plugin runner in APISIX | ||
|
||
To run plugin runner in the prod, add the section below to `config.yaml`: | ||
|
||
```yaml | ||
ext-plugin: | ||
cmd: ["blah"] # replace it to the real runner executable according to the runner you choice | ||
``` | ||
Then APISIX will manage the runner as its subprocess. | ||
Note: APISIX can't manage the runner on the Mac. It is fine, we can run the runner by ourselves | ||
during development. | ||
During development, we want to run the runner separately so that we can restart it without | ||
restarting APISIX first. | ||
By specifying the environment variable `APISIX_LISTEN_ADDRESS`, we can force the runner to | ||
listen to a fixed address. | ||
For instance: | ||
|
||
```bash | ||
APISIX_LISTEN_ADDRESS=unix:/tmp/x.sock ./the_runner | ||
``` | ||
|
||
will force the runner to listen to `/tmp/x.sock`. | ||
|
||
Then you need to configure APISIX to send RPC to the fixed address: | ||
|
||
```yaml | ||
ext-plugin: | ||
# cmd: ["blah"] # don't configure the executable! | ||
path_for_test: "/tmp/x.sock" # without 'unix:' prefix | ||
``` | ||
|
||
In the prod environment, `path_for_test` should not be used and the unix socket | ||
path will be generated dynamically. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
title: ext-plugin-post-req | ||
--- | ||
|
||
<!-- | ||
# | ||
# Licensed to the Apache Software Foundation (ASF) under one or more | ||
# contributor license agreements. See the NOTICE file distributed with | ||
# this work for additional information regarding copyright ownership. | ||
# The ASF licenses this file to You under the Apache License, Version 2.0 | ||
# (the "License"); you may not use this file except in compliance with | ||
# the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
# | ||
--> | ||
|
||
`ext-plugin-post-req` is almost the same as `ext-plugin-pre-req`. | ||
|
||
The only difference is that it runs after executing builtin Lua plugins and | ||
before proxying to the upstream. | ||
|
||
See the documentation of [ext-plugin-pre-req](./ext-plugin-pre-req.md) for how to configure it. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
--- | ||
title: ext-plugin-pre-req | ||
--- | ||
|
||
<!-- | ||
# | ||
# Licensed to the Apache Software Foundation (ASF) under one or more | ||
# contributor license agreements. See the NOTICE file distributed with | ||
# this work for additional information regarding copyright ownership. | ||
# The ASF licenses this file to You under the Apache License, Version 2.0 | ||
# (the "License"); you may not use this file except in compliance with | ||
# the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
# | ||
--> | ||
|
||
## Summary | ||
|
||
- [**Name**](#name) | ||
- [**Attributes**](#attributes) | ||
- [**How To Enable**](#how-to-enable) | ||
- [**Test Plugin**](#test-plugin) | ||
- [**Disable Plugin**](#disable-plugin) | ||
|
||
## Name | ||
|
||
The `ext-plugin-pre-req` runs specific external plugins in the plugin runner, before | ||
executing any builtin Lua plugins. | ||
|
||
To know what is the plugin runner, see [external plugin](../external-plugin.md) section. | ||
|
||
The result of external plugins execution will affect the behavior of the current request. | ||
|
||
## Attributes | ||
|
||
| Name | Type | Requirement | Default | Valid | Description | | ||
| --------- | ------------- | ----------- | ---------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| conf | array | optional | | [{"name": "ext-plugin-A", "value": "{\"enable\":\"feature\"}"}] | The plugins list which will be executed at the plugin runner with their configuration | | ||
|
||
## How To Enable | ||
|
||
Here's an example, enable this plugin on the specified route: | ||
|
||
```shell | ||
curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' | ||
{ | ||
"uri": "/index.html", | ||
"plugins": { | ||
"ext-plugin-pre-req": { | ||
"conf" : [ | ||
{"name": "ext-plugin-A", "value": "{\"enable\":\"feature\"}"} | ||
] | ||
}, | ||
"upstream": { | ||
"type": "roundrobin", | ||
"nodes": { | ||
"39.97.63.215:80": 1 | ||
} | ||
} | ||
}' | ||
``` | ||
|
||
## Test Plugin | ||
|
||
Use curl to access: | ||
|
||
```shell | ||
curl -i http://127.0.0.1:9080/index.html | ||
``` | ||
|
||
You will see the configured plugin runner will be hit and plugin `ext-plugin-A` | ||
is executed at that side. | ||
|
||
## Disable Plugin | ||
|
||
When you want to disable this plugin, it is very simple, | ||
you can delete the corresponding json configuration in the plugin configuration, | ||
no need to restart the service, it will take effect immediately: | ||
|
||
```shell | ||
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' | ||
{ | ||
"uri": "/index.html", | ||
"upstream": { | ||
"type": "roundrobin", | ||
"nodes": { | ||
"39.97.63.215:80": 1 | ||
} | ||
} | ||
}' | ||
``` | ||
|
||
This plugin has been disabled now. It works for other plugins. |