OS Manuals

/usr/bin/vtadmin

Autoscaling components for Kubernetes

From vitess-24 24.0.5-r11 (enterprise-packages), captured 2026-11-08 by running vtadmin --help (exit 0). permalink

Usage:
  vtadmin [flags]

Flags:
      --addr string                             address to serve on (default ":15000")
      --cache-refresh-key string                instructs a request to ignore any cached data (if applicable) and refresh the cache;usable as an HTTP header named 'X-<key>' and as a gRPC metadata key '<key>'
                                                Note: any whitespace characters are replaced with hyphens. (default "vt-cache-refresh")
      --cluster cluster.ClustersFlag            per-cluster configuration. any values here take precedence over those in -cluster-defaults or -cluster-config (default [])
      --cluster-config cluster.FileConfig       path to a yaml cluster configuration. see clusters.example.yaml (default {defaults: *cluster.Config:{ID: Name: DiscoveryImpl: DiscoveryFlagsByImpl:map[] TabletFQDNTmplStr: VtSQLFlags:map[] VtctldFlags:map[] BackupReadPoolConfig:<nil> SchemaReadPoolConfig:<nil> TopoRWPoolConfig:<nil> TopoReadPoolConfig:<nil> WorkflowReadPoolConfig:<nil> EmergencyFailoverPoolConfig:<nil> FailoverPoolConfig:<nil> SchemaCacheConfig:<nil> vtctldConfigOpts:[] vtsqlConfigOpts:[]}, clusters: []})
      --cluster-defaults cluster.Config         default options for all clusters (default *cluster.Config:{ID: Name: DiscoveryImpl: DiscoveryFlagsByImpl:map[] TabletFQDNTmplStr: VtSQLFlags:map[] VtctldFlags:map[] BackupReadPoolConfig:<nil> SchemaReadPoolConfig:<nil> TopoRWPoolConfig:<nil> TopoReadPoolConfig:<nil> WorkflowReadPoolConfig:<nil> EmergencyFailoverPoolConfig:<nil> FailoverPoolConfig:<nil> SchemaCacheConfig:<nil> vtctldConfigOpts:[] vtsqlConfigOpts:[]})
      --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
      --enable-dynamic-clusters                 whether to enable dynamic clusters that are set by request header cookies or gRPC metadata
      --grpc-allow-reflection                   whether to register the gRPC server for reflection; this is required to use tools like grpc_cli
      --grpc-enable-channelz                    whether to enable the channelz service on the gRPC server
      --grpc-tracing                            whether to enable tracing on the gRPC server
  -h, --help                                    help for vtadmin
      --http-debug-omit-env StringSetFlag       name of an environment variable to omit from /debug/env, if http debug endpoints are enabled. specify multiple times to omit multiple env vars
      --http-debug-sanitize-env StringSetFlag   name of an environment variable to sanitize in /debug/env, if http debug endpoints are enabled. specify multiple times to sanitize multiple env vars
      --http-metrics-endpoint string            HTTP endpoint to expose prometheus metrics on. Omit to disable scraping metrics. Using a path used by VTAdmin's http API is unsupported and causes undefined behavior. (default "/metrics")
      --http-no-compress                        whether to disable compression of HTTP API responses
      --http-no-debug                           whether to disable /debug/pprof/* and /debug/env HTTP endpoints
      --http-origin strings                     repeated, comma-separated flag of allowed CORS origins. omit to disable CORS
      --http-tablet-url-tmpl string             [EXPERIMENTAL] Go template string to generate a reachable http(s) address for a tablet. Currently used to make passthrough requests to /debug/vars endpoints. (default "https://{{ .Tablet.Hostname }}:80")
      --http-tracing                            whether to enable tracing on the HTTP server
      --jaeger-agent-host string                host and port to send spans to. if empty, no tracing will be done
      --lame-duck-duration duration             length of lame duck period at shutdown (default 5s)
      --lmux-read-timeout duration              how long to spend connection muxing (default 1s)
      --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)
      --mysql-server-version string             MySQL server version to advertise. (default "8.4.6-Vitess")
      --no-rbac                                 whether to disable RBAC. must be set if not passing --no-rbac
      --otel-endpoint string                    OpenTelemetry collector endpoint (host:port for gRPC); if empty, the OTEL_EXPORTER_OTLP_ENDPOINT env var is used
      --otel-insecure                           use insecure connection to OpenTelemetry collector
      --rbac                                    whether to enable RBAC. must be set if not passing --rbac
      --rbac-config string                      path to an RBAC config file. must be set if passing --rbac
      --tracer string                           tracing service to use (default "noop")
      --tracing-enable-logging                  whether to enable logging in the tracing service
      --tracing-sampling-rate float             sampling parameter for traces; for jaeger this is passed as the sampler parameter (see --tracing-sampling-type), for opentelemetry/datadog it is a probability between 0.0 and 1.0 (default 0.1)
      --tracing-sampling-type string            sampling strategy to use for jaeger. possible values are 'const', 'probabilistic', 'rateLimiting', or 'remote' (default "const")
      --version                                 version for vtadmin
      --vtctld-grpc-ca string                   the server ca to use to validate servers when connecting
      --vtctld-grpc-cert string                 the cert to use to connect
      --vtctld-grpc-crl string                  the server crl to use to validate server certificates when connecting
      --vtctld-grpc-key string                  the key to use to connect
      --vtctld-grpc-server-name string          the server name to use to validate server certificate
Options (44)
OptionDescriptionSource
--addr stringaddress to serve on (default ":15000")help
--cache-refresh-key stringinstructs a request to ignore any cached data (if applicable) and refresh the cache;usable as an HTTP header named 'X-<key>' and as a gRPC metadata key '<key>' Note: any whitespace characters are…help
--cluster cluster.ClustersFlagper-cluster configuration.help
--cluster-config cluster.FileConfigpath to a yaml cluster configuration.help
--cluster-defaults cluster.Configdefault options for all clusters (default *cluster.Config:{ID: Name: DiscoveryImpl: DiscoveryFlagsByImpl:map[] TabletFQDNTmplStr: VtSQLFlags:map[] VtctldFlags:map[] BackupReadPoolConfig:<nil>…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
--enable-dynamic-clusterswhether to enable dynamic clusters that are set by request header cookies or gRPC metadatahelp
--grpc-allow-reflectionwhether to register the gRPC server for reflection;help
--grpc-enable-channelzwhether to enable the channelz service on the gRPC serverhelp
--grpc-tracingwhether to enable tracing on the gRPC serverhelp
-h, --helphelp for vtadminhelp
--http-debug-omit-env StringSetFlagname of an environment variable to omit from /debug/env, if http debug endpoints are enabled.help
--http-debug-sanitize-env StringSetFlagname of an environment variable to sanitize in /debug/env, if http debug endpoints are enabled.help
--http-metrics-endpoint stringHTTP endpoint to expose prometheus metrics on.help
--http-no-compresswhether to disable compression of HTTP API responseshelp
--http-no-debugwhether to disable /debug/pprof/* and /debug/env HTTP endpointshelp
--http-origin stringsrepeated, comma-separated flag of allowed CORS origins.help
--http-tablet-url-tmpl string[EXPERIMENTAL] Go template string to generate a reachable http(s) address for a tablet.help
--http-tracingwhether to enable tracing on the HTTP serverhelp
--jaeger-agent-host stringhost and port to send spans to.help
--lame-duck-duration durationlength of lame duck period at shutdown (default 5s)help
--lmux-read-timeout durationhow long to spend connection muxing (default 1s)help
--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
--mysql-server-version stringMySQL server version to advertise.help
--no-rbacwhether to disable RBAC.help
--otel-endpoint stringOpenTelemetry collector endpoint (host:port for gRPC);help
--otel-insecureuse insecure connection to OpenTelemetry collectorhelp
--rbacwhether to enable RBAC.help
--rbac-config stringpath to an RBAC config file.help
--tracer stringtracing service to use (default "noop")help
--tracing-enable-loggingwhether to enable logging in the tracing servicehelp
--tracing-sampling-rate floatsampling parameter for traces;help
--tracing-sampling-type stringsampling strategy to use for jaeger.help
--versionversion for vtadminhelp
--vtctld-grpc-ca stringthe server ca to use to validate servers when connectinghelp
--vtctld-grpc-cert stringthe cert to use to connecthelp
--vtctld-grpc-crl stringthe server crl to use to validate server certificates when connectinghelp
--vtctld-grpc-key stringthe key to use to connecthelp
--vtctld-grpc-server-name stringthe server name to use to validate server certificatehelp

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