Update docs for vitessio/vitess#17442 (#1912)

* Update docs for vitessio/vitess#17442 Signed-off-by: Matt Lord <[email protected]> * CopySchemaShard is now the same so no need to mention it Signed-off-by: Matt Lord <[email protected]> * Remove vtctl binary docs and update vtctl concept page Signed-off-by: Matt Lord <[email protected]> * Improve text Signed-off-by: Matt Lord <[email protected]> * Update vtctl concept page Signed-off-by: Matt Lord <[email protected]> * Update generated docs from main Signed-off-by: Matt Lord <[email protected]> --------- Signed-off-by: Matt Lord <[email protected]>
vitessio · Feb 11, 2025 · feb82fa · feb82fa
1 parent 5d3c3e4
commit feb82fa
Show file tree

Hide file tree

Showing 182 changed files with 390 additions and 2,732 deletions.
diff --git a/content/en/docs/22.0/concepts/vtctl.md b/content/en/docs/22.0/concepts/vtctl.md
@@ -2,8 +2,14 @@
 title: vtctl
 ---
 
-**vtctl** is a command-line tool used to administer a Vitess cluster. It is available as both a standalone tool (`vtctl`) and client-server (`vtctldclient` in combination with `vtctld`). Using client-server is recommended, as it provides an additional layer of security when using the client remotely.
+**vtctl** is the Vitess control system used to administer a Vitess cluster. It consists of a command-line client, [`vtctldclient`](../../reference/programs/vtctldclient/), that is used as both a standalone tool (`vtctldclient --server=internal`)
+and more commonly in client-server mode with [`vtctldclient`](../../reference/programs/vtctldclient/) interacting with a [`vtctld`](../../reference/programs/vtctld/) server. Using client-server mode is recommended, as it provides an additional
+layer of security when using the client remotely.
 
-Using vtctl, you can identify primary and replica databases, create tables, initiate failovers, perform resharding operations, and so forth.
+Using this you can identify primary and replica databases, create tables, initiate failovers, perform resharding operations, and so forth.
 
-As vtctl performs operations, the Topology Service is updated as needed. Other Vitess servers observe those changes and react accordingly. For example, if you use vtctl to fail over to a new primary database, vtgate sees the change and directs future write operations to the new primary.
+As operations are performed the [Topology Service](../topology-service/) is updated as needed. Other Vitess processes observe those changes and react accordingly. For example, if you use `vtctldclient` to fail over to a new primary database
+using [`PlannedReparentShard`](../../reference/programs/vtctldclient/vtctldclient_plannedreparentshard/), [`vtgate`](../../reference/programs/vtgate/) sees the changes in the [Topology Service](../topology-service/) and directs future write
+operations to the new primary.
+
+Please see the [reference documentation](../../reference/programs/vtctldclient/) for additional details.
diff --git a/content/en/docs/22.0/reference/programs/vtctl/_index.md b/content/en/docs/22.0/reference/programs/vtctl/_index.md
diff --git a/content/en/docs/22.0/reference/programs/vtctl/cell-aliases.md b/content/en/docs/22.0/reference/programs/vtctl/cell-aliases.md
diff --git a/content/en/docs/22.0/reference/programs/vtctl/cells.md b/content/en/docs/22.0/reference/programs/vtctl/cells.md
diff --git a/content/en/docs/22.0/reference/programs/vtctl/generic.md b/content/en/docs/22.0/reference/programs/vtctl/generic.md