From e1494505fc376d5468ed92a1727222231f2fe7af Mon Sep 17 00:00:00 2001
From: Ara Sadoyan <ara.sadoyan@netangels.net>
Date: Thu, 17 Apr 2025 15:54:47 +0200
Subject: [PATCH] comments in configs

---
 etc/upstreams.yaml | 50 +++++++++++++++++++++-------------------------
 1 file changed, 23 insertions(+), 27 deletions(-)

diff --git a/etc/upstreams.yaml b/etc/upstreams.yaml
index e20980e..2d420d8 100644
--- a/etc/upstreams.yaml
+++ b/etc/upstreams.yaml
@@ -1,39 +1,39 @@
-# The file is under watch and hot reload , changes are applied immediately, no need to restart of reload app
+# The file is under watch and hot reload , changes are applied immediately, no need to restart or reload
 provider: "file" # consul
 globals:
-  headers:
+  headers: # Global headers, appended for all upstreams and all paths.
     - "Access-Control-Allow-Origin:*"
     - "Access-Control-Allow-Methods:POST, GET, OPTIONS"
     - "Access-Control-Max-Age:86400"
-  authorization: # if enabled
+    - "X-Custom-Header:Something Special"
+  authorization: #  Optional, only one of auth methods below can be active at a time
     #    - "basic"
     #    - "zangag:Anhnazand1234"
     #    - "apikey"
     #    - "5a28cc4c-ce10-4ff1-824e-743c38835f5c"
     - "jwt"
     - "910517d9-f9a1-48de-8826-dbadacbd84af-cb6f830e-ab16-47ec-9d8f-0090de732774"
-consul: # read only if provider is consul
+consul: # If the provider is consul. Otherwise ignored
   servers:
     - "http://master1:8500"
     - "http://192.168.22.1:8500"
-    - "http://master1.digitai.local:8500"
-  services:
+    - "http://master2:8500"
+  services: # proxy: The hostname to access proxy server, real : The real service name in Consul
     - proxy: "proxy-frontend-dev-frontend-srv"
       real: "frontend-dev-frontend-srv"
     - proxy: "proxy-gateway-test-gateway-srv"
       real: "gateway-test-gateway-srv"
     - proxy: "proxy-backoffice-dev-backoffice-srv"
       real: "backoffice-dev-backoffice-srv"
-  token: "8e2db809-845b-45e1-8b47-2c8356a09da0-a4370955-18c2-4d6e-a8f8-ffcc0b47be81"
-upstreams: # read only if provider is files
-  myip.netangels.net:
-    paths:
+  token: "8e2db809-845b-45e1-8b47-2c8356a09da0-a4370955-18c2-4d6e-a8f8-ffcc0b47be81" # Consul server access token, If Consul auth is enabled
+upstreams: # If provider is files. Otherwise ignored
+  myip.mydomain.com: # Hostname, or header host to access the upstream
+    paths: # URL path(s) for current upstream, closest match wins
       "/":
-        ssl: false
-        headers:
-          - "X-Some-Thing:Yaaaaaaaaaaaaaaa"
-          - "X-Prox-From:Hopaaaaaaaaaaaar"
-        servers:
+        ssl: false # If upstream is SSL enabled
+        headers: # Custom headers, set only for this Host and Path
+          - "X-Proxy-From:Gazan"
+        servers: # List of upstreams HOST:PORT 
           - "127.0.0.1:8000"
           - "127.0.0.2:8000"
           - "127.0.0.3:8000"
@@ -42,7 +42,7 @@ upstreams: # read only if provider is files
         ssl: false
         headers:
           - "X-Some-Thing:Yaaaaaaaaaaaaaaa"
-          - "X-Prox-From:Hopaaaaaaaaaaaar"
+          - "X-Proxy-From:Gazan"
         servers:
           - "127.0.0.1:8000"
           - "127.0.0.2:8000"
@@ -50,7 +50,7 @@ upstreams: # read only if provider is files
         ssl: false
         servers:
           - "192.168.1.1:8000"
-  polo.netangels.net:
+  polo.mydomain.com:
     paths:
       "/":
         ssl: false
@@ -58,11 +58,7 @@ upstreams: # read only if provider is files
           - "X-Some-Thing:Yaaaaaaaaaaaaaaa"
         servers:
           - "192.168.1.10:8000"
-      "/ws":
-        ssl: false
-        servers:
-          - "192.168.1.1:8000"
-  glop.netangels.net:
+  glop.mydomain.com:
     paths:
       "/":
         ssl: false
@@ -70,19 +66,19 @@ upstreams: # read only if provider is files
           - "X-Hopar-From:Hopaaaaaaaaaaaar"
         servers:
           - "192.168.1.10:8000"
-          - "192.168.1.10:8000"
-  apt.netangels.net:
+          - "192.168.1.1:8000"
+  apt.mydomain.com:
     paths:
       "/":
         ssl: true
         servers:
-          - "apt.netangels.net:443"
-  test.netangels.net:
+          - "apt.mydomain.com:443"
+  test.mydomain.com:
     paths:
       "/":
         ssl: false
         servers:
-          - "myip.netangels.net:80"
+          - "myip.mydomain.com:80"
   127.0.0.1:
     paths:
       "/":