前言
在微服务架构中,由于系统和服务的细分,导致系统结构变得非常复杂, 为了跨平台,为了统一集中管理api,同时为了不暴露后置服务。甚至有时候需要对请求进行一些安全、负载均衡、限流、熔断、灰度等中间操作,基于此类种种的客观需求一个类似综合前置的系统就产生了,这就是API网关(API Gateway)。API网关作为分散在各个业务系统微服务的API聚合点和统一接入点,外部请求通过访问这个接入点,即可访问内部所有的REST API服务。目前常用的微服务网关有zuul、gateway,今天来简单介绍一下另一种选择——Kong 。说到Kong可能对大家有点陌生,我们来先了解下另一种不陌生的中间件——OpenResty。
OpenResty
OpenResty® 是一个基于 Nginx 与 Lua 的高性能 Web 平台,其内部集成了大量精良的 Lua 库、第三方模块以及大多数的依赖项。用于方便地搭建能够处理超高并发、扩展性极高的动态 Web 应用、Web 服务和动态网关。因此,我们可以做出各种符合我们需要的网关策略的Lua脚本,以其为基础构建高性能的网关系统。
Kong
Kong基于OpenResty,是一个云原生、快速、可扩展、分布式的Api 网关。继承了OpenResty的高性能、易扩展性等特点。Kong通过简单的增加机器节点,可以很容易的水平扩展。同时功能插件化,可通过插件来扩展其能力。而且在任何基础架构上都可以运行。具有以下特性:
-
提供了多样化的认证层来保护Api。
-
可对出入流量进行管制。
-
提供了可视化的流量检查、监视分析Api。
-
能够及时的转换请求和相应。
-
提供log解决方案
-
可通过api调用Serverless 函数。
业务网关与流量网关
对于具体的后端业务应用或者是服务和业务有一定关联性的策略网关就是上图左边的架构模型——业务网关。 业务网关针对具体的业务需要提供特定的流控策略、缓存策略、鉴权认证策略等等。
与业务网关相反,定义全局性的、跟具体的后端业务应用和服务完全无关的策略网关就是上图右边所示的架构模型——流量网关。流量网关通常只专注于全局的Api管理策略,比如全局流量监控、日志记录、全局限流、黑白名单控制、接入请求到业务系统的负载均衡等,有点类似防火墙。Kong 就是典型的流量网关。
这里需要补充一点的是,业务网关一般部署在流量网关之后、业务系统之前,比流量网关更靠近业务系统。通常API网关指的是业务网关。 有时候我们也会模糊流量网关和业务网关,让一个网关承担所有的工作,所以这两者之间并没有严格的界线。
Kong 的架构
请求流程
每个客户请求都会先到达Kong 网关,然后再代理到最终的API。在请求和响应之间,Kong将执行已安装配置的插件,从而扩展AP的I功能集。
插件
插件作为Kong的一大特色这里不得不简单提一下,目前Kong的插件有免费、有收费(企业版)、还有社区(github)提供的,有能力也可以通过Kong官方提供的模板使用lua脚本来开发自己定制的插件。现阶段提供有8类插件功能涉及身份验证、权限安全、流量控制、Serverless、分析与监控、数据转换、日志信息、部署发布。可通过官方插件库或者github搜索来获取。
上手难度
Kong 提供了在各个平台的安装包。目前最新版本提供了无数据库依赖和数据库依赖两种模式,安装并不复杂。如果从现有的Kong提供的功能来说,全部基于配置。可通过配置文件或者Restful Admin Api 进行配置管理。而且有很多第三方可视化UI,如Konga 。如果需要对Kong进行定制化开发,需要深度掌握OpenResty、Nginx、lua脚本等相关的知识,所以一般建议Kong作为流量网关使用。
总结
今天大体简单介绍了Kong网关,在zuul停止维护,Spring Cloud Gateway还在完善之中的情况下,Kong也是值得关注的网关技术选型之一。今后也会在https://www.spring4all.com 分享相关的使用心得。 也可以关注社区公众号:SpringForAll社区 和我进行直接的探讨交流。
1. 前言
上一文我们对Kong网关的简单介绍,今天我们来搭建Kong的环境。以便于以后对Kong的进一步了解和学习。
2. Kong支持的环境
从上图来看Kong对Linux、MacOS、容器、云 支持的还是比较全面的。鉴于大部分国内开发者使用的是Windows环境。本文依然使用Docker进行安装。建议对Docker不太了解的同学学习相关的知识。也可以关注我的公众号:Felordcn 来及时获取相关的知识。
3. 安装Kong
你的机器中必须有Docker环境,这个是前提。假设你已经具备了必须的环境。Kong的安装其实还是不复杂的,有些文章可能介绍的不是那么清楚。Kong 安装有两种方式一种是没有数据库依赖的DB-less 模式,另一种是with a Database 模式。我们这里使用第二种带Database的模式,因为这种模式功能更全。
3.1 构建Kong的容器网络
首先我们创建一个Docker自定义网络,以允许容器相互发现和通信。在下面的创建命令中kong-net
是我们创建的Docker网络名称,当然你可以使用你认为合适的名称。
docker network create kong-net
3.2 搭建数据库环境
Kong 目前使用Cassandra(Facebook开源的分布式的NoSQL数据库) 或者PostgreSql,你可以执行以下命令中的一个来选择你的Database。请注意定义网络 --network=kong-net
。
-
Cassandra容器:
docker run -d --name kong-database \
--network=kong-net \
-p 9042:9042 \
cassandra:3
-
PostgreSQL容器:
docker run -d --name kong-database \
--network=kong-net \
-p 5432:5432 \
-e "POSTGRES_USER=kong" \
-e "POSTGRES_DB=kong" \
postgres:9.6
这里有个小问题。如果你使用的是PostgreSQL,想挂载卷持久化数据到宿主机。通过 -v
命令是不好用的。这里推荐你使用 docker volume create
命令来创建一个挂载。如果你想知道更多可关注我的公众号:Felordcn 或者通过https://felord.cn 来获取更多信息。
docker volume create kong-volume
然后上面的PostgreSQL就可以通过- v kong-volume:/var/lib/postgresql/data
进行挂载了。
docker run -d --name kong-database \
--network=kong-net \
-p 5432:5432 \
-v kong-volume:/var/lib/postgresql/data \
-e "POSTGRES_USER=kong" \
-e "POSTGRES_DB=kong" \
postgres:9.6
3.3 初始化或者迁移数据库
我们使用docker run --rm
来初始化数据库,该命令执行后会退出容器而保留内部的数据卷(volume)。
docker run --rm \
--network=kong-net \
-e "KONG_DATABASE=postgres" \
-e "KONG_PG_HOST=kong-database" \
-e "KONG_CASSANDRA_CONTACT_POINTS=kong-database" \
kong:latest kong migrations bootstrap
这个命令我们还是要注意的,一定要跟你声明的网络,数据库类型、host名称一致。同时注意Kong的版本号,本文是在Kong 1.3
版本下完成的。
3.4 启动Kong容器
3.3步骤完成初始化或者迁移数据库后,我们就可以启动一个连接到数据库容器的Kong容器,请务必保证你的数据库容器启动状态,同时检查所有的环境参数 -e
是否是你定义的环境。
docker run -d --name kong \
--network=kong-net \
-e "KONG_DATABASE=postgres" \
-e "KONG_PG_HOST=kong-database" \
-e "KONG_CASSANDRA_CONTACT_POINTS=kong-database" \
-e "KONG_PROXY_ACCESS_LOG=/dev/stdout" \
-e "KONG_ADMIN_ACCESS_LOG=/dev/stdout" \
-e "KONG_PROXY_ERROR_LOG=/dev/stderr" \
-e "KONG_ADMIN_ERROR_LOG=/dev/stderr" \
-e "KONG_ADMIN_LISTEN=0.0.0.0:8001, 0.0.0.0:8444 ssl" \
-p 8000:8000 \
-p 8443:8443 \
-p 8001:8001 \
-p 8444:8444 \
kong:latest
3.5 验证
可通过 curl -i http://localhost:8001/
或者浏览器调用 http://localhost:8001/
来验证Kong Admin 是否联通 。
4. 安装Kong 管理UI
Kong 企业版提供了管理UI,开源版本是没有的。但是有很多的开源的管理 UI ,其中比较好用的是Konga。项目地址:https://github.com/pantsel/konga
4.1 Konga 特性
Konga 主要是用 AngularJS 写的,运行于nodejs服务端。具有以下特性:
-
管理所有Kong Admin API对象。
-
支持从远程源(数据库,文件,API等)导入使用者。
-
管理多个Kong节点。使用快照备份,还原和迁移Kong节点。
-
使用运行状况检查监视节点和API状态。
-
支持电子邮件和闲置通知。
-
支持多用户。
-
易于数据库集成(MySQL,postgresSQL,MongoDB,SQL Server)。
4.2 docker安装Konga
同样我们今天通过Docker来安装Konga。安装步骤同样遵循配置数据库,初始化数据库,启动容器的流程。
4.2.1 Konga数据库容器
上面在4.1特性介绍中我们介绍了Konga支持的数据库类型。这里我们依然使用PostgreSQL。请注意我新定义了挂载卷
konga-postgresql
。
docker run -d --name konga-database \
--network=kong-net \
-p 5433:5432 \
-v konga-postgresql:/var/lib/postgresql/data \
-e "POSTGRES_USER=konga" \
-e "POSTGRES_DB=konga" \
-e "POSTGRES_PASSWORD=konga" \
postgres:9.6
4.2.2 初始化Konga数据库
初始化 PostgreSQL 数据库。
docker run --rm --network=kong-net \
pantsel/konga:latest
-c prepare
-a postgres
-u postgres://konga@konga-database:5432/konga
相关命令解读:
命令 | 描述 | 默认 |
---|---|---|
-c | 执行的命令,这里我们执行的是prepare | - |
-a | adapter 简写 ,可以是postgres 或者mysql | - |
-u | db url 数据库连接全称 | - |
到此Konga的数据库环境就搞定了。
4.2.3 环境参数
Konga 还有一些可配置的环境参数:
4.2.4 启动Konga
通过以下命令就可以启动Konga容器了
docker run -d -p 1337:1337 \
--network kong-net \
-e "DB_ADAPTER=postgres" \
-e "DB_URI=postgres://konga@konga-database:5432/konga" \
-e "NODE_ENV=production" \
-e "DB_PASSWORD=konga" \
--name konga \
pantsel/konga
运行完后,如果成功可以通过http://localhost:1337
链接到控制台。通过注册后进入,然后在dashboard面板里面添加Kong的管理Api路径http://yourdomain
。这里添加 http://ip:8001
。注意请不要使用localhost
、127.0.0.1
、0.0.0.0
有可能联通不上Kong。成功后就会出现 上面4. 所显现的界面。
5. 总结
今天对Kong的安装、Konga的安装进行了详细的介绍。希望对你进一步了解和学习Kong有所帮助。