在nginx上搭建api网关-Kong实战

Kong是什么?

随着我们服务拆分的逐渐细化,项目数量的与日俱增,针对于各个项目的一些个性化管控需求也同时出现,比如某些服务仅限内网使用,某些服务需要限流,某些服务需要授权。而这些东西基本上可以归结到我们的api网关层面上,所以我们期望引入一套成熟的api网关系统,且足够轻便,简洁,可扩展化。基于目前小中大的互联网公司都采用nginx来做代理,Kong这个系统便应运而生。kong系统官网地址

选用Kong的原因

star高,有大公司采用,可集成k8s,也可docker化,其实就是一个特殊的nginx,和原生nginx性能差别不大,有比较不错的dashboard,插件化丰富,可自己扩展插件使用。

搭建

目前暂时只做测试搭建

目前我正在调研使用,可能会做一个完成的测试工作后才会选择上线,目前暂时放在测试环境,由于依赖的项目较多,建议采用docker-compose来启动,以下是我实际使用的配置,

kong-database:
  image: postgres:9.5
  ports:
    - 5432:5432
  environment:
    - POSTGRES_USER=kong
    - POSTGRES_DB=kong
    - POSTGRES_PASSWORD=kong
  volumes:
    - ~/kongdata:/var/lib/postgresql/data
  container_name: kong-database

kong:
  image: kong:latest
  restart: always
  links:
    - kong-database:kong-database
  ports:
    - 8000:8000
    - 8443:8443
    - 8001:8001
  environment:
    - KONG_DATABASE=postgres
    - KONG_PG_HOST=kong-database
    - KONG_PG_USER=kong
    - KONG_PG_DATABASE=kong
    - KONG_PG_PASSWORD=kong
    - KONG_CASSANDRA_CONTACT_POINTS=kong-database
    - KONG_ADMIN_LISTEN=0.0.0.0:8001, 0.0.0.0:8444 ssl
  container_name: kong

kong-dashboard:
    image: pgbi/kong-dashboard:v2
    ports:
      - "8081:8080"
    links:
      - kong
    container_name: kong-dashboard

kong-database有两种选择,cassandrapostgres,我选用的是后者,kong最新的版本已经是1.0的正式版了,推荐的postgres应是9.5及其以上的版本。dashboard在github上有许多种,我只是从中选择了一个,大家可以根据自身需要变换。

启动步骤

因为kong其实是深度依赖数据库的,我们数据库这时候并没有初始化建立好表,所以我们还需要执行下列步骤

docker-compose run kong kong migrations up

执行完成后再启动我们的项目

docker-compose up -d

这个时候我们的kong项目应该成功启动了,通过我们的docker管理工具应该能看到。


kong

api管理

kong的api配置管理有两种,一种是直接通过curl发api请求来进行,一种是通过dashboard来管理。
发送请求由于配置不友好,写起来麻烦这篇文章暂不采用,但是有兴趣的可以从这个链接去进行学习kong的admin-api 使用

dashboard篇

我们先输入ifconfig获取本机ip,访问以下地址打开

http://本机ip:8081

然后输入我们在docker文件里配置的账号密码,应该都是kong
大概打开的就如下页面

dashboard

创建一个api

api

首先还是介绍upstream url,指的是我们的上游url,也就是我们反向代理实际访问的url,这个是必须配置的。
Hosts,指的是需要在header头上特定指名Host,kong会根据该Host路由到指定的上游url,可以设置多个。
Uris,指的是特定路由时会反向代理到我们的上游url,也同样可以设置多个。
Methods, 这个则指的是特定的Http方法时可以路由,也是可设置多个。
大致配置例子如下图:
api2

配置完成后,我们可以测试一下效果,以w-a 这个服务为例子,我们需要在header上带上Host,kong项目的端口是8000,所以我们直接访问

http://127.0.0.1:8000
api-get

启动插件

kong的插件多种多样,官方本身就提供了30多种的常见插件,大家可根据自身需要选择插件并且设置,我以其中一款插件来举例子rate-limiting,限流插件

plugin

只配置minute=1,表达1分钟只能访问一次,其余走默认配置。
plugin-api

可以看到,我们频繁访问的话会被限制访问。

consumer

consumer 是kong提供的一个控制用户访问api的功能,我们可以设定api给特定的consumer使用,首先创建一个consumer

consumer

并且给我们的consumer创建一个key-auth的key,且开启key-auth插件,并且keyname不用配置(默认采用apikey为key‘name)
consumer-editor

curl-consumer

这个时候,只有我们传递了apikey时,才有资格访问我们的api。

最后

kong无疑给我们提供了许多的想象空间,其实kong本事也就是对 nginx.conf 文件做了很多个性化的修改,能让我们动态化的变更我们的网关配置,而不是蛋疼地修改nginx文件本身,包括kong扩展的本身其实也就是nginx扩展,只是通过kong可以更快的配置,编写和使用起来,之后,我还会给大家讲解如何编写kong扩展,来加速我们的项目使用,而kong的扩展其实分为两种,利用数据库的和纯逻辑的。两种都会给大家进行详细的讲解,当然,kong的扩展也是利用lua写的,所以想写扩展之前,还得学习lua的相关知识,不过比较简单,我相信你的 lua官方教程。

参考链接

[云框架]KONG API Gateway-用户指南
kong-ui部署 docker-compose编排
kong官方文档

你可能感兴趣的:(在nginx上搭建api网关-Kong实战)