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

2020-12-15 Thread GitBox


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



##
File path: doc/control-api.md
##
@@ -0,0 +1,51 @@
+
+
+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 to each plugin's documentation 
for those APIs.

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

##
File path: doc/control-api.md
##
@@ -0,0 +1,51 @@
+
+
+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!

Review comment:
   ```suggestion
   Note that the control API server should not be configured to listen to 
public traffic!
   ```





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:
us...@infra.apache.org




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

2020-12-15 Thread GitBox


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 @@
+
+
+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:
us...@infra.apache.org