change: remove listen.host from api/conf/conf.yaml (#1767)

Author: nic-chen

.github/workflows/backend-e2e-test.yml

@@ -29,10 +29,9 @@ jobs:
       - name: Modify conf.yaml
         run: |
           sed -i 's/127.0.0.1:2379/172.16.238.10:2379/' ./api/conf/conf.yaml
-          sed -i 's/127.0.0.1/0.0.0.0/' ./api/conf/conf.yaml
+          sed -i 's@127.0.0.1@0.0.0.0/0@' ./api/conf/conf.yaml
           sed -i '/172.16.238.10:2379/a\      - 172.16.238.11:2379' ./api/conf/conf.yaml
           sed -i '/172.16.238.10:2379/a\      - 172.16.238.12:2379' ./api/conf/conf.yaml
-          sed -i '[email protected]/[email protected]/0@' ./api/conf/conf.yaml
           sed -i 's@# - dubbo-proxy@- dubbo-proxy@' ./api/conf/conf.yaml
 
       - name: download file Dockerfile-apisix
@@ -98,10 +97,9 @@ jobs:
       - name: Modify conf.yaml Configure for use by the manage-api cluster
         run: |
           sed -i 's/127.0.0.1:2379/172.16.238.10:2379/' ./api/conf/conf.yaml
-          sed -i 's/127.0.0.1/0.0.0.0/' ./api/conf/conf.yaml
+          sed -i 's@127.0.0.1@0.0.0.0/0@' ./api/conf/conf.yaml
           sed -i '/172.16.238.10:2379/a\      - 172.16.238.11:2379' ./api/conf/conf.yaml
           sed -i '/172.16.238.10:2379/a\      - 172.16.238.12:2379' ./api/conf/conf.yaml
-          sed -i '[email protected]/[email protected]/0@' ./api/conf/conf.yaml
 
       - name: download file Dockerfile-apisix
         working-directory: ./api/test/docker

.github/workflows/deploy-with-docker.yml

@@ -33,8 +33,11 @@ jobs:
       - name: Modify Config
         run: |
           sed -i 's/127.0.0.1:2379/172.16.238.10:2379/' api/conf/conf.yaml
-          sed -i 's/host: 127.0.0.1/host: 0.0.0.0/' api/conf/conf.yaml
-          sed -i '[email protected]/[email protected]/0@' ./api/conf/conf.yaml
+          sed -i '[email protected]@0.0.0.0/0@' ./api/conf/conf.yaml
+
+          # At present, the docker CI is still running the code of the master branch
+          # So we need to configure `listen.host` so that it can be accessed outside docker
+          sed -i '/port: 9000/i\    host: 0.0.0.0' ./api/conf/conf.yaml
 
       - name: Run Docker Compose
         working-directory: ./api/test/docker-deploy

api/conf/conf.yaml

@@ -16,13 +16,17 @@
 #
 
 conf:
-  listen:
-    host: 127.0.0.1     # `manager api` listening ip or host name
-    port: 9000          # `manager api` listening port
-  allow_list:           # If we don't set any IP list, then any IP access is allowed by default.
-    - 127.0.0.0/24
+  listen:                 # yamllint disable rule:comments-indentation
+    # host: 127.0.0.1     # the address on which the `Manager API` should listen.
+                          # The default value is 0.0.0.0, if want to specify, please enable it.
+                          # This value accepts IPv4, IPv6, and hostname.
+    port: 9000            # The port on which the `Manager API` should listen.
+  allow_list:             # If we don't set any IP list, then any IP access is allowed by default.
+    - 127.0.0.1           # The rules are checked in sequence until the first match is found.
+    - ::1                 # In this example, access is allowed only for IPv4 network 127.0.0.1, and for IPv6 network ::1.
+                          # It also support CIDR like 192.168.1.0/24 and 2001:0db8::/32
   etcd:
-    endpoints:          # supports defining multiple etcd host addresses for an etcd cluster
+    endpoints:            # supports defining multiple etcd host addresses for an etcd cluster
       - 127.0.0.1:2379
                           # yamllint disable rule:comments-indentation
                           # etcd basic auth info
@@ -32,7 +36,7 @@ conf:
       key_file: ""          # Path of your self-signed client side key
       cert_file: ""         # Path of your self-signed client side cert
       ca_file: ""           # Path of your self-signed ca cert, the CA is used to sign callers' certificates
-    # prefix: /apisix     # apisix config's prefix in etcd, /apisix by default
+    # prefix: /apisix       # apisix config's prefix in etcd, /apisix by default
   log:
     error_log:
       level: warn       # supports levels, lower to higher: debug, info, warn, error, panic, fatal

api/internal/conf/conf.go

@@ -44,7 +44,7 @@ var (
 	ENV              string
 	Schema           gjson.Result
 	WorkDir          = "."
-	ServerHost       = "127.0.0.1"
+	ServerHost       = "0.0.0.0"
 	ServerPort       = 80
 	ETCDConfig       *Etcd
 	ErrorLogLevel    = "warn"

api/test/docker/setup.sh

@@ -99,10 +99,9 @@ up() {
 
     #modifying config
     sed -i 's/127.0.0.1:2379/172.16.238.10:2379/' "$YAML_FILE"
-    sed -i 's/127.0.0.1/0.0.0.0/' "$YAML_FILE"
+    sed -i 's@127.0.0.1@0.0.0.0/0@' "$YAML_FILE"
     sed -i '/172.16.238.10:2379/a\      - 172.16.238.11:2379' "$YAML_FILE"
     sed -i '/172.16.238.10:2379/a\      - 172.16.238.12:2379' "$YAML_FILE"
-    sed -i '[email protected]/[email protected]/0@' "$YAML_FILE"
     sed -i 's@# - dubbo-proxy@- dubbo-proxy@' "$YAML_FILE"
 
   fi

api/test/shell/cli_test.sh

@@ -189,7 +189,7 @@ if [[ `grep -c "${LOGLEVEL}" ${STDOUT}` -ne '1' ]]; then
     exit 1
 fi
 
-if [[ `grep -c "${HOST}:${PORT}" ${STDOUT}` -ne '1' ]]; then
+if [[ `grep -c "0.0.0.0:${PORT}" ${STDOUT}` -ne '1' ]]; then
     echo "failed: the manager server didn't show started info"
     exit 1
 fi
@@ -252,9 +252,9 @@ clean_up
 
 # set ip allowed list
 if [[ $KERNEL = "Darwin" ]]; then
-  sed -i "" '[email protected].0/24@10.0.0.1@' conf/conf.yaml
+  sed -i "" 's@- 127.0.0.1 @- 10.0.0.1 @' conf/conf.yaml
 else
-  sed -i '[email protected].0/24@10.0.0.1@' conf/conf.yaml
+  sed -i 's@- 127.0.0.1 @- 10.0.0.1 @' conf/conf.yaml
 fi
 
 ./manager-api &