DanielZhangQD
commented
3 years ago The following should be covered:
- TidbCluster
- Refer https://github.com/pingcap/tidb-operator/blob/master/examples/advanced/tidb-cluster.yaml, but need to cover all of the fields.
- For the configuration field of each component, we can put the link to the comment for the default toml config and tell user that they can covert the toml config to yaml config via online tools to config these fields.
- TidbMonitor
- Refer to https://github.com/pingcap/tidb-operator/blob/master/manifests/monitor/tidb-monitor.yaml but follow the format of https://github.com/pingcap/tidb-operator/blob/master/examples/advanced/tidb-cluster.yaml and add a new file to https://github.com/pingcap/tidb-operator/blob/master/examples/advanced
- TidbInitializer
- Refer to https://github.com/pingcap/tidb-operator/blob/master/manifests/initializer/tidb-initializer.yaml but follow the format of https://github.com/pingcap/tidb-operator/blob/master/examples/advanced/tidb-cluster.yaml and add a new file to https://github.com/pingcap/tidb-operator/blob/master/examples/advanced
- Backup
- Refer to the files in https://github.com/pingcap/tidb-operator/blob/master/manifests/backup but follow the format of https://github.com/pingcap/tidb-operator/blob/master/examples/advanced/tidb-cluster.yaml and add a new file to https://github.com/pingcap/tidb-operator/blob/master/examples/advanced
- Restore
- Same as backup
- BackupSchedule
- Same as backup
dragonly
mianhk
Feature Request
Is your feature request related to a problem? Please describe:
Currently, we have an advanced example yaml here https://github.com/pingcap/tidb-operator/blob/master/examples/advanced/tidb-cluster.yaml, however, it does not cover all of the fields in the CR, we have to improve it to cover all of the fields in the CR so users can refer to it to customize their own CR.
Describe the feature you'd like:
Describe alternatives you've considered:
Teachability, Documentation, Adoption, Migration Strategy: