Skip to content

Commit

Permalink
sync cobradocs to latest release branches
Browse files Browse the repository at this point in the history
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
  • Loading branch information
frouioui committed Oct 4, 2023
1 parent 4ba2805 commit c100bc7
Show file tree
Hide file tree
Showing 55 changed files with 314 additions and 98 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: workflow
series: vtctldclient
commit: dced85dd0f33b8bd95d37adb781d6cdc1949af92
---
## vtctldclient workflow

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: workflow_update
title: workflow update
series: vtctldclient
commit: dced85dd0f33b8bd95d37adb781d6cdc1949af92
---
## vtctldclient workflow update

Expand Down Expand Up @@ -36,5 +37,5 @@ vtctldclient --server=localhost:15999 workflow --keyspace=customer update --work

### SEE ALSO

* [vtctldclient workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace
* [vtctldclient workflow](../) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: init
series: mysqlctl
commit: b089f78945653f6acd17c66f896820e36df49437
commit: 6ab165ade925b35a00cf447827d874eba13998b6
---
## mysqlctl init

Expand Down Expand Up @@ -44,7 +44,7 @@ mysqlctl \
--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/vtwebsite/vitessio.website/vitess])
--config-path strings Paths to search for config files in. (default [/Users/florentpoinsard/Code/website/vitessio.website])
--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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: init config
series: mysqlctl
commit: b089f78945653f6acd17c66f896820e36df49437
commit: 6ab165ade925b35a00cf447827d874eba13998b6
---
## mysqlctl init_config

Expand Down Expand Up @@ -42,7 +42,7 @@ mysqlctl \
--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/vtwebsite/vitessio.website/vitess])
--config-path strings Paths to search for config files in. (default [/Users/florentpoinsard/Code/website/vitessio.website])
--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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: position
series: mysqlctl
commit: b089f78945653f6acd17c66f896820e36df49437
commit: 6ab165ade925b35a00cf447827d874eba13998b6
---
## mysqlctl position

Expand All @@ -27,7 +27,7 @@ mysqlctl position <operation> <pos1> <pos2 | gtid> [flags]
--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/vtwebsite/vitessio.website/vitess])
--config-path strings Paths to search for config files in. (default [/Users/florentpoinsard/Code/website/vitessio.website])
--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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: reinit config
series: mysqlctl
commit: b089f78945653f6acd17c66f896820e36df49437
commit: 6ab165ade925b35a00cf447827d874eba13998b6
---
## mysqlctl reinit_config

Expand Down Expand Up @@ -42,7 +42,7 @@ mysqlctl \
--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/vtwebsite/vitessio.website/vitess])
--config-path strings Paths to search for config files in. (default [/Users/florentpoinsard/Code/website/vitessio.website])
--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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: shutdown
series: mysqlctl
commit: b089f78945653f6acd17c66f896820e36df49437
commit: 6ab165ade925b35a00cf447827d874eba13998b6
---
## mysqlctl shutdown

Expand Down Expand Up @@ -40,7 +40,7 @@ mysqlctl --tablet_uid 101 --alsologtostderr shutdown
--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/vtwebsite/vitessio.website/vitess])
--config-path strings Paths to search for config files in. (default [/Users/florentpoinsard/Code/website/vitessio.website])
--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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: start
series: mysqlctl
commit: b089f78945653f6acd17c66f896820e36df49437
commit: 6ab165ade925b35a00cf447827d874eba13998b6
---
## mysqlctl start

Expand Down Expand Up @@ -39,7 +39,7 @@ mysqlctl --tablet_uid 101 --alsologtostderr start
--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/vtwebsite/vitessio.website/vitess])
--config-path strings Paths to search for config files in. (default [/Users/florentpoinsard/Code/website/vitessio.website])
--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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: teardown
series: mysqlctl
commit: b089f78945653f6acd17c66f896820e36df49437
commit: 6ab165ade925b35a00cf447827d874eba13998b6
---
## mysqlctl teardown

Expand Down Expand Up @@ -43,7 +43,7 @@ mysqlctl --tablet_uid 101 --alsologtostderr teardown
--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/vtwebsite/vitessio.website/vitess])
--config-path strings Paths to search for config files in. (default [/Users/florentpoinsard/Code/website/vitessio.website])
--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
Expand Down
4 changes: 3 additions & 1 deletion content/en/docs/18.0/reference/programs/mysqlctld/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: mysqlctld
series: mysqlctld
commit: 30385807689b40668d60dbb5059ea0987f19da5c
commit: 6ab165ade925b35a00cf447827d874eba13998b6
---
## mysqlctld

Expand Down Expand Up @@ -39,6 +39,7 @@ mysqlctld \
--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)
--bind-address string Bind address for the server. If empty, the server will listen on all available unicast and anycast IP addresses of the local system.
--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)
Expand Down Expand Up @@ -81,6 +82,7 @@ mysqlctld \
--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_bind_address string Bind address for gRPC calls. If empty, listen on all addresses.
--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
Expand Down
3 changes: 2 additions & 1 deletion content/en/docs/18.0/reference/programs/vtbackup/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtbackup
series: vtbackup
commit: 30385807689b40668d60dbb5059ea0987f19da5c
commit: 6ab165ade925b35a00cf447827d874eba13998b6
---
## vtbackup

Expand Down Expand Up @@ -69,6 +69,7 @@ vtbackup [flags]
--backup_storage_compress if set, the backup files will be compressed. (default true)
--backup_storage_implementation string Which backup storage implementation to use for creating and restoring backups.
--backup_storage_number_blocks int if backup_storage_compress is true, backup_storage_number_blocks sets the number of blocks that can be processed, in parallel, before the writer blocks, during compression (default is 2). It should be equal to the number of CPUs available for compression. (default 2)
--bind-address string Bind address for the server. If empty, the server will listen on all available unicast and anycast IP addresses of the local system.
--builtinbackup-file-read-buffer-size uint read files using an IO buffer of this many bytes. Golang defaults are used when set to 0.
--builtinbackup-file-write-buffer-size uint write files using an IO buffer of this many bytes. Golang defaults are used when set to 0. (default 2097152)
--builtinbackup_mysqld_timeout duration how long to wait for mysqld to shutdown at the start of the backup. (default 10m0s)
Expand Down
4 changes: 3 additions & 1 deletion content/en/docs/18.0/reference/programs/vtcombo/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtcombo
series: vtcombo
commit: 30385807689b40668d60dbb5059ea0987f19da5c
commit: 6ab165ade925b35a00cf447827d874eba13998b6
---
## vtcombo

Expand Down Expand Up @@ -34,6 +34,7 @@ vtcombo [flags]
--backup_storage_block_size int if backup_storage_compress is true, backup_storage_block_size sets the byte size for each block while compressing (default is 250000). (default 250000)
--backup_storage_compress if set, the backup files will be compressed. (default true)
--backup_storage_number_blocks int if backup_storage_compress is true, backup_storage_number_blocks sets the number of blocks that can be processed, in parallel, before the writer blocks, during compression (default is 2). It should be equal to the number of CPUs available for compression. (default 2)
--bind-address string Bind address for the server. If empty, the server will listen on all available unicast and anycast IP addresses of the local system.
--binlog_host string PITR restore parameter: hostname/IP of binlog server.
--binlog_password string PITR restore parameter: password of binlog server.
--binlog_player_protocol string the protocol to download binlogs from a vttablet (default "grpc")
Expand Down Expand Up @@ -159,6 +160,7 @@ vtcombo [flags]
--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_password_file string JSON File to read the users/passwords from.
--grpc_bind_address string Bind address for gRPC calls. If empty, listen on all addresses.
--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_crl string path to a certificate revocation list in PEM format, client certificates will be further verified against this file during TLS handshake
Expand Down
Loading

0 comments on commit c100bc7

Please sign in to comment.