介绍

本文原文链接：https://docs.konghq.com/1.1.x/cli/

提供的CLI（命令行界面Command Line Interface）允许启动，停止和管理Kong实例。CLI可以管理本地节点（如在当前计算机上）。

如果您还没有使用，我们建议您阅读配置参考。

通用标志参数

所有命令都将一组特殊的可选标志作为参数：

  • --help：打印此命令的帮助信息
  • --v：启用详细模式
  • --vv：启用调试模式（很多输出）

可用命令

kong check

  1. Usage: kong check <conf>
  3. 检查给定Kong配置文件的有效性。
  5. <conf> (default /etc/kong/kong.conf) 配置文件

kong health

  1. Usage: kong health [OPTIONS]
  3. 验证Kong 的服务组件是否正常运行
  5. Options:
  6.  -p,--prefix      (可选参数) Kong运行位置的前缀

kong migrations

  1. Usage: kong migrations COMMAND [OPTIONS]
  3. 管理数据库迁移。
  5. 可用的命令如下：
  6.   bootstrap                         引导数据库并运行全部迁移（初始化）。
  8.   up                                运行新迁移。
  10.   finish                            完成正在等待中的迁移命令，在执行`up`后。
  12.   list                              列出已执行的迁移。
  14.   reset                             重置数据库。
  16. Options（可选）:
  17.  -y,--yes                           假设提示“yes”，并运行非交互模式
  19.  -q,--quiet                         忽略所有输出
  21.  -f,--force                         依旧执行迁移，即使数据库报告已经执行过了。
  23.  --db-timeout     (default 60)      超时时间，以秒为单位，所有数据库操作通用（包括Cassandra的schema consensus）。
  25.  --lock-timeout   (default 60)      超时时间，以秒为单位, 节点等待领导节点迁移完成。
  27.  -c,--conf        (optional string) 配置文件。

kong prepare

此命令用来准备Kong前缀文件夹及其子文件夹和文件。

  1. Usage: kong prepare [OPTIONS]
  3. 在配置的前缀目录中准备Kong前缀。这个命令可以用于从nginx二进制文件启动Kong而不使用`kong start`命令。
  5. Example usage:
  6.   kong migrations up
  7.   kong prepare -p /usr/local/kong -c kong.conf
  8.   nginx -p /usr/local/kong -c /usr/local/kong/nginx.conf
  10. Options:
  11.   -c,--conf       (optional string) 配置文件
  12.   -p,--prefix     (optional string) 覆盖前缀目录
  13.   --nginx-conf    (optional string) 自定义Nginx配置模板

kong quit

  1. Usage: kong quit [OPTIONS]
  3. 优雅地退出一个正在运行的Kong节点（Nginx和其他节点）在给定的前缀目录中配置的服务。
  5. 此命令将会向Nginx发送SIGQUIT信号，表示全部请求将在关闭之前完成处理。
  6. 如果达到超时延迟，则该节点将被强制执行停止（SIGTERM）
  8. Options:
  9.  -p,--prefix      (optional string) kong正在运行的前缀
  10.  -t,--timeout     (default 10) 强制停止前的超时

kong reload

  1. Usage: kong reload [OPTIONS]
  3. 重新加载Kong节点（并启动其他已配置的服务）在给定的前缀目录中。
  5. 此命令将HUP信号发送到Nginx，它将生成workers（告知account配置变更），当他们处理完成当前的请求后就停止旧的。
  7. Options:
  8.   -c,--conf       (optional string) 配置文件
  9.   -p,--prefix     (optional string) 覆盖前缀目录
  10.   --nginx-conf    (optional string) 自定义Nginx配置模板

kong restart

  1. Usage: kong restart [OPTIONS]
  3. 重新启动Kong节点（以及其他配置的服务，如Serf）在给定的前缀目录中。
  5. 这个命令相当于同时执行`kong stop`和`kong start`。
  7. Options:
  8.  -c,--conf        (optional string)   配置文件
  9.  -p,--prefix      (optional string)   Kong运行的前缀
  10.  --nginx-conf     (optional string)   自定义Nginx配置模板
  11.  --run-migrations (optional boolean)  可选地在DB上运行迁移
  12.  --db-timeout     (default 60)
  13.  --lock-timeout   (default 60)

kong start

  1. Usage: kong start [OPTIONS]
  3. 在配置中启动Kong（Nginx和其他配置的服务）。
  5. Options:
  6.  -c,--conf        (optional string)   配置文件。
  8.  -p,--prefix      (optional string)   覆盖前缀目录。
  10.  --nginx-conf     (optional string)   自定义Nginx配置模板。
  12.  --run-migrations (optional boolean)  在开始之前运行迁移。
  14.  --db-timeout     (default 60)      超时时间，以秒为单位，所有数据库操作通用（包括Cassandra的schema consensus）。
  16.  --lock-timeout   (default 60)      超时时间，以秒为单位, 节点等待领导节点迁移完成。

kong stop

  1. Usage: kong stop [OPTIONS]
  3. 停止给定的正在运行的Kong节点（Nginx和其他已配置的服务）在指定的前缀目录。
  5. 此命令将SIGTERM信号发送到Nginx。
  7. Options:
  8.  -p,--prefix      (optional string) Kong运行的前缀

kong version

  1. Usage: kong version [OPTIONS]
  3. 打印kong的版本。
  4. 使用-a选项，将打印所有底层依赖项的版本。
  6. Options:
  7.  -a,--all         获取所有依赖项的版本