簡介
用戶可以使用CLI啟動(dòng),停止和管理Kong實(shí)例、僅限于本地節(jié)點(diǎn)
全局標(biāo)志位
所有指令都可以攜帶下列全局標(biāo)志位:
- --help:打印指令的幫助信息;
- --v:打印詳細(xì)信息;
- --vv:打印調(diào)試信息;
可用指令
- kong check
用法:kong check \<conf\>
檢查Kong配置文件的完備性
\<conf\> 配置文件,(默認(rèn)為 /etc/kong/kong.conf)
- kong config
用法:kong config COMMAND [OPTIONS]
使用Kong的配置文件
可選的命令包含:
init:生成一份配置文件樣例
db_import <file>:將配置導(dǎo)入Kong數(shù)據(jù)庫
parse <file>:解析配置文件,但不加載到Kong實(shí)例中
Options:
-c,--conf:指定配置文件
-p,--prefix:覆蓋相對(duì)路徑目錄
- kong health
用法:kong health [OPTIONS]
查看運(yùn)行在當(dāng)前節(jié)點(diǎn)的Kong服務(wù)的健康狀態(tài)
Options:
-p,--prefix:Kong服務(wù)運(yùn)行的路徑
- kong migrations
用法:kong migrations COMMAND [OPTIONS]
可選的命令包含:
bootstrap:執(zhí)行所有數(shù)據(jù)遷移
up:執(zhí)行新的數(shù)據(jù)遷移
finish:在up指令之后結(jié)束所有掛起的數(shù)據(jù)遷移任務(wù)
list:列出已執(zhí)行的數(shù)據(jù)遷移任務(wù)
reset:重置數(shù)據(jù)庫
Options:
-y,--yes:運(yùn)行非交互模式
-q,--quiet:屏蔽所有輸出
-f,--force:強(qiáng)制執(zhí)行指令
--db-timeout:數(shù)據(jù)庫操作超時(shí)時(shí)間,默認(rèn)60秒
--lock-timeout:啟用--run-migrations指令時(shí),等待主節(jié)點(diǎn)同步數(shù)據(jù)超時(shí)時(shí)間,默認(rèn)60秒
-c,--conf:指定配置文件
- kong prepare
用法:kong prepare [OPTIONS]
用`kong start`之外的另一種方法啟動(dòng)Kong服務(wù)
示例:
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:覆蓋相對(duì)路徑目錄
--nginx-conf:自定義配置模板
- kong quit
用法:kong quit [OPTIONS]
優(yōu)雅地關(guān)閉運(yùn)行中的Kong服務(wù)節(jié)點(diǎn),這條執(zhí)行會(huì)向Nginx發(fā)送一個(gè) SIGQUIT 指令,等待所有的請(qǐng)求都處理完了再關(guān)閉服務(wù),當(dāng)超過超時(shí)間后,會(huì)強(qiáng)制關(guān)閉
Options:
-p,--prefix:覆蓋相對(duì)路徑目錄
-t,--timeout:執(zhí)行強(qiáng)制關(guān)閉等待時(shí)間,默認(rèn)為10秒
-w,--wait:等待若干秒后,執(zhí)行關(guān)閉操作,默認(rèn)為0秒
- kong reload
用法:kong reload [OPTIONS]
重新加載Kong服務(wù)節(jié)點(diǎn),這條命令會(huì)向Nginx發(fā)送一個(gè) HUP 命令,Nginx用新的配置生成新的worker線程,老的線程處理完當(dāng)前的請(qǐng)求時(shí)被殺掉
Options:
-c,--conf:指定配置文件
-p,--prefix:覆蓋相對(duì)路徑目錄
--nginx-conf:自定義配置模板
- kong restart
用法:kong restart [OPTIONS]
重啟Kong服務(wù)節(jié)點(diǎn),這條指令等同于執(zhí)行`kong stop`和`kong start`兩條指令
Options:
-c,--conf:指定配置文件
-p,--prefix:覆蓋相對(duì)路徑目錄
--nginx-conf:自定義配置模板
--run-migrations:啟動(dòng)前先執(zhí)行數(shù)據(jù)遷移
--db-timeout:數(shù)據(jù)庫操作超時(shí)時(shí)間,默認(rèn)60秒
--lock-timeout:啟用--run-migrations指令時(shí),等待主節(jié)點(diǎn)同步數(shù)據(jù)超時(shí)時(shí)間,默認(rèn)60秒
- kong start
用法:kong start [OPTIONS]
啟動(dòng)Kong服務(wù)
Options:
-c,--conf:指定配置文件
-p,--prefix:覆蓋相對(duì)路徑目錄
--nginx-conf:自定義配置模板
--run-migrations:啟動(dòng)前先執(zhí)行遷移
--db-timeout:數(shù)據(jù)庫操作超時(shí)時(shí)間,默認(rèn)60秒
--lock-timeout:啟用--run-migrations指令時(shí),等待主節(jié)點(diǎn)同步數(shù)據(jù)超時(shí)時(shí)間,默認(rèn)60秒
- kong stop
用法:kong stop [OPTIONS]
停止運(yùn)行的Kong節(jié)點(diǎn),這條命令會(huì)向Nginx發(fā)送一條 SIGTERM 信號(hào)
Options:
-p,--prefix:Kong服務(wù)運(yùn)行的路徑
- kong version
用法:kong version [OPTIONS]
打印Kong的版本
Options:
-a,--all:打印所有依賴的版本