OS Manuals

/usr/bin/zkctl

All the binaries built by Vitess

From vitess-21-binaries 21.0.6-r4 (enterprise-packages), captured 2026-11-08 by running zkctl --help (exit 0). permalink

Initializes and controls zookeeper with Vitess-specific configuration.

Usage:
  zkctl [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  init        Generates a new config and then starts zookeeper.
  shutdown    Terminates a zookeeper server but keeps its data dir intact.
  start       Runs an already initialized zookeeper server.
  teardown    Shuts down the zookeeper server and removes its data dir.

Flags:
      --alsologtostderr                                             log to standard error as well as files
      --config-file string                                          Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
      --config-file-not-found-handling ConfigFileNotFoundHandling   Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
      --config-name string                                          Name of the config file (without extension) to search for. (default "vtconfig")
      --config-path strings                                         Paths to search for config files in. (default [/tmp])
      --config-persistence-min-interval duration                    minimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done). (default 1s)
      --config-type string                                          Config file type (omit to infer config type from file extension).
  -h, --help                                                        help for zkctl
      --keep_logs duration                                          keep logs for this long (using ctime) (zero to keep forever)
      --keep_logs_by_mtime duration                                 keep logs for this long (using mtime) (zero to keep forever)
      --log_backtrace_at traceLocations                             when logging hits line file:N, emit a stack trace
      --log_dir string                                              If non-empty, write log files in this directory
      --log_err_stacks                                              log stack traces for errors
      --log_rotate_max_size uint                                    size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
      --logtostderr                                                 log to standard error instead of files
      --pprof strings                                               enable profiling
      --pprof-http                                                  enable pprof http endpoints
      --purge_logs_interval duration                                how often try to remove old logs (default 1h0m0s)
      --stderrthreshold severityFlag                                logs at or above this threshold go to stderr (default 1)
      --v Level                                                     log level for V logs
  -v, --version                                                     print binary version
      --vmodule vModuleFlag                                         comma-separated list of pattern=N settings for file-filtered logging
      --zk.cfg string                                               zkid@server1:leaderPort1:electionPort1:clientPort1,...) (default "6@<hostname>:3801:3802:3803")
      --zk.extra stringArray                                        extra config line(s) to append verbatim to config (flag can be specified more than once)
      --zk.myid uint                                                which server do you want to be? only needed when running multiple instance on one box, otherwise myid is implied by hostname

Use "zkctl [command] --help" for more information about a command.
Options (25)
OptionDescriptionSource
--alsologtostderrlog to standard error as well as fileshelp
--config-file stringFull path of the config file (with extension) to use.help
--config-file-not-found-handling ConfigFileNotFoundHandlingBehavior when a config file is not found.help
--config-name stringName of the config file (without extension) to search for.help
--config-path stringsPaths to search for config files in.help
--config-persistence-min-interval durationminimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done).help
--config-type stringConfig file type (omit to infer config type from file extension).help
-h, --helphelp for zkctlhelp
--keep_logs durationkeep logs for this long (using ctime) (zero to keep forever)help
--keep_logs_by_mtime durationkeep logs for this long (using mtime) (zero to keep forever)help
--log_backtrace_at traceLocationswhen logging hits line file:N, emit a stack tracehelp
--log_dir stringIf non-empty, write log files in this directoryhelp
--log_err_stackslog stack traces for errorshelp
--log_rotate_max_size uintsize in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)help
--logtostderrlog to standard error instead of fileshelp
--pprof stringsenable profilinghelp
--pprof-httpenable pprof http endpointshelp
--purge_logs_interval durationhow often try to remove old logs (default 1h0m0s)help
--stderrthreshold severityFlaglogs at or above this threshold go to stderr (default 1)help
--v Levellog level for V logshelp
-v, --versionprint binary versionhelp
--vmodule vModuleFlagcomma-separated list of pattern=N settings for file-filtered logginghelp
--zk.cfg stringzkid@server1:leaderPort1:electionPort1:clientPort1,...) (default "6@<hostname>:3801:3802:3803")help
--zk.extra stringArrayextra config line(s) to append verbatim to config (flag can be specified more than once)help
--zk.myid uintwhich server do you want to be? only needed when running multiple instance on one box, otherwise myid is implied by hostnamehelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.