Provide API document for the new CRD based cluster management

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.22k stars 493 forks source link

Provide API document for the new CRD based cluster management #1571

Closed tennix closed 4 years ago

tennix commented 4 years ago

Feature Request

In 1.1, we've already migrated all the helm based cluster management to CRD. This makes it easy for users to integrate TiDB Operator to their own platform. However, we only have Golang SDK (the auto-generated client), no API documentation and other language SDK.

So we need to add API document for users to interact with tidb-operator.

aylei commented 4 years ago

There are lots of utility libs for this, e.g. https://github.com/ahmetb/gen-crd-api-reference-docs