This is an automated email from the ASF dual-hosted git repository.
juzhiyuan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new 95519bc0a docs: move "Plugin Config" to "Terminology" sec (#7553)
95519bc0a is described below
commit 95519bc0ab3497bdb5f9fe4baac050b252a10168
Author: Navendu Pottekkat <[email protected]>
AuthorDate: Thu Jul 28 06:29:07 2022 +0530
docs: move "Plugin Config" to "Terminology" sec (#7553)
Signed-off-by: Navendu Pottekkat <[email protected]>
---
docs/en/latest/config.json | 2 +-
.../{architecture-design => terminology}/plugin-config.md | 15 ++++++++++-----
docs/en/latest/terminology/plugin.md | 14 +++++++++-----
3 files changed, 20 insertions(+), 11 deletions(-)
diff --git a/docs/en/latest/config.json b/docs/en/latest/config.json
index 46c6ab4e9..cba5f934f 100644
--- a/docs/en/latest/config.json
+++ b/docs/en/latest/config.json
@@ -6,7 +6,6 @@
"label": "Architecture Design",
"items": [
"architecture-design/apisix",
- "architecture-design/plugin-config",
"architecture-design/debug-mode",
"architecture-design/deployment-role"
]
@@ -19,6 +18,7 @@
"terminology/consumer",
"terminology/global-rule",
"terminology/plugin",
+ "terminology/plugin-config",
"terminology/route",
"terminology/router",
"terminology/script",
diff --git a/docs/en/latest/architecture-design/plugin-config.md
b/docs/en/latest/terminology/plugin-config.md
similarity index 88%
rename from docs/en/latest/architecture-design/plugin-config.md
rename to docs/en/latest/terminology/plugin-config.md
index 075562f41..95d69df0c 100644
--- a/docs/en/latest/architecture-design/plugin-config.md
+++ b/docs/en/latest/terminology/plugin-config.md
@@ -1,5 +1,10 @@
---
title: Plugin Config
+keywords:
+ - API gateway
+ - Apache APISIX
+ - Plugin Config
+description: Plugin Config in Apache APISIX.
---
<!--
@@ -23,11 +28,10 @@ title: Plugin Config
Plugin Configs are used to extract commonly used [Plugin](./plugin.md)
configurations and can be bound directly to a [Route](./route.md).
-The example below illustrates how this can be used:
+The example below illustrates how to create a Plugin Config and bind it to a
Route:
```shell
-# create a plugin config
-$ curl http://127.0.0.1:9080/apisix/admin/plugin_configs/1 -H 'X-API-KEY:
edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
+curl http://127.0.0.1:9080/apisix/admin/plugin_configs/1 -H 'X-API-KEY:
edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
{
"desc": "blah",
"plugins": {
@@ -38,9 +42,10 @@ $ curl http://127.0.0.1:9080/apisix/admin/plugin_configs/1
-H 'X-API-KEY: edd1c9
}
}
}'
+```
-# bind it to route
-$ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY:
edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
+```shell
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY:
edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
{
"uris": ["/index.html"],
"plugin_config_id": 1,
diff --git a/docs/en/latest/terminology/plugin.md
b/docs/en/latest/terminology/plugin.md
index f5c81c2b4..bca3fe665 100644
--- a/docs/en/latest/terminology/plugin.md
+++ b/docs/en/latest/terminology/plugin.md
@@ -29,6 +29,8 @@ This represents the configuration of the plugins that are
executed during the HT
While configuring the same plugin, only one copy of the configuration is
valid. The order of precedence is always `Consumer` > `Route` > `Service`.
+:::
+
While [configuring
APISIX](./architecture-design/apisix.md#configuring-apisix), you can declare
the Plugins that are supported by the local APISIX node. This acts as a
whitelisting mechanism as Plugins that are not in this whitelist will be
automatically ignored. So, this feature can be used to temporarily turn
off/turn on specific plugins.
## Adding a Plugin
@@ -72,7 +74,7 @@ A warning level log as shown below indicates that the request
was rejected by th
ip-restriction exits with http status code 403
```
-## Plugin Common Configuration
+## Plugin common configuration
Some common configurations can be applied to the plugin configuration. For
example,
@@ -104,7 +106,7 @@ the configuration above means customizing the error
response from the jwt-auth p
This configuration example means that the `jwt-auth` plugin will only execute
if `version` in the request parameter equals `v2`.
-### Plugin Common Configuration Under `_meta`
+### Plugin common configuration under `_meta`
| Name | Type | Description |
|--------------|------|-------------|
@@ -112,7 +114,7 @@ This configuration example means that the `jwt-auth` plugin
will only execute if
| priority | integer | Custom plugin priority |
| filter | array | Depending on the requested parameters, it is decided at
runtime whether the plugin should be executed. List of variables to match for
filtering requests for conditional traffic split. It is in the format {variable
operator value}. For example, `{"arg_name", "==", "json"}`. The variables here
are consistent with Nginx internal variables. For details on supported
operators, please see
[lua-resty-expr](https://github.com/api7/lua-resty-expr#operator-list). |
-### Custom Plugin Priority
+### Custom Plugin priority
All plugins have a default priority, but it is possible to customize the
plugin priority to change the plugin's execution order.
@@ -143,12 +145,14 @@ The default priority of serverless-pre-function is 10000,
and the default priori
The above configuration means setting the priority of the
serverless-pre-function plugin to -2000 and the priority of the
serverless-post-function plugin to 10000. The serverless-post-function plugin
will be executed first, and serverless-pre-function plugin will be executed
next.
-Note:
+:::note
- Custom plugin priority only affects the current object(route, service ...)
of the plugin instance binding, not all instances of that plugin. For example,
if the above plugin configuration belongs to Route A, the order of execution of
the plugins serverless-post-function and serverless-post-function on Route B
will not be affected and the default priority will be used.
- Custom plugin priority does not apply to the rewrite phase of some plugins
configured on the consumer. The rewrite phase of plugins configured on the
route will be executed first, and then the rewrite phase of plugins (exclude
auth plugins) from the consumer will be executed.
-## Hot Reload
+:::
+
+## Hot reload
APISIX Plugins are hot-loaded. This means that there is no need to restart the
service if you add, delete, modify plugins, or even if you update the plugin
code. To hot-reload, you can send an HTTP request through the [Admin
API](../admin-api.md):
