Rainbond上部署API Gateway Kong及环境配置教程

什么是Kong

Kong是一个可扩展的开源API平台（也称为API网关，API中间件或微服务服务网格）。Kong最初是由Kong Inc.（以前称为Mashape）实现的，用于为其API Marketplace维护、管理和扩展超过15,000个微服务，这些微服务每月产生数十亿个请求。

技术上讲，Kong是在Nginx中运行的Lua应用程序，并且通过lua-nginx-module实现。Kong是与OpenResty一起分发的，而不是使用此模块来编译Nginx，OpenResty已经包括lua-nginx-module。

OpenResty? 是一个基于 Nginx 与 Lua 的高性能 Web 平台，其内部集成了大量精良的 Lua 库、第三方模块以及大多数的依赖项。用于方便地搭建能够处理超高并发、扩展性极高的动态 Web 应用、Web 服务和动态网关。

OpenResty? 通过汇聚各种设计精良的 Nginx 模块（主要由 OpenResty 团队自主开发），从而将 Nginx 有效地变成一个强大的通用 Web 应用平台。这样，Web 开发人员和系统工程师可以使用 Lua 脚本语言调动 Nginx 支持的各种 C 以及 Lua 模块，快速构造出足以胜任 10K 乃至 1000K 以上单机并发连接的高性能 Web 应用系统。

OpenResty? 的目标是让你的Web服务直接跑在 Nginx 服务内部，充分利用 Nginx 的非阻塞 I/O 模型，不仅仅对 HTTP 客户端请求,甚至于对远程后端诸如 MySQL、PostgreSQL、Memcached 以及 Redis 等都进行一致的高性能响应。

参考 组件 可以知道 OpenResty? 中包含了多少软件。

参考 上路 学习如何从最简单的 hello world 开始使用 OpenResty? 开发 HTTP 业务，或前往 下载 直接获取 OpenResty? 的源代码包开始体验。

了解更多有关Kong的事情，你需要点击Kong Inc.了解一下。

从应用市场快速安装

目前我们已经将最新版本（v1.4.X）的Kong发布到了应用市场，如果你想要快速的搭建以及使用Kong，你只需要做一件事情，那就是点击一下安装：

等待一小段时间后，Kong就已经部署在了你的Rainbond集群中了。在这个应用中，我们已经集成了Konga作为UI管理工具，接下来的步骤，需要你访问Konga，做几步简单的设置，就可以愉快的探索Kong了。

• 注册Konga

• 配置Kong的连接地址，写入 http://127.0.0.1:8001即可

• 连接成功，就可以使用Konga来管理你的Kong了

注意事项

如果你所使用的Rainbond平台，是在2019年12月25日以前安装的，并且没有进行过任何升级操作，那么你可能遇到Konga连接不到Kong的问题，解决的方案如下：

• 如果你使用了v5.1.9以前的版本，请升级到最新版本。
• 如果你现在已经在使用v5.1.9版本，那么请点击链接，打个补丁。

Kong的启动很消耗内存

配置Kong

环境变量

Kong支持以KONG_开头的环境变量进行配置。举例说明：

对于部署在Rainbond上的Kong来说，直接添加环境变量

KONG_LOG_LEVEL = error

即可在Kong的配置文件中生成

log_level = error

添加完成后，点击更新，即可使之生效。

注入Nginx配置

通过调整Kong实例的Nginx配置，可以优化其基础架构的性能。

Kong启动时，将构建一个Nginx配置文件。你可以通过Kong配置直接将自定义Nginx配置注入此文件。

注入单个Nginx配置

Kong的配置文件中的任何前缀为的条目nginx_http_， nginx_proxy_或nginx_admin_通过删除前缀将其转换为等效的Nginx指令，并将其添加到Nginx配置的相应部分：

前缀为的条目nginx_http_将注入到整体http 块指令中。

前缀为的条目nginx_proxy_将注入到server处理Kong代理端口的block指令中。

前缀为的条目nginx_admin_将注入到server处理Kong的Admin API端口的block指令中。

例如，如果将以下行添加到kong.conf文件中：

nginx_proxy_large_client_header_buffers=16 128k

它将以下指令添加到serverKong的Nginx配置的代理块中：

large_client_header_buffers 16 128k;

为了达到这个目的，你需要参考环境变量，为Kong添加以下环境变量：

KONG_NGINX_HTTP_OUTPUT_BUFFERS = "4 64k"

通过注入的Nginx指令包含文件

对于更复杂的配置方案，例如添加整个新 server块，可以使用上述方法include向Nginx配置注入 指令，指向包含其他Nginx设置的文件。

可以通过在kong.conf文件中添加以下条目来包含目标文件：

nginx_http_include = /path/to/your/my-server.kong.conf

在Rainbond上，可以通过环境变量进行配置：

KONG_NGINX_HTTP_INCLUDE="/path/to/your/my-server.kong.conf"

Kong应用怎么制作

即点即用的Kong，使用起来非常方便。那么这个应用是怎么制作的呢？

我们只需要做到以下几点，就可以发布出可以即点即用的云市场应用：

目标应用的所有组件都已经部署在Rainbond并正常运行各服务组件使用的数据库具备自动初始化数据的功能各服务组件间的依赖关系已经处理妥当，从业务层面已经正常运行

接下来，只需要参考应用分享与发布，将你的应用发布出去即可。

数据库自动初始化

Kong可以使用的数据库包括 Postgres与Cassandra，我们这里使用了前者。

首先利用docker run 命令快速部署一个Postgresql：

docker run -d --name kong-database \
                -p 5432:5432 \
                -e "POSTGRES_USER=kong" \
                -e "POSTGRES_DB=kong" \
                postgres:9.6

使用Kong的镜像，即可初始化数据库表结构，在部署初始化组件时，要记得建立从 kong-init 指向 kong-database的依赖关系：

docker run --rm \
    --name kong-init \
    --link kong-database:kong-database \
    -e "KONG_DATABASE=postgres" \
    -e "KONG_PG_HOST=127.0.0.1" \
    -e "KONG_CASSANDRA_CONTACT_POINTS=kong-database" \
    kong kong migrations bootstrap

kong-init 运行完成后会自动退出，在Rainbond上显示运行异常，不用担心，它已经完成了使命，验证下 kong-database 中已存在数据表结构，就可以删除kong-init 了。

进入 kong-database 的容器实例，通过命令行工具备份出数据库。

pg_dump -U kong -d kong > /var/lib/postgresql/data/data.sql

找到 kong-database 的数据持久化目录，得到 data.sql，kong-database 的使命也就达成了，可以被关闭删除。

自定义一个代码仓库，参考 https://github.com/dazuimao1990/pri-postgresql/tree/kong 将 data.sql 放到 sql 目录下，即可用这份代码创建一个可以自动初始化表结构的Postgresql了。创建之，命名为 kong-postgres 备用。

部署Kong

直接使用docker run 命令创建Kong，要记得建立从 Kong 指向 kong-postgres 的依赖关系：

docker run -d --name kong \
    --link kong-database:kong-database \
    -e "KONG_DATABASE=postgres" \
    -e "KONG_PG_HOST=127.0.0.1" \
    -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

内存至少提高至4G。

部署Konga

直接使用docker run 命令创建Konga，要记得建立从 Konga 指向 Kong 的依赖关系：

docker run -p 1337:1337 \
             --name konga \
             pantsel/konga

完成后，最终拓扑将会是这个样子的：

发布应用

点击 发布到市场，编辑它的信息，即可发布了。