kong笔记——自定义插件目录及部署

kong笔记目录导航

简述

本文目标：

了解kong插件的基本信息
手动部署自定义插件

注意：本文不涉及自定义插件的开发，仅仅说明自定义插件的目录结构与部署方式

目录结构

基本插件模块

两个必须的文件：

simple-plugin
├── handler.lua
└── schema.lua

高级插件的模块：
除了handler.lua、schema.lua外，还包含：

complete-plugin
├── api.lua
├── daos.lua
├── handler.lua
├── migrations
│   ├── cassandra.lua
│   └── postgres.lua
└── schema.lua

以下是具体的说明：

模块文件名称	是否必须	描述
api.lua	No	定义Admin API中可用的端点列表，以与插件处理的实体自定义实体进行交互。
daos.lua	No	定义DAO（数据库访问对象）列表，这些DAO是插件所需并存储在数据存储区中的自定义实体的抽象。
handler.lua	Yes	一个接口的实现。每个函数都由Kong在请求的生命周期中的所需时刻运行。
migrations/xxxx.lua	No	给定数据存储的相应迁移。只有当您的插件必须在数据库中存储自定义实体并通过daos.lua定义的其中一个DAO与它们进行交互时，才需要进行迁移。
schema.lua	Yes	保存插件配置的架构，以便用户只能输入有效的配置值。

通俗点来讲：

handler.lua：是实现kong各个阶段生命周期的业务逻辑接口；

schema.lua：是传递给表单需要配置的参数，让用户自己自定义配置。

对于kong的生命周期，在kong笔记——认识kong本篇已经说过了，就不在详述了

部署插件

官方提供了两种方式：

通过LuaRocks；（没试过，暂时部讲）
手动

手动的方式有两种：

自定义你插件的存放位置（自动化好，比如自定义dockerfile+k8s部署）
将插件放到kong 插件默认的位置（测试时方便，生产环境非常不建议！！！！！）

自定义插件位置

采用此方式的时候，必须符合kong官方的规则：

整体步骤

编写好你自己写好的插件，并存储到你自定义的位置（自定义位置一定要以/kong/plugins/结尾的，不然会扫描不到！！！！！！！！！！！）；

在kong.conf中指定lua扫描的路径

lua_package_path = /<path-to-plugin-location>/kong/plugins/?.lua;;

如果你配置了多个插件，而这些插件又放到了多个路径，则：

lua_package_path = /<path-to-plugin-location>/kong/plugins;/<path-to-plugin-location2>/kong/plugins/?.lua;;

;;代表默认路径

;代表扫描路径

加载插件
在kong.conf中引入
```
plugins = bundled,<plugin-name>
```
如果你不需要kong自带的插件，可以取消掉 bundled
重启kong
```
kong reload
```

example

我们这里要发布一个change-log的插件（此插件是拷贝kong默认插件的 file-log）

新建一个目录，暂时命名为/opt/share/kong/plugins
拷贝file-log(kong默认的位置：/usr/local/share/lua/5.1/kong/plugins)

修改kong.conf文件（/etc/kong），主要修改两部分，lua的扫描路径以及kong加载你自定义的插件

# 添加自定义插件工作目录
lua_package_path = /opt/share/?.lua;;# 启用插件: change-log
#  bundled: 表示Kong, 自带插件
plugins = bundled, change-log

重启kong即可
```
kong reload
```

kong默认的位置

整体步骤

编写好你自己写好的插件，并存储到/usr/local/share/lua/5.1/kong/plugins/change-log；
加载插件
在kong.conf中引入
```
plugins = bundled,<plugin-name>
```
如果你不需要kong自带的插件，可以取消掉 bundled
在/usr/local/share/lua/5.1/kong/目录下，找到constants.lua文件，在 local plugins table中添加你的插件名称
重启kong
```
kong reload
```

example

我们这里要发布一个change-log的插件（此插件是拷贝kong默认插件的 file-log）

创建change-log插件

修改kong.conf

# 启用插件: change-log
#  bundled: 表示Kong, 自带插件
plugins = bundled, change-log

修改constants.lua文件
重启kong
```
kong reload
```

最后效果如下：