簡介
用戶可以使用CLI啟動,停止和管理Kong實例黔帕、僅限于本地節(jié)點
全局標志位
所有指令都可以攜帶下列全局標志位:
- --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]
查看運行在當前節(jié)點的Kong服務的健康狀態(tài)
Options:
-p荸百,--prefix:Kong服務運行的路徑
- kong migrations
用法:kong migrations COMMAND [OPTIONS]
可選的命令包含:
bootstrap:執(zhí)行所有數據遷移
up:執(zhí)行新的數據遷移
finish:在up指令之后結束所有掛起的數據遷移任務
list:列出已執(zhí)行的數據遷移任務
reset:重置數據庫
Options:
-y闻伶,--yes:運行非交互模式
-q,--quiet:屏蔽所有輸出
-f够话,--force:強制執(zhí)行指令
--db-timeout:數據庫操作超時時間蓝翰,默認60秒
--lock-timeout:啟用--run-migrations指令時,等待主節(jié)點同步數據超時時間女嘲,默認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]
優(yōu)雅地關閉運行中的Kong服務節(jié)點爆雹,這條執(zhí)行會向Nginx發(fā)送一個 SIGQUIT 指令,等待所有的請求都處理完了再關閉服務,當超過超時間后钙态,會強制關閉
Options:
-p慧起,--prefix:覆蓋相對路徑目錄
-t,--timeout:執(zhí)行強制關閉等待時間册倒,默認為10秒
-w蚓挤,--wait:等待若干秒后,執(zhí)行關閉操作剩失,默認為0秒
- kong reload
用法:kong reload [OPTIONS]
重新加載Kong服務節(jié)點屈尼,這條命令會向Nginx發(fā)送一個 HUP 命令,Nginx用新的配置生成新的worker線程拴孤,老的線程處理完當前的請求時被殺掉
Options:
-c脾歧,--conf:指定配置文件
-p,--prefix:覆蓋相對路徑目錄
--nginx-conf:自定義配置模板
- kong restart
用法:kong restart [OPTIONS]
重啟Kong服務節(jié)點演熟,這條指令等同于執(zhí)行`kong stop`和`kong start`兩條指令
Options:
-c鞭执,--conf:指定配置文件
-p,--prefix:覆蓋相對路徑目錄
--nginx-conf:自定義配置模板
--run-migrations:啟動前先執(zhí)行數據遷移
--db-timeout:數據庫操作超時時間芒粹,默認60秒
--lock-timeout:啟用--run-migrations指令時兄纺,等待主節(jié)點同步數據超時時間,默認60秒
- kong start
用法:kong start [OPTIONS]
啟動Kong服務
Options:
-c化漆,--conf:指定配置文件
-p估脆,--prefix:覆蓋相對路徑目錄
--nginx-conf:自定義配置模板
--run-migrations:啟動前先執(zhí)行遷移
--db-timeout:數據庫操作超時時間,默認60秒
--lock-timeout:啟用--run-migrations指令時座云,等待主節(jié)點同步數據超時時間疙赠,默認60秒
- kong stop
用法:kong stop [OPTIONS]
停止運行的Kong節(jié)點,這條命令會向Nginx發(fā)送一條 SIGTERM 信號
Options:
-p朦拖,--prefix:Kong服務運行的路徑
- kong version
用法:kong version [OPTIONS]
打印Kong的版本
Options:
-a圃阳,--all:打印所有依賴的版本