diff --git a/bin/kong b/bin/kong index 01f39176dba..f12d909ff14 100755 --- a/bin/kong +++ b/bin/kong @@ -18,7 +18,7 @@ local help_message = string.format([[ Usage: kong where is one of: - start, stop, quit, restart, reload, config, db, version + start, restart, reload, stop, quit, db, version kong --help print this message kong --help print the help message of a command diff --git a/src/cli/config.lua b/src/cli/config.lua index f69b94d65b9..1a1b1b8961b 100644 --- a/src/cli/config.lua +++ b/src/cli/config.lua @@ -4,12 +4,14 @@ local constants = require "kong.constants" local cutils = require "kong.cli.utils" local IO = require "kong.tools.io" local args = require("lapp")(string.format([[ +For development purposes only. + Duplicate an existing configuration for given environment. Usage: kong config [options] Options: - -c,--config (default %s) configuration file + -c,--config (default %s) path to configuration file -o,--output (default .) ouput -e,--env (string) environment name ]], constants.CLI.GLOBAL_KONG_CONF)) diff --git a/src/cli/db.lua b/src/cli/db.lua index 29d7491fe1d..31521ecf57b 100644 --- a/src/cli/db.lua +++ b/src/cli/db.lua @@ -8,7 +8,7 @@ local cutils = require "kong.cli.utils" local IO = require "kong.tools.io" local lapp = require("lapp") local args = lapp(string.format([[ -Migrations, seeding of the DB. +Kong datastore management operations. Usage: kong db [options] @@ -17,9 +17,9 @@ Commands: migrations, migrations:up, migrations:down, migrations:reset, seed, drop Options: - -c,--config (default %s) configuration file - -r,--random : flag to also insert random entities - -n,--number (default 1000) : number of random entities to insert if --random + -c,--config (default %s) path to configuration file + -r,--random (seed) flag to also insert random entities + -n,--number (default 1000) (seed) number of random entities to insert if --random ]], constants.CLI.GLOBAL_KONG_CONF)) -- $ kong db diff --git a/src/cli/quit.lua b/src/cli/quit.lua index 091e791e169..ee620409e38 100644 --- a/src/cli/quit.lua +++ b/src/cli/quit.lua @@ -4,12 +4,12 @@ local constants = require "kong.constants" local cutils = require "kong.cli.utils" local signal = require "kong.cli.utils.signal" local args = require("lapp")(string.format([[ -Graceful shutdown +Graceful shutdown. Stop the Kong instance running in the configured 'nginx_working_dir' directory. Usage: kong stop [options] Options: - -c,--config (default %s) configuration file + -c,--config (default %s) path to configuration file ]], constants.CLI.GLOBAL_KONG_CONF)) -- Check if running, will exit if not diff --git a/src/cli/reload.lua b/src/cli/reload.lua index 40e8062621b..fdffccd0a1d 100644 --- a/src/cli/reload.lua +++ b/src/cli/reload.lua @@ -4,12 +4,14 @@ local constants = require "kong.constants" local cutils = require "kong.cli.utils" local signal = require "kong.cli.utils.signal" local args = require("lapp")(string.format([[ -Gracefully reload Kong applying any configuration changes (including nginx) +Gracefully reload the Kong instance running in the configured 'nginx_working_dir'. + +Any configuration change will be applied. Usage: kong reload [options] Options: - -c,--config (default %s) configuration file + -c,--config (default %s) path to configuration file ]], constants.CLI.GLOBAL_KONG_CONF)) signal.prepare_kong(args.config) diff --git a/src/cli/restart.lua b/src/cli/restart.lua index 0a2e12a06d0..578668018f7 100644 --- a/src/cli/restart.lua +++ b/src/cli/restart.lua @@ -4,10 +4,15 @@ local constants = require "kong.constants" local cutils = require "kong.cli.utils" local signal = require "kong.cli.utils.signal" local args = require("lapp")(string.format([[ +Restart the Kong instance running in the configured 'nginx_working_dir'. + +Kong will be shutdown before restarting. For a zero-downtime reload +of your configuration, look at 'kong reload'. + Usage: kong restart [options] Options: - -c,--config (default %s) configuration file + -c,--config (default %s) path to configuration file ]], constants.CLI.GLOBAL_KONG_CONF)) if signal.is_running(args.config) then diff --git a/src/cli/start.lua b/src/cli/start.lua index e90b809d140..1f5813a527e 100755 --- a/src/cli/start.lua +++ b/src/cli/start.lua @@ -4,10 +4,12 @@ local constants = require "kong.constants" local cutils = require "kong.cli.utils" local signal = require "kong.cli.utils.signal" local args = require("lapp")(string.format([[ +Start Kong with given configuration. Kong will run in the configured 'nginx_working_dir' directory. + Usage: kong start [options] Options: - -c,--config (default %s) configuration file + -c,--config (default %s) path to configuration file ]], constants.CLI.GLOBAL_KONG_CONF)) signal.prepare_kong(args.config) diff --git a/src/cli/stop.lua b/src/cli/stop.lua index 9ffaf68955b..552b184df7c 100755 --- a/src/cli/stop.lua +++ b/src/cli/stop.lua @@ -4,12 +4,12 @@ local constants = require "kong.constants" local cutils = require "kong.cli.utils" local signal = require "kong.cli.utils.signal" local args = require("lapp")(string.format([[ -Fast shutdown +Fast shutdown. Stop the Kong instance running in the configured 'nginx_working_dir' directory. Usage: kong stop [options] Options: - -c,--config (default %s) configuration file + -c,--config (default %s) path to configuration file ]], constants.CLI.GLOBAL_KONG_CONF)) -- Check if running, will exit if not diff --git a/src/cli/utils/utils.lua b/src/cli/utils/utils.lua index 6e05636772d..c5145d25f02 100644 --- a/src/cli/utils/utils.lua +++ b/src/cli/utils/utils.lua @@ -103,7 +103,7 @@ local function get_kong_config_path(args_config) -- Make sure the configuration file really exists if not IO.file_exists(args_config) then logger:warn("No config at: "..args_config) - logger:error_exit("Could not find a configuration file.") + logger:error_exit("Could not find a path to configuration file.") end logger:log("Using config: "..args_config)