[GitHub] [apisix] jbampton commented on a change in pull request #3048: feat: add control API

[GitBox <gi...@apache.org>]

jbampton commented on a change in pull request #3048:
URL: https://github.com/apache/apisix/pull/3048#discussion_r543257943



##########
File path: .travis/apisix_cli_test/test_ci_only.sh
##########
@@ -17,18 +17,10 @@
 # limitations under the License.
 #
 
-# This file is like apisix_cli_test.sh, but requires extra dependencies which
+# This file is like other test_*.sh, but requires extra dependencies which
 # you don't need them in daily development.

Review comment:
       ```suggestion
   # you don't need in daily development.
   ```

##########
File path: doc/control-api.md
##########
@@ -0,0 +1,51 @@
+<!--
+#
+# 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.
+#
+-->
+
+The control API can be used to
+* expose APISIX internal state
+* control the behavior of a single isolate APISIX data panel
+
+By default, the control API server is enabled and listens to `127.0.0.1:9090`. You can change it via
+the `control` section under `apisix` in `conf/config.yaml`:
+
+```yaml
+apisix:
+  ...
+  enable_control: true
+  control:
+    ip: "127.0.0.1"
+    port: 9090
+```
+
+Note that the control API server should not be configured to listen the public traffic!
+
+## Control API Added via plugin
+
+Plugin can add its control API when it is enabled.
+If a plugin adds such control API, please refer each plugin's documentation for those APIs.

Review comment:
       ```suggestion
   If a plugin adds such control API, please refer to each plugin's documentation for those APIs.
   ```




----------------------------------------------------------------
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