简介
用户可以使用CLI启动,停止和管理Kong实例、仅限于本地节点
全局标志位
所有指令都可以携带下列全局标志位:
- --help:打印指令的帮助信息;
- --v:打印详细信息;
- --vv:打印调试信息;
可用指令
- kong check
用法:kong check \<conf\>
检查Kong配置文件的完备性
\<conf\> 配置文件,(默认为 /etc/kong/kong.conf)
- kong config
用法:kong config COMMAND [OPTIONS]
使用Kong的配置文件
可选的命令包含:
init:生成一份配置文件样例
db_import <file>:将配置导入Kong数据库
parse <file>:解析配置文件,但不加载到Kong实例中
Options:
-c,--conf:指定配置文件
-p,--prefix:覆盖相对路径目录
- kong health
用法:kong health [OPTIONS]
查看运行在当前节点的Kong服务的健康状态
Options:
-p,--prefix:Kong服务运行的路径
- kong migrations
用法:kong migrations COMMAND [OPTIONS]
可选的命令包含:
bootstrap:执行所有数据迁移
up:执行新的数据迁移
finish:在up指令之后结束所有挂起的数据迁移任务
list:列出已执行的数据迁移任务
reset:重置数据库
Options:
-y,--yes:运行非交互模式
-q,--quiet:屏蔽所有输出
-f,--force:强制执行指令
--db-timeout:数据库操作超时时间,默认60秒
--lock-timeout:启用--run-migrations指令时,等待主节点同步数据超时时间,默认60秒
-c,--conf:指定配置文件
- kong prepare
用法:kong prepare [OPTIONS]
用`kong start`之外的另一种方法启动Kong服务
示例:
kong migrations up
kong prepare -p /usr/local/kong -c kong.conf
nginx -p /usr/local/kong -c /usr/local/kong/nginx.conf
Options:
-c,--conf:指定配置文件
-p,--prefix:覆盖相对路径目录
--nginx-conf:自定义配置模板
- kong quit
用法:kong quit [OPTIONS]
优雅地关闭运行中的Kong服务节点,这条执行会向Nginx发送一个 SIGQUIT 指令,等待所有的请求都处理完了再关闭服务,当超过超时间后,会强制关闭
Options:
-p,--prefix:覆盖相对路径目录
-t,--timeout:执行强制关闭等待时间,默认为10秒
-w,--wait:等待若干秒后,执行关闭操作,默认为0秒
- kong reload
用法:kong reload [OPTIONS]
重新加载Kong服务节点,这条命令会向Nginx发送一个 HUP 命令,Nginx用新的配置生成新的worker线程,老的线程处理完当前的请求时被杀掉
Options:
-c,--conf:指定配置文件
-p,--prefix:覆盖相对路径目录
--nginx-conf:自定义配置模板
- kong restart
用法:kong restart [OPTIONS]
重启Kong服务节点,这条指令等同于执行`kong stop`和`kong start`两条指令
Options:
-c,--conf:指定配置文件
-p,--prefix:覆盖相对路径目录
--nginx-conf:自定义配置模板
--run-migrations:启动前先执行数据迁移
--db-timeout:数据库操作超时时间,默认60秒
--lock-timeout:启用--run-migrations指令时,等待主节点同步数据超时时间,默认60秒
- kong start
用法:kong start [OPTIONS]
启动Kong服务
Options:
-c,--conf:指定配置文件
-p,--prefix:覆盖相对路径目录
--nginx-conf:自定义配置模板
--run-migrations:启动前先执行迁移
--db-timeout:数据库操作超时时间,默认60秒
--lock-timeout:启用--run-migrations指令时,等待主节点同步数据超时时间,默认60秒
- kong stop
用法:kong stop [OPTIONS]
停止运行的Kong节点,这条命令会向Nginx发送一条 SIGTERM 信号
Options:
-p,--prefix:Kong服务运行的路径
- kong version
用法:kong version [OPTIONS]
打印Kong的版本
Options:
-a,--all:打印所有依赖的版本