# kongx
kongx(最新版本2.1.0)是網關kong的可視化界面管理平臺(參考konga的部分界面布局方式),能夠集中化管理應用不同環境的網關配置,提供同步各環境的網關配置功能,并且具備規范的權限管理、參數配置、環境管理及日志審計等特性。
基于Spring Boot和Spring Cloud開發,打包后可以直接運行,不需要額外安裝Tomcat等應用容器,支持在線Shell。
Kongx 使用指南請參考:[Wiki](http://www.hmoore.net/raoxiaoyan/kongx/1984321)
平臺快速部署請參見[Quick Start](http://www.hmoore.net/raoxiaoyan/kongx/1984323)
Docker部署(2.0.0+支持)請參見[Docker Quick Start](https://gitee.com/raoxy/kongx/blob/master/docker-quick-start/readme.md)
可視化設計網關pipeline使用文檔請參考[網關流水線](http://www.hmoore.net/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#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自主發現服務](http://www.hmoore.net/raoxiaoyan/kongx/1984357)
* 如何應用灰度插件(canary)及使用場景介紹
* kong插件開發實踐
* [kong的健康檢查及熔斷](http://www.hmoore.net/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(未滿) | 技術合作
| 請掃描微信二維碼 |
| --- |
|  |
## 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對比差異,原則上基礎功能全部可用,(參考差異對比)\[[http://www.hmoore.net/raoxiaoyan/kongx/1991178](http://www.hmoore.net/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對比差異,原則上基礎功能全部可用,(參考差異對比)\[[http://www.hmoore.net/raoxiaoyan/kongx/1991178](http://www.hmoore.net/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最佳實踐](http://www.hmoore.net/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模式