-
Notifications
You must be signed in to change notification settings - Fork 208
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
base: prod
Are you sure you want to change the base?
Changes from all commits
3305b4b
0c489d4
7bd2496
070c94f
6c3a679
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,8 +2,10 @@ | |
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 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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same here. We can probably get rid of There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Here it definitely seems off. In your mind, is |
||
|
||
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. |
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
There was a problem hiding this comment.
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
?There was a problem hiding this comment.
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.