Docs: OnlineDDL cut-over backoff and force-cut-over (#1641)

* Documenting --force-cut-over-after DDL strategy flag Signed-off-by: Shlomi Noach <[email protected]> * Explain backoff, mention force cut-over in Vitess strategy Signed-off-by: Shlomi Noach <[email protected]> * Document 'ALTER VITESS_MIGRATION ... FORCE_CUTOVER ... Signed-off-by: Shlomi Noach <[email protected]> * spacing Signed-off-by: Shlomi Noach <[email protected]> * cross reference Signed-off-by: Shlomi Noach <[email protected]> * OnlineDDL force-cutover (dash rather than underscore) Signed-off-by: Shlomi Noach <[email protected]> * make vttablet-docs Signed-off-by: Shlomi Noach <[email protected]> * vtctldclient docs Signed-off-by: Shlomi Noach <[email protected]> * automated docs Signed-off-by: Shlomi Noach <[email protected]> --------- Signed-off-by: Shlomi Noach <[email protected]>
vitessio · Dec 13, 2023 · c0a5c49 · c0a5c49
1 parent e64d981
commit c0a5c49
Show file tree

Hide file tree

Showing 468 changed files with 1,639 additions and 891 deletions.
diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/_index.md b/content/en/docs/16.0/reference/programs/vtctldclient/_index.md
@@ -1,6 +1,7 @@
 ---
 title: vtctldclient
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_AddCellInfo.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_AddCellInfo.md
@@ -1,6 +1,7 @@
 ---
 title: AddCellInfo
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient AddCellInfo
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_AddCellsAlias.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_AddCellsAlias.md
@@ -1,6 +1,7 @@
 ---
 title: AddCellsAlias
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient AddCellsAlias
 

diff --git a/.../en/docs/16.0/reference/programs/vtctldclient/vtctldclient_ApplyRoutingRules.md b/.../en/docs/16.0/reference/programs/vtctldclient/vtctldclient_ApplyRoutingRules.md
@@ -1,6 +1,7 @@
 ---
 title: ApplyRoutingRules
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient ApplyRoutingRules
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_ApplySchema.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_ApplySchema.md
@@ -1,6 +1,7 @@
 ---
 title: ApplySchema
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient ApplySchema
 

diff --git a/...ocs/16.0/reference/programs/vtctldclient/vtctldclient_ApplyShardRoutingRules.md b/...ocs/16.0/reference/programs/vtctldclient/vtctldclient_ApplyShardRoutingRules.md
@@ -1,6 +1,7 @@
 ---
 title: ApplyShardRoutingRules
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient ApplyShardRoutingRules
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md
@@ -1,6 +1,7 @@
 ---
 title: ApplyVSchema
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient ApplyVSchema
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_Backup.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_Backup.md
@@ -1,6 +1,7 @@
 ---
 title: Backup
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient Backup
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md
@@ -1,6 +1,7 @@
 ---
 title: BackupShard
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient BackupShard
 

diff --git a/...t/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_ChangeTabletType.md b/...t/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_ChangeTabletType.md
@@ -1,6 +1,7 @@
 ---
 title: ChangeTabletType
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient ChangeTabletType
 

diff --git a/...ent/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_CreateKeyspace.md b/...ent/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_CreateKeyspace.md
@@ -1,6 +1,7 @@
 ---
 title: CreateKeyspace
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient CreateKeyspace
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_CreateShard.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_CreateShard.md
@@ -1,6 +1,7 @@
 ---
 title: CreateShard
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient CreateShard
 

diff --git a/...ent/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_DeleteCellInfo.md b/...ent/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_DeleteCellInfo.md
@@ -1,6 +1,7 @@
 ---
 title: DeleteCellInfo
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient DeleteCellInfo
 

diff --git a/...t/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_DeleteCellsAlias.md b/...t/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_DeleteCellsAlias.md
@@ -1,6 +1,7 @@
 ---
 title: DeleteCellsAlias
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient DeleteCellsAlias
 

diff --git a/...ent/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_DeleteKeyspace.md b/...ent/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_DeleteKeyspace.md
@@ -1,6 +1,7 @@
 ---
 title: DeleteKeyspace
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient DeleteKeyspace
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_DeleteShards.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_DeleteShards.md
@@ -1,6 +1,7 @@
 ---
 title: DeleteShards
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient DeleteShards
 

diff --git a/...t/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_DeleteSrvVSchema.md b/...t/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_DeleteSrvVSchema.md
@@ -1,6 +1,7 @@
 ---
 title: DeleteSrvVSchema
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient DeleteSrvVSchema
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_DeleteTablets.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_DeleteTablets.md
@@ -1,6 +1,7 @@
 ---
 title: DeleteTablets
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient DeleteTablets
 

diff --git a/...ocs/16.0/reference/programs/vtctldclient/vtctldclient_EmergencyReparentShard.md b/...ocs/16.0/reference/programs/vtctldclient/vtctldclient_EmergencyReparentShard.md
@@ -1,6 +1,7 @@
 ---
 title: EmergencyReparentShard
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient EmergencyReparentShard
 

diff --git a/.../en/docs/16.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsApp.md b/.../en/docs/16.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsApp.md
@@ -1,6 +1,7 @@
 ---
 title: ExecuteFetchAsApp
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient ExecuteFetchAsApp
 

diff --git a/.../en/docs/16.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsDBA.md b/.../en/docs/16.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsDBA.md
@@ -1,6 +1,7 @@
 ---
 title: ExecuteFetchAsDBA
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient ExecuteFetchAsDBA
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_ExecuteHook.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_ExecuteHook.md
@@ -1,6 +1,7 @@
 ---
 title: ExecuteHook
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient ExecuteHook
 

diff --git a/...cs/16.0/reference/programs/vtctldclient/vtctldclient_FindAllShardsInKeyspace.md b/...cs/16.0/reference/programs/vtctldclient/vtctldclient_FindAllShardsInKeyspace.md
@@ -1,6 +1,7 @@
 ---
 title: FindAllShardsInKeyspace
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient FindAllShardsInKeyspace
 

diff --git a/...n/docs/16.0/reference/programs/vtctldclient/vtctldclient_GenerateShardRanges.md b/...n/docs/16.0/reference/programs/vtctldclient/vtctldclient_GenerateShardRanges.md
@@ -1,6 +1,7 @@
 ---
 title: GenerateShardRanges
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GenerateShardRanges
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetBackups.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetBackups.md
@@ -1,6 +1,7 @@
 ---
 title: GetBackups
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetBackups
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetCellInfo.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetCellInfo.md
@@ -1,6 +1,7 @@
 ---
 title: GetCellInfo
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetCellInfo
 

diff --git a/...t/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetCellInfoNames.md b/...t/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetCellInfoNames.md
@@ -1,6 +1,7 @@
 ---
 title: GetCellInfoNames
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetCellInfoNames
 

diff --git a/...nt/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetCellsAliases.md b/...nt/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetCellsAliases.md
@@ -1,6 +1,7 @@
 ---
 title: GetCellsAliases
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetCellsAliases
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetFullStatus.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetFullStatus.md
@@ -1,6 +1,7 @@
 ---
 title: GetFullStatus
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetFullStatus
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetKeyspace.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetKeyspace.md
@@ -1,6 +1,7 @@
 ---
 title: GetKeyspace
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetKeyspace
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetKeyspaces.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetKeyspaces.md
@@ -1,6 +1,7 @@
 ---
 title: GetKeyspaces
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetKeyspaces
 

diff --git a/...ent/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetPermissions.md b/...ent/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetPermissions.md
@@ -1,6 +1,7 @@
 ---
 title: GetPermissions
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetPermissions
 

diff --git a/...nt/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetRoutingRules.md b/...nt/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetRoutingRules.md
@@ -1,6 +1,7 @@
 ---
 title: GetRoutingRules
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetRoutingRules
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetSchema.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetSchema.md
@@ -1,6 +1,7 @@
 ---
 title: GetSchema
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetSchema
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetShard.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetShard.md
@@ -1,6 +1,7 @@
 ---
 title: GetShard
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetShard
 

diff --git a/.../docs/16.0/reference/programs/vtctldclient/vtctldclient_GetShardRoutingRules.md b/.../docs/16.0/reference/programs/vtctldclient/vtctldclient_GetShardRoutingRules.md
@@ -1,6 +1,7 @@
 ---
 title: GetShardRoutingRules
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetShardRoutingRules
 

diff --git a/...n/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetSrvKeyspaceNames.md b/...n/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetSrvKeyspaceNames.md
@@ -1,6 +1,7 @@
 ---
 title: GetSrvKeyspaceNames
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetSrvKeyspaceNames
 

diff --git a/...nt/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetSrvKeyspaces.md b/...nt/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetSrvKeyspaces.md
@@ -1,6 +1,7 @@
 ---
 title: GetSrvKeyspaces
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetSrvKeyspaces
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetSrvVSchema.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetSrvVSchema.md
@@ -1,6 +1,7 @@
 ---
 title: GetSrvVSchema
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetSrvVSchema
 

diff --git a/...ent/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetSrvVSchemas.md b/...ent/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetSrvVSchemas.md
@@ -1,6 +1,7 @@
 ---
 title: GetSrvVSchemas
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetSrvVSchemas
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetTablet.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetTablet.md
@@ -1,6 +1,7 @@
 ---
 title: GetTablet
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetTablet
 

diff --git a/...t/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetTabletVersion.md b/...t/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetTabletVersion.md
@@ -1,6 +1,7 @@
 ---
 title: GetTabletVersion
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetTabletVersion
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetTablets.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetTablets.md
@@ -1,6 +1,7 @@
 ---
 title: GetTablets
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetTablets
 

diff --git a/...nt/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetTopologyPath.md b/...nt/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetTopologyPath.md
@@ -1,6 +1,7 @@
 ---
 title: GetTopologyPath
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetTopologyPath
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetVSchema.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetVSchema.md
@@ -1,6 +1,7 @@
 ---
 title: GetVSchema
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetVSchema
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetWorkflows.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_GetWorkflows.md
@@ -1,6 +1,7 @@
 ---
 title: GetWorkflows
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient GetWorkflows
 

diff --git a/...en/docs/16.0/reference/programs/vtctldclient/vtctldclient_LegacyVtctlCommand.md b/...en/docs/16.0/reference/programs/vtctldclient/vtctldclient_LegacyVtctlCommand.md
@@ -1,6 +1,7 @@
 ---
 title: LegacyVtctlCommand
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient LegacyVtctlCommand
 

diff --git a/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_PingTablet.md b/content/en/docs/16.0/reference/programs/vtctldclient/vtctldclient_PingTablet.md
@@ -1,6 +1,7 @@
 ---
 title: PingTablet
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient PingTablet
 

diff --git a/.../docs/16.0/reference/programs/vtctldclient/vtctldclient_PlannedReparentShard.md b/.../docs/16.0/reference/programs/vtctldclient/vtctldclient_PlannedReparentShard.md
@@ -1,6 +1,7 @@
 ---
 title: PlannedReparentShard
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient PlannedReparentShard
 

diff --git a/.../docs/16.0/reference/programs/vtctldclient/vtctldclient_RebuildKeyspaceGraph.md b/.../docs/16.0/reference/programs/vtctldclient/vtctldclient_RebuildKeyspaceGraph.md
@@ -1,6 +1,7 @@
 ---
 title: RebuildKeyspaceGraph
 series: vtctldclient
+commit: a7f80a82e5d99cf00c253c3902367bec5fa40e5d
 ---
 ## vtctldclient RebuildKeyspaceGraph