yesinteractive/kongmap

KongMap

镜像概述和主要用途

KongMap 是一款免费可视化工具，用于查看和声明式编辑Kong API网关集群的配置，包括路由、服务及插件/策略。目前仅支持通过Docker和Kubernetes安装。

https://github.com/yesinteractive/kong-map/blob/main/CHANGELOG.md

!GitHub

核心功能和特性

集群视图（Cluster View）

允许管理员查看Kong API网关集群的动态映射，直观展示工作区（Kong企业版）、服务、路由（端点）和插件（策略）之间的关系。还可查看Kong Kubernetes Ingress Controller的代理平面配置。点击任何实体可显示详细信息及相关链接，可切换插件显示状态，支持按实体名称、Kong标签、工作区、URL等进行搜索。

若启用编辑功能，可直接从集群视图编辑任何Kong实体，点击编辑按钮将跳转至声明式编辑器中的对应实体。

!https://github.com/yesinteractive/kong-map/blob/main/screenshots/kongmap-home.png?raw=true "kongmap"

端点分析器（Endpoint Analyzer）

查看API端点（路由）的详细信息，显示附加到端点/路由的服务，以及按执行顺序展示所有插件/策略的分解情况。Kong企业版用户可通过链接直接在Kong Manager中查看所有实体。

若启用编辑功能，可从端点分析器编辑任何Kong实体，点击编辑按钮将跳转至声明式编辑器中的对应实体。

!https://github.com/yesinteractive/kong-map/blob/main/screenshots/kongmap-endpoint.png?raw=true "kongmap"

声明式配置查看器/编辑器（Declarative Configuration Viewer/Editor）

KongMap部署了基于浏览器的Kong CLI工具decK实现，可通过YAML格式查看、编辑和导出开源及企业版集群的Kong声明式配置。配置可轻松在Kong集群间或工作区间复制粘贴。可通过KongMap配置禁用声明式配置编辑，或在使用Kong企业版时通过RBAC权限管理。

可从集群视图点击任何Kong实体，或从端点分析器的任何元素调用查看器/编辑器。可在查看器/编辑器中切换显示/隐藏Kong实体ID。

!https://github.com/yesinteractive/kong-map/blob/main/screenshots/kongmap-deck.png?raw=true "kongmap"

兼容性

KongMap支持Kong开源版和企业版集群（版本1.3以上），兼容DB和非DB（dbless）Kong配置。同时支持Kong Kubernetes Ingress Controller（版本0.5以上，需确保Ingress Controller的代理容器Admin API已暴露）。

KongMap使用多个公共CDN加载UI元素（如Bootstrap、jQuery等），因此在无互联网访问的封闭网络环境中无法正常显示。

使用方法和配置说明

Docker安装

Docker镜像基于Alpine 3.11，运行PHP 7.3 on Apache，容器暴露8100（HTTP）和8143（HTTPS，自签名证书）端口。

以下是使用docker run命令的安装说明，docker-compose示例可查看https://github.com/yesinteractive/kong-map/blob/main/examples%E3%80%82

1. 导出集群配置到KONG_CLUSTERS环境变量

Kong集群连接通过JSON定义，以下示例展示添加两个Kong集群到KongMap：

json
{
  "my enterprise cluster": {
    "kong_admin_api_url": "http://kongapi_url:8001",
    "kong_edit_config": "true",
    "kong_ent": "true",
    "kong_ent_token": "admin",
    "kong_ent_token_name": "kong-admin-token",
    "kong_ent_manager_url": "http://kongmanager_url:8002"
  },
  "my kong open source cluster": {
    "kong_admin_api_url": "http://kongapi_url:8001",
    "kong_edit_config": "true",
    "kong_ent": "false",
    "kong_ent_token": "null",
    "kong_ent_token_name": "null",
    "kong_ent_manager_url": "null"
  }
}

KONG_CLUSTERS JSON配置参数说明（所有参数均为必填）：

将配置导出为环境变量：

shell
export KONG_CLUSTERS='{  "my enterprise cluster": {    "kong_admin_api_url": "http://kongapi_url:8001",    "kong_edit_config": "true",   "kong_ent": "true",    "kong_ent_token": "admin",    "kong_ent_token_name": "kong-admin-token",    "kong_ent_manager_url": "http://kongmanager_url:8002"  }}'

2. 启动容器

使用以下命令启动容器，可自定义暴露端口。示例中KongMap暴露8100和8143端口。注意KONGMAP_URL变量需设置为浏览器访问KongMap的URL，例如本地运行且暴露8100端口时设为http://localhost:8100。

bash
docker run -d \
  -e "KONGMAP_CLUSTERS_JSON=$KONG_CLUSTERS" \
  -e "KONGMAP_URL=http://url_to_kongmap:8100" \
  -p 8100:8100 \
  -p 8143:8143 \
  yesinteractive/kongmap

完整文档见：https://github.com/yesinteractive/kong-map/

3. 认证

若需启用KongMap UI认证，建议将KongMap部署在Kong网关之后，通过网关实现适当的认证策略（如OIDC、OAUTH2、Basic Auth等）。

问题与反馈

如有问题、反馈或需提交issue，请访问：https://github.com/yesinteractive/kong-map/issues%E3%80%82