2.6.13

Author: anjia0532

README.md

@@ -9,7 +9,7 @@ gateway等网关插件的高扩展性
 ### 通过docker运行
 
 ```bash
-docker run anjia0532/discovery-syncer-python:v2.6.12
+docker run anjia0532/discovery-syncer-python:v2.6.13
 ```
 
 特别的，`-c ` 支持配置远端http[s]的地址，比如读取静态资源的，比如读取nacos的
@@ -27,17 +27,17 @@ docker run anjia0532/discovery-syncer-python:v2.6.12
 头校验，需要在配置文件 `common.syncer-api-key` 修改默认值，
 长度最低为32位，需要同时包含大小写字母，数字，和特殊字符
 
-| 路径                                               | 返回值        | 用途                                                     |
-|--------------------------------------------------|:-----------|:-------------------------------------------------------|
-| `GET /`                                          | `OK`       | 服务是否启动                                                 |
-| `GET /redoc/`                                    | redocly ui | Redocly 接口文档                                           |
-| `GET /docs/`                                     | swagger ui | Swagger 接口文档                                           |
-| `GET /-/reload`                                  | `OK`       | 重新加载配置文件，加载成功返回OK，主要是cicd场景或者k8s的configmap reload 场景使用 |
-| `GET /health`                                    | JSON       | 判断服务是否健康，可以配合k8s等容器服务的健康检查使用                           |
-| `PUT /discovery/{discovery-name}?alive_num=1`    | `OK`       | 主动下线上线注册中心的服务,配合CI/CD发版业务用                             |
-| `GET /gateway-api-to-file/{gateway-name}`        | text/plain | 读取网关admin api转换成文件用于备份或者db-less模式                      |
-| `POST /migrate/{gateway-name}/to/{gateway-name}` | `OK`       | 将网关数据迁移(目前仅支持apisix)                                   |
-| `PUT /restore/{gateway-name}`                    | `OK`       | 将 db-less 文件还原到网关(目前仅支持apisix)                         |
+| 路径                                               | 返回值        | 用途                                                         |
+|--------------------------------------------------|:-----------|:-----------------------------------------------------------|
+| `GET /`                                          | `OK`       | 服务是否启动                                                     |
+| `GET /redoc/`                                    | redocly ui | Redocly 接口文档                                               |
+| `GET /docs/`                                     | swagger ui | Swagger 接口文档                                               |
+| `GET /-/reload`                                  | `OK`       | 重新加载配置文件，加载成功返回OK，主要是cicd场景或者k8s的configmap reload 场景使用     |
+| `GET /health`                                    | JSON       | 判断服务是否健康，可以配合k8s等容器服务的健康检查使用                               |
+| `PUT /discovery/{discovery-name}?alive_num=1`    | `OK`       | 主动下线上线注册中心的服务,配合CI/CD发版业务用                                 |
+| `GET /gateway-api-to-file/{gateway-name}`        | text/plain | 读取网关admin api转换成文件用于备份或者db-less模式(目前仅支持apisix,kong建议用deck) |
+| `POST /migrate/{gateway-name}/to/{gateway-name}` | `OK`       | 将网关数据迁移(目前仅支持apisix,kong建议用deck)                           |
+| `PUT /restore/{gateway-name}`                    | `OK`       | 将 db-less 文件还原到网关(目前仅支持apisix,kong建议用deck)                 |
 
 #### `GET /-/reload` 重新加载配置文件
 

app/service/gateway/apisix.py

@@ -26,7 +26,7 @@
         "read": 30
     },
     "type":"roundrobin",
-    "desc": "auto sync by https://github.com/anjia0532/discovery-syncer-python-python"
+    "desc": "auto sync by https://github.com/anjia0532/discovery-syncer-python"
 }
 """
 

app/service/gateway/kong.py

@@ -12,15 +12,15 @@
 default_kong_upstream_template = """
 {
     "name": "$name",
-    "tags": ["discovery-syncer-auto"]
+    "tags": ["discovery-syncer-python-auto"]
 }
 """
 
 default_kong_target_template = """
 {
     "target": "$ip:$port",
     "weight": $weight,
-    "tags": ["discovery-syncer-auto"]
+    "tags": ["discovery-syncer-python-auto"]
 }
 """
 
@@ -33,7 +33,7 @@ def __init__(self, config):
     def get_service_all_instances(self, target: dict, upstream_name: str = None) -> List[Instance]:
         # https://docs.konghq.com/gateway/api/admin-oss/latest/
         upstream_name = self.get_upstream_name(target, upstream_name)
-        uri = f"{upstream_name}{self._config.config.get('targets_uri', '/targets')}"
+        uri = f"upstreams/{upstream_name}{self._config.config.get('targets_uri', '/targets')}"
         resp = self.kong_execute("GET", uri, {})
         if resp.status_code == 404:
             return []
@@ -51,37 +51,42 @@ def sync_instances(self, target: dict, upstream_name: str, diff_ins: list, insta
             return
         if upstream_name not in self.service_name_map:
             tpl = Template(target.get("config").get("template", default_kong_upstream_template))
-            resp = self.kong_execute("POST", "", {}, tpl.substitute(name=upstream_name))
+            self.kong_execute("PUT", "upstreams", {}, tpl.substitute(name=upstream_name))
             self.service_name_map[upstream_name] = True
 
         tpl = Template(default_kong_target_template)
         for instance in diff_ins:
-            target_uri = f"{upstream_name}/targets/"
+            target_uri = f"upstreams/{upstream_name}/targets/"
             method = "POST"
             data = None
             if instance.enabled:
                 data = tpl.substitute(ip=instance.ip, port=instance.port, weight=instance.weight)
             else:
                 target_uri = f"{target_uri}/{instance.ip}:{instance.port}"
                 method = "DELETE"
-            self.kong_execute(method, target_uri, {}, data)
+            resp = self.kong_execute(method, target_uri, {}, data)
+            if instance.enabled and resp.status_code == 409:
+                target_uri = f"{target_uri}/{instance.ip}:{instance.port}"
+                method = "PUT"
+                self.kong_execute(method, target_uri, {}, data)
 
     def fetch_admin_api_to_file(self, file_name: str) -> Tuple[str, str]:
         # https://docs.konghq.com/gateway/3.6.x/production/deployment-topologies/db-less-and-declarative-config/
+        # https://docs.konghq.com/deck/1.38.x/guides/backup-restore/
         raise Exception("Unrealized")
 
     def migrate_to(self, target_gateway: 'Gateway'):
+        # https://docs.konghq.com/deck/1.38.x/guides/backup-restore/
         raise Exception("Unrealized")
 
     def restore_gateway(self, body: str) -> str:
+        # https://docs.konghq.com/deck/1.38.x/guides/backup-restore/
         raise Exception("Unrealized")
 
     def kong_execute(self, method, uri, params, data=None):
         resp = httpx.request(method, f"{self._config.admin_url}{self._config.prefix}{uri}",
                              params=params, data=data, timeout=10,
-                             headers={"X-API-KEY": self._config.config.get("X-API-KEY"),
-                                      "Content-Type": "application/json",
-                                      "Accept": "application/json"})
+                             headers={"Content-Type": "application/json", "Accept": "application/json"})
 
         logger.info(
             f"请求 kong 接口, method: {method}, url: {self._config.admin_url}{self._config.prefix}{uri}, 请求参数: {params}, 请求数据: {data}, 响应结果: {resp.text}")

config-example.yaml

@@ -23,7 +23,7 @@ gateway-servers:
     kong1:
         type: kong
         admin-url: http://kong-server:8001
-        prefix: /upstreams/
+        prefix: /
         config:
             targets_uri: /targets/all
 
@@ -153,5 +153,5 @@ targets:
                         },
                         "threshold": 0
                     },
-                    "tags": ["discovery-syncer-auto"]
+                    "tags": ["discovery-syncer-python-auto"]
                 }