You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2021/05/27 08:01:35 UTC
[GitHub] [apisix] spacewander opened a new pull request #4321: docs(ext-plugin): init docs
spacewander opened a new pull request #4321:
URL: https://github.com/apache/apisix/pull/4321
Signed-off-by: spacewander <sp...@gmail.com>
### What this PR does / why we need it:
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->
### Pre-submission checklist:
* [x] Did you explain what problem does this PR solve? Or what new features have been added?
* [ ] Have you added corresponding test cases?
* [x] Have you modified the corresponding document?
* [ ] Is this PR backward compatible? **If it is not backward compatible, please discuss on the [mailing list](https://github.com/apache/apisix/tree/master#community) first**
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] tokers merged pull request #4321: docs(ext-plugin): init docs
Posted by GitBox <gi...@apache.org>.
tokers merged pull request #4321:
URL: https://github.com/apache/apisix/pull/4321
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] nic-chen commented on a change in pull request #4321: docs(ext-plugin): init docs
Posted by GitBox <gi...@apache.org>.
nic-chen commented on a change in pull request #4321:
URL: https://github.com/apache/apisix/pull/4321#discussion_r641839604
##########
File path: docs/en/latest/plugins/ext-plugin-pre-req.md
##########
@@ -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 and their configuration |
Review comment:
with their configurations?
##########
File path: docs/en/latest/plugins/ext-plugin-pre-req.md
##########
@@ -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 and 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 the serverless plugin, it is very simple,
Review comment:
serverless —> external
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] juzhiyuan commented on a change in pull request #4321: docs(ext-plugin): init docs
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #4321:
URL: https://github.com/apache/apisix/pull/4321#discussion_r641945236
##########
File path: docs/en/latest/external-plugin.md
##########
@@ -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
+
+
+
+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 PRC 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`:
+
+```
Review comment:
```suggestion
```yaml
```
##########
File path: docs/en/latest/external-plugin.md
##########
@@ -0,0 +1,91 @@
+---
+title: external plugin
Review comment:
```suggestion
title: External Plugin
```
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] tokers commented on a change in pull request #4321: docs(ext-plugin): init docs
Posted by GitBox <gi...@apache.org>.
tokers commented on a change in pull request #4321:
URL: https://github.com/apache/apisix/pull/4321#discussion_r642031556
##########
File path: docs/en/latest/external-plugin.md
##########
@@ -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
+
+
+
+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 PRC call, create a fake request at its side,
Review comment:
```suggestion
The plugin runner will handle the RPC call, create a fake request at its side,
```
--
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org