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

Open
wants to merge 5 commits into
base: prod
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 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,10 @@
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.

---

**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 a command-line tool, `vtctldclient`, that is used as both a standalone tool (`vtctldclient --server=internal`) and client-server (`vtctldclient` in combination with `vtctld`) to administer a Vitess cluster. Using client-server is recommended, as it provides an additional layer of security when using the client remotely.
Copy link
Member

Choose a reason for hiding this comment

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

Same here. We can probably get rid of vtctl terminology now.

Copy link
Collaborator Author

@mattlord mattlord Jan 24, 2025

Choose a reason for hiding this comment

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

Here it definitely seems off. In your mind, is vtctl a binary (same name) and a concept (client and server binaries)? If it's really just the former then we should definitely remove usage of it. My reading of the page was that it's a concept that spans the client and server pieces but maybe I just misread it.


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 it 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.

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