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/02/09 06:41:28 UTC
[GitHub] [apisix] spacewander opened a new pull request #3567: feat: add plugin config
spacewander opened a new pull request #3567:
URL: https://github.com/apache/apisix/pull/3567
Fix #3532
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?
* [x] 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] spacewander commented on a change in pull request #3567: feat: add plugin config
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #3567:
URL: https://github.com/apache/apisix/pull/3567#discussion_r579635201
##########
File path: apisix/cli/etcd.lua
##########
@@ -251,7 +251,7 @@ function _M.init(env, args)
for _, dir_name in ipairs({"/routes", "/upstreams", "/services",
"/plugins", "/consumers", "/node_status",
"/ssl", "/global_rules", "/stream_routes",
- "/proto", "/plugin_metadata"}) do
+ "/proto", "/plugin_metadata", "/plugin_configs"}) do
Review comment:
After we can sync etcd data in that phase.
----------------------------------------------------------------
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] membphis commented on pull request #3567: feat: add plugin config
Posted by GitBox <gi...@apache.org>.
membphis commented on pull request #3567:
URL: https://github.com/apache/apisix/pull/3567#issuecomment-782633819
merged, many thx
----------------------------------------------------------------
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] membphis merged pull request #3567: feat: add plugin config
Posted by GitBox <gi...@apache.org>.
membphis merged pull request #3567:
URL: https://github.com/apache/apisix/pull/3567
----------------------------------------------------------------
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 #3567: feat: add plugin config
Posted by GitBox <gi...@apache.org>.
tokers commented on a change in pull request #3567:
URL: https://github.com/apache/apisix/pull/3567#discussion_r579642226
##########
File path: apisix/admin/plugin_config.lua
##########
@@ -0,0 +1,173 @@
+--
+-- 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.
+--
+local core = require("apisix.core")
+local utils = require("apisix.admin.utils")
+local schema_plugin = require("apisix.admin.plugins").check_schema
+local type = type
+local tostring = tostring
+
+
+local _M = {
+}
+
+
+local function check_conf(id, conf, need_id)
+ if not conf then
+ return nil, {error_msg = "missing configurations"}
+ end
+
+ id = id or conf.id
+ if need_id and not id then
+ return nil, {error_msg = "missing id"}
+ end
+
+ if not need_id and id then
+ return nil, {error_msg = "wrong id, do not need it"}
+ end
+
+ if need_id and conf.id and tostring(conf.id) ~= tostring(id) then
+ return nil, {error_msg = "wrong id"}
+ end
+
+ conf.id = id
+
+ core.log.info("conf: ", core.json.delay_encode(conf))
+ local ok, err = core.schema.check(core.schema.global_rule, conf)
+ if not ok then
+ return nil, {error_msg = "invalid configuration: " .. err}
+ end
+
+ local ok, err = schema_plugin(conf.plugins)
+ if not ok then
+ return nil, {error_msg = err}
+ end
+
+ return true
+end
+
+
+function _M.put(id, conf)
+ local ok, err = check_conf(id, conf, true)
+ if not ok then
+ return 400, err
+ end
+
+ local key = "/plugin_configs/" .. id
+
+ local ok, err = utils.inject_conf_with_prev_conf("route", key, conf)
+ if not ok then
+ return 500, {error_msg = err}
+ end
+
+ local res, err = core.etcd.set(key, conf)
+ if not res then
+ core.log.error("failed to put global rule[", key, "]: ", err)
+ return 500, {error_msg = err}
+ end
+
+ return res.status, res.body
+end
+
+
+function _M.get(id)
+ local key = "/plugin_configs"
+ if id then
+ key = key .. "/" .. id
+ end
+ local res, err = core.etcd.get(key, not id)
+ if not res then
+ core.log.error("failed to get global rule[", key, "]: ", err)
+ return 500, {error_msg = err}
+ end
+
+ return res.status, res.body
+end
+
+
+function _M.delete(id)
+ local key = "/plugin_configs/" .. id
+ local res, err = core.etcd.delete(key)
+ if not res then
+ core.log.error("failed to delete global rule[", key, "]: ", err)
Review comment:
Typo: should be "failed to delete plugin_config"
##########
File path: t/admin/plugin-configs.t
##########
@@ -0,0 +1,309 @@
+#
+# 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.
+#
+use t::APISIX 'no_plan';
+
+repeat_each(1);
+no_long_string();
+no_root_location();
+no_shuffle();
+log_level("info");
+
+add_block_preprocessor(sub {
+ my ($block) = @_;
+
+ if (!$block->request) {
+ $block->set_value("request", "GET /t");
+ }
+
+ if (!$block->no_error_log) {
+ $block->set_value("no_error_log", "[error]\n[alert]");
+ }
+});
+
+run_tests;
+
+__DATA__
+
+=== TEST 1: PUT
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local etcd = require("apisix.core.etcd")
+ local code, body = t('/apisix/admin/plugin_configs/1',
+ ngx.HTTP_PUT,
+ [[{
+ "plugins": {
+ "limit-count": {
+ "count": 2,
+ "time_window": 60,
+ "rejected_code": 503,
+ "key": "remote_addr"
+ }
+ }
+ }]],
+ [[{
+ "node": {
+ "value": {
+ "plugins": {
+ "limit-count": {
+ "count": 2,
+ "time_window": 60,
+ "rejected_code": 503,
+ "key": "remote_addr"
+ }
+ }
+ },
+ "key": "/apisix/plugin_configs/1"
+ },
+ "action": "set"
+ }]]
+ )
+
+ ngx.status = code
+ ngx.say(body)
+
+ local res = assert(etcd.get('/plugin_configs/1'))
+ local create_time = res.body.node.value.create_time
+ assert(create_time ~= nil, "create_time is nil")
+ local update_time = res.body.node.value.update_time
+ assert(update_time ~= nil, "update_time is nil")
+ }
+ }
+--- response_body
+passed
+
+
+
+=== TEST 2: GET
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/plugin_configs/1',
+ ngx.HTTP_GET,
+ nil,
+ [[{
+ "node": {
+ "value": {
+ "plugins": {
+ "limit-count": {
+ "count": 2,
+ "time_window": 60,
+ "rejected_code": 503,
+ "key": "remote_addr"
+ }
+ }
+ },
+ "key": "/apisix/plugin_configs/1"
+ },
+ "action": "get"
+ }]]
+ )
+
+ ngx.status = code
+ ngx.say(body)
+ }
+ }
+--- response_body
+passed
+
+
+
+=== TEST 3: GET all
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/plugin_configs',
+ ngx.HTTP_GET,
+ nil,
+ [[{
+ "node": {
+ "dir": true,
+ "nodes": [
+ {
+ "key": "/apisix/plugin_configs/1",
+ "value": {
+ "plugins": {
+ "limit-count": {
+ "time_window": 60,
+ "policy": "local",
+ "count": 2,
+ "key": "remote_addr",
+ "rejected_code": 503
+ }
+ }
+ }
+ }
+ ],
+ "key": "/apisix/plugin_configs"
+ },
+ "action": "get"
+ }]]
+ )
+
+ ngx.status = code
+ ngx.say(body)
+ }
+ }
+--- response_body
+passed
+
+
+
+=== TEST 4: PATCH
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local etcd = require("apisix.core.etcd")
+ local res = assert(etcd.get('/plugin_configs/1'))
+ local prev_create_time = res.body.node.value.create_time
+ assert(prev_create_time ~= nil, "create_time is nil")
+ local prev_update_time = res.body.node.value.update_time
+ assert(prev_update_time ~= nil, "update_time is nil")
+ ngx.sleep(1)
+
+ local code, body = t('/apisix/admin/plugin_configs/1',
+ ngx.HTTP_PATCH,
+ [[{
+ "plugins": {
+ "limit-count": {
+ "count": 3,
+ "time_window": 60,
+ "rejected_code": 503,
+ "key": "remote_addr"
+ }
+ }}]],
+ [[{
+ "node": {
+ "value": {
+ "plugins": {
+ "limit-count": {
+ "count": 3,
+ "time_window": 60,
+ "rejected_code": 503,
+ "key": "remote_addr"
+ }
+ }
+ },
+ "key": "/apisix/plugin_configs/1"
+ },
+ "action": "compareAndSwap"
+ }]]
+ )
+
+ ngx.status = code
+ ngx.say(body)
+
+ local res = assert(etcd.get('/plugin_configs/1'))
+ local create_time = res.body.node.value.create_time
+ assert(prev_create_time == create_time, "create_time mismatched")
+ local update_time = res.body.node.value.update_time
+ assert(update_time ~= nil, "update_time is nil")
+ assert(prev_update_time ~= update_time, "update_time should be changed")
+ }
+ }
+--- response_body
+passed
+
+
+
+=== TEST 5: PATCH (sub path)
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local etcd = require("apisix.core.etcd")
+ local res = assert(etcd.get('/plugin_configs/1'))
+ local prev_create_time = res.body.node.value.create_time
+ assert(prev_create_time ~= nil, "create_time is nil")
+ local prev_update_time = res.body.node.value.update_time
+ assert(prev_update_time ~= nil, "update_time is nil")
+ ngx.sleep(1)
+
+ local code, body = t('/apisix/admin/plugin_configs/1/plugins',
+ ngx.HTTP_PATCH,
+ [[{
+ "limit-count": {
Review comment:
Should use some different parameters for `limit-count` since the value is totally same as the one in test case 4.
##########
File path: doc/architecture-design.md
##########
@@ -614,6 +615,129 @@ curl https://{apisix_listen_address}/apisix/admin/global_rules
[Back to top](#table-of-contents)
+## Plugin Config
+
+To reuse common plugin configurations, you can exact them into a plugin config and
Review comment:
`exact` should be `extract`?
----------------------------------------------------------------
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] spacewander commented on a change in pull request #3567: feat: add plugin config
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #3567:
URL: https://github.com/apache/apisix/pull/3567#discussion_r579648191
##########
File path: t/admin/plugin-configs.t
##########
@@ -0,0 +1,309 @@
+#
+# 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.
+#
+use t::APISIX 'no_plan';
+
+repeat_each(1);
+no_long_string();
+no_root_location();
+no_shuffle();
+log_level("info");
+
+add_block_preprocessor(sub {
+ my ($block) = @_;
+
+ if (!$block->request) {
+ $block->set_value("request", "GET /t");
+ }
+
+ if (!$block->no_error_log) {
+ $block->set_value("no_error_log", "[error]\n[alert]");
+ }
+});
+
+run_tests;
+
+__DATA__
+
+=== TEST 1: PUT
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local etcd = require("apisix.core.etcd")
+ local code, body = t('/apisix/admin/plugin_configs/1',
+ ngx.HTTP_PUT,
+ [[{
+ "plugins": {
+ "limit-count": {
+ "count": 2,
+ "time_window": 60,
+ "rejected_code": 503,
+ "key": "remote_addr"
+ }
+ }
+ }]],
+ [[{
+ "node": {
+ "value": {
+ "plugins": {
+ "limit-count": {
+ "count": 2,
+ "time_window": 60,
+ "rejected_code": 503,
+ "key": "remote_addr"
+ }
+ }
+ },
+ "key": "/apisix/plugin_configs/1"
+ },
+ "action": "set"
+ }]]
+ )
+
+ ngx.status = code
+ ngx.say(body)
+
+ local res = assert(etcd.get('/plugin_configs/1'))
+ local create_time = res.body.node.value.create_time
+ assert(create_time ~= nil, "create_time is nil")
+ local update_time = res.body.node.value.update_time
+ assert(update_time ~= nil, "update_time is nil")
+ }
+ }
+--- response_body
+passed
+
+
+
+=== TEST 2: GET
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/plugin_configs/1',
+ ngx.HTTP_GET,
+ nil,
+ [[{
+ "node": {
+ "value": {
+ "plugins": {
+ "limit-count": {
+ "count": 2,
+ "time_window": 60,
+ "rejected_code": 503,
+ "key": "remote_addr"
+ }
+ }
+ },
+ "key": "/apisix/plugin_configs/1"
+ },
+ "action": "get"
+ }]]
+ )
+
+ ngx.status = code
+ ngx.say(body)
+ }
+ }
+--- response_body
+passed
+
+
+
+=== TEST 3: GET all
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local code, body = t('/apisix/admin/plugin_configs',
+ ngx.HTTP_GET,
+ nil,
+ [[{
+ "node": {
+ "dir": true,
+ "nodes": [
+ {
+ "key": "/apisix/plugin_configs/1",
+ "value": {
+ "plugins": {
+ "limit-count": {
+ "time_window": 60,
+ "policy": "local",
+ "count": 2,
+ "key": "remote_addr",
+ "rejected_code": 503
+ }
+ }
+ }
+ }
+ ],
+ "key": "/apisix/plugin_configs"
+ },
+ "action": "get"
+ }]]
+ )
+
+ ngx.status = code
+ ngx.say(body)
+ }
+ }
+--- response_body
+passed
+
+
+
+=== TEST 4: PATCH
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local etcd = require("apisix.core.etcd")
+ local res = assert(etcd.get('/plugin_configs/1'))
+ local prev_create_time = res.body.node.value.create_time
+ assert(prev_create_time ~= nil, "create_time is nil")
+ local prev_update_time = res.body.node.value.update_time
+ assert(prev_update_time ~= nil, "update_time is nil")
+ ngx.sleep(1)
+
+ local code, body = t('/apisix/admin/plugin_configs/1',
+ ngx.HTTP_PATCH,
+ [[{
+ "plugins": {
+ "limit-count": {
+ "count": 3,
+ "time_window": 60,
+ "rejected_code": 503,
+ "key": "remote_addr"
+ }
+ }}]],
+ [[{
+ "node": {
+ "value": {
+ "plugins": {
+ "limit-count": {
+ "count": 3,
+ "time_window": 60,
+ "rejected_code": 503,
+ "key": "remote_addr"
+ }
+ }
+ },
+ "key": "/apisix/plugin_configs/1"
+ },
+ "action": "compareAndSwap"
+ }]]
+ )
+
+ ngx.status = code
+ ngx.say(body)
+
+ local res = assert(etcd.get('/plugin_configs/1'))
+ local create_time = res.body.node.value.create_time
+ assert(prev_create_time == create_time, "create_time mismatched")
+ local update_time = res.body.node.value.update_time
+ assert(update_time ~= nil, "update_time is nil")
+ assert(prev_update_time ~= update_time, "update_time should be changed")
+ }
+ }
+--- response_body
+passed
+
+
+
+=== TEST 5: PATCH (sub path)
+--- config
+ location /t {
+ content_by_lua_block {
+ local t = require("lib.test_admin").test
+ local etcd = require("apisix.core.etcd")
+ local res = assert(etcd.get('/plugin_configs/1'))
+ local prev_create_time = res.body.node.value.create_time
+ assert(prev_create_time ~= nil, "create_time is nil")
+ local prev_update_time = res.body.node.value.update_time
+ assert(prev_update_time ~= nil, "update_time is nil")
+ ngx.sleep(1)
+
+ local code, body = t('/apisix/admin/plugin_configs/1/plugins',
+ ngx.HTTP_PATCH,
+ [[{
+ "limit-count": {
Review comment:
@tokers
Updated
----------------------------------------------------------------
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] spacewander commented on a change in pull request #3567: feat: add plugin config
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #3567:
URL: https://github.com/apache/apisix/pull/3567#discussion_r579635126
##########
File path: apisix/schema_def.lua
##########
@@ -746,6 +749,20 @@ _M.plugins = {
}
+_M.plugin_config = {
+ type = "object",
+ properties = {
+ id = id_schema,
+ desc = {type = "string", maxLength = 256},
Review comment:
Will do it in the next PR.
----------------------------------------------------------------
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] membphis commented on a change in pull request #3567: feat: add plugin config
Posted by GitBox <gi...@apache.org>.
membphis commented on a change in pull request #3567:
URL: https://github.com/apache/apisix/pull/3567#discussion_r579627401
##########
File path: apisix/cli/etcd.lua
##########
@@ -251,7 +251,7 @@ function _M.init(env, args)
for _, dir_name in ipairs({"/routes", "/upstreams", "/services",
"/plugins", "/consumers", "/node_status",
"/ssl", "/global_rules", "/stream_routes",
- "/proto", "/plugin_metadata"}) do
+ "/proto", "/plugin_metadata", "/plugin_configs"}) do
Review comment:
Is it possible to move this logic to the `init_by_lua phase` in the future?
##########
File path: apisix/plugin_config.lua
##########
@@ -0,0 +1,69 @@
+--
+-- 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.
+--
+local core = require("apisix.core")
+local plugin_checker = require("apisix.plugin").plugin_checker
+local pairs = pairs
+local error = error
+
+
+local plugin_configs
+
+
+local _M = {
+}
+
+
+function _M.init_worker()
+ local err
+ plugin_configs, err = core.config.new("/plugin_configs", {
+ automatic = true,
+ checker = plugin_checker,
+ })
+ if not plugin_configs then
+ error("failed to sync /plugin_configs: " .. err)
+ end
+end
+
+
+function _M.get(id)
+ return plugin_configs:get(id)
+end
+
+
+function _M.merge(route_conf, plugin_config)
+ if route_conf.prev_plugin_config_ver ~= plugin_config.modifiedIndex then
Review comment:
another code style:
```lua
if route_conf.prev_plugin_config_ver == plugin_config.modifiedIndex then
return route_conf
end
...
```
##########
File path: apisix/init.lua
##########
@@ -381,6 +383,18 @@ function _M.http_access_phase()
core.json.delay_encode(api_ctx.matched_route, true))
local enable_websocket = route.value.enable_websocket
+
+ if route.value.plugin_config_id then
+ local pc = plugin_config.get(route.value.plugin_config_id)
Review comment:
`pc` is not a good name
##########
File path: apisix/schema_def.lua
##########
@@ -746,6 +749,20 @@ _M.plugins = {
}
+_M.plugin_config = {
+ type = "object",
+ properties = {
+ id = id_schema,
+ desc = {type = "string", maxLength = 256},
Review comment:
all of the `desc` should be the same, declare it as a variable and just quote it
----------------------------------------------------------------
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