Skip to content

Refactor vtctld flags to follow standard naming convention #18269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Refactor vtctld flags to follow standard naming convention #18269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions go/cmd/vtctld/cli/schema.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import (
"vitess.io/vitess/go/vt/logutil"
"vitess.io/vitess/go/vt/schemamanager"
"vitess.io/vitess/go/vt/servenv"
"vitess.io/vitess/go/vt/utils"
"vitess.io/vitess/go/vt/vtctl/grpcvtctldserver"
"vitess.io/vitess/go/vt/vttablet/tmclient"
"vitess.io/vitess/go/vt/wrangler"
Expand All @@ -39,12 +40,12 @@ var (
)

func init() {
Main.Flags().StringVar(&schemaChangeDir, "schema_change_dir", schemaChangeDir, "Directory containing schema changes for all keyspaces. Each keyspace has its own directory, and schema changes are expected to live in '$KEYSPACE/input' dir. (e.g. 'test_keyspace/input/*sql'). Each sql file represents a schema change.")
Main.Flags().StringVar(&schemaChangeController, "schema_change_controller", schemaChangeController, "Schema change controller is responsible for finding schema changes and responding to schema change events.")
Main.Flags().StringVar(&schemaChangeUser, "schema_change_user", schemaChangeUser, "The user who schema changes are submitted on behalf of.")
utils.SetFlagStringVar(Main.Flags(), &schemaChangeDir, "schema-change-dir", schemaChangeDir, "Directory containing schema changes for all keyspaces. Each keyspace has its own directory, and schema changes are expected to live in '$KEYSPACE/input' dir. (e.g. 'test_keyspace/input/*sql'). Each sql file represents a schema change.")
utils.SetFlagStringVar(Main.Flags(), &schemaChangeController, "schema-change-controller", schemaChangeController, "Schema change controller is responsible for finding schema changes and responding to schema change events.")
utils.SetFlagStringVar(Main.Flags(), &schemaChangeUser, "schema-change-user", schemaChangeUser, "The user who schema changes are submitted on behalf of.")

Main.Flags().DurationVar(&schemaChangeCheckInterval, "schema_change_check_interval", schemaChangeCheckInterval, "How often the schema change dir is checked for schema changes. This value must be positive; if zero or lower, the default of 1m is used.")
Main.Flags().DurationVar(&schemaChangeReplicasTimeout, "schema_change_replicas_timeout", schemaChangeReplicasTimeout, "How long to wait for replicas to receive a schema change.")
utils.SetFlagDurationVar(Main.Flags(), &schemaChangeCheckInterval, "schema-change-check-interval", schemaChangeCheckInterval, "How often the schema change dir is checked for schema changes. This value must be positive; if zero or lower, the default of 1m is used.")
utils.SetFlagDurationVar(Main.Flags(), &schemaChangeReplicasTimeout, "schema-change-replicas-timeout", schemaChangeReplicasTimeout, "How long to wait for replicas to receive a schema change.")
}

func initSchema(ctx context.Context) {
Expand Down
2 changes: 1 addition & 1 deletion go/cmd/vttablet/cli/cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ var (
* Managed MySQL (most common)
* External MySQL

In addition to these deployment types, a partially managed VTTablet is also possible by setting ` + "`--disable_active_reparents`." + `
In addition to these deployment types, a partially managed VTTablet is also possible by setting ` + "`--disable-active-reparents`." + `

### Managed MySQL

Expand Down
2 changes: 1 addition & 1 deletion go/flags/endtoend/vtbackup.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ Flags:
--mysql-shutdown-timeout duration how long to wait for mysqld shutdown (default 5m0s)
--mysql-socket string Path to the mysqld socket file
--mysql_timeout duration how long to wait for mysqld startup (default 5m0s)
--opentsdb_uri string URI of opentsdb /api/put method
--opentsdb-uri string URI of opentsdb /api/put method
--port int port for the server
--pprof strings enable profiling
--pprof-http enable pprof http endpoints
Expand Down
6 changes: 3 additions & 3 deletions go/flags/endtoend/vtcombo.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,8 +261,8 @@ Flags:
--pprof strings enable profiling
--pprof-http enable pprof http endpoints
--proto_topo vttest.TopoData vttest proto definition of the topology, encoded in compact text format. See vttest.proto for more information.
--proxy-tablets Setting this true will make vtctld proxy the tablet status instead of redirecting to them
--proxy_protocol Enable HAProxy PROXY protocol on MySQL listener socket
--proxy_tablets Setting this true will make vtctld proxy the tablet status instead of redirecting to them
--publish_retry_interval duration how long vttablet waits to retry publishing the tablet record (default 30s)
--purge-logs-interval duration how often try to remove old logs (default 1h0m0s)
--query-log-stream-handler string URL handler for streaming queries log (default "/debug/querylog")
Expand Down Expand Up @@ -344,6 +344,7 @@ Flags:
--table_gc_lifecycle string States for a DROP TABLE garbage collection cycle. Default is 'hold,purge,evac,drop', use any subset ('drop' implicitly always included) (default "hold,purge,evac,drop")
--tablet-dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid.
--tablet-filter-tags StringMap Specifies a comma-separated list of tablet tags (as key:value pairs) to filter the tablets to watch.
--tablet-health-keep-alive duration close streaming tablet health connection if there are no requests for this long (default 5m0s)
--tablet-hostname string if not empty, this hostname will be assumed instead of trying to resolve it
--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
Expand All @@ -358,7 +359,6 @@ Flags:
--tablet-types-to-wait strings Wait till connected for specified tablet types during Gateway initialization. Should be provided as a comma-separated set of tablet types.
--tablet-url-template string Format string describing debug tablet url formatting. See getTabletDebugURL() for how to customize this. (default "http://{{ "{{.GetTabletHostPort}}" }}")
--tablet_filters strings Specifies a comma-separated list of 'keyspace|shard_name or keyrange' values to filter the tablets to watch.
--tablet_health_keep_alive duration close streaming tablet health connection if there are no requests for this long (default 5m0s)
--throttle_tablet_types string Comma separated VTTablet types to be considered by the throttler. default: 'replica'. example: 'replica,rdonly'. 'replica' always implicitly included (default "replica")
--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")
Expand Down Expand Up @@ -424,7 +424,7 @@ Flags:
--vstream-binlog-rotation-threshold int Byte size at which a VStreamer will attempt to rotate the source's open binary log before starting a GTID snapshot based stream (e.g. a ResultStreamer or RowStreamer) (default 67108864)
--vstream-dynamic-packet-size Enable dynamic packet sizing for vstreamers. This will adjust the packet size in vreplication workflows to improve performance. (default true)
--vstream-packet-size int Suggested packet size for vstreamers. The actual packet size may be more or less than this amount. (default 250000)
--vtctld_sanitize_log_messages When true, vtctld sanitizes logging.
--vtctld-sanitize-log-messages When true, vtctld sanitizes logging.
--vtgate-config-terse-errors prevent bind vars from escaping in returned errors
--vtgate_grpc_ca string the server ca to use to validate servers when connecting
--vtgate_grpc_cert string the cert to use to connect
Expand Down
20 changes: 10 additions & 10 deletions go/flags/endtoend/vtctld.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Flags:
--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
--disable_active_reparents if set, do not allow active reparents. Use this to protect a cluster using external reparents.
--disable-active-reparents if set, do not allow active reparents. Use this to protect a cluster using external reparents.
--emit-stats If set, emit stats to push-based monitoring and stats backends
--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.
Expand Down Expand Up @@ -101,12 +101,12 @@ Flags:
--mysql-server-version string MySQL server version to advertise. (default "8.0.40-Vitess")
--onclose-timeout duration wait no more than this for OnClose handlers before stopping (default 10s)
--onterm-timeout duration wait no more than this for OnTermSync handlers before stopping (default 10s)
--opentsdb_uri string URI of opentsdb /api/put method
--opentsdb-uri string URI of opentsdb /api/put method
--pid-file string If set, the process will write its pid to the named file, and delete it on graceful shutdown.
--port int port for the server
--pprof strings enable profiling
--pprof-http enable pprof http endpoints
--proxy_tablets Setting this true will make vtctld proxy the tablet status instead of redirecting to them
--proxy-tablets Setting this true will make vtctld proxy the tablet status instead of redirecting to them
--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).
Expand All @@ -119,11 +119,11 @@ Flags:
--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.
--schema_change_check_interval duration How often the schema change dir is checked for schema changes. This value must be positive; if zero or lower, the default of 1m is used. (default 1m0s)
--schema_change_controller string Schema change controller is responsible for finding schema changes and responding to schema change events.
--schema_change_dir string Directory containing schema changes for all keyspaces. Each keyspace has its own directory, and schema changes are expected to live in '$KEYSPACE/input' dir. (e.g. 'test_keyspace/input/*sql'). Each sql file represents a schema change.
--schema_change_replicas_timeout duration How long to wait for replicas to receive a schema change. (default 10s)
--schema_change_user string The user who schema changes are submitted on behalf of.
--schema-change-check-interval duration How often the schema change dir is checked for schema changes. This value must be positive; if zero or lower, the default of 1m is used. (default 1m0s)
--schema-change-controller string Schema change controller is responsible for finding schema changes and responding to schema change events.
--schema-change-dir string Directory containing schema changes for all keyspaces. Each keyspace has its own directory, and schema changes are expected to live in '$KEYSPACE/input' dir. (e.g. 'test_keyspace/input/*sql'). Each sql file represents a schema change.
--schema-change-replicas-timeout duration How long to wait for replicas to receive a schema change. (default 10s)
--schema-change-user string The user who schema changes are submitted on behalf of.
--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)
--service-map strings comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice
--sql-max-length-errors int truncate queries in error logs to the given length (default unlimited)
Expand All @@ -141,6 +141,7 @@ Flags:
--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-health-keep-alive duration close streaming tablet health connection if there are no requests for this long (default 5m0s)
--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)
Expand All @@ -153,7 +154,6 @@ Flags:
--tablet-refresh-interval duration Tablet refresh interval. (default 1m0s)
--tablet-refresh-known-tablets Whether to reload the tablet's address/port map from topo in case they change. (default true)
--tablet-url-template string Format string describing debug tablet url formatting. See getTabletDebugURL() for how to customize this. (default "http://{{ "{{.GetTabletHostPort}}" }}")
--tablet_health_keep_alive duration close streaming tablet health connection if there are no requests for this long (default 5m0s)
--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.
Expand All @@ -179,4 +179,4 @@ Flags:
--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
--vtctld_sanitize_log_messages When true, vtctld sanitizes logging.
--vtctld-sanitize-log-messages When true, vtctld sanitizes logging.
2 changes: 1 addition & 1 deletion go/flags/endtoend/vtgate.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ Flags:
--normalize_queries Rewrite queries with bind vars. Turn this off if the app itself sends normalized queries with bind vars. (default true)
--onclose-timeout duration wait no more than this for OnClose handlers before stopping (default 10s)
--onterm-timeout duration wait no more than this for OnTermSync handlers before stopping (default 10s)
--opentsdb_uri string URI of opentsdb /api/put method
--opentsdb-uri string URI of opentsdb /api/put method
--pid-file string If set, the process will write its pid to the named file, and delete it on graceful shutdown.
--planner-version string Sets the default planner to use when the session has not changed it. Valid values are: Gen4, Gen4Greedy, Gen4Left2Right
--port int port for the server
Expand Down
4 changes: 2 additions & 2 deletions go/flags/endtoend/vttablet.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ The VTTablet server _controls_ a running MySQL server. VTTablet supports two pri
* Managed MySQL (most common)
* External MySQL

In addition to these deployment types, a partially managed VTTablet is also possible by setting `--disable_active_reparents`.
In addition to these deployment types, a partially managed VTTablet is also possible by setting `--disable-active-reparents`.

### Managed MySQL

Expand Down Expand Up @@ -252,7 +252,7 @@ Flags:
--mysqlctl_socket string socket file to use for remote mysqlctl actions (empty for local actions)
--onclose-timeout duration wait no more than this for OnClose handlers before stopping (default 10s)
--onterm-timeout duration wait no more than this for OnTermSync handlers before stopping (default 10s)
--opentsdb_uri string URI of opentsdb /api/put method
--opentsdb-uri string URI of opentsdb /api/put method
--pid-file string If set, the process will write its pid to the named file, and delete it on graceful shutdown.
--pool-hostname-resolve-interval duration if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled)
--port int port for the server
Expand Down
Loading
Loading