OS Manuals

/usr/bin/zkctl

All the binaries built by Vitess

From vitess-24-binaries 24.0.5-r11 (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:
      --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-err-stacks                                              log stack traces for errors
      --log-format string                                           log output format: json for machine-readable JSON, text for human-readable colored output (default "json")
      --log-level string                                            minimum log level when structured logging is enabled (debug, info, warn, error) (default "info")
      --log-rotate-max-size uint                                    size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
      --log-structured                                              enable structured JSON logging (default true)
      --pprof strings                                               enable profiling
      --pprof-http                                                  enable pprof http endpoints
      --purge-logs-interval duration                                how often try to remove old logs (default 1h0m0s)
  -v, --version                                                     print binary version
      --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 (21)
OptionDescriptionSource
--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-err-stackslog stack traces for errorshelp
--log-format stringlog output format: json for machine-readable JSON, text for human-readable colored output (default "json")help
--log-level stringminimum log level when structured logging is enabled (debug, info, warn, error) (default "info")help
--log-rotate-max-size uintsize in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)help
--log-structuredenable structured JSON logging (default true)help
--pprof stringsenable profilinghelp
--pprof-httpenable pprof http endpointshelp
--purge-logs-interval durationhow often try to remove old logs (default 1h0m0s)help
-v, --versionprint binary versionhelp
--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.