介绍

Kong提供的CLI(命令行界面)允许您启动、停止和管理您的Kong实例。CLI会管理您的本地节点(就像在当前机器上一样)。

全局标识

所有命令都采用一组特殊的、可选的标识作为参数:

• --help：打印命令的帮助信息。
• --v：启用详情模式。
• --vv：启用调试模式

可用命令

kong check

用法： kong check <conf>

检查给定Kong配置文件的有效性。

<conf> 默认配置文件路径： /etc/kong/kong.conf

kong config

用法: kong config COMMAND [OPTIONS]

带有Kong的声明性配置文件。

可用的命令有:
  init [<file>]             生成一个示例启动的配置文件。如果没有给出文件名，默认使用./kong.yml。
              
  db_import <file>    在Kong数据库中输入一个声明性的配置文件。               

  db_export [<file>]  将Kong数据库导出到一个声明性配置文件中。
                                 如果没有给出文件名，默认使用./kong.yml。

  parse <file>           解析一个声明式配置文件(检查它的语法)但不加载到Kong。  
  
  可选项:
 -c,--conf        (optional string)  配置文件。
 -p,--prefix      (optional string) 覆盖配置文件中的prefix指定的路径。

kong health

用法： kong health [OPTIONS]

检查此节点是否正在运行必要的服务

可选项：
 -p,--prefix      (optional string) 

kong hybrid

用法： kong hybrid COMMAND [OPTIONS]

Kong的混合模式。

可用的命令有：
  gen_cert [<cert> <key>]    生成适合在混合模式部署中使用的证书/密钥对。
           除非给定文件名，否则在当前目录中将Cert和key被写入 './cluster.crt' 和 './cluster.key'。
可选项:
 -d,--days        (optional number)  重写证书有效期。默认:1095天(3年)

kong migrations

用法： kong migrations COMMAND [OPTIONS]

管理数据的迁移方式。

可用的命令有：
  bootstrap                引导并运行数据库所有迁移。

  up                             运行任何新的迁移。

  finish                         在“启动”之后，运行所有up的迁移。

  list                             执行迁移的列表。

  reset                          重置数据库。
  
  可选项：
 -y,--yes                        假设“yes”提示并以非交互方式运行。

 -q,--quiet                      压缩所有输出内容。

 -f,--force                        即使数据库迁移工程中出现报告，也要继续进行迁移。

 --db-timeout     (默认值 60)   所有数据库(包括Cassandra的模式一致)操作的超时时间(以秒为单位)。

 --lock-timeout   (默认值 60)    等待leader节点完成迁移的节点超时时间(以秒为单位)。
 
 -c,--conf        (optional string) 配置文件.

kong prepare

这个命令准备Kong的prefix文件夹及其子文件夹和文件。

用法： kong prepare [OPTIONS]

在配置的prefix目录中准备Kong的prefix。这个命令可以用来从nginx二进制文件中启动Kong，而不需要使用“Kong start”命令。

用法示例：
kong migrations up
kong prepare -p /usr/local/kong -c kong.conf
nginx -p /usr/local/kong -c /usr/local/kong/nginx.conf

可选项：
 -c,--conf       (optional string) 配置文件。
 -p,--prefix     (optional string)覆盖prefix对应的目录。
 --nginx-conf    (optional string)自定义nginx的配置模板。

kong quit

用法：kong quit [OPTIONS]

在给定的prefix目录中优雅地退出运行中的Kong节点(Nginx和其他配置的服务)。

Options:
 -p,--prefix      (optional string) Kong 运行所在的prefix的路径。
 -t,--timeout   (默认值 10) 强制停机的超时时间。
 -w,--wait        (默认值 0)  启动关闭之前等待的时间。

kong reload

用法： kong reload [OPTIONS]

在给定的prefix目录中重新加载Kong节点(并在必要时启动其他配置的服务)。

这个命令向Nginx发送一个HUP信号，这会产生新的worker(考虑到配置变化)，并在旧的工作进程完成当前请求处理后停止它们。

可选项：
 -c,--conf        (optional string) 配置文件路径
 -p,--prefix      (optional string) Kong运行所在的prefix的路径
 --nginx-conf     (optional string) 自定义的nginx配置模板

kong restart

用法： kong restart [OPTIONS]

重新启动指定的prefix目录中Kong节点(以及其他配置的服务，如Serf)。

这个命令相当于同时执行“kong stop”和“kong start”。

可选项：
 -c,--conf        (optional string)   配置文件路径
 -p,--prefix      (optional string)   通过prefix指定Kong将运行的所在的目录。
 --nginx-conf     (optional string)   自定义nginx的配置模板
 --run-migrations (optional boolean)  可以选择在数据库上运行迁移
 --db-timeout     (默认值 60)
 --lock-timeout   (默认值 60)

kong start

用法： kong start [OPTIONS]

在已配置的prefix目录中启动Kong (Nginx和其他已配置的服务)。

可选项：
 -c,--conf        (optional string)   配置文件路径。

 -p,--prefix      (optional string)  覆盖配置文件中指定的prefix路径。

 --nginx-conf     (optional string)  自定义nginx配置文件模板。

 --run-migrations (optional boolean)  在开始之前运行迁移。

 --db-timeout     (默认值 60)     所有数据库(包括Cassandra的一致性)操作的超时时间(以秒为单位)。

 --lock-timeout   (默认值 60)     当启用 --run-migrations时，
                                                  对于等待leader节点完成迁移的节点，超时时间(以秒为单位)。

kong stop

用法：kong stop [OPTIONS]

在指定的prefix目录中停止运行的Kong节点(Nginx和其他配置的服务)。

这个命令向Nginx发送一个SIGTERM信号。

可选项:
 -p,--prefix      (optional string) Kong运行所在的prefix目录。

kong version

用法： kong version [OPTIONS]

打印Kong的版本号。通过-a选项，将打印所有基础依赖项的版本。

可选项：
 -a,--all         获取所有依赖项的版本