1、增加升级文档;

2、更新版本号为1.3.0
This commit is contained in:
raoxiaoyan 2020-11-02 14:32:23 +08:00
parent 0698f574e2
commit 559223f71a
8 changed files with 128 additions and 18 deletions

View File

@ -1,13 +1,36 @@
# kongx
#### Description
kongx是网关kong的可视化界面管理平台(参考konga的部分界面布局方式),能够集中化管理应用不同环境的网关配置,提供同步各环境的网关配置功能,并且具备规范的权限管理、参数配置、环境管理及日志审计等特性。
基于Spring Boot和Spring Cloud开发打包后可以直接运行不需要额外安装Tomcat等应用容器
#### Screenshots
![](https://gitee.com/raoxy/kongx/blob/master/docs/screen.png)
#### Features
Kongx 使用指南请参考:[Wiki](https://www.kancloud.cn/raoxiaoyan/kongx/1984321)
平台快速部署请参见[Quick Start](https://www.kancloud.cn/raoxiaoyan/kongx/1984323)
系统环境默认用户admin/123456(部署登录后,请前往'个人设置'页面,及时修改密码)
## Screenshots
![](./docs/screen.png)
![](./docs/services.png)
![](./docs/service1.png)
![](./docs/kong%20shell.png)
![](./docs/user.png)
![](./docs/env.png)
![](./docs/params.png)
![](./docs/log.png)
![](./docs/synclog.png)
## Features
- Kong Manage:Upstream,Service,Route,Plugin,Consumer等
- 同步Kong配置:同步不同环境间的kong配置便于多环境同一项目配置管理
@ -15,15 +38,42 @@ kongx是网关kong的可视化界面管理平台(参考konga的部分界面布
- 参数管理:具有良好的扩展性,基于平台的参数管理可扩展多环境及服务管理;包括:环境管理、参数参数等
- 日志管理:平台具有完善的日志审计功能,包括:同步日志、操作日志;
#### Quick start
[快速安装](https://gitee.com/raoxy/kongx/wikis/pages?sort_id=2979225&doc_id=983590)
## Kong插件列表
- [官网插件](https://docs.konghq.com/hub/)
- [灰度插件canary](https://gitee.com/raoxy/kong-plugins-canary)
- [防攻击 kong_injection](https://github.com/ror6ax/kong_injection)
#### Kong网关插件列表
- [灰度插件Canary](https://gitee.com/raoxy/kong-plugins-canary)
- [...]
## kong最佳实践
#### kong网关最佳实践
- Kong与consul自主发现服务
- [Kong与consul自主发现服务](https://www.kancloud.cn/raoxiaoyan/kongx/1984357)
- 如何应用灰度插件(canary)及使用场景介绍
- kong插件开发实践
- 整理中...尽情期待
## kongx与kong版本关系
## RoadMap
1、初步计划kongx自适应kong后续所有版本;
2、增加shell界面和可视化管理界面
## 技术支持
![](./docs/Kongx技术支持1群聊二维码.png)
## 版本支持
| 序号 | kongx版本 | Kong版本 | 说明 |
| --- | --- | --- | --- |
| 1 | 1.2.x | 1.2.x | 1.2.x测试|
| 1 | 1.3.x | 1.2.x、1.3.x+ | 只做过1.2.x、1.3.x测试,对1.4.x以上版本与1.3.x对比差异原则上基础功能全部可用(参考差异对比)[https://www.kancloud.cn/raoxiaoyan/kongx/1991178]|
## 升级历史
- 1.3.x发布版本(2020/11/10)
> 1. 增加upstream被动健康检查的配置
> 2. 所有页面由弹窗改为面包屑导航
> 3. 增加版本自适应功能1.3.x可适配至kong所有版本1.3.x,1.4.x,1.5.x,2.0.x,2.1.x)
>
## 参考链接
- [Kong官网](https://docs.konghq.com/1.2.x/admin-api/)
- [OpenResty最佳实践](https://www.kancloud.cn/kancloud/openresty-best-practices/50428)

View File

@ -50,6 +50,10 @@ Kongx 使用指南请参考:[Wiki](https://www.kancloud.cn/raoxiaoyan/kongx/19
- kong插件开发实践
- 整理中...尽情期待
## kongx与kong版本关系
## RoadMap
1、初步计划kongx自适应kong后续所有版本;
@ -57,6 +61,15 @@ Kongx 使用指南请参考:[Wiki](https://www.kancloud.cn/raoxiaoyan/kongx/19
## 技术支持
![](./docs/Kongx技术支持1群聊二维码.png)
## 版本支持
| 序号 | kongx版本 | Kong版本 | 说明 |
| --- | --- | --- | --- |
| 1 | 1.2.x | 1.2.x | 1.2.x测试|
| 1 | 1.3.0 | 1.2.x、1.3.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)

14
docs/upgrade.md Normal file
View File

@ -0,0 +1,14 @@
## 升级向导
- 1.3.0发布(2020/11/10)
> 1. 增加certificate及ca_certificate
> 2. 增加upstream被动健康检查的配置
> 3. 所有页面由弹窗改为面包屑导航
> 4. 增加版本自适应功能1.3.0可适配至kong所有版本1.2.x、1.3.x,1.4.x,1.5.x,2.0.x,2.1.x)
## 1. 升级到1.3.0
参考Kongx [Quick Start](https://www.kancloud.cn/raoxiaoyan/kongx/1984323)即可
## 2. 1.2.x升级到1.3.0
由1.2.x升级到1.3.0只需要两个步骤:
2.1、 下载1.3.0的kongx安装包
2.2、 下载数据库升级脚本,[1.2.xto1.3.0.sql](./upgrade/1.2.xto1.3.xlog.md)

View File

@ -0,0 +1,33 @@
# 1.2.x 升级1.3.0 sql脚本
```sql
INSERT INTO `kongx_system_function` (`parent_id`, `code`, `name`, `menu_icon`, `visit_view`, `visit_path`, `use_yn`, `menu_type`, `application_code`, `sort_order`) VALUES ('5', '', 'Snis', 'icon-sni', 'views/gateway/sni/index', 'snis', 'y', 'menu', 'kongx', '7');
INSERT INTO `kongx_system_function` (`parent_id`, `code`, `name`, `menu_icon`, `visit_view`, `visit_path`, `use_yn`, `menu_type`, `application_code`, `sort_order`) VALUES ('5', '', 'Certificates', 'icon-certificate', 'views/gateway/certificate/index', 'certificate', 'y', 'menu', 'kongx', '8');
INSERT INTO `kongx_system_function` (`parent_id`, `code`, `name`, `menu_icon`, `visit_view`, `visit_path`, `use_yn`, `menu_type`, `application_code`, `sort_order`) VALUES ('53', 'consumer_add', '新增consumer', '', '', '', 'y', 'point', 'kongx', '999');
INSERT INTO `kongx_system_function` (`parent_id`, `code`, `name`, `menu_icon`, `visit_view`, `visit_path`, `use_yn`, `menu_type`, `application_code`, `sort_order`) VALUES ('53', 'consumer_update', '更新consumer', '', '', '', 'y', 'point', 'kongx', '999');
INSERT INTO `kongx_system_function` (`parent_id`, `code`, `name`, `menu_icon`, `visit_view`, `visit_path`, `use_yn`, `menu_type`, `application_code`, `sort_order`) VALUES ('53', 'consumer_delete', '删除consumer', '', '', '', 'y', 'point', 'kongx', '999');
INSERT INTO `kongx_system_function` (`parent_id`, `code`, `name`, `menu_icon`, `visit_view`, `visit_path`, `use_yn`, `menu_type`, `application_code`, `sort_order`) VALUES ('60', 'certificate_view', '查看certificate', '', '', '', 'y', 'point', 'kongx', '999');
INSERT INTO `kongx_system_function` (`parent_id`, `code`, `name`, `menu_icon`, `visit_view`, `visit_path`, `use_yn`, `menu_type`, `application_code`, `sort_order`) VALUES ('60', 'certificate_add', '新增certificate', '', '', '', 'y', 'point', 'kongx', '999');
INSERT INTO `kongx_system_function` (`parent_id`, `code`, `name`, `menu_icon`, `visit_view`, `visit_path`, `use_yn`, `menu_type`, `application_code`, `sort_order`) VALUES ('60', 'certificate_update', '修改certificate', '', '', '', 'y', 'point', 'kongx', '999');
INSERT INTO `kongx_system_function` (`parent_id`, `code`, `name`, `menu_icon`, `visit_view`, `visit_path`, `use_yn`, `menu_type`, `application_code`, `sort_order`) VALUES ('60', 'certificate_delete', '删除certificate', '', '', '', 'y', 'point', 'kongx', '999');
insert into kongx_system_role_function(role_id,half_checked,function_id)
select * from (
select '1' role_id,'n' half_checked,'-1' as function_id
union all
select '1' role_id,'n' half_checked,id as function_id from kongx_system_function
) a
where not EXISTS (select * from kongx_system_role_function b where a.function_id=b.function_id and b.role_id=a.role_id);
insert into kongx_system_role_function(role_id,half_checked,function_id)
select * from (
select '2' role_id,'y' half_checked,'-1' as function_id
union
select '2' role_id,'y' half_checked,id as function_id from kongx_system_function where name in ('Gateway','Upstreams','Services','Routes','Plugins','Kong Shell','Consumers','Certificates','日志管理')
union
select '2' role_id,'n' half_checked,id as function_id from kongx_system_function where code in ('service_view','upstream_view','route_view','plugin_view','consumer_view','certificate_view')
union
select '2' role_id,'n' half_checked,id as function_id from kongx_system_function where name='操作日志'
) a
where not EXISTS (select * from kongx_system_role_function b where a.function_id=b.function_id and b.role_id=a.role_id);
```

BIN
docs/wechat.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

View File

@ -5,7 +5,7 @@
<parent>
<artifactId>kongx</artifactId>
<groupId>com.kongx</groupId>
<version>1.2.x</version>
<version>1.3.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>

View File

@ -5,7 +5,7 @@
<parent>
<artifactId>kongx</artifactId>
<groupId>com.kongx</groupId>
<version>1.2.x</version>
<version>1.3.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@ -14,7 +14,7 @@
<dependency>
<groupId>com.kongx</groupId>
<artifactId>kongx-common</artifactId>
<version>1.2.x</version>
<version>1.3.0</version>
</dependency>
<dependency>

View File

@ -13,7 +13,7 @@
<groupId>com.kongx</groupId>
<artifactId>kongx</artifactId>
<packaging>pom</packaging>
<version>1.2.x</version>
<version>1.3.0</version>
<modules>
<module>kongx-serve</module>
<module>kongx-common</module>