search

pingcap / tidb-operator

TiDB operator creates and manages TiDB clusters running in Kubernetes.
https://docs.pingcap.com/tidb-in-kubernetes/
Apache License 2.0
1.2k stars 490 forks source link

Documentation for operator features #5653

Open sachin-japate opened 1 month ago

sachin-japate commented 1 month ago

Feature Request

Documentation for operator features:

We see that TiDB supports features like

  1. AdvancedStatefulSet
  2. VolumeModifying
  3. VolumeReplacing

But don't see any proper documentation around these features and the use cases that can be addressed using these features.

csuzhangxc commented 1 month ago

We plan to add some comments around here.

For the documentation, do you have any suggestions about where we add this description?

csuzhangxc commented 1 month ago

updated the code comment in https://github.com/pingcap/tidb-operator/pull/5641/commits/4db19fb6a9626ab56d3941a9f09efb51f8fca21e