# kongx
kongx(最新版本2.1.0)是网关kong的可视化界面管理平台(参考konga的部分界面布局方式),能够集中化管理应用不同环境的网关配置,提供同步各环境的网关配置功能,并且具备规范的权限管理、参数配置、环境管理及日志审计等特性。
基于Spring Boot和Spring Cloud开发,打包后可以直接运行,不需要额外安装Tomcat等应用容器,支持在线Shell。
Kongx 使用指南请参考:[Wiki](https://www.kancloud.cn/raoxiaoyan/kongx/1984321)
平台快速部署请参见[Quick Start](https://www.kancloud.cn/raoxiaoyan/kongx/1984323)
Docker部署(2.0.0+支持)请参见[Docker Quick Start](https://gitee.com/raoxy/kongx/blob/master/docker-quick-start/readme.md)
可视化设计网关pipeline使用文档请参考[网关流水线](https://www.kancloud.cn/raoxiaoyan/kongx/2055264)
演示地址:[http://159.75.135.225/](http://49.232.174.106/)(用户名: guest/123456)
系统环境默认用户:admin/123456(部署登录后,请前往'个人设置'页面,及时修改密码)
## [](https://gitee.com/raoxy/kongx#screenshots)Screenshots
![](https://gitee.com/raoxy/kongx/raw/master/docs/screen.png)
![](https://gitee.com/raoxy/kongx/raw/master/docs/kong%20shell.png)
![](https://gitee.com/raoxy/kongx/raw/master/docs/service2.png)
![](https://gitee.com/raoxy/kongx/raw/master/docs/pipeline.png)
![](https://gitee.com/raoxy/kongx/raw/master/docs/consumers.png)
![](https://gitee.com/raoxy/kongx/raw/master/docs/certificate.png)
## [](https://gitee.com/raoxy/kongx#features)Features
* Kong Manage:Upstream,Service,Route,Plugin,Consumer,Certificates及Ca Certificates等
* 新增网关流水线
* 同步Kong配置:不同环境间的kong配置进行同步,便于多环境配置管理;
* 系统管理:具有完善的权限管理系统,包括:用户管理、菜单管理、角色管理及用户组管理等功能;
* 参数管理:具有良好的扩展性,基于平台的参数管理可扩展多环境及服务管理;包括:环境管理、参数参数等
* 日志管理:平台具有完善的日志审计功能,包括:同步日志、操作日志;
## [](https://gitee.com/raoxy/kongx#kong%E6%8F%92%E4%BB%B6%E5%88%97%E8%A1%A8)Kong插件列表
* [官网插件](https://docs.konghq.com/hub/)
* [灰度插件canary](https://gitee.com/raoxy/kong-plugins-canary)
* [防攻击 kong\_injection](https://github.com/ror6ax/kong_injection)
## [](https://gitee.com/raoxy/kongx#kong%E6%9C%80%E4%BD%B3%E5%AE%9E%E8%B7%B5)kong最佳实践
* [Kong与consul自主发现服务](https://www.kancloud.cn/raoxiaoyan/kongx/1984357)
* 如何应用灰度插件(canary)及使用场景介绍
* kong插件开发实践
* [kong的健康检查及熔断](https://www.kancloud.cn/raoxiaoyan/kongx/2044771)
* kong网关流水线
* 整理中...尽情期待
## [](https://gitee.com/raoxy/kongx#roadmap)RoadMap
1、初步计划kongx自适应kong后续所有版本;(2.0.0版本,已完成自动适配至2.1.x版本)
2、增加shell界面和可视化管理界面(2.0.1版本支持, 2020/11/18 已完成);
3、增加网关流水线的图形化界面设计;
## [](https://gitee.com/raoxy/kongx#%E6%8A%80%E6%9C%AF%E6%94%AF%E6%8C%81)技术支持
| Kongx技术支持1群群号:980245072(未满) | 技术合作
| 请扫描微信二维码 |
| --- |
| ![](https://gitee.com/raoxy/kongx/raw/master/docs/kongx_tech1.png) |
## kongx与kong版本关系
| 序号 | kongx版本 | Kong版本 | 说明 |
| --- | --- | --- | --- |
| 1 | 1.2.x | 1.2.x | 1.2.x测试 |
| 1 | 2.0.0 | 1.2.x、1.3.x、1.4.x、1.5.x、2.0.x | 目前仅针对kong版本1.2.x、1.3.x测试通过,对1.4.x以上版本与1.3.x对比差异,原则上基础功能全部可用,(参考差异对比)\[[https://www.kancloud.cn/raoxiaoyan/kongx/1991178](https://www.kancloud.cn/raoxiaoyan/kongx/1991178)\] |
| 1 | 2.1.0 | 1.2.x、1.3.x、1.4.x、1.5.x、2.0.x | 目前仅针对kong版本1.2.x、1.3.x测试通过,对1.4.x以上版本与1.3.x对比差异,原则上基础功能全部可用,(参考差异对比)\[[https://www.kancloud.cn/raoxiaoyan/kongx/1991178](https://www.kancloud.cn/raoxiaoyan/kongx/1991178)\] |
## [](https://gitee.com/raoxy/kongx#upgrade)Upgrade
[更新历史](https://gitee.com/raoxy/kongx/blob/master/docs/upgrade.md)
## [](https://gitee.com/raoxy/kongx#%E5%8F%82%E8%80%83%E9%93%BE%E6%8E%A5)参考链接
* [Kong官网](https://docs.konghq.com/1.2.x/admin-api/)
* [OpenResty最佳实践](https://www.kancloud.cn/kancloud/openresty-best-practices/50428)
- 1. 概述
- 2. 快速安装
- 2.1 环境准备
- 2.2 开始安装
- 2.3 启动/关闭kongx
- 2.4 使用kongx
- 3. 使用指南
- 3.0 mockbin配置示例
- 3.0.1 不含upstream的配置
- 3.0.2 含upstream的配置
- 3.1 Gateway
- 3.1.1 Upstreams
- 3.1.1.1 新增/修改upstreams
- 3.1.1.2 管理targets
- 3.1.1.3 设置健康检查
- 3.1.1.4 upstream视图
- 3.1.2 Services
- 3.1.2.1 新建/修改service
- 3.1.2.2 添加服务路由
- 3.1.2.3 添加服务插件
- 3.1.2.4 同步services
- 3.1.2.5 services视图
- 3.1.3 Routes
- 3.1.3.1 路由列表
- 3.1.3.2 修改路由
- 3.1.3.3 批量修改HOSTS
- 3.1.4 Plugins
- 3.1.4.1 新增插件
- 3.1.4.2 插件列表
- 3.1.5 Consumers
- 3.1.5.1 新建/修改consumers
- 3.1.6 Kong Shell
- 3.1.6.1 shell安装
- 3.1.6.2 使用Shell
- 3.2 系统管理
- 3.2.1 用户管理
- 3.2.2 角色管理
- 3.2.3 用户组管理
- 3.2.4 菜单管理
- 3.3 参数管理
- 3.3.1 环境管理
- 3.3.2 系统参数
- 3.3.3 如何增加多个环境?
- 3.4 日志管理
- 3.4.1 操作日志
- 3.4.2 同步日志
- 3.5 工具箱
- 3.5.1 Kong Shell
- 3.5.2 切换工作台
- 3.6 网关流水线
- 3.6.1 Pipeline
- 4. 最佳实践
- 4.1 灰度插件canary使用
- 4.2 kong与consul集成
- 4.2.1 使用kong提供dns服务
- 4.2.2 使用dnsmasq提供dns服务
- 4.2.3 使用consul自主发现服务
- 4.3 kong健康检查
- 4.3.1 简介
- 4.3.2 健康检查(主动检查)
- 4.3.3 断路器(被动检查)
- 4.3.4 总结
- 4.4 认证插件之key-auth
- 4.5 认证插件之basic-auth
- 4.6 认证插件之oauth2-auth
- 4.7 认证插件之jwt
- 4.8 kong自定义access_log格式
- 4.8.1 前言
- 4.8.2 配置文本格式
- 4.8.3 配置JSON格式
- 4.9 kong的访问监控
- 4.9.1 解决方案
- 4.9.2 方案实施
- 4.9.3 接入grafana报表
- 5. 常见问题
- 5.1 默认账号及密码
- 5.2 新增用户默认密码为123456
- 5.3 如何设置超级管理员
- 5.4 密码忘记了咋办
- 6. Kong
- 6.1 Kong简介
- 6.2 kong安装指南
- 6.2.1 kong安装-RPM
- 6.2.2 kong安装-源码
- 6.2.3 kong基于yum源安装
- 6.3 Admin API
- 6.3.1 API支持两种内容类型
- 6.3.2 声明式配置(Declarative Configuration)
- 6.3.3 获取实体schema
- 6.3.4 services
- 6.3.5 Routes
- 6.3.6 Consumers
- 6.3.7 Plugins
- 6.3.8 Certficate
- 6.3.9 CA certficate(1.3.x+以上版本)
- 6.3.10 SNI
- 6.3.11 Upstreams
- 6.3.12 Targets
- 6.4 Kong使用
- 6.4.1 DB-LESS模式
- 6.4.2 DB模式