Document vtadmin flags in programs/reference/vtadmin#1019
Merged
Conversation
Signed-off-by: Sara Bee <855595+doeg@users.noreply.github.com>
Signed-off-by: Sara Bee <855595+doeg@users.noreply.github.com>
Signed-off-by: Sara Bee <855595+doeg@users.noreply.github.com>
✅ Deploy Preview for vitess ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
ajm188
approved these changes
May 12, 2022
Contributor
ajm188
left a comment
ajm188
left a comment
There was a problem hiding this comment.
one nitpick on the duration types, then feel free to merge!
Comment on lines
+14
to
+15
| | `lame-duck-duration` | Optional | seconds | 5s | The length of the lame duck period at shutdown. | | ||
| | `lmux-read-timeout` | Optional | seconds | 1s | How long to spend connection muxing. | |
Contributor
There was a problem hiding this comment.
technically, these are of type time.Duration, not "seconds" (i'm not just being a pedant here (but SORRY), but this means you can pass a value of, say, 1h as well)
Contributor
Author
There was a problem hiding this comment.
Oh thank you! Not pedantic at all!! I was unsure about it + forgot to flag it for you so thanks for catching it.
Signed-off-by: Sara Bee <855595+doeg@users.noreply.github.com>
Signed-off-by: Sara Bee <855595+doeg@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Sara Bee 855595+doeg@users.noreply.github.com
🔬 Staging: https://deploy-preview-1019--vitess.netlify.app/docs/14.0/reference/programs/vtadmin/
I extracted this from #1012, since these flag references tend to get out of date quickly so we may as well put a stake in the ground! (The schema caching PR adds a few, as will single-component vtadmin.)
Two small things I changed after pilfering this from #1012:
I had initially referred to the binary as
vtadmin-apibut it's actually calledvtadmin(which makes even more sense in light of single-component vtadmin, so 🎉 for once naming worked out nicely!)I addressed this comment about wording (thank you!)
I intentionally did not add these to the 13.0 docs, since I'll have to go back and actually
git checkoutthat tag + see if there are any inconsistencies.For full disclosure, I know we have some kind of tooling in vitessio/vitess to generate documentation, but in the interests of getting this out the door, I just wrote these cursed markdown tables by hand. 🤷