feat: disable node-status by default

Fix #2952
apache · Dec 4, 2020 · fa615fc · fa615fc
1 parent 9e3c34a
commit fa615fc
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 5 deletions.
diff --git a/conf/config-default.yaml b/conf/config-default.yaml
@@ -217,7 +217,7 @@ plugins:                          # plugin list (sorted in alphabetical order)
   - limit-count
   - limit-req
   #- log-rotate
-  - node-status
+  #- node-status
   - openid-connect
   - prometheus
   - proxy-cache

diff --git a/doc/plugins/node-status.md b/doc/plugins/node-status.md
@@ -47,7 +47,7 @@ You may need to use [interceptors](../plugin-interceptors.md) to protect it.
 
 ## How To Enable
 
-1. Configure `node-status` in the plugin list of the configuration file `apisix/conf/config.yaml`,
+1. Configure `node-status` in the plugin list of the configuration file `conf/config.yaml`,
 then you can add this plugin in any route.
 
 ```

diff --git a/doc/zh-cn/plugins/node-status.md b/doc/zh-cn/plugins/node-status.md
@@ -46,7 +46,7 @@
 
 ## 启用插件
 
-1. 配置文件 `apisix/conf/config.yaml` 的 plugin list 中配置 `node-status`
+1. 配置文件 `conf/config.yaml` 的 plugin list 中配置 `node-status`
 
 ```
 plugins:                          # plugin list

diff --git a/t/admin/plugins.t b/t/admin/plugins.t
@@ -40,7 +40,7 @@ __DATA__
 --- request
 GET /apisix/admin/plugins/list
 --- response_body_like eval
-qr/\["zipkin","request-id","fault-injection","serverless-pre-function","batch-requests","cors","ip-restriction","referer-restriction","uri-blocker","request-validation","openid-connect","wolf-rbac","hmac-auth","basic-auth","jwt-auth","key-auth","consumer-restriction","authz-keycloak","proxy-mirror","proxy-cache","proxy-rewrite","api-breaker","limit-conn","limit-count","limit-req","node-status","redirect","response-rewrite","grpc-transcode","prometheus","echo","http-logger","sls-logger","tcp-logger","kafka-logger","syslog","udp-logger","example-plugin","serverless-post-function"\]/
+qr/\["zipkin","request-id","fault-injection","serverless-pre-function","batch-requests","cors","ip-restriction","referer-restriction","uri-blocker","request-validation","openid-connect","wolf-rbac","hmac-auth","basic-auth","jwt-auth","key-auth","consumer-restriction","authz-keycloak","proxy-mirror","proxy-cache","proxy-rewrite","api-breaker","limit-conn","limit-count","limit-req","redirect","response-rewrite","grpc-transcode","prometheus","echo","http-logger","sls-logger","tcp-logger","kafka-logger","syslog","udp-logger","example-plugin","serverless-post-function"\]/
 --- no_error_log
 [error]
 
@@ -79,6 +79,9 @@ GET /apisix/admin/plugins
 
 
 === TEST 4: get plugin node-status schema
+--- extra_yaml_config
+plugins:
+    - node-status
 --- config
     location /t {
         content_by_lua_block {

diff --git a/t/admin/schema.t b/t/admin/schema.t
@@ -272,6 +272,9 @@ qr/"disable":\{"type":"boolean"\}/
 
 
 === TEST 14: get plugin node-status schema
+--- extra_yaml_config
+plugins:
+    - node-status
 --- request
 GET /apisix/admin/schema/plugins/node-status
 --- response_body eval

diff --git a/t/debug/debug-mode.t b/t/debug/debug-mode.t
@@ -71,7 +71,6 @@ loaded plugin and sort by priority: 1005 name: api-breaker
 loaded plugin and sort by priority: 1003 name: limit-conn
 loaded plugin and sort by priority: 1002 name: limit-count
 loaded plugin and sort by priority: 1001 name: limit-req
-loaded plugin and sort by priority: 1000 name: node-status
 loaded plugin and sort by priority: 900 name: redirect
 loaded plugin and sort by priority: 899 name: response-rewrite
 loaded plugin and sort by priority: 506 name: grpc-transcode

diff --git a/t/plugin/node-status.t b/t/plugin/node-status.t
@@ -16,6 +16,19 @@
 #
 use t::APISIX 'no_plan';
 
+add_block_preprocessor(sub {
+    my ($block) = @_;
+
+    my $extra_yaml_config = <<_EOC_;
+plugins:
+    - node-status
+_EOC_
+
+    $block->set_value("extra_yaml_config", $extra_yaml_config);
+
+    $block;
+});
+
 master_on();
 repeat_each(1);
 no_long_string();