API网关——Kong实践分享

小咪咪 2022-01-16 23:05 310阅读 0赞

# **概述** #

### 01什么是Kong ###

Kong是一个在Nginx中运行的Lua应用程序，可以通过lua-nginx模块实现，Kong不是用这个模块编译Nginx，而是与OpenRestry一起发布，OpenRestry已经包含了lua-nginx-module，OpenRestry是Nginx的一组扩展功能模块。

### 02为什么是Kong ###

Kong是一个Api Gateway，通过插件的形式提供负载均衡，日志记录，身份验证，速率限制，转换等功能。

Kong可以很轻松扩展功能，模块化，可以运行在任何基础设施上。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70][]

### 03术语 ###

Route：是请求的转发规则，按照Hostname和PATH，将请求转发给Service。

Services：是多个Upstream的集合，是Route的转发目标。

Consumer：是API的用户，里面记录用户的一些信息。

Plugin：是插件，plugin可以是全局的，绑定到Service，绑定到Router，绑定到Consumer。

Certificate：是https证书。

Sni：是域名与Certificate的绑定，指定了一个域名对应的https证书。

Upstream：是负载均衡策略。

Target：是最终处理请求的Backend服务。

### 04特性 ###

*  动态负载均衡
 *  基于散列的负载均衡
 *  断路器
 *  健康检查
 *  Websockets
 *  OAuth2.0
 *  日志记录
 *  安全性
 *  Syslog
 *  监控
 *  转发代理
 *  认证
 *  速率限制
 *  故障检测和恢复

……

更多详情参考：https://docs.konghq.com/hub/

### 05开源/企业对比 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 1][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 2][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 3][]

# **架构** #

### 01架构图 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 4][]

1.1版本以后支持无db模式

### 02执行流程 ###

加入kong后，每个客户端对API的请求将首先到达Kong，然后被代理到最终API，在请求和响应之间，Kong将执行任何已安装的插件，扩展API功能集，Kong有效的成为每个API的入口点。

# **部署** #

Kong支持在任何基础设施上运行，支持docker、packages、vagrant、Homebrew、CloudFormation、AWS、Azure、Kubernetes等。

本次部署基于package方式，部署软件版本。

<table> 
 <thead> 
  <tr> 
   <th>软件</th> 
   <th>版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Kong</td> 
   <td>1.0.3</td> 
  </tr> 
  <tr> 
   <td>Postgresql</td> 
   <td>9.6</td> 
  </tr> 
  <tr> 
   <td>Kong-dashboard</td> 
   <td>3.5.0</td> 
  </tr> 
 </tbody> 
</table>

### 01部署Postgresql ###

docker run --name postgres -e POSTGRES_PASSWORD=123456 -p 5432:5432 -d postgres:9.6

### 02创建用户及数据库 ###

\# 登陆

psql -U postgres -h 10.20.1.190 -p 5432

\#创建用户

create user kong with password ‘kong’;

\#创建数据库

create database kong owner kong;

\#退出控制台

\\q

### 03下载安装包 ###

wget：https://kong.bintray.com/kong-rpm/centos/7/:kong-1.0.3.el7.noarch.rpm

### 04安装配置 ###

\#安装rpm

yum install kong-1.0.3.el7.noarch.rpm

\#拷贝配置

cp /etc/kong/kong.conf.default /etc/kong/kong.conf

\#配置

admin_listen = 0.0.0.0:8001, 0.0.0.0:8444 ssl
    
    pg_host = 10.20.1.190
    
    pg_port = 5432
    
    pg_user = kong
    
    pg_password = kong
    
    pg_database = kong

保存并退出。

### 05启动kong ###

\#数据库迁移，初始化表

kong migrations bootstrap -c /etc/kong/kong.conf –vv

\#启动

kong start -c /etc/kong/kong.conf

### 06部署kong-dashboard ###

dashboard目前只支持kong版本1.0.3，kong最新版本不支持，使用pgbi/kong-dashboard镜像

\#启动dashboard

docker run -p 8888:8080 pgbi/kong-dashboard start --kong-url http://10.20.1.190:8001

# **使用** #

01upstream

![20190612160010846.png][]

02target

![20190612160021783.png][]

03service

![20190612160031683.png][]

04routers

![20190612160042902.png][]

05验证

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 5][]

06插件

**1.Base-auth**

*  创建consumer

![20190612160104866.png][]

*  创建Basic-auth-credential

![20190612160114686.png][]

*  服务开启Basic-auth

![20190612160124869.png][]

*  验证

未加用户信息，没权限，效果如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 6][]

加入用户信息后，效果如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 7][]

# **集成** #

01Dns SRV

Kong利用Dns轮询访问后端应用。

**1.架构图**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 8][]

**2.检查服务域名**

使用Dns做服务发现，查看boms-user-service服务如下：

# dig @10.20.11.118 -p 8600 boms-user-service.service.dc1.consul SRV

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 9][]

含义解释：

![20190612160300622.png][]

调用服务域名boms-user-service.service.dc1.consul，通过dns解析找到实例ip+port，如上例中10.20.11.118:8081。

**3.修改kong配置**

vim 编辑kong.conf，增加：

dns_resolver: 127.0.0.1:8600

**4.kong中使用**

在kong中手动增加一个service，host填入服务域名，增加router，即可转发。

**5.总结**

需要手动在kong中创建服务，并且仅适用consul注册中心。

https://github.com/faizalpribadi/kongsul

02Agent 轮询

**1.架构图**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 10][]

agent负责监听注册中心，动态调用kong admin API创建upstream、target、service、router等资源。

用户通过boms平台调用admin API修改router信息，实现服务转发功能，在此数据基础之上在启用插件，丰富功能。

# **开发** #

01命令行

https://docs.konghq.com/1.0.x/cli/

02Admin API

https://docs.konghq.com/1.0.x/admin-api/

例如：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 11][]

03插件开发

https://docs.konghq.com/1.0.x/pdk/ 插件开发工具包。

参考

*  https://docs.konghq.com Kong官方文档
 *  https://docs.konghq.com/hub/kong-inc 插件文档
 *  https://www.lijiaocn.com/%E6%8A%80%E5%B7%A7/2017/03/06/dns-srv.html dns-srv 详解
 *  https://github.com/faizalpribadi/kongsul
 *  https://github.com/YeautyYE/nacos-nginx-template
 *  https://github.com/quancheng-ec/eureka-kong-register

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70]: /images/20220117/0a049abe2b2f491eaef31424816c991a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 1]: /images/20220117/d535f0cb1fa8473e82befa5c1d6e724e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 2]: /images/20220117/f81dff9306e543e5843bb500532c8dba.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 3]: /images/20220117/a39f2255b4554670bedd5c36d57db1b6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 4]: /images/20220117/24a0e46a6e044b3eb92079a9adff067b.png
[20190612160010846.png]: /images/20220117/03cceecec21d47fe92a0b770c6a5b4f0.png
[20190612160021783.png]: /images/20220117/fc937096a17a4808af4c15905975a25d.png
[20190612160031683.png]: /images/20220117/44f7dcdc7a3c47f48456a3af9ac25585.png
[20190612160042902.png]: /images/20220117/424e1b9fb35c4daba4ccbc2879185b51.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 5]: /images/20220117/e789cb0dacc0408189dce9161e05c123.png
[20190612160104866.png]: /images/20220117/15f171ba7a0342c0bd30ba183204a8f4.png
[20190612160114686.png]: /images/20220117/5a082ec3ad934b9694a02c601d8417f5.png
[20190612160124869.png]: /images/20220117/fc3962b05be94bb489bad49a393ee580.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 6]: /images/20220117/7c1c632832214ce6bb55314950bdcde1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 7]: /images/20220117/4c93f16f3a564adaa7a1f823a0bbdebd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 8]: /images/20220117/e9f59ce3618648b5b292ed8ba07efccf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 9]: /images/20220117/1331ac236c6844c6a225470d46aff11b.png
[20190612160300622.png]: /images/20220117/43e0589b59c94c6c9a374acfc4ab3f57.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 10]: /images/20220117/df8d4ab2cd1f4a529ea62925f75e8a43.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NxdWlycmVsYW5pbWFsMDkyMg_size_16_color_FFFFFF_t_70 11]: /images/20220117/daf9659c08fe4c24a02906fa05c44935.png