Kong Gateway OSS [ARCHIVE]
0.10.x
CLI Reference
Introduction
The provided CLI (Command Line Interface) allows you to start, stop, and manage your Kong instances. The CLI manages your local node (as in, on the current machine).
If you haven’t yet, we recommend you read the configuration reference.
Global flags
All commands take a set of special, optional flags as arguments:
--help
: print the command’s help message--v
: enable verbose mode--vv
: enable debug mode (noisy)
Available commands
kong check
Usage: kong check <conf>
Check the validity of a given Kong configuration file.
<conf> (default /etc/kong.conf or /etc/kong/kong.conf) configuration file
kong cluster
Usage: kong cluster COMMAND [OPTIONS]
Manage Kong's clustering capabilities.
The available commands are:
keygen -c Generate an encryption key for intracluster traffic.
See 'cluster_encrypt_key' setting
members -p Show members of this cluster and their state.
reachability -p Check if the cluster is reachable.
force-leave -p <node_name> Forcefully remove a node from the cluster (useful
if the node is in a failed state).
keys install <key> Install a new key onto Kong's internal keyring. This
will enable the key for decryption. The key will not
be used to encrypt messages until the primary key is
changed.
keys use <key> Change the primary key used for encrypting messages.
All nodes in the cluster must already have this key
installed if they are to continue communicating with
each other.
keys remove <key> Remove a key from Kong's internal keyring. The key
being removed may not be the current primary key.
keys list List all currently known keys in the cluster. This
will ask all nodes in the cluster for a list of keys
and dump a summary containing each key and the
number of members it is installed on to the console.
Options:
-c,--conf (optional string) configuration file
-p,--prefix (optional string) prefix Kong is running at
kong compile
For a detailed example of this command, see the Embedding Kong section of the configuration reference.
Usage: kong compile [OPTIONS]
Compile the Nginx configuration file containing Kong's servers
contexts from a given Kong configuration file.
Example usage:
kong compile -c kong.conf > /usr/local/openresty/nginx-kong.conf
This file can then be included in an OpenResty configuration:
http {
# ...
include 'nginx-kong.conf';
}
Note:
Third-party services such as Serf need to be properly configured
and started for Kong to be fully compatible while embedded.
Options:
-c,--conf (optional string) configuration file
kong health
Usage: kong health [OPTIONS]
Check if the necessary services are running for this node.
Options:
-p,--prefix (optional string) prefix at which Kong should be running
kong migrations
Usage: kong migrations COMMAND [OPTIONS]
Manage Kong's database migrations.
The available commands are:
list List migrations currently executed.
up Execute all missing migrations up to the latest available.
reset Reset the configured database (irreversible).
Options:
-c,--conf (optional string) configuration file
kong quit
Usage: kong quit [OPTIONS]
Gracefully quit a running Kong node (Nginx and other
configured services) in given prefix directory.
This command sends a SIGQUIT signal to Nginx, meaning all
requests will finish processing before shutting down.
If the timeout delay is reached, the node will be forcefully
stopped (SIGTERM).
Options:
-p,--prefix (optional string) prefix Kong is running at
-t,--timeout (default 10) timeout before forced shutdown
kong reload
Usage: kong reload [OPTIONS]
Reload a Kong node (and start other configured services
if necessary) in given prefix directory.
This command sends a HUP signal to Nginx, which will spawn
new workers (taking configuration changes into account),
and stop the old ones when they have finished processing
current requests.
Options:
-c,--conf (optional string) configuration file
-p,--prefix (optional string) prefix Kong is running at
--nginx-conf (optional string) custom Nginx configuration template
kong restart
Usage: kong restart [OPTIONS]
Restart a Kong node (and other configured services like Serf)
in the given prefix directory.
This command is equivalent to doing both 'kong stop' and
'kong start'.
Options:
-c,--conf (optional string) configuration file
-p,--prefix (optional string) prefix at which Kong should be running
--nginx-conf (optional string) custom Nginx configuration template
kong start
Usage: kong start [OPTIONS]
Start Kong (Nginx and other configured services) in the configured
prefix directory.
Options:
-c,--conf (optional string) configuration file
-p,--prefix (optional string) override prefix directory
--nginx-conf (optional string) custom Nginx configuration template
kong stop
Usage: kong stop [OPTIONS]
Stop a running Kong node (Nginx and other configured services) in given
prefix directory.
This command sends a SIGTERM signal to Nginx.
Options:
-p,--prefix (optional string) prefix Kong is running at
kong version
Usage: kong version [OPTIONS]
Print Kong's version. With the -a option, will print
the version of all underlying dependencies.
Options:
-a,--all get version of all dependencies