From b193b31b72653c0a36011478e9328224c48586e6 Mon Sep 17 00:00:00 2001 From: Andrew Mason Date: Sun, 10 Sep 2023 15:32:52 -0400 Subject: [PATCH 1/4] docs for mysqlctl and mysqlctld Signed-off-by: Andrew Mason --- Makefile | 10 +- .../reference/programs/mysqlctl/_index.md | 97 ++++++++++++++ .../programs/mysqlctl/mysqlctl_init.md | 33 +++++ .../programs/mysqlctl/mysqlctl_init_config.md | 31 +++++ .../programs/mysqlctl/mysqlctl_position.md | 31 +++++ .../mysqlctl/mysqlctl_reinit_config.md | 31 +++++ .../programs/mysqlctl/mysqlctl_shutdown.md | 32 +++++ .../programs/mysqlctl/mysqlctl_start.md | 33 +++++ .../programs/mysqlctl/mysqlctl_teardown.md | 33 +++++ .../reference/programs/mysqlctld/_index.md | 121 ++++++++++++++++++ 10 files changed, 451 insertions(+), 1 deletion(-) create mode 100644 content/en/docs/18.0/reference/programs/mysqlctl/_index.md create mode 100644 content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init.md create mode 100644 content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init_config.md create mode 100644 content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_position.md create mode 100644 content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md create mode 100644 content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_shutdown.md create mode 100644 content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_start.md create mode 100644 content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_teardown.md create mode 100644 content/en/docs/18.0/reference/programs/mysqlctld/_index.md diff --git a/Makefile b/Makefile index 476e92152..16be0b3f2 100644 --- a/Makefile +++ b/Makefile @@ -45,7 +45,15 @@ ifndef COBRADOC_VERSION_PAIRS export COBRADOC_VERSION_PAIRS="main:18.0,v17.0.2:17.0,v16.0.4:16.0,v15.0.4:15.0" endif -generated-docs: vtctld-docs vtctldclient-docs vtgate-docs vtorc-docs vttablet-docs +generated-docs: mysqlctl-docs mysqlctld-docs vtctld-docs vtctldclient-docs vtgate-docs vtorc-docs vttablet-docs + +# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make mysqlctl-docs +mysqlctl-docs: + go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" mysqlctl + +# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make mysqlctld-docs +mysqlctld-docs: + go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" mysqlctld # Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vtctld-docs vtctld-docs: diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/_index.md b/content/en/docs/18.0/reference/programs/mysqlctl/_index.md new file mode 100644 index 000000000..3c8ce5e73 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/mysqlctl/_index.md @@ -0,0 +1,97 @@ +--- +title: mysqlctl +series: mysqlctl +--- +## mysqlctl + +mysqlctl initializes and controls mysqld with Vitess-specific configuration. + +### Options + +``` + --alsologtostderr log to standard error as well as files + --app_idle_timeout duration Idle timeout for app connections (default 1m0s) + --app_pool_size int Size of the connection pool for app connections (default 40) + --catch-sigpipe catch and ignore SIGPIPE on stdout and stderr if specified + --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 [/Users/andrew/dev/vitess]) + --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). + --db-credentials-file string db credentials file; send SIGHUP to reload this file + --db-credentials-server string db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default "file") + --db-credentials-vault-addr string URL to Vault server + --db-credentials-vault-path string Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds + --db-credentials-vault-role-mountpoint string Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default "approle") + --db-credentials-vault-role-secretidfile string Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable + --db-credentials-vault-roleid string Vault AppRole id; can also be passed using VAULT_ROLEID environment variable + --db-credentials-vault-timeout duration Timeout for vault API operations (default 10s) + --db-credentials-vault-tls-ca string Path to CA PEM for validating Vault server certificate + --db-credentials-vault-tokenfile string Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable + --db-credentials-vault-ttl duration How long to cache DB credentials from the Vault server (default 30m0s) + --db_charset string Character set used for this tablet. (default "utf8mb4") + --db_conn_query_info enable parsing and processing of QUERY_OK info fields + --db_connect_timeout_ms int connection timeout to mysqld in milliseconds (0 for no timeout) + --db_dba_password string db dba password + --db_dba_use_ssl Set this flag to false to make the dba connection to not use ssl (default true) + --db_dba_user string db dba user userKey (default "vt_dba") + --db_flags uint Flag values as defined by MySQL. + --db_flavor string Flavor overrid. Valid value is FilePos. + --db_host string The host name for the tcp connection. + --db_port int tcp port + --db_server_name string server name of the DB we are connecting to. + --db_socket string The unix socket to connect on. If this is specified, host and port will not be used. + --db_ssl_ca string connection ssl ca + --db_ssl_ca_path string connection ssl ca path + --db_ssl_cert string connection ssl certificate + --db_ssl_key string connection ssl key + --db_ssl_mode SslMode SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity. + --db_tls_min_version string Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. + --dba_idle_timeout duration Idle timeout for dba connections (default 1m0s) + --dba_pool_size int Size of the connection pool for dba connections (default 20) + -h, --help help for mysqlctl + --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) + --lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms) + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log_dir string If non-empty, write log files in this directory + --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) + --logtostderr log to standard error instead of files + --max-stack-size int configure the maximum stack size in bytes (default 67108864) + --mysql_port int MySQL port. (default 3306) + --mysql_server_version string MySQL server version to advertise. (default "8.0.30-Vitess") + --mysql_socket string Path to the mysqld socket file. + --mysqlctl_client_protocol string the protocol to use to talk to the mysqlctl server (default "grpc") + --mysqlctl_mycnf_template string template file to use for generating the my.cnf file during server init + --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) + --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) + --pprof strings enable profiling + --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) + --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) + --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 + --socket_file string Local unix socket file to listen on + --stderrthreshold severity logs at or above this threshold go to stderr (default 1) + --table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class + --tablet_dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid. + --tablet_uid uint32 Tablet UID. (default 41983) + --v Level log level for V logs + -v, --version print binary version + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [mysqlctl init](./mysqlctl_init/) - Initializes the directory structure and starts mysqld. +* [mysqlctl init_config](./mysqlctl_init_config/) - Initializes the directory structure, creates my.cnf file, but does not start mysqld. +* [mysqlctl position](./mysqlctl_position/) - Compute operations on replication positions +* [mysqlctl reinit_config](./mysqlctl_reinit_config/) - Reinitializes my.cnf file with new server_id. +* [mysqlctl shutdown](./mysqlctl_shutdown/) - Shuts down mysqld, without removing any files. +* [mysqlctl start](./mysqlctl_start/) - Starts mysqld on an already 'init'-ed directory. +* [mysqlctl teardown](./mysqlctl_teardown/) - Shuts mysqld down and removes the directory. + diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init.md new file mode 100644 index 000000000..82db1fd07 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init.md @@ -0,0 +1,33 @@ +--- +title: init +series: mysqlctl +--- +## mysqlctl init + +Initializes the directory structure and starts mysqld. + +``` +mysqlctl init [flags] +``` + +### Options + +``` + -h, --help help for init + --init_db_sql_file string Path to .sql file to run after mysqld initiliaztion. + --wait_time duration How long to wait for mysqld startup. (default 5m0s) +``` + +### Options inherited from parent commands + +``` + --mysql_port int MySQL port. (default 3306) + --mysql_socket string Path to the mysqld socket file. + --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) + --tablet_uid uint32 Tablet UID. (default 41983) +``` + +### SEE ALSO + +* [mysqlctl](../) - mysqlctl initializes and controls mysqld with Vitess-specific configuration. + diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init_config.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init_config.md new file mode 100644 index 000000000..6ef9062dd --- /dev/null +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init_config.md @@ -0,0 +1,31 @@ +--- +title: init config +series: mysqlctl +--- +## mysqlctl init_config + +Initializes the directory structure, creates my.cnf file, but does not start mysqld. + +``` +mysqlctl init_config [flags] +``` + +### Options + +``` + -h, --help help for init_config +``` + +### Options inherited from parent commands + +``` + --mysql_port int MySQL port. (default 3306) + --mysql_socket string Path to the mysqld socket file. + --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) + --tablet_uid uint32 Tablet UID. (default 41983) +``` + +### SEE ALSO + +* [mysqlctl](../) - mysqlctl initializes and controls mysqld with Vitess-specific configuration. + diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_position.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_position.md new file mode 100644 index 000000000..b6d2e9368 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_position.md @@ -0,0 +1,31 @@ +--- +title: position +series: mysqlctl +--- +## mysqlctl position + +Compute operations on replication positions + +``` +mysqlctl position [flags] +``` + +### Options + +``` + -h, --help help for position +``` + +### Options inherited from parent commands + +``` + --mysql_port int MySQL port. (default 3306) + --mysql_socket string Path to the mysqld socket file. + --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) + --tablet_uid uint32 Tablet UID. (default 41983) +``` + +### SEE ALSO + +* [mysqlctl](../) - mysqlctl initializes and controls mysqld with Vitess-specific configuration. + diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md new file mode 100644 index 000000000..9e5ce5fec --- /dev/null +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md @@ -0,0 +1,31 @@ +--- +title: reinit config +series: mysqlctl +--- +## mysqlctl reinit_config + +Reinitializes my.cnf file with new server_id. + +``` +mysqlctl reinit_config [flags] +``` + +### Options + +``` + -h, --help help for reinit_config +``` + +### Options inherited from parent commands + +``` + --mysql_port int MySQL port. (default 3306) + --mysql_socket string Path to the mysqld socket file. + --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) + --tablet_uid uint32 Tablet UID. (default 41983) +``` + +### SEE ALSO + +* [mysqlctl](../) - mysqlctl initializes and controls mysqld with Vitess-specific configuration. + diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_shutdown.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_shutdown.md new file mode 100644 index 000000000..0634563bc --- /dev/null +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_shutdown.md @@ -0,0 +1,32 @@ +--- +title: shutdown +series: mysqlctl +--- +## mysqlctl shutdown + +Shuts down mysqld, without removing any files. + +``` +mysqlctl shutdown [flags] +``` + +### Options + +``` + -h, --help help for shutdown + --wait_time duration How long to wait for mysqld shutdown. (default 5m0s) +``` + +### Options inherited from parent commands + +``` + --mysql_port int MySQL port. (default 3306) + --mysql_socket string Path to the mysqld socket file. + --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) + --tablet_uid uint32 Tablet UID. (default 41983) +``` + +### SEE ALSO + +* [mysqlctl](../) - mysqlctl initializes and controls mysqld with Vitess-specific configuration. + diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_start.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_start.md new file mode 100644 index 000000000..e47ad42d6 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_start.md @@ -0,0 +1,33 @@ +--- +title: start +series: mysqlctl +--- +## mysqlctl start + +Starts mysqld on an already 'init'-ed directory. + +``` +mysqlctl start [flags] +``` + +### Options + +``` + -h, --help help for start + --mysqld_args strings List of comma-separated flags to pass additionally to mysqld + --wait_time duration How long to wait for mysqld startup (default 5m0s) +``` + +### Options inherited from parent commands + +``` + --mysql_port int MySQL port. (default 3306) + --mysql_socket string Path to the mysqld socket file. + --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) + --tablet_uid uint32 Tablet UID. (default 41983) +``` + +### SEE ALSO + +* [mysqlctl](../) - mysqlctl initializes and controls mysqld with Vitess-specific configuration. + diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_teardown.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_teardown.md new file mode 100644 index 000000000..a5d479c91 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_teardown.md @@ -0,0 +1,33 @@ +--- +title: teardown +series: mysqlctl +--- +## mysqlctl teardown + +Shuts mysqld down and removes the directory. + +``` +mysqlctl teardown [flags] +``` + +### Options + +``` + -f, --force Remove the root directory even if mysqld shutdown fails + -h, --help help for teardown + --wait_time duration How long to wait for mysqld shutdown (default 5m0s) +``` + +### Options inherited from parent commands + +``` + --mysql_port int MySQL port. (default 3306) + --mysql_socket string Path to the mysqld socket file. + --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) + --tablet_uid uint32 Tablet UID. (default 41983) +``` + +### SEE ALSO + +* [mysqlctl](../) - mysqlctl initializes and controls mysqld with Vitess-specific configuration. + diff --git a/content/en/docs/18.0/reference/programs/mysqlctld/_index.md b/content/en/docs/18.0/reference/programs/mysqlctld/_index.md new file mode 100644 index 000000000..133eb4786 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/mysqlctld/_index.md @@ -0,0 +1,121 @@ +--- +title: mysqlctld +series: mysqlctld +--- +## mysqlctld + +mysqlctld is a daemon that starts or initializes mysqld. + +### Synopsis + +mysqlctld is a daemon that starts or initializes mysqld. + +It provides an RPC interface for vttablet to stop and start mysqld from a different container without having to restart the container running mysqlctld. + +``` +mysqlctld [flags] +``` + +### Options + +``` + --alsologtostderr log to standard error as well as files + --app_idle_timeout duration Idle timeout for app connections (default 1m0s) + --app_pool_size int Size of the connection pool for app connections (default 40) + --catch-sigpipe catch and ignore SIGPIPE on stdout and stderr if specified + --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 [/Users/andrew/dev/vitess]) + --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). + --db-credentials-file string db credentials file; send SIGHUP to reload this file + --db-credentials-server string db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default "file") + --db-credentials-vault-addr string URL to Vault server + --db-credentials-vault-path string Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds + --db-credentials-vault-role-mountpoint string Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default "approle") + --db-credentials-vault-role-secretidfile string Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable + --db-credentials-vault-roleid string Vault AppRole id; can also be passed using VAULT_ROLEID environment variable + --db-credentials-vault-timeout duration Timeout for vault API operations (default 10s) + --db-credentials-vault-tls-ca string Path to CA PEM for validating Vault server certificate + --db-credentials-vault-tokenfile string Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable + --db-credentials-vault-ttl duration How long to cache DB credentials from the Vault server (default 30m0s) + --db_charset string Character set used for this tablet. (default "utf8mb4") + --db_conn_query_info enable parsing and processing of QUERY_OK info fields + --db_connect_timeout_ms int connection timeout to mysqld in milliseconds (0 for no timeout) + --db_dba_password string db dba password + --db_dba_use_ssl Set this flag to false to make the dba connection to not use ssl (default true) + --db_dba_user string db dba user userKey (default "vt_dba") + --db_flags uint Flag values as defined by MySQL. + --db_flavor string Flavor overrid. Valid value is FilePos. + --db_host string The host name for the tcp connection. + --db_port int tcp port + --db_server_name string server name of the DB we are connecting to. + --db_socket string The unix socket to connect on. If this is specified, host and port will not be used. + --db_ssl_ca string connection ssl ca + --db_ssl_ca_path string connection ssl ca path + --db_ssl_cert string connection ssl certificate + --db_ssl_key string connection ssl key + --db_ssl_mode SslMode SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity. + --db_tls_min_version string Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. + --dba_idle_timeout duration Idle timeout for dba connections (default 1m0s) + --dba_pool_size int Size of the connection pool for dba connections (default 20) + --grpc_auth_mode string Which auth plugin implementation to use (eg: static) + --grpc_auth_mtls_allowed_substrings string List of substrings of at least one of the client certificate names (separated by colon). + --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_auth_static_password_file string JSON File to read the users/passwords from. + --grpc_ca string server CA to use for gRPC connections, requires TLS, and enforces client certificate check + --grpc_cert string server certificate to use for gRPC connections, requires grpc_key, enables TLS + --grpc_compression string Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy + --grpc_crl string path to a certificate revocation list in PEM format, client certificates will be further verified against this file during TLS handshake + --grpc_enable_optional_tls enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port + --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_key string server private key to use for gRPC connections, requires grpc_cert, enables TLS + --grpc_max_connection_age duration Maximum age of a client connection before GoAway is sent. (default 2562047h47m16.854775807s) + --grpc_max_connection_age_grace duration Additional grace period after grpc_max_connection_age, after which connections are forcibly closed. (default 2562047h47m16.854775807s) + --grpc_port int Port to listen on for gRPC calls. If zero, do not listen. + --grpc_server_ca string path to server CA in PEM format, which will be combine with server cert, return full certificate chain to clients + --grpc_server_initial_conn_window_size int gRPC server initial connection window size + --grpc_server_initial_window_size int gRPC server initial window size + --grpc_server_keepalive_enforcement_policy_min_time duration gRPC server minimum keepalive time (default 10s) + --grpc_server_keepalive_enforcement_policy_permit_without_stream gRPC server permit client keepalive pings even when there are no active streams (RPCs) + -h, --help help for mysqlctld + --init_db_sql_file string Path to .sql file to run after mysqld initialization + --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) + --lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms) + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log_dir string If non-empty, write log files in this directory + --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) + --logtostderr log to standard error instead of files + --max-stack-size int configure the maximum stack size in bytes (default 67108864) + --mysql_port int MySQL port (default 3306) + --mysql_server_version string MySQL server version to advertise. (default "8.0.30-Vitess") + --mysql_socket string Path to the mysqld socket file + --mysqlctl_mycnf_template string template file to use for generating the my.cnf file during server init + --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) + --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 + --pprof strings enable profiling + --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) + --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) + --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 + --socket_file string Local unix socket file to listen on + --stderrthreshold severity logs at or above this threshold go to stderr (default 1) + --table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class + --tablet_dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid. + --tablet_uid uint32 Tablet UID (default 41983) + --v Level log level for V logs + -v, --version print binary version + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging + --wait_time duration How long to wait for mysqld startup or shutdown (default 5m0s) +``` + From a1b332558aef1cc75cbd7808bc0e4d5914ed6fae Mon Sep 17 00:00:00 2001 From: Andrew Mason Date: Mon, 11 Sep 2023 14:47:24 -0400 Subject: [PATCH 2/4] update docs Signed-off-by: Andrew Mason --- .../programs/mysqlctl/mysqlctl_init.md | 77 +++++++++++++++++- .../programs/mysqlctl/mysqlctl_init_config.md | 77 +++++++++++++++++- .../programs/mysqlctl/mysqlctl_position.md | 77 +++++++++++++++++- .../mysqlctl/mysqlctl_reinit_config.md | 77 +++++++++++++++++- .../programs/mysqlctl/mysqlctl_shutdown.md | 77 +++++++++++++++++- .../programs/mysqlctl/mysqlctl_start.md | 81 +++++++++++++++++-- .../programs/mysqlctl/mysqlctl_teardown.md | 81 +++++++++++++++++-- 7 files changed, 515 insertions(+), 32 deletions(-) diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init.md index 82db1fd07..32152ad79 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init.md @@ -21,10 +21,79 @@ mysqlctl init [flags] ### Options inherited from parent commands ``` - --mysql_port int MySQL port. (default 3306) - --mysql_socket string Path to the mysqld socket file. - --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) - --tablet_uid uint32 Tablet UID. (default 41983) + --alsologtostderr log to standard error as well as files + --app_idle_timeout duration Idle timeout for app connections (default 1m0s) + --app_pool_size int Size of the connection pool for app connections (default 40) + --catch-sigpipe catch and ignore SIGPIPE on stdout and stderr if specified + --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 [/Users/andrew/dev/vitess]) + --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). + --db-credentials-file string db credentials file; send SIGHUP to reload this file + --db-credentials-server string db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default "file") + --db-credentials-vault-addr string URL to Vault server + --db-credentials-vault-path string Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds + --db-credentials-vault-role-mountpoint string Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default "approle") + --db-credentials-vault-role-secretidfile string Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable + --db-credentials-vault-roleid string Vault AppRole id; can also be passed using VAULT_ROLEID environment variable + --db-credentials-vault-timeout duration Timeout for vault API operations (default 10s) + --db-credentials-vault-tls-ca string Path to CA PEM for validating Vault server certificate + --db-credentials-vault-tokenfile string Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable + --db-credentials-vault-ttl duration How long to cache DB credentials from the Vault server (default 30m0s) + --db_charset string Character set used for this tablet. (default "utf8mb4") + --db_conn_query_info enable parsing and processing of QUERY_OK info fields + --db_connect_timeout_ms int connection timeout to mysqld in milliseconds (0 for no timeout) + --db_dba_password string db dba password + --db_dba_use_ssl Set this flag to false to make the dba connection to not use ssl (default true) + --db_dba_user string db dba user userKey (default "vt_dba") + --db_flags uint Flag values as defined by MySQL. + --db_flavor string Flavor overrid. Valid value is FilePos. + --db_host string The host name for the tcp connection. + --db_port int tcp port + --db_server_name string server name of the DB we are connecting to. + --db_socket string The unix socket to connect on. If this is specified, host and port will not be used. + --db_ssl_ca string connection ssl ca + --db_ssl_ca_path string connection ssl ca path + --db_ssl_cert string connection ssl certificate + --db_ssl_key string connection ssl key + --db_ssl_mode SslMode SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity. + --db_tls_min_version string Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. + --dba_idle_timeout duration Idle timeout for dba connections (default 1m0s) + --dba_pool_size int Size of the connection pool for dba connections (default 20) + --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) + --lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms) + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log_dir string If non-empty, write log files in this directory + --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) + --logtostderr log to standard error instead of files + --max-stack-size int configure the maximum stack size in bytes (default 67108864) + --mysql_port int MySQL port. (default 3306) + --mysql_server_version string MySQL server version to advertise. (default "8.0.30-Vitess") + --mysql_socket string Path to the mysqld socket file. + --mysqlctl_client_protocol string the protocol to use to talk to the mysqlctl server (default "grpc") + --mysqlctl_mycnf_template string template file to use for generating the my.cnf file during server init + --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) + --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) + --pprof strings enable profiling + --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) + --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) + --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 + --socket_file string Local unix socket file to listen on + --stderrthreshold severity logs at or above this threshold go to stderr (default 1) + --table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class + --tablet_dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid. + --tablet_uid uint32 Tablet UID. (default 41983) + --v Level log level for V logs + -v, --version print binary version + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init_config.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init_config.md index 6ef9062dd..8050773a7 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init_config.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init_config.md @@ -19,10 +19,79 @@ mysqlctl init_config [flags] ### Options inherited from parent commands ``` - --mysql_port int MySQL port. (default 3306) - --mysql_socket string Path to the mysqld socket file. - --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) - --tablet_uid uint32 Tablet UID. (default 41983) + --alsologtostderr log to standard error as well as files + --app_idle_timeout duration Idle timeout for app connections (default 1m0s) + --app_pool_size int Size of the connection pool for app connections (default 40) + --catch-sigpipe catch and ignore SIGPIPE on stdout and stderr if specified + --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 [/Users/andrew/dev/vitess]) + --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). + --db-credentials-file string db credentials file; send SIGHUP to reload this file + --db-credentials-server string db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default "file") + --db-credentials-vault-addr string URL to Vault server + --db-credentials-vault-path string Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds + --db-credentials-vault-role-mountpoint string Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default "approle") + --db-credentials-vault-role-secretidfile string Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable + --db-credentials-vault-roleid string Vault AppRole id; can also be passed using VAULT_ROLEID environment variable + --db-credentials-vault-timeout duration Timeout for vault API operations (default 10s) + --db-credentials-vault-tls-ca string Path to CA PEM for validating Vault server certificate + --db-credentials-vault-tokenfile string Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable + --db-credentials-vault-ttl duration How long to cache DB credentials from the Vault server (default 30m0s) + --db_charset string Character set used for this tablet. (default "utf8mb4") + --db_conn_query_info enable parsing and processing of QUERY_OK info fields + --db_connect_timeout_ms int connection timeout to mysqld in milliseconds (0 for no timeout) + --db_dba_password string db dba password + --db_dba_use_ssl Set this flag to false to make the dba connection to not use ssl (default true) + --db_dba_user string db dba user userKey (default "vt_dba") + --db_flags uint Flag values as defined by MySQL. + --db_flavor string Flavor overrid. Valid value is FilePos. + --db_host string The host name for the tcp connection. + --db_port int tcp port + --db_server_name string server name of the DB we are connecting to. + --db_socket string The unix socket to connect on. If this is specified, host and port will not be used. + --db_ssl_ca string connection ssl ca + --db_ssl_ca_path string connection ssl ca path + --db_ssl_cert string connection ssl certificate + --db_ssl_key string connection ssl key + --db_ssl_mode SslMode SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity. + --db_tls_min_version string Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. + --dba_idle_timeout duration Idle timeout for dba connections (default 1m0s) + --dba_pool_size int Size of the connection pool for dba connections (default 20) + --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) + --lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms) + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log_dir string If non-empty, write log files in this directory + --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) + --logtostderr log to standard error instead of files + --max-stack-size int configure the maximum stack size in bytes (default 67108864) + --mysql_port int MySQL port. (default 3306) + --mysql_server_version string MySQL server version to advertise. (default "8.0.30-Vitess") + --mysql_socket string Path to the mysqld socket file. + --mysqlctl_client_protocol string the protocol to use to talk to the mysqlctl server (default "grpc") + --mysqlctl_mycnf_template string template file to use for generating the my.cnf file during server init + --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) + --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) + --pprof strings enable profiling + --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) + --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) + --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 + --socket_file string Local unix socket file to listen on + --stderrthreshold severity logs at or above this threshold go to stderr (default 1) + --table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class + --tablet_dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid. + --tablet_uid uint32 Tablet UID. (default 41983) + --v Level log level for V logs + -v, --version print binary version + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_position.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_position.md index b6d2e9368..3311cf169 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_position.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_position.md @@ -19,10 +19,79 @@ mysqlctl position [flags] ### Options inherited from parent commands ``` - --mysql_port int MySQL port. (default 3306) - --mysql_socket string Path to the mysqld socket file. - --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) - --tablet_uid uint32 Tablet UID. (default 41983) + --alsologtostderr log to standard error as well as files + --app_idle_timeout duration Idle timeout for app connections (default 1m0s) + --app_pool_size int Size of the connection pool for app connections (default 40) + --catch-sigpipe catch and ignore SIGPIPE on stdout and stderr if specified + --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 [/Users/andrew/dev/vitess]) + --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). + --db-credentials-file string db credentials file; send SIGHUP to reload this file + --db-credentials-server string db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default "file") + --db-credentials-vault-addr string URL to Vault server + --db-credentials-vault-path string Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds + --db-credentials-vault-role-mountpoint string Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default "approle") + --db-credentials-vault-role-secretidfile string Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable + --db-credentials-vault-roleid string Vault AppRole id; can also be passed using VAULT_ROLEID environment variable + --db-credentials-vault-timeout duration Timeout for vault API operations (default 10s) + --db-credentials-vault-tls-ca string Path to CA PEM for validating Vault server certificate + --db-credentials-vault-tokenfile string Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable + --db-credentials-vault-ttl duration How long to cache DB credentials from the Vault server (default 30m0s) + --db_charset string Character set used for this tablet. (default "utf8mb4") + --db_conn_query_info enable parsing and processing of QUERY_OK info fields + --db_connect_timeout_ms int connection timeout to mysqld in milliseconds (0 for no timeout) + --db_dba_password string db dba password + --db_dba_use_ssl Set this flag to false to make the dba connection to not use ssl (default true) + --db_dba_user string db dba user userKey (default "vt_dba") + --db_flags uint Flag values as defined by MySQL. + --db_flavor string Flavor overrid. Valid value is FilePos. + --db_host string The host name for the tcp connection. + --db_port int tcp port + --db_server_name string server name of the DB we are connecting to. + --db_socket string The unix socket to connect on. If this is specified, host and port will not be used. + --db_ssl_ca string connection ssl ca + --db_ssl_ca_path string connection ssl ca path + --db_ssl_cert string connection ssl certificate + --db_ssl_key string connection ssl key + --db_ssl_mode SslMode SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity. + --db_tls_min_version string Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. + --dba_idle_timeout duration Idle timeout for dba connections (default 1m0s) + --dba_pool_size int Size of the connection pool for dba connections (default 20) + --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) + --lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms) + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log_dir string If non-empty, write log files in this directory + --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) + --logtostderr log to standard error instead of files + --max-stack-size int configure the maximum stack size in bytes (default 67108864) + --mysql_port int MySQL port. (default 3306) + --mysql_server_version string MySQL server version to advertise. (default "8.0.30-Vitess") + --mysql_socket string Path to the mysqld socket file. + --mysqlctl_client_protocol string the protocol to use to talk to the mysqlctl server (default "grpc") + --mysqlctl_mycnf_template string template file to use for generating the my.cnf file during server init + --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) + --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) + --pprof strings enable profiling + --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) + --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) + --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 + --socket_file string Local unix socket file to listen on + --stderrthreshold severity logs at or above this threshold go to stderr (default 1) + --table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class + --tablet_dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid. + --tablet_uid uint32 Tablet UID. (default 41983) + --v Level log level for V logs + -v, --version print binary version + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md index 9e5ce5fec..6ba2eb15f 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md @@ -19,10 +19,79 @@ mysqlctl reinit_config [flags] ### Options inherited from parent commands ``` - --mysql_port int MySQL port. (default 3306) - --mysql_socket string Path to the mysqld socket file. - --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) - --tablet_uid uint32 Tablet UID. (default 41983) + --alsologtostderr log to standard error as well as files + --app_idle_timeout duration Idle timeout for app connections (default 1m0s) + --app_pool_size int Size of the connection pool for app connections (default 40) + --catch-sigpipe catch and ignore SIGPIPE on stdout and stderr if specified + --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 [/Users/andrew/dev/vitess]) + --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). + --db-credentials-file string db credentials file; send SIGHUP to reload this file + --db-credentials-server string db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default "file") + --db-credentials-vault-addr string URL to Vault server + --db-credentials-vault-path string Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds + --db-credentials-vault-role-mountpoint string Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default "approle") + --db-credentials-vault-role-secretidfile string Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable + --db-credentials-vault-roleid string Vault AppRole id; can also be passed using VAULT_ROLEID environment variable + --db-credentials-vault-timeout duration Timeout for vault API operations (default 10s) + --db-credentials-vault-tls-ca string Path to CA PEM for validating Vault server certificate + --db-credentials-vault-tokenfile string Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable + --db-credentials-vault-ttl duration How long to cache DB credentials from the Vault server (default 30m0s) + --db_charset string Character set used for this tablet. (default "utf8mb4") + --db_conn_query_info enable parsing and processing of QUERY_OK info fields + --db_connect_timeout_ms int connection timeout to mysqld in milliseconds (0 for no timeout) + --db_dba_password string db dba password + --db_dba_use_ssl Set this flag to false to make the dba connection to not use ssl (default true) + --db_dba_user string db dba user userKey (default "vt_dba") + --db_flags uint Flag values as defined by MySQL. + --db_flavor string Flavor overrid. Valid value is FilePos. + --db_host string The host name for the tcp connection. + --db_port int tcp port + --db_server_name string server name of the DB we are connecting to. + --db_socket string The unix socket to connect on. If this is specified, host and port will not be used. + --db_ssl_ca string connection ssl ca + --db_ssl_ca_path string connection ssl ca path + --db_ssl_cert string connection ssl certificate + --db_ssl_key string connection ssl key + --db_ssl_mode SslMode SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity. + --db_tls_min_version string Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. + --dba_idle_timeout duration Idle timeout for dba connections (default 1m0s) + --dba_pool_size int Size of the connection pool for dba connections (default 20) + --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) + --lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms) + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log_dir string If non-empty, write log files in this directory + --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) + --logtostderr log to standard error instead of files + --max-stack-size int configure the maximum stack size in bytes (default 67108864) + --mysql_port int MySQL port. (default 3306) + --mysql_server_version string MySQL server version to advertise. (default "8.0.30-Vitess") + --mysql_socket string Path to the mysqld socket file. + --mysqlctl_client_protocol string the protocol to use to talk to the mysqlctl server (default "grpc") + --mysqlctl_mycnf_template string template file to use for generating the my.cnf file during server init + --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) + --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) + --pprof strings enable profiling + --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) + --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) + --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 + --socket_file string Local unix socket file to listen on + --stderrthreshold severity logs at or above this threshold go to stderr (default 1) + --table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class + --tablet_dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid. + --tablet_uid uint32 Tablet UID. (default 41983) + --v Level log level for V logs + -v, --version print binary version + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_shutdown.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_shutdown.md index 0634563bc..09ff4b5c2 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_shutdown.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_shutdown.md @@ -20,10 +20,79 @@ mysqlctl shutdown [flags] ### Options inherited from parent commands ``` - --mysql_port int MySQL port. (default 3306) - --mysql_socket string Path to the mysqld socket file. - --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) - --tablet_uid uint32 Tablet UID. (default 41983) + --alsologtostderr log to standard error as well as files + --app_idle_timeout duration Idle timeout for app connections (default 1m0s) + --app_pool_size int Size of the connection pool for app connections (default 40) + --catch-sigpipe catch and ignore SIGPIPE on stdout and stderr if specified + --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 [/Users/andrew/dev/vitess]) + --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). + --db-credentials-file string db credentials file; send SIGHUP to reload this file + --db-credentials-server string db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default "file") + --db-credentials-vault-addr string URL to Vault server + --db-credentials-vault-path string Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds + --db-credentials-vault-role-mountpoint string Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default "approle") + --db-credentials-vault-role-secretidfile string Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable + --db-credentials-vault-roleid string Vault AppRole id; can also be passed using VAULT_ROLEID environment variable + --db-credentials-vault-timeout duration Timeout for vault API operations (default 10s) + --db-credentials-vault-tls-ca string Path to CA PEM for validating Vault server certificate + --db-credentials-vault-tokenfile string Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable + --db-credentials-vault-ttl duration How long to cache DB credentials from the Vault server (default 30m0s) + --db_charset string Character set used for this tablet. (default "utf8mb4") + --db_conn_query_info enable parsing and processing of QUERY_OK info fields + --db_connect_timeout_ms int connection timeout to mysqld in milliseconds (0 for no timeout) + --db_dba_password string db dba password + --db_dba_use_ssl Set this flag to false to make the dba connection to not use ssl (default true) + --db_dba_user string db dba user userKey (default "vt_dba") + --db_flags uint Flag values as defined by MySQL. + --db_flavor string Flavor overrid. Valid value is FilePos. + --db_host string The host name for the tcp connection. + --db_port int tcp port + --db_server_name string server name of the DB we are connecting to. + --db_socket string The unix socket to connect on. If this is specified, host and port will not be used. + --db_ssl_ca string connection ssl ca + --db_ssl_ca_path string connection ssl ca path + --db_ssl_cert string connection ssl certificate + --db_ssl_key string connection ssl key + --db_ssl_mode SslMode SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity. + --db_tls_min_version string Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. + --dba_idle_timeout duration Idle timeout for dba connections (default 1m0s) + --dba_pool_size int Size of the connection pool for dba connections (default 20) + --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) + --lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms) + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log_dir string If non-empty, write log files in this directory + --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) + --logtostderr log to standard error instead of files + --max-stack-size int configure the maximum stack size in bytes (default 67108864) + --mysql_port int MySQL port. (default 3306) + --mysql_server_version string MySQL server version to advertise. (default "8.0.30-Vitess") + --mysql_socket string Path to the mysqld socket file. + --mysqlctl_client_protocol string the protocol to use to talk to the mysqlctl server (default "grpc") + --mysqlctl_mycnf_template string template file to use for generating the my.cnf file during server init + --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) + --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) + --pprof strings enable profiling + --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) + --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) + --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 + --socket_file string Local unix socket file to listen on + --stderrthreshold severity logs at or above this threshold go to stderr (default 1) + --table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class + --tablet_dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid. + --tablet_uid uint32 Tablet UID. (default 41983) + --v Level log level for V logs + -v, --version print binary version + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_start.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_start.md index e47ad42d6..f2c8b7b5e 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_start.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_start.md @@ -14,17 +14,86 @@ mysqlctl start [flags] ``` -h, --help help for start - --mysqld_args strings List of comma-separated flags to pass additionally to mysqld - --wait_time duration How long to wait for mysqld startup (default 5m0s) + --mysqld_args strings List of comma-separated flags to pass additionally to mysqld. + --wait_time duration How long to wait for mysqld startup. (default 5m0s) ``` ### Options inherited from parent commands ``` - --mysql_port int MySQL port. (default 3306) - --mysql_socket string Path to the mysqld socket file. - --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) - --tablet_uid uint32 Tablet UID. (default 41983) + --alsologtostderr log to standard error as well as files + --app_idle_timeout duration Idle timeout for app connections (default 1m0s) + --app_pool_size int Size of the connection pool for app connections (default 40) + --catch-sigpipe catch and ignore SIGPIPE on stdout and stderr if specified + --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 [/Users/andrew/dev/vitess]) + --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). + --db-credentials-file string db credentials file; send SIGHUP to reload this file + --db-credentials-server string db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default "file") + --db-credentials-vault-addr string URL to Vault server + --db-credentials-vault-path string Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds + --db-credentials-vault-role-mountpoint string Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default "approle") + --db-credentials-vault-role-secretidfile string Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable + --db-credentials-vault-roleid string Vault AppRole id; can also be passed using VAULT_ROLEID environment variable + --db-credentials-vault-timeout duration Timeout for vault API operations (default 10s) + --db-credentials-vault-tls-ca string Path to CA PEM for validating Vault server certificate + --db-credentials-vault-tokenfile string Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable + --db-credentials-vault-ttl duration How long to cache DB credentials from the Vault server (default 30m0s) + --db_charset string Character set used for this tablet. (default "utf8mb4") + --db_conn_query_info enable parsing and processing of QUERY_OK info fields + --db_connect_timeout_ms int connection timeout to mysqld in milliseconds (0 for no timeout) + --db_dba_password string db dba password + --db_dba_use_ssl Set this flag to false to make the dba connection to not use ssl (default true) + --db_dba_user string db dba user userKey (default "vt_dba") + --db_flags uint Flag values as defined by MySQL. + --db_flavor string Flavor overrid. Valid value is FilePos. + --db_host string The host name for the tcp connection. + --db_port int tcp port + --db_server_name string server name of the DB we are connecting to. + --db_socket string The unix socket to connect on. If this is specified, host and port will not be used. + --db_ssl_ca string connection ssl ca + --db_ssl_ca_path string connection ssl ca path + --db_ssl_cert string connection ssl certificate + --db_ssl_key string connection ssl key + --db_ssl_mode SslMode SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity. + --db_tls_min_version string Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. + --dba_idle_timeout duration Idle timeout for dba connections (default 1m0s) + --dba_pool_size int Size of the connection pool for dba connections (default 20) + --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) + --lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms) + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log_dir string If non-empty, write log files in this directory + --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) + --logtostderr log to standard error instead of files + --max-stack-size int configure the maximum stack size in bytes (default 67108864) + --mysql_port int MySQL port. (default 3306) + --mysql_server_version string MySQL server version to advertise. (default "8.0.30-Vitess") + --mysql_socket string Path to the mysqld socket file. + --mysqlctl_client_protocol string the protocol to use to talk to the mysqlctl server (default "grpc") + --mysqlctl_mycnf_template string template file to use for generating the my.cnf file during server init + --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) + --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) + --pprof strings enable profiling + --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) + --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) + --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 + --socket_file string Local unix socket file to listen on + --stderrthreshold severity logs at or above this threshold go to stderr (default 1) + --table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class + --tablet_dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid. + --tablet_uid uint32 Tablet UID. (default 41983) + --v Level log level for V logs + -v, --version print binary version + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_teardown.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_teardown.md index a5d479c91..f1dfd74f7 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_teardown.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_teardown.md @@ -13,18 +13,87 @@ mysqlctl teardown [flags] ### Options ``` - -f, --force Remove the root directory even if mysqld shutdown fails + -f, --force Remove the root directory even if mysqld shutdown fails. -h, --help help for teardown - --wait_time duration How long to wait for mysqld shutdown (default 5m0s) + --wait_time duration How long to wait for mysqld shutdown. (default 5m0s) ``` ### Options inherited from parent commands ``` - --mysql_port int MySQL port. (default 3306) - --mysql_socket string Path to the mysqld socket file. - --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) - --tablet_uid uint32 Tablet UID. (default 41983) + --alsologtostderr log to standard error as well as files + --app_idle_timeout duration Idle timeout for app connections (default 1m0s) + --app_pool_size int Size of the connection pool for app connections (default 40) + --catch-sigpipe catch and ignore SIGPIPE on stdout and stderr if specified + --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 [/Users/andrew/dev/vitess]) + --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). + --db-credentials-file string db credentials file; send SIGHUP to reload this file + --db-credentials-server string db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default "file") + --db-credentials-vault-addr string URL to Vault server + --db-credentials-vault-path string Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds + --db-credentials-vault-role-mountpoint string Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default "approle") + --db-credentials-vault-role-secretidfile string Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable + --db-credentials-vault-roleid string Vault AppRole id; can also be passed using VAULT_ROLEID environment variable + --db-credentials-vault-timeout duration Timeout for vault API operations (default 10s) + --db-credentials-vault-tls-ca string Path to CA PEM for validating Vault server certificate + --db-credentials-vault-tokenfile string Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable + --db-credentials-vault-ttl duration How long to cache DB credentials from the Vault server (default 30m0s) + --db_charset string Character set used for this tablet. (default "utf8mb4") + --db_conn_query_info enable parsing and processing of QUERY_OK info fields + --db_connect_timeout_ms int connection timeout to mysqld in milliseconds (0 for no timeout) + --db_dba_password string db dba password + --db_dba_use_ssl Set this flag to false to make the dba connection to not use ssl (default true) + --db_dba_user string db dba user userKey (default "vt_dba") + --db_flags uint Flag values as defined by MySQL. + --db_flavor string Flavor overrid. Valid value is FilePos. + --db_host string The host name for the tcp connection. + --db_port int tcp port + --db_server_name string server name of the DB we are connecting to. + --db_socket string The unix socket to connect on. If this is specified, host and port will not be used. + --db_ssl_ca string connection ssl ca + --db_ssl_ca_path string connection ssl ca path + --db_ssl_cert string connection ssl certificate + --db_ssl_key string connection ssl key + --db_ssl_mode SslMode SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity. + --db_tls_min_version string Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. + --dba_idle_timeout duration Idle timeout for dba connections (default 1m0s) + --dba_pool_size int Size of the connection pool for dba connections (default 20) + --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) + --lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms) + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log_dir string If non-empty, write log files in this directory + --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) + --logtostderr log to standard error instead of files + --max-stack-size int configure the maximum stack size in bytes (default 67108864) + --mysql_port int MySQL port. (default 3306) + --mysql_server_version string MySQL server version to advertise. (default "8.0.30-Vitess") + --mysql_socket string Path to the mysqld socket file. + --mysqlctl_client_protocol string the protocol to use to talk to the mysqlctl server (default "grpc") + --mysqlctl_mycnf_template string template file to use for generating the my.cnf file during server init + --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) + --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) + --pprof strings enable profiling + --purge_logs_interval duration how often try to remove old logs (default 1h0m0s) + --replication_connect_retry duration how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) + --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 + --socket_file string Local unix socket file to listen on + --stderrthreshold severity logs at or above this threshold go to stderr (default 1) + --table-refresh-interval int interval in milliseconds to refresh tables in status page with refreshRequired class + --tablet_dir string The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid. + --tablet_uid uint32 Tablet UID. (default 41983) + --v Level log level for V logs + -v, --version print binary version + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO From 59f2e6f74c01fe3b50bd4ce991fe66f2ccc9e747 Mon Sep 17 00:00:00 2001 From: Andrew Mason Date: Wed, 13 Sep 2023 07:45:53 -0400 Subject: [PATCH 3/4] regen docs Signed-off-by: Andrew Mason --- .../reference/programs/mysqlctl/_index.md | 8 ++++++++ .../programs/mysqlctl/mysqlctl_init.md | 15 ++++++++++++++ .../programs/mysqlctl/mysqlctl_init_config.md | 15 ++++++++++++++ .../mysqlctl/mysqlctl_reinit_config.md | 15 ++++++++++++++ .../programs/mysqlctl/mysqlctl_shutdown.md | 12 +++++++++++ .../programs/mysqlctl/mysqlctl_start.md | 10 ++++++++++ .../programs/mysqlctl/mysqlctl_teardown.md | 14 +++++++++++++ .../reference/programs/mysqlctld/_index.md | 20 +++++++++++++++++-- 8 files changed, 107 insertions(+), 2 deletions(-) diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/_index.md b/content/en/docs/18.0/reference/programs/mysqlctl/_index.md index 3c8ce5e73..1197f4766 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/_index.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/_index.md @@ -6,6 +6,14 @@ series: mysqlctl mysqlctl initializes and controls mysqld with Vitess-specific configuration. +### Synopsis + +`mysqlctl` is a command-line client used for managing `mysqld` instances. + +It is responsible for bootstrapping tasks such as generating a configuration file for `mysqld` and initializing the instance and its data directory. +The `mysqld_safe` watchdog is utilized when present. +This helps ensure that `mysqld` is automatically restarted after failures. + ### Options ``` diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init.md index 32152ad79..1e3363da8 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init.md @@ -6,10 +6,25 @@ series: mysqlctl Initializes the directory structure and starts mysqld. +### Synopsis + +Bootstraps a new `mysqld` instance, initializes its data directory, and starts the instance. +The MySQL version and flavor will be auto-detected, with a minimal configuration file applied. + ``` mysqlctl init [flags] ``` +### Examples + +``` +mysqlctl \ + --alsologtostderr \ + --tablet_uid 101 \ + --mysql_port 12345 \ + init +``` + ### Options ``` diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init_config.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init_config.md index 8050773a7..62f509fff 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init_config.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_init_config.md @@ -6,10 +6,25 @@ series: mysqlctl Initializes the directory structure, creates my.cnf file, but does not start mysqld. +### Synopsis + +Bootstraps the configuration for a new `mysqld` instance and initializes its data directory. +This command is the same as `init` except the `mysqld` server will not be started. + ``` mysqlctl init_config [flags] ``` +### Examples + +``` +mysqlctl \ + --alsologtostderr \ + --tablet_uid 101 \ + --mysql_port 12345 \ + init_config +``` + ### Options ``` diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md index 6ba2eb15f..976543473 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md @@ -6,10 +6,25 @@ series: mysqlctl Reinitializes my.cnf file with new server_id. +### Synopsis + +Regenerate new configuration files for an existing `mysqld` instance (generating new server_id and server_uuid values). +This could be helpful to revert configuration changes, or to pick up changes made to the bundled config in newer Vitess versions. + ``` mysqlctl reinit_config [flags] ``` +### Examples + +``` +mysqlctl \ + --alsologtostderr \ + --tablet_uid 101 \ + --mysql_port 12345 \ + reinit_config +``` + ### Options ``` diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_shutdown.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_shutdown.md index 09ff4b5c2..f24968d1c 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_shutdown.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_shutdown.md @@ -6,10 +6,22 @@ series: mysqlctl Shuts down mysqld, without removing any files. +### Synopsis + +Stop a `mysqld` instance that was previously started with `init` or `start`. + +For large `mysqld` instances, you may need to extend the `wait_time` to shutdown cleanly. + ``` mysqlctl shutdown [flags] ``` +### Examples + +``` +mysqlctl --tablet_uid 101 --alsologtostderr shutdown +``` + ### Options ``` diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_start.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_start.md index f2c8b7b5e..752032e30 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_start.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_start.md @@ -6,10 +6,20 @@ series: mysqlctl Starts mysqld on an already 'init'-ed directory. +### Synopsis + +Resume an existing `mysqld` instance that was previously bootstrapped with `init` or `init_config` + ``` mysqlctl start [flags] ``` +### Examples + +``` +mysqlctl --tablet_uid 101 --alsologtostderr start +``` + ### Options ``` diff --git a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_teardown.md b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_teardown.md index f1dfd74f7..92d764719 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_teardown.md +++ b/content/en/docs/18.0/reference/programs/mysqlctl/mysqlctl_teardown.md @@ -6,10 +6,24 @@ series: mysqlctl Shuts mysqld down and removes the directory. +### Synopsis + +{{< warning >}} +This is a destructive operation. +{{}} + +Shuts down a `mysqld` instance and removes its data directory. + ``` mysqlctl teardown [flags] ``` +### Examples + +``` +mysqlctl --tablet_uid 101 --alsologtostderr teardown +``` + ### Options ``` diff --git a/content/en/docs/18.0/reference/programs/mysqlctld/_index.md b/content/en/docs/18.0/reference/programs/mysqlctld/_index.md index 133eb4786..5ccc2c8b5 100644 --- a/content/en/docs/18.0/reference/programs/mysqlctld/_index.md +++ b/content/en/docs/18.0/reference/programs/mysqlctld/_index.md @@ -8,14 +8,30 @@ mysqlctld is a daemon that starts or initializes mysqld. ### Synopsis -mysqlctld is a daemon that starts or initializes mysqld. +`mysqlctld` is a gRPC server that can be used instead of the `mysqlctl` client tool. +If the target directories are empty when it is invoked, it automatically performs initialization operations to bootstrap the `mysqld` instance before starting it. +The `mysqlctld` process can subsequently receive gRPC commands from a `vttablet` to perform housekeeping operations like shutting down and restarting the `mysqld` instance as needed. + +{{< warning >}} +`mysqld_safe` is not used so the `mysqld` process will not be automatically restarted in case of a failure. +{{}} -It provides an RPC interface for vttablet to stop and start mysqld from a different container without having to restart the container running mysqlctld. +To enable communication with a `vttablet`, the server must be configured to receive gRPC messages on a unix domain socket. ``` mysqlctld [flags] ``` +### Examples + +``` +mysqlctld \ + --log_dir=${VTDATAROOT}/logs \ + --tablet_uid=100 \ + --mysql_port=17100 \ + --socket_file=/path/to/socket_file +``` + ### Options ``` From 4552d9f28cffb5b9e4e1adbb196a981609e9d674 Mon Sep 17 00:00:00 2001 From: Andrew Mason Date: Wed, 13 Sep 2023 07:46:25 -0400 Subject: [PATCH 4/4] remove handwritten mysqlctl/mysqlctld docs Signed-off-by: Andrew Mason --- .../docs/18.0/reference/programs/mysqlctl.md | 158 ------------------ .../docs/18.0/reference/programs/mysqlctld.md | 122 -------------- 2 files changed, 280 deletions(-) delete mode 100644 content/en/docs/18.0/reference/programs/mysqlctl.md delete mode 100644 content/en/docs/18.0/reference/programs/mysqlctld.md diff --git a/content/en/docs/18.0/reference/programs/mysqlctl.md b/content/en/docs/18.0/reference/programs/mysqlctl.md deleted file mode 100644 index c0430522d..000000000 --- a/content/en/docs/18.0/reference/programs/mysqlctl.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: mysqlctl ---- - -`mysqlctl` is a command-line client used for managing `mysqld` instances. It is responsible for bootstrapping tasks such as generating a configuration file for `mysqld` and initializing the instance and its data directory. - -The `mysqld_safe` watchdog is utilized when present. This helps ensure that `mysqld` is automatically restarted after failures. - -## Commands - -### init [--wait_time=5m] [--init_db_sql_file=(default)] - -Bootstraps a new `mysqld` instance, initializes its data directory, and starts the instance. The MySQL version and flavor will be auto-detected, with a minimal configuration file applied. For example: - -```bash -export VTDATAROOT=/tmp -mysqlctl \ - --alsologtostderr \ - --tablet_uid 101 \ - --mysql_port 12345 \ - init -``` - -### init_config - -Bootstraps the configuration for a new `mysqld` instance and initializes its data directory. This command is the same as `init` except the `mysqld` server will not be started. For example: - -```bash -export VTDATAROOT=/tmp -mysqlctl \ - --alsologtostderr \ - --tablet_uid 101 \ - --mysql_port 12345 \ - init_config -``` - -### reinit_config - -Regenerate new configuration files for an existing `mysqld` instance (generating new server_id and server_uuid values). This could be helpful to revert configuration changes, or to pick up changes made to the bundled config in newer Vitess versions. For example: - -```bash -export VTDATAROOT=/tmp -mysqlctl \ - --alsologtostderr \ - --tablet_uid 101 \ - --mysql_port 12345 \ - reinit_config -``` - -### teardown [--wait_time=5m] [--force] - -{{< warning >}} -This is a destructive operation. -{{}} - -Shuts down a `mysqld` instance and removes its data directory. For example: - -```bash -export VTDATAROOT=/tmp -mysqlctl --tablet_uid 101 --alsologtostderr teardown -``` - -### start [--wait_time=5m] - -Resume an existing `mysqld` instance that was previously bootstrapped with `init` or `init_config`: - -```bash -export VTDATAROOT=/tmp -mysqlctl --tablet_uid 101 --alsologtostderr start -``` - -### shutdown [--wait_time=5m] - -Stop a `mysqld` instance that was previously started with `init` or `start`. - -For large `mysqld` instances, you may need to extend the `wait_time` to shutdown cleanly. - -```bash -export VTDATAROOT=/tmp -mysqlctl --tablet_uid 101 --alsologtostderr shutdown -``` - -## Options - -The following global parameters apply to `mysqlctl`: - -| Name | Type | Definition | -| :-------------------------------- | :--------- | :--------- | -| --alsologtostderr | boolean | log to standard error as well as files | -| --app_idle_timeout | duration | Idle timeout for app connections (default 1m0s) | -| --app_pool_size | int | Size of the connection pool for app connections (default 40) | -| --catch-sigpipe | boolean | catch and ignore SIGPIPE on stdout and stderr if specified | -| --db-credentials-file | string | db credentials file; send SIGHUP to reload this file | -| --db-credentials-server | string | db credentials server type (use 'file' for the file implementation) (default "file") | -| --db-credentials-vault-addr | string | URL to Vault server | -| --db-credentials-vault-path | string | Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds | -| --db-credentials-vault-role-mountpoint | string | Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default "approle") | -| --db-credentials-vault-role-secretidfile | string | Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable | -| --db-credentials-vault-roleid | string | Vault AppRole id; can also be passed using VAULT_ROLEID environment variable | -| --db-credentials-vault-timeout | duration | Timeout for vault API operations (default 10s) | -| --db-credentials-vault-tls-ca | string | Path to CA PEM for validating Vault server certificate | -| --db-credentials-vault-tokenfile | string | Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable | -| --db-credentials-vault-ttl | duration | How long to cache DB credentials from the Vault server (default 30m0s) | -| --db_charset | string | Character set. Only utf8 or latin1 based character sets are supported. | -| --db_conn_query_info | boolean | enable parsing and processing of QUERY_OK info fields | -| --db_connect_timeout_ms | int | connection timeout to mysqld in milliseconds (0 for no timeout) | -| --db_dba_password | string | db dba password | -| --db_dba_use_ssl | boolean | Set this flag to false to make the dba connection not use ssl (default true) | -| --db_dba_user | string | db dba user userKey (default "vt_dba") | -| --db_flags | uint | Flag values as defined by MySQL. | -| --db_flavor | string | Flavor overrid. Valid value is FilePos. | -| --db_host | string | The host name for the tcp connection. | -| --db_port | int | tcp port | -| --db_server_name | string | server name of the DB we are connecting to. | -| --db_socket | string | The unix socket to connect on. If this is specified, host and port will not be used. | -| --db_ssl_ca | string | connection ssl ca | -| --db_ssl_ca_path | string | connection ssl ca path | -| --db_ssl_cert | string | connection ssl certificate | -| --db_ssl_key | string | connection ssl key | -| --db_ssl_mode | string | SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity. | -| --db_tls_min_version | string | Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. | -| --dba_idle_timeout | duration | Idle timeout for dba connections (default 1m0s) | -| --dba_pool_size | int | Size of the connection pool for dba connections (default 20) | -| -h, --help | display usage and exit | -| --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) | -| --lameduck-period | duration | keep running at least this long after SIGTERM before stopping (default 50ms) | -| --log_backtrace_at | value | when logging hits line file:N, emit a stack trace | -| --log_dir | string | If non-empty, write log files in this directory | -| --log_err_stacks | boolean | log stack traces for errors | -| --log_rotate_max_size | uint | size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) | -| --logtostderr | boolean | log to standard error instead of files | -| --max-stack-size | int | configure the maximum stack size in bytes (default 67108864) | -| --mysql_port | int | mysql port (default 3306) | -| --mysql_server_version | string | MySQL server version to advertise. | -| --mysql_server_flush_delay | duration | Delay after which buffered response will be flushed to the client. (default 100ms) | -| --mysql_socket | string | path to the mysql socket | -| --mysqlctl_client_protocol | string | the protocol to use to talk to the mysqlctl server (default "grpc") | -| --mysqlctl_mycnf_template | string | template file to use for generating the my.cnf file during server init | -| --mysqlctl_socket | string | socket file to use for remote mysqlctl actions (empty for local actions) | -| --mysqlctl_client_protocol | string | the protocol to use to talk to the mysqlctl server (default "grpc") | -| --mysqlctl_mycnf_template | string | template file to use for generating the my.cnf file during server init | -| --mysqlctl_socket | string | socket file to use for remote mysqlctl actions (empty for local actions) | -| --onterm_timeout | duration | wait no more than this for OnTermSync handlers before stopping (default 10s) | -| --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) | -| --pprof | strings | enable profiling | -| --purge_logs_interval | duration | how often try to remove old logs (default 1h0m0s) | -| --replication_connect_retry | duration | how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) | -| --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 | value | comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice | -| --socket_file | string | Local unix socket file to listen on | -| --stderrthreshold | value | logs at or above this threshold go to stderr (default 1) | -| --tablet_dir | string | The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid. | -| --tablet_uid | uint | Tablet UID (default 41983) | -| --v | value | log level for V logs | -| -v, --version | boolean | print binary version | -| --vmodule | string | comma-separated list of pattern=N settings for file-filtered logging | \ No newline at end of file diff --git a/content/en/docs/18.0/reference/programs/mysqlctld.md b/content/en/docs/18.0/reference/programs/mysqlctld.md deleted file mode 100644 index 0e9fd706d..000000000 --- a/content/en/docs/18.0/reference/programs/mysqlctld.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: mysqlctld ---- - -`mysqlctld` is a gRPC server that can be used instead of the [`mysqlctl`](../mysqlctl/) client tool. If the target directories are empty when it is invoked, it automatically performs initialization operations to bootstrap the `mysqld` instance before starting it. The `mysqlctld` process can subsequently receive gRPC commands from a `vttablet` to perform housekeeping operations like shutting down and restarting the `mysqld` instance as needed. - -{{< warning >}} -`mysqld_safe` is not used so the `mysqld` process will not be automatically restarted in case of a failure. -{{}} - -To enable communication with a `vttablet`, the server must be configured to receive gRPC messages on a unix domain socket. For example: - -```bash -export VTDATAROOT=/tmp -mysqlctld \ - --log_dir=${VTDATAROOT}/logs \ - --tablet_uid=100 \ - --mysql_port=17100 \ - --socket_file=/path/to/socket_file -``` - -## Options - -The following global parameters apply to `mysqlctld`: - -| Name | Type | Definition | -| :-------------------------------- | :--------- | :--------- | -| --alsologtostderr | boolean | log to standard error as well as files | -| --app_idle_timeout | duration | Idle timeout for app connections (default 1m0s) | -| --app_pool_size | int | Size of the connection pool for app connections (default 40) | -| --catch-sigpipe | boolean | catch and ignore SIGPIPE on stdout and stderr if specified | -| --db-credentials-file | string | db credentials file; send SIGHUP to reload this file | -| --db-credentials-server | string | db credentials server type (use 'file' for the file implementation) (default "file") | -| --db-credentials-vault-addr | string | URL to Vault server | -| --db-credentials-vault-path | string | Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds | -| --db-credentials-vault-role-mountpoint | string | Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default "approle") | -| --db-credentials-vault-role-secretidfile | string | Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable | -| --db-credentials-vault-roleid | string | Vault AppRole id; can also be passed using VAULT_ROLEID environment variable | -| --db-credentials-vault-timeout | duration | Timeout for vault API operations (default 10s) | -| --db-credentials-vault-tls-ca | string | Path to CA PEM for validating Vault server certificate | -| --db-credentials-vault-tokenfile | string | Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable | -| --db-credentials-vault-ttl | duration | How long to cache DB credentials from the Vault server (default 30m0s) | -| --db_charset | string | Character set. Only utf8 or latin1 based character sets are supported. | -| --db_conn_query_info | boolean | enable parsing and processing of QUERY_OK info fields | -| --db_connect_timeout_ms | int | connection timeout to mysqld in milliseconds (0 for no timeout) | -| --db_dba_password | string | db dba password | -| --db_dba_use_ssl | boolean | Set this flag to false to make the dba connection to not use ssl (default true) | -| --db_dba_user | string | db dba user userKey (default "vt_dba") | -| --db_flags | uint | Flag values as defined by MySQL. | -| --db_flavor | string | Flavor overrid. Valid value is FilePos. | -| --db_host | string | The host name for the tcp connection. | -| --db_port | int | tcp port | -| --db_server_name | string | server name of the DB we are connecting to. | -| --db_socket | string | The unix socket to connect on. If this is specified, host and port will not be used. | -| --db_ssl_ca | string | connection ssl ca | -| --db_ssl_ca_path | string | connection ssl ca path | -| --db_ssl_cert | string | connection ssl certificate | -| --db_ssl_key | string | connection ssl key | -| --db_ssl_mode | string | SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity. | -| --db_tls_min_version | string | Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. | -| --dba_idle_timeout | duration | Idle timeout for dba connections (default 1m0s) | -| --dba_pool_size | int | Size of the connection pool for dba connections (default 20) | -| --grpc_auth_mode | string | Which auth plugin implementation to use (eg: static) | -| --grpc_auth_mtls_allowed_substrings | string | List of substrings of at least one of the client certificate names (separated by colon). | -| --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_auth_static_password_file | string | JSON File to read the users/passwords from. | -| --grpc_ca | string | server CA to use for gRPC connections, requires TLS, and enforces client certificate check | -| --grpc_cert | string | server certificate to use for gRPC connections, requires grpc_key, enables TLS | -| --grpc_compression | string | Which protocol to use for compressing gRPC. Default: nothing. Supported: snappy | -| --grpc_crl | string | path to a certificate revocation list in PEM format, client certificates will be further verified against this file during TLS handshake | -| --grpc_enable_optional_tls | boolean | enable optional TLS mode when a server accepts both TLS and plain-text connections on the same port | -| --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_key | string | server private key to use for gRPC connections, requires grpc_cert, enables TLS | -| --grpc_max_connection_age | duration | Maximum age of a client connection before GoAway is sent. (default 2562047h47m16.854775807s) | -| --grpc_max_connection_age_grace | duration | Additional grace period after grpc_max_connection_age, after which connections are forcibly closed. (default 2562047h47m16.854775807s) | -| --grpc_port | int | Port to listen on for gRPC calls. If zero, do not listen. | -| --grpc_server_ca | string | path to server CA in PEM format, which will be combine with server cert, return full certificate chain to clients | -| --grpc_server_initial_conn_window_size | int | gRPC server initial connection window size | -| --grpc_server_initial_window_size | int | gRPC server initial window size | -| --grpc_server_keepalive_enforcement_policy_min_time | duration | gRPC server minimum keepalive time (default 10s) | -| --grpc_server_keepalive_enforcement_policy_permit_without_stream | boolean | gRPC server permit client keepalive pings even when there are no active streams (RPCs) | -| -h, --help | display usage and exit | -| --init_db_sql_file | string | Path to .sql file to run after mysqld initialization | -| --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) | -| --lameduck-period | duration | keep running at least this long after SIGTERM before stopping (default 50ms) | -| --log_backtrace_at | value | when logging hits line file:N, emit a stack trace | -| --log_dir | string | If non-empty, write log files in this directory | -| --log_err_stacks | boolean | log stack traces for errors | -| --log_rotate_max_size | uint | size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) | -| --logtostderr | boolean | log to standard error instead of files | -| --max-stack-size | int | configure the maximum stack size in bytes (default 67108864) | -| --mysql_port | int | mysql port (default 3306) | -| --mysql_server_version | string | MySQL server version to advertise. | -| --mysql_server_flush_delay | duration | Delay after which buffered response will be flushed to the client. (default 100ms) | -| --mysql_socket | string | path to the mysql socket | -| --mysqlctl_mycnf_template | string | template file to use for generating the my.cnf file during server init | -| --mysqlctl_socket | string | socket file to use for remote mysqlctl actions (empty for local actions) | -| --mysqlctl_client_protocol | string | the protocol to use to talk to the mysqlctl server (default "grpc") | -| --mysqlctl_mycnf_template | string | template file to use for generating the my.cnf file during server init | -| --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) | -| --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 | vttablet port (default 6612) | -| --pprof | strings | enable profiling | -| --purge_logs_interval | duration | how often try to remove old logs (default 1h0m0s) | -| --replication_connect_retry | duration | how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s) | -| --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 | value | comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice | -| --socket_file | string | Local unix socket file to listen on | -| --stderrthreshold | value | logs at or above this threshold go to stderr (default 1) | -| --tablet_dir | string | The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid. | -| --tablet_uid | uint | Tablet UID (default 41983) | -| --v | value | log level for V logs | -| -v, --version | boolean | print binary version | -| --vmodule | string | comma-separated list of pattern=N settings for file-filtered logging | -| --wait_time | duration | How long to wait for mysqld startup or shutdown (default 5m0s) | \ No newline at end of file