Feature Request
Is your feature request related to a problem? Please describe:
So when we run tiup cluster help, we get a list of subcommands and options, which is fine, but to a complete newbie they are total lost what to do next 🤷. This is unlike tiup itself or tiup playground which contains some examples to start with.
Describe the feature you'd like:
Since tiup cluster requires a config file, I doubt playground-like examples would be sound. But it should be good if we point to the docs in the help page like:
$ tiup cluster --help
Deploy a TiDB cluster for production
See <https://docs.pingcap.com/tidb/stable/production-deployment-using-tiup> for how to start.
Usage:
tiup cluster [command]
...
Describe alternatives you've considered:
There could also be a example-topology command to which generates an example topology.yaml file, thus allowing an Example section
$ tiup cluster example-topology minimal > topology.yaml; vi topology.yaml # prepare topology config
$ tiup cluster deploy tidb-test v4.0.10 ./topology.yaml --user root # deploy the cluster, ssh-login as 'root'
$ tiup cluster start tidb-test # start the cluster
$ tiup cluster display tidb-test # check cluster status
Teachability, Documentation, Adoption, Migration Strategy:
Feature Request
Is your feature request related to a problem? Please describe:
So when we run
tiup cluster help, we get a list of subcommands and options, which is fine, but to a complete newbie they are total lost what to do next 🤷. This is unliketiupitself ortiup playgroundwhich contains some examples to start with.Describe the feature you'd like:
Since
tiup clusterrequires a config file, I doubt playground-like examples would be sound. But it should be good if we point to the docs in the help page like:Describe alternatives you've considered:
There could also be a
example-topologycommand to which generates an exampletopology.yamlfile, thus allowing an Example sectionTeachability, Documentation, Adoption, Migration Strategy: