pantsel/konga

Konga - Kong Admin API的增强型GUI工具

!https://raw.githubusercontent.com/pantsel/konga/master/screenshots/bc2.png

注意：Konga非官方应用，与Kong无附属关系。

镜像概述和主要用途

Konga是一款针对Kong API网关的图形化管理工具，提供直观的界面用于管理Kong Admin API的所有对象。它不仅支持基本的Kong资源管理，还提供多节点监控、数据备份与恢复、用户管理及通知集成等增强功能，适用于需要简化Kong网关日常运维的场景。

核心功能和特性

• 全面的Kong对象管理：支持管理Kong Admin API的所有对象（如服务、路由、插件、消费者等）。
• 多节点管理：可同时管理多个Kong节点，集中监控和配置。
• 数据导入导出：支持从数据库、文件或API导入消费者。
• 快照功能：对Kong节点进行备份、恢复和迁移。
• 健康监控：监控节点和API状态，提供健康检查。
• 通知集成：支持邮件和Slack通知。
• 多用户支持：多用户管理，满足团队协作需求。
• 数据库集成：支持MySQL、PostgreSQL、MongoDB等主流数据库存储配置。

兼容性

• 0.14.0及以上版本：仅兼容Kong 1.x。
• 旧版Kong：如需支持Kong旧版本，请使用konga:legacy镜像或https://github.com/pantsel/konga/tree/legacy%E3%80%82

前提条件

• 运行中的Kong实例
• Node.js 8.x - 12.x（推荐12.16 LTS版本）
• npm

安装与配置

环境变量配置

Konga通过环境变量进行配置，主要参数如下：

Docker部署示例

1. 拉取镜像

bash
docker pull docker.xuanyuan.run/pantsel/konga

2. 准备数据库（MySQL/PostgreSQL）

注意：使用MongoDB时无需此步骤。

通过临时容器执行数据库迁移：

bash
docker run --rm docker.xuanyuan.run/pantsel/konga:latest -c prepare -a {{adapter}} -u {{connection-uri}}

• {{adapter}}：数据库适配器（postgres或mysql）
• {{connection-uri}}：数据库连接字符串（如postgresql://user:password@host:port/dbname）

3. 启动Konga容器

基础启动（使用默认本地存储）：

bash
docker run -p 1337:1337 \
  --name konga \
  -e "NODE_ENV=production" \
  -e "TOKEN_SECRET=your_random_secret" \
  docker.xuanyuan.run/pantsel/konga

使用PostgreSQL数据库：

bash
docker run -p 1337:1337 \
  --network kong-network \  # 可选，连接Kong网络
  -e "NODE_ENV=production" \
  -e "TOKEN_SECRET=your_random_secret" \
  -e "DB_ADAPTER=postgres" \
  -e "DB_HOST=postgres-host" \
  -e "DB_PORT=5432" \
  -e "DB_USER=postgres-user" \
  -e "DB_PASSWORD=postgres-password" \
  -e "DB_DATABASE=konga_db" \
  --name konga \
  pantsel/konga

使用数据库连接字符串：

bash
docker run -p 1337:1337 \
  -e "NODE_ENV=production" \
  -e "TOKEN_SECRET=your_random_secret" \
  -e "DB_ADAPTER=mysql" \
  -e "DB_URI=mysql://user:password@host:port/konga_db" \
  --name konga \
  docker.xuanyuan.run/pantsel/konga

使用方法

访问界面

启动后，通过http://{服务器IP}:1337访问Konga界面，首次登录需创建管理员账户。

主要操作

1. 添加Kong节点：在界面中配置Kong Admin API地址，添加需要管理的Kong节点。
2. 管理Kong资源：通过左侧菜单管理服务、路由、插件、消费者等Kong对象。
3. 创建快照：对Kong节点配置进行备份，支持导出和导入。
4. 设置通知：配置邮件或Slack通知，监控节点健康状态。

升级

当Konga版本更新导致数据库 schema 变更时，需执行数据库迁移：

bash
# Docker环境
docker run --rm docker.xuanyuan.run/pantsel/konga:latest -c prepare -a {{adapter}} -u {{connection-uri}}

常见问题（FAQ）

1. 页面空白并提示Uncaught ReferenceError: angular is not defined
   解决：手动安装bower依赖：npm run bower-deps。

2. 无法添加/编辑插件数组类型属性
   解决：输入值后需按Enter键确认，将值添加到数组中。

3. 权限错误：EACCES permission denied, mkdir '/kongadata/'
   解决：通过STORAGE_PATH环境变量指定可写目录。

4. 启动超时：The hook grunt is taking too long to load
   解决：设置KONGA_HOOK_TIMEOUT环境变量延长超时时间（如120000毫秒）。

许可协议

Konga遵循MIT许可协议，详见https://github.com/pantsel/konga%E3%80%82