vitess.io/vitess@v0.16.2/doc/flags/14.0-to-15.0-transition/vtorc.diff (about) 1 diff --git a/flags/14.0/vtorc.txt b/flags/15.0/vtorc.txt 2 index 732595e..74ab84c 100644 3 --- a/flags/14.0/vtorc.txt 4 +++ b/flags/15.0/vtorc.txt 5 @@ -1,123 +1,85 @@ 6 Usage of vtorc: 7 - --alsologtostderr log to standard error as well as files 8 - --binlog string Binary log file name 9 - --catch-sigpipe catch and ignore SIGPIPE on stdout and stderr if specified 10 - --clusters_to_watch string Comma-separated list of keyspaces or keyspace/shards that this instance will monitor and repair. Defaults to all clusters in the topology. Example: "ks1,ks2/-80" 11 - --config string config file name 12 - --consul_auth_static_file string JSON File to read the topos/tokens from. 13 - --cpu_profile string deprecated: use '-pprof=cpu' instead 14 - --d string destination instance, host_fqdn[:port] (synonym to -s) 15 - --datadog-agent-host string host to send spans to. if empty, no tracing will be done 16 - --datadog-agent-port string port to send spans to. if empty, no tracing will be done 17 - --debug debug mode (very verbose) 18 - --discovery auto discovery mode (default true) 19 - --emit_stats If set, emit stats to push-based monitoring and stats backends 20 - --enable-database-update Enable database update, overrides SkipOrchestratorDatabaseUpdate 21 - --grab-election Grab leadership (only applies to continuous mode) 22 - --grpc_auth_mode string Which auth plugin implementation to use (eg: static) 23 - --grpc_auth_mtls_allowed_substrings string List of substrings of at least one of the client certificate names (separated by colon). 24 - --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 25 - --grpc_auth_static_password_file string JSON File to read the users/passwords from. 26 - --grpc_ca string server CA to use for gRPC connections, requires TLS, and enforces client certificate check 27 - --grpc_cert string server certificate to use for gRPC connections, requires grpc_key, enables TLS 28 - --grpc_compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy 29 - --grpc_crl string path to a certificate revocation list in PEM format, client certificates will be further verified against this file during TLS handshake 30 - --grpc_enable_optional_tls enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port 31 - --grpc_enable_tracing Enable GRPC tracing 32 - --grpc_initial_conn_window_size int gRPC initial connection window size 33 - --grpc_initial_window_size int gRPC initial window size 34 - --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) 35 - --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) 36 - --grpc_key string server private key to use for gRPC connections, requires grpc_cert, enables TLS 37 - --grpc_max_connection_age duration Maximum age of a client connection before GoAway is sent. (default 2562047h47m16.854775807s) 38 - --grpc_max_connection_age_grace duration Additional grace period after grpc_max_connection_age, after which connections are forcibly closed. (default 2562047h47m16.854775807s) 39 - --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) 40 - --grpc_port int Port to listen on for gRPC calls 41 - --grpc_prometheus Enable gRPC monitoring with Prometheus 42 - --grpc_server_ca string path to server CA in PEM format, which will be combine with server cert, return full certificate chain to clients 43 - --grpc_server_initial_conn_window_size int gRPC server initial connection window size 44 - --grpc_server_initial_window_size int gRPC server initial window size 45 - --grpc_server_keepalive_enforcement_policy_min_time duration gRPC server minimum keepalive time (default 10s) 46 - --grpc_server_keepalive_enforcement_policy_permit_without_stream gRPC server permit client keepalive pings even when there are no active streams (RPCs) 47 - --ignore-raft-setup Override RaftEnabled for CLI invocation (CLI by default not allowed for raft setups). NOTE: operations by CLI invocation may not reflect in all raft nodes. 48 - --jaeger-agent-host string host and port to send spans to. if empty, no tracing will be done 49 - --keep_logs duration keep logs for this long (using ctime) (zero to keep forever) 50 - --keep_logs_by_mtime duration keep logs for this long (using mtime) (zero to keep forever) 51 - --lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms) 52 - --log_backtrace_at value when logging hits line file:N, emit a stack trace 53 - --log_dir string If non-empty, write log files in this directory 54 - --log_err_stacks log stack traces for errors 55 - --log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) 56 - --logtostderr log to standard error instead of files 57 - --mem-profile-rate int deprecated: use '-pprof=mem' instead (default 524288) 58 - --mutex-profile-fraction int deprecated: use '-pprof=mutex' instead 59 - --mysql_auth_server_static_file string JSON File to read the users/passwords from. 60 - --mysql_auth_server_static_string string JSON representation of the users/passwords config. 61 - --mysql_auth_static_reload_interval duration Ticker to reload credentials 62 - --mysql_clientcert_auth_method string client-side authentication method to use. Supported values: mysql_clear_password, dialog. (default "mysql_clear_password") 63 - --mysql_server_flush_delay duration Delay after which buffered response will be flushed to the client. (default 100ms) 64 - --mysql_server_version string MySQL server version to advertise. 65 - --noop Dry run; do not perform destructing operations 66 - --onclose_timeout duration wait no more than this for OnClose handlers before stopping (default 1ns) 67 - --onterm_timeout duration wait no more than this for OnTermSync handlers before stopping (default 10s) 68 - --orc_web_dir string Orchestrator http file location (default "web/orchestrator") 69 - --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. 70 - --pprof string enable profiling 71 - --promotion-rule string Promotion rule for register-andidate (prefer|neutral|prefer_not|must_not) (default "prefer") 72 - --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) 73 - --quiet quiet 74 - --remote_operation_timeout duration time to wait for a remote operation (default 30s) 75 - --s string sibling instance, host_fqdn[:port] 76 - --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) 77 - --service_map value comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-vtworker 78 - --shutdown_wait_time duration maximum time to wait for vtorc to release all the locks that it is holding before shutting down on SIGTERM (default 30s) 79 - --skip-continuous-registration Skip cli commands performaing continuous registration (to reduce orchestratrator backend db load 80 - --skip-unresolve Do not unresolve a host name 81 - --skip-unresolve-check Skip/ignore checking an unresolve mapping (via hostname_unresolve table) resolves back to same hostname 82 - --sql-max-length-errors int truncate queries in error logs to the given length (default unlimited) 83 - --sql-max-length-ui int truncate queries in debug UIs to the given length (default 512) (default 512) 84 - --stack add stack trace upon error 85 - --statement string Statement/hint 86 - --stats_backend string The name of the registered push-based monitoring/stats backend to use 87 - --stats_combine_dimensions string List of dimensions to be combined into a single "all" value in exported stats vars 88 - --stats_common_tags string Comma-separated list of common tags for the stats backend. It provides both label and values. Example: label1:value1,label2:value2 89 - --stats_drop_variables string Variables to be dropped from the list of exported variables. 90 - --stats_emit_period duration Interval between emitting stats to all registered backends (default 1m0s) 91 - --stderrthreshold value logs at or above this threshold go to stderr (default 1) 92 - --tablet_manager_grpc_ca string the server ca to use to validate servers when connecting 93 - --tablet_manager_grpc_cert string the cert to use to connect 94 - --tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8) 95 - --tablet_manager_grpc_connpool_size int number of tablets to keep tmclient connections open to (default 100) 96 - --tablet_manager_grpc_crl string the server crl to use to validate server certificates when connecting 97 - --tablet_manager_grpc_key string the key to use to connect 98 - --tablet_manager_grpc_server_name string the server name to use to validate server certificate 99 - --tablet_manager_protocol string the protocol to use to talk to vttablet (default "grpc") 100 - --tag string tag to add ('tagname' or 'tagname=tagvalue') or to search ('tagname' or 'tagname=tagvalue' or comma separated 'tag0,tag1=val1,tag2' for intersection of all) 101 - --topo_consul_lock_delay duration LockDelay for consul session. (default 15s) 102 - --topo_consul_lock_session_checks string List of checks for consul session. (default "serfHealth") 103 - --topo_consul_lock_session_ttl string TTL for consul session. 104 - --topo_consul_watch_poll_duration duration time of the long poll for watch queries. (default 30s) 105 - --topo_etcd_lease_ttl int Lease TTL for locks and leader election. The client will use KeepAlive to keep the lease going. (default 30) 106 - --topo_etcd_tls_ca string path to the ca to use to validate the server cert when connecting to the etcd topo server 107 - --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 108 - --topo_etcd_tls_key string path to the client key to use to connect to the etcd topo server, enables TLS 109 - --topo_global_root string the path of the global topology data in the global topology server 110 - --topo_global_server_address string the address of the global topology server 111 - --topo_implementation string the topology implementation to use 112 - --topo_k8s_context string The kubeconfig context to use, overrides the 'current-context' from the config 113 - --topo_k8s_kubeconfig string Path to a valid kubeconfig file. When running as a k8s pod inside the same cluster you wish to use as the topo, you may omit this and the below arguments, and Vitess is capable of auto-discovering the correct values. https://kubernetes.io/docs/tasks/access-application-cluster/access-cluster/#accessing-the-api-from-a-pod 114 - --topo_k8s_namespace string The kubernetes namespace to use for all objects. Default comes from the context or in-cluster config 115 - --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 116 - --topo_zk_base_timeout duration zk base timeout (see zk.Connect) (default 30s) 117 - --topo_zk_max_concurrency int maximum number of pending requests to send to a Zookeeper server. (default 64) 118 - --topo_zk_tls_ca string the server ca to use to validate servers when connecting to the zk topo server 119 - --topo_zk_tls_cert string the cert to use to connect to the zk topo server, requires topo_zk_tls_key, enables TLS 120 - --topo_zk_tls_key string the key to use to connect to the zk topo server, enables TLS 121 - --tracer string tracing service to use (default "noop") 122 - --tracing-enable-logging whether to enable logging in the tracing service 123 - --tracing-sampling-rate value sampling rate for the probabilistic jaeger sampler (default 0.1) 124 - --tracing-sampling-type value sampling strategy to use for jaeger. possible values are 'const', 'probabilistic', 'rateLimiting', or 'remote' (default const) 125 - --v value log level for V logs 126 - --verbose verbose 127 - --version print binary version 128 - --vmodule value comma-separated list of pattern=N settings for file-filtered logging 129 + --alsologtostderr log to standard error as well as files 130 + --audit-file-location string File location where the audit logs are to be stored 131 + --audit-purge-duration duration Duration for which audit logs are held before being purged. Should be in multiples of days (default 168h0m0s) 132 + --audit-to-backend Whether to store the audit log in the VTOrc database 133 + --audit-to-syslog Whether to store the audit log in the syslog 134 + --catch-sigpipe catch and ignore SIGPIPE on stdout and stderr if specified 135 + --clusters_to_watch strings Comma-separated list of keyspaces or keyspace/shards that this instance will monitor and repair. Defaults to all clusters in the topology. Example: "ks1,ks2/-80" 136 + --config string config file name 137 + --consul_auth_static_file string JSON File to read the topos/tokens from. 138 + --emit_stats If set, emit stats to push-based monitoring and stats backends 139 + --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. 140 + --grpc_compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy 141 + --grpc_enable_tracing Enable gRPC tracing. 142 + --grpc_initial_conn_window_size int gRPC initial connection window size 143 + --grpc_initial_window_size int gRPC initial window size 144 + --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) 145 + --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) 146 + --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) 147 + --grpc_prometheus Enable gRPC monitoring with Prometheus. 148 + -h, --help display usage and exit 149 + --instance-poll-time duration Timer duration on which VTOrc refreshes MySQL information (default 5s) 150 + --keep_logs duration keep logs for this long (using ctime) (zero to keep forever) 151 + --keep_logs_by_mtime duration keep logs for this long (using mtime) (zero to keep forever) 152 + --lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms) 153 + --lock-shard-timeout duration Duration for which a shard lock is held when running a recovery (default 30s) 154 + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) 155 + --log_dir string If non-empty, write log files in this directory 156 + --log_err_stacks log stack traces for errors 157 + --log_rotate_max_size uint size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) 158 + --logtostderr log to standard error instead of files 159 + --onclose_timeout duration wait no more than this for OnClose handlers before stopping (default 1ns) 160 + --onterm_timeout duration wait no more than this for OnTermSync handlers before stopping (default 10s) 161 + --pid_file string If set, the process will write its pid to the named file, and delete it on graceful shutdown. 162 + --port int port for the server 163 + --pprof strings enable profiling 164 + --prevent-cross-cell-failover Prevent VTOrc from promoting a primary in a different cell than the current primary in case of a failover 165 + --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) 166 + --reasonable-replication-lag duration Maximum replication lag on replicas which is deemed to be acceptable (default 10s) 167 + --recovery-period-block-duration duration Duration for which a new recovery is blocked on an instance after running a recovery (default 30s) 168 + --recovery-poll-duration duration Timer duration on which VTOrc polls its database to run a recovery (default 1s) 169 + --remote_operation_timeout duration time to wait for a remote operation (default 30s) 170 + --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) 171 + --shutdown_wait_time duration Maximum time to wait for VTOrc to release all the locks that it is holding before shutting down on SIGTERM (default 30s) 172 + --snapshot-topology-interval duration Timer duration on which VTOrc takes a snapshot of the current MySQL information it has in the database. Should be in multiple of hours 173 + --sqlite-data-file string SQLite Datafile to use as VTOrc's database (default "file::memory:?mode=memory&cache=shared") 174 + --stats_backend string The name of the registered push-based monitoring/stats backend to use 175 + --stats_combine_dimensions string List of dimensions to be combined into a single "all" value in exported stats vars 176 + --stats_common_tags strings Comma-separated list of common tags for the stats backend. It provides both label and values. Example: label1:value1,label2:value2 177 + --stats_drop_variables string Variables to be dropped from the list of exported variables. 178 + --stats_emit_period duration Interval between emitting stats to all registered backends (default 1m0s) 179 + --stderrthreshold severity logs at or above this threshold go to stderr (default 1) 180 + --tablet_manager_grpc_ca string the server ca to use to validate servers when connecting 181 + --tablet_manager_grpc_cert string the cert to use to connect 182 + --tablet_manager_grpc_concurrency int concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8) 183 + --tablet_manager_grpc_connpool_size int number of tablets to keep tmclient connections open to (default 100) 184 + --tablet_manager_grpc_crl string the server crl to use to validate server certificates when connecting 185 + --tablet_manager_grpc_key string the key to use to connect 186 + --tablet_manager_grpc_server_name string the server name to use to validate server certificate 187 + --tablet_manager_protocol string Protocol to use to make tabletmanager RPCs to vttablets. (default "grpc") 188 + --topo-information-refresh-duration duration Timer duration on which VTOrc refreshes the keyspace and vttablet records from the topology server (default 15s) 189 + --topo_consul_lock_delay duration LockDelay for consul session. (default 15s) 190 + --topo_consul_lock_session_checks string List of checks for consul session. (default "serfHealth") 191 + --topo_consul_lock_session_ttl string TTL for consul session. 192 + --topo_consul_watch_poll_duration duration time of the long poll for watch queries. (default 30s) 193 + --topo_etcd_lease_ttl int Lease TTL for locks and leader election. The client will use KeepAlive to keep the lease going. (default 30) 194 + --topo_etcd_tls_ca string path to the ca to use to validate the server cert when connecting to the etcd topo server 195 + --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 196 + --topo_etcd_tls_key string path to the client key to use to connect to the etcd topo server, enables TLS 197 + --topo_global_root string the path of the global topology data in the global topology server 198 + --topo_global_server_address string the address of the global topology server 199 + --topo_implementation string the topology implementation to use 200 + --topo_k8s_context string The kubeconfig context to use, overrides the 'current-context' from the config 201 + --topo_k8s_kubeconfig string Path to a valid kubeconfig file. When running as a k8s pod inside the same cluster you wish to use as the topo, you may omit this and the below arguments, and Vitess is capable of auto-discovering the correct values. https://kubernetes.io/docs/tasks/access-application-cluster/access-cluster/#accessing-the-api-from-a-pod 202 + --topo_k8s_namespace string The kubernetes namespace to use for all objects. Default comes from the context or in-cluster config 203 + --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 204 + --topo_zk_base_timeout duration zk base timeout (see zk.Connect) (default 30s) 205 + --topo_zk_max_concurrency int maximum number of pending requests to send to a Zookeeper server. (default 64) 206 + --topo_zk_tls_ca string the server ca to use to validate servers when connecting to the zk topo server 207 + --topo_zk_tls_cert string the cert to use to connect to the zk topo server, requires topo_zk_tls_key, enables TLS 208 + --topo_zk_tls_key string the key to use to connect to the zk topo server, enables TLS 209 + --v Level log level for V logs 210 + -v, --version print binary version 211 + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging 212 + --wait-replicas-timeout duration Duration for which to wait for replica's to respond when issuing RPCs (default 30s)