From 79b2ddbeb0c85a128d650452b863697b44acdf1f Mon Sep 17 00:00:00 2001 From: Andrew Mason Date: Mon, 25 Sep 2023 12:20:50 -0400 Subject: [PATCH] docs for https://github.com/vitessio/vitess/pull/14091 Signed-off-by: Andrew Mason --- content/en/docs/18.0/reference/programs/vtcombo/_index.md | 2 ++ .../programs/vtctldclient/vtctldclient_OnlineDDL/_index.md | 7 ++++--- .../vtctldclient_OnlineDDL_cancel.md | 3 ++- .../vtctldclient_OnlineDDL_cleanup.md | 1 + .../vtctldclient_OnlineDDL_complete.md | 3 ++- .../vtctldclient_OnlineDDL_launch.md | 3 ++- .../vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_retry.md | 1 + .../vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_show.md | 1 + .../vtctldclient_OnlineDDL_throttle.md | 1 + .../vtctldclient_OnlineDDL_unthrottle.md | 1 + 10 files changed, 17 insertions(+), 6 deletions(-) diff --git a/content/en/docs/18.0/reference/programs/vtcombo/_index.md b/content/en/docs/18.0/reference/programs/vtcombo/_index.md index bab8b8af6..4a2f77aee 100644 --- a/content/en/docs/18.0/reference/programs/vtcombo/_index.md +++ b/content/en/docs/18.0/reference/programs/vtcombo/_index.md @@ -1,6 +1,7 @@ --- title: vtcombo series: vtcombo +commit: 476ca265d0583549c05a3ab88f76bc8d24174364 --- ## vtcombo @@ -152,6 +153,7 @@ vtcombo [flags] --gc_check_interval duration Interval between garbage collection checks (default 1h0m0s) --gc_purge_check_interval duration Interval between purge discovery checks (default 1m0s) --gh-ost-path string override default gh-ost binary full path + --grpc-send-session-in-streaming If set, will send the session as last packet in streaming api to support transactions in streaming --grpc-use-effective-groups If set, and SSL is not used, will set the immediate caller's security groups from the effective caller id's groups. --grpc-use-static-authentication-callerid If set, will set the immediate caller id to the username authenticated by the static auth plugin. --grpc_auth_mode string Which auth plugin implementation to use (eg: static) diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/_index.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/_index.md index f4e9e5a78..417e1dbcd 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/_index.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/_index.md @@ -1,6 +1,7 @@ --- title: OnlineDDL series: vtctldclient +commit: 476ca265d0583549c05a3ab88f76bc8d24174364 --- ## vtctldclient OnlineDDL @@ -22,10 +23,10 @@ Operates on online DDL (schema migrations). ### SEE ALSO * [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. -* [vtctldclient OnlineDDL cancel](./vtctldclient_onlineddl_cancel/) - cancel one or all migrations, terminating any running ones as needed. +* [vtctldclient OnlineDDL cancel](./vtctldclient_onlineddl_cancel/) - Cancel one or all migrations, terminating any running ones as needed. * [vtctldclient OnlineDDL cleanup](./vtctldclient_onlineddl_cleanup/) - Mark a given schema migration ready for artifact cleanup. -* [vtctldclient OnlineDDL complete](./vtctldclient_onlineddl_complete/) - complete one or all migrations executed with --postpone-completion -* [vtctldclient OnlineDDL launch](./vtctldclient_onlineddl_launch/) - launch one or all migrations executed with --postpone-launch +* [vtctldclient OnlineDDL complete](./vtctldclient_onlineddl_complete/) - Complete one or all migrations executed with --postpone-completion +* [vtctldclient OnlineDDL launch](./vtctldclient_onlineddl_launch/) - Launch one or all migrations executed with --postpone-launch * [vtctldclient OnlineDDL retry](./vtctldclient_onlineddl_retry/) - Mark a given schema migration for retry. * [vtctldclient OnlineDDL show](./vtctldclient_onlineddl_show/) - Display information about online DDL operations. * [vtctldclient OnlineDDL throttle](./vtctldclient_onlineddl_throttle/) - Throttles one or all migrations diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cancel.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cancel.md index 407589f96..dad214cc8 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cancel.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cancel.md @@ -1,10 +1,11 @@ --- title: OnlineDDL cancel series: vtctldclient +commit: 476ca265d0583549c05a3ab88f76bc8d24174364 --- ## vtctldclient OnlineDDL cancel -cancel one or all migrations, terminating any running ones as needed. +Cancel one or all migrations, terminating any running ones as needed. ``` vtctldclient OnlineDDL cancel diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cleanup.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cleanup.md index 665c2013b..028527e96 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cleanup.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cleanup.md @@ -1,6 +1,7 @@ --- title: OnlineDDL cleanup series: vtctldclient +commit: 476ca265d0583549c05a3ab88f76bc8d24174364 --- ## vtctldclient OnlineDDL cleanup diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_complete.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_complete.md index 0bf8da583..619b12a0c 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_complete.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_complete.md @@ -1,10 +1,11 @@ --- title: OnlineDDL complete series: vtctldclient +commit: 476ca265d0583549c05a3ab88f76bc8d24174364 --- ## vtctldclient OnlineDDL complete -complete one or all migrations executed with --postpone-completion +Complete one or all migrations executed with --postpone-completion ``` vtctldclient OnlineDDL complete diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_launch.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_launch.md index f9e4d5b09..91f77ce8e 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_launch.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_launch.md @@ -1,10 +1,11 @@ --- title: OnlineDDL launch series: vtctldclient +commit: 476ca265d0583549c05a3ab88f76bc8d24174364 --- ## vtctldclient OnlineDDL launch -launch one or all migrations executed with --postpone-launch +Launch one or all migrations executed with --postpone-launch ``` vtctldclient OnlineDDL launch diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_retry.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_retry.md index 369374cbc..65bff1be5 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_retry.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_retry.md @@ -1,6 +1,7 @@ --- title: OnlineDDL retry series: vtctldclient +commit: 476ca265d0583549c05a3ab88f76bc8d24174364 --- ## vtctldclient OnlineDDL retry diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_show.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_show.md index b8f5f784a..991ed3911 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_show.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_show.md @@ -1,6 +1,7 @@ --- title: OnlineDDL show series: vtctldclient +commit: 476ca265d0583549c05a3ab88f76bc8d24174364 --- ## vtctldclient OnlineDDL show diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_throttle.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_throttle.md index 1dc4c6684..6c0dfc637 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_throttle.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_throttle.md @@ -1,6 +1,7 @@ --- title: OnlineDDL throttle series: vtctldclient +commit: 476ca265d0583549c05a3ab88f76bc8d24174364 --- ## vtctldclient OnlineDDL throttle diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_unthrottle.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_unthrottle.md index d6b35d567..874d62616 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_unthrottle.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_unthrottle.md @@ -1,6 +1,7 @@ --- title: OnlineDDL unthrottle series: vtctldclient +commit: 476ca265d0583549c05a3ab88f76bc8d24174364 --- ## vtctldclient OnlineDDL unthrottle