[GitHub] [apisix] juzhiyuan commented on a change in pull request #4321: docs(ext-plugin): init docs

[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
+
+![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 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