OS Manuals

/usr/bin/vtctl

Autoscaling components for Kubernetes

From vitess-23 23.0.4-r5 (os), captured 2026-11-05 by running vtctl --help (exit 0). permalink

Also provided by 11 other package versions
Usage of /usr/bin/vtctl:
      --alsologtostderr                                             log to standard error as well as files
      --azblob-backup-account-key-file string                       Path to a file containing the Azure Storage account key; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_KEY will be used as the key itself (NOT a file path).
      --azblob-backup-account-name string                           Azure Storage Account name for backups; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_NAME will be used.
      --azblob-backup-buffer-size int                               The memory buffer size to use in bytes, per file or stripe, when streaming to Azure Blob Service. (default 104857600)
      --azblob-backup-container-name string                         Azure Blob Container Name.
      --azblob-backup-parallelism int                               Azure Blob operation parallelism (requires extra memory when increased -- a multiple of azblob-backup-buffer-size). (default 1)
      --azblob-backup-storage-root string                           Root prefix for all backup-related Azure Blobs; this should exclude both initial and trailing '/' (e.g. just 'a/b' not '/a/b/').
      --backup-storage-implementation string                        Which backup storage implementation to use for creating and restoring backups.
      --ceph-backup-storage-config string                           Path to JSON config file for ceph backup storage. (default "ceph_backup_config.json")
      --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).
      --consul-auth-static-file string                              JSON File to read the topos/tokens from.
      --datadog-agent-host string                                   host to send spans to. if empty, no tracing will be done
      --datadog-agent-port string                                   port to send spans to. if empty, no tracing will be done
      --datadog-trace-debug-mode                                    enable debug mode for datadog tracing
      --detach                                                      detached mode - run vtcl detached from the terminal
      --file-backup-storage-root string                             Root directory for the file backup storage.
      --gcs-backup-storage-bucket string                            Google Cloud Storage bucket to use for backups.
      --gcs-backup-storage-root string                              Root prefix for all backup-related object names.
      --grpc-auth-static-client-creds string                        When using grpc_static_auth in the server, this file provides the credentials to use to authenticate with server.
      --grpc-compression string                                     Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy
      --grpc-dial-concurrency-limit int                             Maximum concurrency of grpc dial operations. This should be less than the golang max thread limit of 10000. (default 1024)
      --grpc-enable-tracing                                         Enable gRPC tracing.
      --grpc-initial-conn-window-size int                           gRPC initial connection window size
      --grpc-initial-window-size int                                gRPC initial window size
      --grpc-keepalive-time duration                                After a duration of this time, if the client doesn't see any activity, it pings the server to see if the transport is still alive. (default 10s)
      --grpc-keepalive-timeout duration                             After having pinged for keepalive check, the client waits for a duration of Timeout and if no activity is seen even after that the connection is closed. (default 10s)
      --grpc-max-message-size int                                   Maximum allowed RPC message size. Larger messages will be rejected by gRPC with the error 'exceeding the max size'. (default 16777216)
      --grpc-prometheus                                             Enable gRPC monitoring with Prometheus.
  -h, --help                                                        display usage and exit
      --jaeger-agent-host string                                    host and port to send spans to. if empty, no tracing will be done
      --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)
      --lock-timeout duration                                       Maximum time to wait when attempting to acquire a lock from the topo server (default 45s)
      --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)
      --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_link string                                             If non-empty, add symbolic links in this directory to the log files
      --logbuflevel int                                             Buffer log messages logged at this level or lower (-1 means don't buffer; 0 means buffer INFO only; ...). Has limited applicability on non-prod platforms.
      --logtostderr                                                 log to standard error instead of files
      --mysql-server-version string                                 MySQL server version to advertise. (default "8.4.6-Vitess")
      --pprof strings                                               enable profiling
      --pprof-http                                                  enable pprof http endpoints
      --purge-logs-interval duration                                how often try to remove old logs (default 1h0m0s)
      --remote-operation-timeout duration                           time to wait for a remote operation (default 15s)
      --s3-backup-aws-endpoint string                               endpoint of the S3 backend (region must be provided).
      --s3-backup-aws-min-partsize int                              Minimum part size to use, defaults to 5MiB but can be increased due to the dataset size. (default 5242880)
      --s3-backup-aws-region string                                 AWS region to use. (default "us-east-1")
      --s3-backup-aws-retries int                                   AWS request retries. (default -1)
      --s3-backup-force-path-style                                  force the s3 path style.
      --s3-backup-log-level string                                  determine the S3 loglevel to use from LogOff, LogDebug, LogDebugWithSigning, LogDebugWithHTTPBody, LogDebugWithRequestRetries, LogDebugWithRequestErrors. (default "LogOff")
      --s3-backup-server-side-encryption string                     server-side encryption algorithm (e.g., AES256, aws:kms, sse_c:/path/to/key/file).
      --s3-backup-storage-bucket string                             S3 bucket to use for backups.
      --s3-backup-storage-root string                               root prefix for all backup-related object names.
      --s3-backup-tls-skip-verify-cert                              skip the 'certificate is valid' check for SSL connections.
      --security-policy string                                      the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only)
      --sql-max-length-errors int                                   truncate queries in error logs to the given length (default unlimited)
      --sql-max-length-ui int                                       truncate queries in debug UIs to the given length (default 512) (default 512)
      --stderrthreshold severityFlag                                logs at or above this threshold go to stderr (default 1)
      --tablet-grpc-ca string                                       the server ca to use to validate servers when connecting
      --tablet-grpc-cert string                                     the cert to use to connect
      --tablet-grpc-crl string                                      the server crl to use to validate server certificates when connecting
      --tablet-grpc-key string                                      the key to use to connect
      --tablet-grpc-server-name string                              the server name to use to validate server certificate
      --tablet-manager-grpc-ca string                               the server ca to use to validate servers when connecting
      --tablet-manager-grpc-cert string                             the cert to use to connect
      --tablet-manager-grpc-concurrency int                         concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,App}, CheckThrottler and FullStatus) (default 8)
      --tablet-manager-grpc-connpool-size int                       number of tablets to keep tmclient connections open to (default 100)
      --tablet-manager-grpc-crl string                              the server crl to use to validate server certificates when connecting
      --tablet-manager-grpc-key string                              the key to use to connect
      --tablet-manager-grpc-server-name string                      the server name to use to validate server certificate
      --tablet-manager-protocol string                              Protocol to use to make tabletmanager RPCs to vttablets. (default "grpc")
      --tablet-protocol string                                      Protocol to use to make queryservice RPCs to vttablets. (default "grpc")
      --topo-consul-lock-delay duration                             LockDelay for consul session. (default 15s)
      --topo-consul-lock-session-checks string                      List of checks for consul session. (default "serfHealth")
      --topo-consul-lock-session-ttl string                         TTL for consul session.
      --topo-consul-watch-poll-duration duration                    time of the long poll for watch queries. (default 30s)
      --topo-etcd-lease-ttl int                                     Lease TTL for locks and leader election. The client will use KeepAlive to keep the lease going. (default 30)
      --topo-etcd-tls-ca string                                     path to the ca to use to validate the server cert when connecting to the etcd topo server
      --topo-etcd-tls-cert string                                   path to the client cert to use to connect to the etcd topo server, requires topo-etcd-tls-key, enables TLS
      --topo-etcd-tls-key string                                    path to the client key to use to connect to the etcd topo server, enables TLS
      --topo-global-root string                                     the path of the global topology data in the global topology server
      --topo-global-server-address string                           the address of the global topology server
      --topo-implementation string                                  the topology implementation to use
      --topo-read-concurrency int                                   Maximum concurrency of topo reads per global or local cell. (default 32)
      --topo-zk-auth-file string                                    auth to use when connecting to the zk topo server, file contents should be <scheme>:<auth>, e.g., digest:user:pass
      --topo-zk-base-timeout duration                               zk base timeout (see zk.Connect) (default 30s)
      --topo-zk-max-concurrency int                                 maximum number of pending requests to send to a Zookeeper server. (default 64)
      --topo-zk-tls-ca string                                       the server ca to use to validate servers when connecting to the zk topo server
      --topo-zk-tls-cert string                                     the cert to use to connect to the zk topo server, requires topo-zk-tls-key, enables TLS
      --topo-zk-tls-key string                                      the key to use to connect to the zk topo server, enables TLS
      --tracer string                                               tracing service to use (default "noop")
      --tracing-enable-logging                                      whether to enable logging in the tracing service
      --tracing-sampling-rate float                                 sampling rate for the probabilistic jaeger sampler (default 0.1)
      --tracing-sampling-type string                                sampling strategy to use for jaeger. possible values are 'const', 'probabilistic', 'rateLimiting', or 'remote' (default "const")
      --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
      --vtgate-grpc-ca string                                       the server ca to use to validate servers when connecting
      --vtgate-grpc-cert string                                     the cert to use to connect
      --vtgate-grpc-crl string                                      the server crl to use to validate server certificates when connecting
      --vtgate-grpc-fail-fast                                       whether to enable grpc fail fast when connecting
      --vtgate-grpc-key string                                      the key to use to connect
      --vtgate-grpc-server-name string                              the server name to use to validate server certificate
      --wait-time duration                                          time to wait on an action (default 24h0m0s)
Options (110)
OptionDescriptionSource
--alsologtostderrlog to standard error as well as fileshelp
--azblob-backup-account-key-file stringPath to a file containing the Azure Storage account key;help
--azblob-backup-account-name stringAzure Storage Account name for backups;help
--azblob-backup-buffer-size intThe memory buffer size to use in bytes, per file or stripe, when streaming to Azure Blob Service.help
--azblob-backup-container-name stringAzure Blob Container Name.help
--azblob-backup-parallelism intAzure Blob operation parallelism (requires extra memory when increased -- a multiple of azblob-backup-buffer-size).help
--azblob-backup-storage-root stringRoot prefix for all backup-related Azure Blobs;help
--backup-storage-implementation stringWhich backup storage implementation to use for creating and restoring backups.help
--ceph-backup-storage-config stringPath to JSON config file for ceph backup storage.help
--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
--consul-auth-static-file stringJSON File to read the topos/tokens from.help
--datadog-agent-host stringhost to send spans to.help
--datadog-agent-port stringport to send spans to.help
--datadog-trace-debug-modeenable debug mode for datadog tracinghelp
--detachdetached mode - run vtcl detached from the terminalhelp
--file-backup-storage-root stringRoot directory for the file backup storage.help
--gcs-backup-storage-bucket stringGoogle Cloud Storage bucket to use for backups.help
--gcs-backup-storage-root stringRoot prefix for all backup-related object names.help
--grpc-auth-static-client-creds stringWhen using grpc_static_auth in the server, this file provides the credentials to use to authenticate with server.help
--grpc-compression stringWhich protocol to use for compressing gRPC.help
--grpc-dial-concurrency-limit intMaximum concurrency of grpc dial operations.help
--grpc-enable-tracingEnable gRPC tracing.help
--grpc-initial-conn-window-size intgRPC initial connection window sizehelp
--grpc-initial-window-size intgRPC initial window sizehelp
--grpc-keepalive-time durationAfter a duration of this time, if the client doesn't see any activity, it pings the server to see if the transport is still alive.help
--grpc-keepalive-timeout durationAfter having pinged for keepalive check, the client waits for a duration of Timeout and if no activity is seen even after that the connection is closed.help
--grpc-max-message-size intMaximum allowed RPC message size.help
--grpc-prometheusEnable gRPC monitoring with Prometheus.help
-h, --helpdisplay usage and exithelp
--jaeger-agent-host stringhost and port to send spans to.help
--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
--lock-timeout durationMaximum time to wait when attempting to acquire a lock from the topo server (default 45s)help
--log-err-stackslog stack traces for errorshelp
--log-rotate-max-size uintsize in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)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_link stringIf non-empty, add symbolic links in this directory to the log fileshelp
--logbuflevel intBuffer log messages logged at this level or lower (-1 means don't buffer;help
--logtostderrlog to standard error instead of fileshelp
--mysql-server-version stringMySQL server version to advertise.help
--pprof stringsenable profilinghelp
--pprof-httpenable pprof http endpointshelp
--purge-logs-interval durationhow often try to remove old logs (default 1h0m0s)help
--remote-operation-timeout durationtime to wait for a remote operation (default 15s)help
--s3-backup-aws-endpoint stringendpoint of the S3 backend (region must be provided).help
--s3-backup-aws-min-partsize intMinimum part size to use, defaults to 5MiB but can be increased due to the dataset size.help
--s3-backup-aws-region stringAWS region to use.help
--s3-backup-aws-retries intAWS request retries.help
--s3-backup-force-path-styleforce the s3 path style.help
--s3-backup-log-level stringdetermine the S3 loglevel to use from LogOff, LogDebug, LogDebugWithSigning, LogDebugWithHTTPBody, LogDebugWithRequestRetries, LogDebugWithRequestErrors.help
--s3-backup-server-side-encryption stringserver-side encryption algorithm (e.g., AES256, aws:kms, sse_c:/path/to/key/file).help
--s3-backup-storage-bucket stringS3 bucket to use for backups.help
--s3-backup-storage-root stringroot prefix for all backup-related object names.help
--s3-backup-tls-skip-verify-certskip the 'certificate is valid' check for SSL connections.help
--security-policy stringthe name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only)help
--sql-max-length-errors inttruncate queries in error logs to the given length (default unlimited)help
--sql-max-length-ui inttruncate queries in debug UIs to the given length (default 512) (default 512)help
--stderrthreshold severityFlaglogs at or above this threshold go to stderr (default 1)help
--tablet-grpc-ca stringthe server ca to use to validate servers when connectinghelp
--tablet-grpc-cert stringthe cert to use to connecthelp
--tablet-grpc-crl stringthe server crl to use to validate server certificates when connectinghelp
--tablet-grpc-key stringthe key to use to connecthelp
--tablet-grpc-server-name stringthe server name to use to validate server certificatehelp
--tablet-manager-grpc-ca stringthe server ca to use to validate servers when connectinghelp
--tablet-manager-grpc-cert stringthe cert to use to connecthelp
--tablet-manager-grpc-concurrency intconcurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,App}, CheckThrottler and FullStatus) (default 8)help
--tablet-manager-grpc-connpool-size intnumber of tablets to keep tmclient connections open to (default 100)help
--tablet-manager-grpc-crl stringthe server crl to use to validate server certificates when connectinghelp
--tablet-manager-grpc-key stringthe key to use to connecthelp
--tablet-manager-grpc-server-name stringthe server name to use to validate server certificatehelp
--tablet-manager-protocol stringProtocol to use to make tabletmanager RPCs to vttablets.help
--tablet-protocol stringProtocol to use to make queryservice RPCs to vttablets.help
--topo-consul-lock-delay durationLockDelay for consul session.help
--topo-consul-lock-session-checks stringList of checks for consul session.help
--topo-consul-lock-session-ttl stringTTL for consul session.help
--topo-consul-watch-poll-duration durationtime of the long poll for watch queries.help
--topo-etcd-lease-ttl intLease TTL for locks and leader election.help
--topo-etcd-tls-ca stringpath to the ca to use to validate the server cert when connecting to the etcd topo serverhelp
--topo-etcd-tls-cert stringpath to the client cert to use to connect to the etcd topo server, requires topo-etcd-tls-key, enables TLShelp
--topo-etcd-tls-key stringpath to the client key to use to connect to the etcd topo server, enables TLShelp
--topo-global-root stringthe path of the global topology data in the global topology serverhelp
--topo-global-server-address stringthe address of the global topology serverhelp
--topo-implementation stringthe topology implementation to usehelp
--topo-read-concurrency intMaximum concurrency of topo reads per global or local cell.help
--topo-zk-auth-file stringauth to use when connecting to the zk topo server, file contents should be <scheme>:<auth>, e.g., digest:user:passhelp
--topo-zk-base-timeout durationzk base timeout (see zk.Connect) (default 30s)help
--topo-zk-max-concurrency intmaximum number of pending requests to send to a Zookeeper server.help
--topo-zk-tls-ca stringthe server ca to use to validate servers when connecting to the zk topo serverhelp
--topo-zk-tls-cert stringthe cert to use to connect to the zk topo server, requires topo-zk-tls-key, enables TLShelp
--topo-zk-tls-key stringthe key to use to connect to the zk topo server, enables TLShelp
--tracer stringtracing service to use (default "noop")help
--tracing-enable-loggingwhether to enable logging in the tracing servicehelp
--tracing-sampling-rate floatsampling rate for the probabilistic jaeger sampler (default 0.1)help
--tracing-sampling-type stringsampling strategy to use for jaeger.help
--v Levellog level for V logshelp
-v, --versionprint binary versionhelp
--vmodule vModuleFlagcomma-separated list of pattern=N settings for file-filtered logginghelp
--vtgate-grpc-ca stringthe server ca to use to validate servers when connectinghelp
--vtgate-grpc-cert stringthe cert to use to connecthelp
--vtgate-grpc-crl stringthe server crl to use to validate server certificates when connectinghelp
--vtgate-grpc-fail-fastwhether to enable grpc fail fast when connectinghelp
--vtgate-grpc-key stringthe key to use to connecthelp
--vtgate-grpc-server-name stringthe server name to use to validate server certificatehelp
--wait-time durationtime to wait on an action (default 24h0m0s)help

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