kongx/README.md
2023-03-17 21:42:09 +08:00

95 lines
3.8 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# kongx
kongx(最新版本3.1.0)是网关kong的可视化界面管理平台(参考konga的部分界面布局方式),能够集中化管理应用不同环境的网关配置,提供同步各环境的网关配置功能,并且具备规范的权限管理、参数配置、环境管理及日志审计等特性。
基于Spring Boot和Spring Cloud开发打包后可以直接运行不需要额外安装Tomcat等应用容器支持在线Shell。
Kongx 使用指南请参考:[Wiki](https://www.kancloud.cn/raoxiaoyan/kongx/1984321)
kongxe的前端页面[kongx-web](https://gitee.com/raoxy/kongx-web)
平台快速部署请参见[Quick Start](https://www.kancloud.cn/raoxiaoyan/kongx/1984323)
Docker部署(3.0.0+支持)请参见[Docker Quick Start](./docker-quick-start/readme.md)
可视化设计网关pipeline使用文档请参考[网关流水线](https://www.kancloud.cn/raoxiaoyan/kongx/2055265)
演示地址http://159.75.135.225/ (用户名: guest/123456)
系统环境默认用户admin/123456(部署登录后,请前往'个人设置'页面,及时修改密码)
## Screenshots
![](./docs/screen.png)
![](./docs/kong%20shell.png)
![](./docs/service2.png)
![可视化网关流水线](./docs/pipeline.png)
![](./docs/consumers.png)
![](./docs/certificate.png)
## Features
- Kong Manage:Upstream,Service,Route,Plugin,Consumer,Certificates及Ca Certificates等
- 支持网关流水线
- 同步Kong配置:不同环境间的kong配置进行同步便于多环境配置管理
- 系统管理:具有完善的权限管理系统,包括:用户管理、菜单管理、角色管理及用户组管理等功能;
- 参数管理:具有良好的扩展性,基于平台的参数管理可扩展多环境及服务管理;包括:环境管理、参数参数等
- 日志管理:平台具有完善的日志审计功能,包括:同步日志、操作日志;
## Kong插件列表
- [官网插件](https://docs.konghq.com/hub/)
- [灰度插件canary](https://gitee.com/raoxy/kong-plugins-canary)
- [防攻击 kong_injection](https://github.com/ror6ax/kong_injection)
## kong最佳实践
- [Kong与consul自主发现服务](https://www.kancloud.cn/raoxiaoyan/kongx/1984357)
- 如何应用灰度插件(canary)及使用场景介绍
- kong插件开发实践
- [kong的健康检查及熔断](https://www.kancloud.cn/raoxiaoyan/kongx/2044771)
- kong网关流水线
- 整理中...尽情期待
## RoadMap
1、初步计划kongx自适应kong后续所有版本;(3.1.0版本已完成自动适配至3.1.x版本)
2、增加shell界面和可视化管理界面(2.0.1版本支持, 2020/11/18 已完成)
3、增加网关流水线的图形化界面设计
## 技术支持
<table>
<thead>
<th>Kongx技术支持1群<br />群号980245072(未满)</th>
<th>技术合作<br />请扫描微信二维码</th>
</thead>
<tbody>
<tr>
<td><img src="./docs/kongx_tech1.png" alt="tech-support-qq-1"></td>
<td><img src="./docs/cooperate.jpg" alt="cooperate" width="230px;"></td>
</tr>
</tbody>
</table>
## kongx与kong版本关系
| 序号 | kongx版本 | Kong版本 | 说明 |
| --- | --- | --- | --- |
| 1 | 1.2.x | 1.2.x | 1.2.x测试|
| 2 | 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]|
| 3 | 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]|
## Upgrade
[更新历史](docs/upgrade.md)
## 参考链接
- [Kong官网](https://docs.konghq.com/1.2.x/admin-api/)
- [OpenResty最佳实践](https://www.kancloud.cn/kancloud/openresty-best-practices/50428)