Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for https://github.com/vitessio/vitess/pull/17442 #1912

Merged
merged 8 commits into from
Feb 11, 2025
12 changes: 9 additions & 3 deletions content/en/docs/22.0/concepts/vtctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,14 @@
title: vtctl
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we just replace this with vtctldclient?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure. We frame the concept of vtctl here as being the pairing of the client and server. I'd follow your lead here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated it here: 4771ab9

I think it's MUCH clearer now. Thanks!

---

**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.
268 changes: 0 additions & 268 deletions content/en/docs/22.0/reference/programs/vtctl/_index.md

This file was deleted.

80 changes: 0 additions & 80 deletions content/en/docs/22.0/reference/programs/vtctl/cell-aliases.md

This file was deleted.

114 changes: 0 additions & 114 deletions content/en/docs/22.0/reference/programs/vtctl/cells.md

This file was deleted.

91 changes: 0 additions & 91 deletions content/en/docs/22.0/reference/programs/vtctl/generic.md

This file was deleted.

Loading