Initial pass at some vtadmin docs #8526
Merged
Conversation
This file contains 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
Signed-off-by: Andrew Mason <[email protected]>
doeg
approved these changes
Jul 23, 2021
There was a problem hiding this comment.
This looks so great!!! Thank you so much for writing all this down. I'll do a documentation pass soon, too, especially to consolidate some of the front-end docs.
At some point (per our conversation with @deepthi) we could consider moving these to https://vitess.io, which might make them more generally discoverable (at the expense of colocating it with the code, I guess).
Thank you again!
doc/vtadmin/clusters.yaml
Outdated
| # to the regex: | ||
| # ^discovery-(?P<impl>\w+)-(?P<flag>.+)$ | ||
| # The full set of options for each discovery implementation is defined in that | ||
| # implementations factory function, e.g. NewConsul in |
There was a problem hiding this comment.
typo: "implementations" -> "implementation's"
doc/vtadmin/clusters.yaml
Outdated
| # go/vt/vtadmin/cluster/discovery/discovery_consul.go and NewStaticFile in | ||
| # discovery_static_file.go in the same directory. | ||
|
|
||
| # Service name to use when discovery vtctlds from consul. |
There was a problem hiding this comment.
"when discovering vtctlds" maybe?
| VTAdmin is in alpha, you may use it if you wish, but should not treat it as stable. | ||
| It does not meet the standard Vitess backwards compatibility guarantees, and is subject to change at any time. | ||
| VTAdmin is an experimental replacement for the vtctld2 web UI, that also allows | ||
| users to manage multiple Vitess clusters from a single API and web UI. |
There was a problem hiding this comment.
Could probably link to our original RFC for breadcrumbs/historical interest, if ya like: #7117
Signed-off-by: Andrew Mason <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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: Andrew Mason [email protected]
Description
This is all I had time to put together before a vacation, and something is better than nothing!
Related Issue(s)
Checklist
Deployment Notes