README.md

etc/main.yaml

@@ -1,17 +1,18 @@
-version: 1
-threads: 8
-#idle_timeout: 1000
-upstream_keepalive_pool_size: 100
-pid_file: /tmp/load_balancer.pid
-error_log: /tmp/load_balancer_err.log
-upgrade_sock: /tmp/load_balancer.sock
-config_address: 0.0.0.0:3000
-proxy_address_http: 0.0.0.0:6193
+# Default configuration file for Pingora, read only once at startup
+version: 1 # Pingora default setting
+threads: 8 # Pingora default setting
+#idle_timeout: 1000 # Pingora default setting
+upstream_keepalive_pool_size: 100 # Pingora default setting
+pid_file: /tmp/load_balancer.pid # Pingora default setting
+error_log: /tmp/load_balancer_err.log # Pingora default setting
+upgrade_sock: /tmp/load_balancer.sock # Pingora default setting
+config_address: 0.0.0.0:3000 # HTTP API address for pushing upstreams.yaml from remote location
+proxy_address_http: 0.0.0.0:6193 # Pingora default setting
 proxy_address_tls: 0.0.0.0:6194 # Optional
 tls_certificate: etc/server.crt # Mandatory if proxy_address_tls is set
 tls_key_file: etc/key.pem # Mandatory if proxy_address_tls is set
-upstreams_conf: etc/upstreams.yaml
+upstreams_conf: etc/upstreams.yaml # the location of upstreams file
 log_level: info # info, warn, error, debug, trace, off
-hc_method: HEAD
-hc_interval: 2
+hc_method: HEAD # Healthcheck method (HEAD, GET, POST are supported)
+hc_interval: 2 #Intervak for Healthcheck in seconds
 

etc/upstreams.yaml

@@ -1,15 +1,16 @@
-provider: "file"
+# The file is under watch and hot reload , changes are applied immediately, no need to restart of reload app
+provider: "file" # consul
 globals:
   headers:
     - "Access-Control-Allow-Origin:*"
     - "Access-Control-Allow-Methods:POST, GET, OPTIONS"
     - "Access-Control-Max-Age:86400"
-#  authorization:
+#  authorization: # if enabled
 #    - "basic"
 #    - "zangag:Anhnazand1234"
 #    - "apikey"
 #    - "qweasdqweadhbk"
-consul:
+consul: # read only if provider is consul
   servers:
     - "http://master1:8500"
     - "http://192.168.22.1:8500"
@@ -22,7 +23,7 @@ consul:
     - proxy: "proxy-backoffice-dev-backoffice-srv"
       real: "backoffice-dev-backoffice-srv"
   token: "8e2db809-845b-45e1-8b47-2c8356a09da0-a4370955-18c2-4d6e-a8f8-ffcc0b47be81"
-upstreams:
+upstreams: # read only if provider is files
   myip.netangels.net:
     paths:
       "/":