Update docs for 16654 and 16709 (#1835)

* Update docs for vitessio/vitess#16654 Signed-off-by: Matt Lord <mattalord@gmail.com> * Update docs after moving to --auto-start Signed-off-by: Matt Lord <mattalord@gmail.com> * Also document vitessio/vitess#16709 Signed-off-by: Matt Lord <mattalord@gmail.com> * Rebuild docs base on main Signed-off-by: Matt Lord <mattalord@gmail.com> * Kick CI Signed-off-by: Matt Lord <mattalord@gmail.com> --------- Signed-off-by: Matt Lord <mattalord@gmail.com>
vitessio · Sep 17, 2024 · 77a5fd7 · 77a5fd7
1 parent 6ad3082
commit 77a5fd7
Show file tree

Hide file tree

Showing 159 changed files with 267 additions and 159 deletions.
diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/_index.md b/content/en/docs/21.0/reference/programs/vtctldclient/_index.md
@@ -1,7 +1,7 @@
 ---
 title: vtctldclient
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient
 
@@ -52,6 +52,7 @@ vtctldclient [flags]
 * [vtctldclient DeleteShards](./vtctldclient_deleteshards/)	 - Deletes the specified shards from the topology.
 * [vtctldclient DeleteSrvVSchema](./vtctldclient_deletesrvvschema/)	 - Deletes the SrvVSchema object in the given cell.
 * [vtctldclient DeleteTablets](./vtctldclient_deletetablets/)	 - Deletes tablet(s) from the topology.
+* [vtctldclient DistributedTransaction](./vtctldclient_distributedtransaction/)	 - Perform commands on distributed transaction
 * [vtctldclient EmergencyReparentShard](./vtctldclient_emergencyreparentshard/)	 - Reparents the shard to the new primary. Assumes the old primary is dead and not responding.
 * [vtctldclient ExecuteFetchAsApp](./vtctldclient_executefetchasapp/)	 - Executes the given query as the App user on the remote tablet.
 * [vtctldclient ExecuteFetchAsDBA](./vtctldclient_executefetchasdba/)	 - Executes the given query as the DBA user on the remote tablet.

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_AddCellInfo.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_AddCellInfo.md
@@ -1,7 +1,7 @@
 ---
 title: AddCellInfo
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient AddCellInfo
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_AddCellsAlias.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_AddCellsAlias.md
@@ -1,7 +1,7 @@
 ---
 title: AddCellsAlias
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient AddCellsAlias
 

diff --git a/.../21.0/reference/programs/vtctldclient/vtctldclient_ApplyKeyspaceRoutingRules.md b/.../21.0/reference/programs/vtctldclient/vtctldclient_ApplyKeyspaceRoutingRules.md
@@ -1,7 +1,7 @@
 ---
 title: ApplyKeyspaceRoutingRules
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient ApplyKeyspaceRoutingRules
 

diff --git a/.../en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ApplyRoutingRules.md b/.../en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ApplyRoutingRules.md
@@ -1,7 +1,7 @@
 ---
 title: ApplyRoutingRules
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient ApplyRoutingRules
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ApplySchema.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ApplySchema.md
@@ -1,7 +1,7 @@
 ---
 title: ApplySchema
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient ApplySchema
 

diff --git a/...ocs/21.0/reference/programs/vtctldclient/vtctldclient_ApplyShardRoutingRules.md b/...ocs/21.0/reference/programs/vtctldclient/vtctldclient_ApplyShardRoutingRules.md
@@ -1,7 +1,7 @@
 ---
 title: ApplyShardRoutingRules
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient ApplyShardRoutingRules
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md
@@ -1,7 +1,7 @@
 ---
 title: ApplyVSchema
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient ApplyVSchema
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_Backup.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_Backup.md
@@ -1,7 +1,7 @@
 ---
 title: Backup
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient Backup
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md
@@ -1,7 +1,7 @@
 ---
 title: BackupShard
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient BackupShard
 

diff --git a/...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ChangeTabletType.md b/...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ChangeTabletType.md
@@ -1,7 +1,7 @@
 ---
 title: ChangeTabletType
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient ChangeTabletType
 

diff --git a/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_CheckThrottler.md b/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_CheckThrottler.md
@@ -1,7 +1,7 @@
 ---
 title: CheckThrottler
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient CheckThrottler
 

diff --git a/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_CreateKeyspace.md b/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_CreateKeyspace.md
@@ -1,7 +1,7 @@
 ---
 title: CreateKeyspace
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient CreateKeyspace
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_CreateShard.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_CreateShard.md
@@ -1,7 +1,7 @@
 ---
 title: CreateShard
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient CreateShard
 

diff --git a/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteCellInfo.md b/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteCellInfo.md
@@ -1,7 +1,7 @@
 ---
 title: DeleteCellInfo
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient DeleteCellInfo
 

diff --git a/...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteCellsAlias.md b/...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteCellsAlias.md
@@ -1,7 +1,7 @@
 ---
 title: DeleteCellsAlias
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient DeleteCellsAlias
 

diff --git a/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteKeyspace.md b/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteKeyspace.md
@@ -1,7 +1,7 @@
 ---
 title: DeleteKeyspace
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient DeleteKeyspace
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteShards.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteShards.md
@@ -1,7 +1,7 @@
 ---
 title: DeleteShards
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient DeleteShards
 

diff --git a/...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteSrvVSchema.md b/...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteSrvVSchema.md
@@ -1,7 +1,7 @@
 ---
 title: DeleteSrvVSchema
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient DeleteSrvVSchema
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteTablets.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteTablets.md
@@ -1,7 +1,7 @@
 ---
 title: DeleteTablets
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient DeleteTablets
 

diff --git a/...0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/_index.md b/...0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/_index.md
@@ -0,0 +1,32 @@
+---
+title: DistributedTransaction
+series: vtctldclient
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
+---
+## vtctldclient DistributedTransaction
+
+Perform commands on distributed transaction
+
+### Options
+
+```
+  -h, --help   help for DistributedTransaction
+```
+
+### Options inherited from parent commands
+
+```
+      --action_timeout duration              timeout to use for the command (default 1h0m0s)
+      --compact                              use compact format for otherwise verbose outputs
+      --server string                        server to use for the connection (required)
+      --topo-global-root string              the path of the global topology data in the global topology server (default "/vitess/global")
+      --topo-global-server-address strings   the address of the global topology server(s) (default [localhost:2379])
+      --topo-implementation string           the topology implementation to use (default "etcd2")
+```
+
+### SEE ALSO
+
+* [vtctldclient](../)	 - Executes a cluster management command on the remote vtctld server.
+* [vtctldclient DistributedTransaction conclude](./vtctldclient_distributedtransaction_conclude/)	 - Concludes the unresolved transaction by rolling back the prepared transaction on each participating shard and removing the transaction metadata record.
+* [vtctldclient DistributedTransaction list](./vtctldclient_distributedtransaction_list/)	 - Retrieves unresolved transactions for the given keyspace.
+
diff --git a/...ldclient_DistributedTransaction/vtctldclient_DistributedTransaction_conclude.md b/...ldclient_DistributedTransaction/vtctldclient_DistributedTransaction_conclude.md
@@ -0,0 +1,34 @@
+---
+title: DistributedTransaction conclude
+series: vtctldclient
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
+---
+## vtctldclient DistributedTransaction conclude
+
+Concludes the unresolved transaction by rolling back the prepared transaction on each participating shard and removing the transaction metadata record.
+
+```
+vtctldclient DistributedTransaction conclude <dtid> [<keyspace/shard> ...]
+```
+
+### Options
+
+```
+  -h, --help   help for conclude
+```
+
+### Options inherited from parent commands
+
+```
+      --action_timeout duration              timeout to use for the command (default 1h0m0s)
+      --compact                              use compact format for otherwise verbose outputs
+      --server string                        server to use for the connection (required)
+      --topo-global-root string              the path of the global topology data in the global topology server (default "/vitess/global")
+      --topo-global-server-address strings   the address of the global topology server(s) (default [localhost:2379])
+      --topo-implementation string           the topology implementation to use (default "etcd2")
+```
+
+### SEE ALSO
+
+* [vtctldclient DistributedTransaction](../)	 - Perform commands on distributed transaction
+
diff --git a/...vtctldclient_DistributedTransaction/vtctldclient_DistributedTransaction_list.md b/...vtctldclient_DistributedTransaction/vtctldclient_DistributedTransaction_list.md
@@ -0,0 +1,34 @@
+---
+title: DistributedTransaction list
+series: vtctldclient
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
+---
+## vtctldclient DistributedTransaction list
+
+Retrieves unresolved transactions for the given keyspace.
+
+```
+vtctldclient DistributedTransaction list <keyspace>
+```
+
+### Options
+
+```
+  -h, --help   help for list
+```
+
+### Options inherited from parent commands
+
+```
+      --action_timeout duration              timeout to use for the command (default 1h0m0s)
+      --compact                              use compact format for otherwise verbose outputs
+      --server string                        server to use for the connection (required)
+      --topo-global-root string              the path of the global topology data in the global topology server (default "/vitess/global")
+      --topo-global-server-address strings   the address of the global topology server(s) (default [localhost:2379])
+      --topo-implementation string           the topology implementation to use (default "etcd2")
+```
+
+### SEE ALSO
+
+* [vtctldclient DistributedTransaction](../)	 - Perform commands on distributed transaction
+
diff --git a/...ocs/21.0/reference/programs/vtctldclient/vtctldclient_EmergencyReparentShard.md b/...ocs/21.0/reference/programs/vtctldclient/vtctldclient_EmergencyReparentShard.md
@@ -1,7 +1,7 @@
 ---
 title: EmergencyReparentShard
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient EmergencyReparentShard
 

diff --git a/.../en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsApp.md b/.../en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsApp.md
@@ -1,7 +1,7 @@
 ---
 title: ExecuteFetchAsApp
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient ExecuteFetchAsApp
 

diff --git a/.../en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsDBA.md b/.../en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsDBA.md
@@ -1,7 +1,7 @@
 ---
 title: ExecuteFetchAsDBA
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient ExecuteFetchAsDBA
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteHook.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteHook.md
@@ -1,7 +1,7 @@
 ---
 title: ExecuteHook
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient ExecuteHook
 

diff --git a/...ocs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteMultiFetchAsDBA.md b/...ocs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteMultiFetchAsDBA.md
@@ -1,7 +1,7 @@
 ---
 title: ExecuteMultiFetchAsDBA
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient ExecuteMultiFetchAsDBA
 

diff --git a/...cs/21.0/reference/programs/vtctldclient/vtctldclient_FindAllShardsInKeyspace.md b/...cs/21.0/reference/programs/vtctldclient/vtctldclient_FindAllShardsInKeyspace.md
@@ -1,7 +1,7 @@
 ---
 title: FindAllShardsInKeyspace
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient FindAllShardsInKeyspace
 

diff --git a/...n/docs/21.0/reference/programs/vtctldclient/vtctldclient_GenerateShardRanges.md b/...n/docs/21.0/reference/programs/vtctldclient/vtctldclient_GenerateShardRanges.md
@@ -1,7 +1,7 @@
 ---
 title: GenerateShardRanges
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient GenerateShardRanges
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetBackups.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetBackups.md
@@ -1,7 +1,7 @@
 ---
 title: GetBackups
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient GetBackups
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetCellInfo.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetCellInfo.md
@@ -1,7 +1,7 @@
 ---
 title: GetCellInfo
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient GetCellInfo
 

diff --git a/...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetCellInfoNames.md b/...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetCellInfoNames.md
@@ -1,7 +1,7 @@
 ---
 title: GetCellInfoNames
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient GetCellInfoNames
 

diff --git a/...nt/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetCellsAliases.md b/...nt/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetCellsAliases.md
@@ -1,7 +1,7 @@
 ---
 title: GetCellsAliases
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient GetCellsAliases
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetFullStatus.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetFullStatus.md
@@ -1,7 +1,7 @@
 ---
 title: GetFullStatus
 series: vtctldclient
-commit: 4bc3b998941037e0446f5c0899587e4093d79f57
+commit: 069651aed3c06088dc00f8f699a276665056e3d0
 ---
 ## vtctldclient GetFullStatus