README
¶
TiDB Operator
NOTE: The v2 is expermential now, PLEASE don't use it in production
- Stack Overflow
- Community Slack Channel
- Mailing list: Google Group
- For support, please contact PingCAP
TiDB Operator manages TiDB clusters on Kubernetes and automates tasks related to operating a TiDB cluster. It makes TiDB a truly cloud-native database.
Why a new TiDB Operator
See Why we need a new TiDB Operator
Arch
See arch.md
Roadmap
See rfcs
Documentation(TODO)
Contributing
Contributions are welcome and greatly appreciated. See CONTRIBUTING.md for details on submitting patches and the contribution workflow.
License
TiDB Operator is under the Apache 2.0 license. See the LICENSE file for details.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
crd-modifier
command
|
|
|
overlay-gen
command
|
|
|
prestop-checker
command
|
|
|
runtime-gen
command
|
|
|
testing-workload
command
|
|
|
tidb-backup-manager
command
|
|
|
tidb-operator
command
|
|
|
verify-feature-gates
command
|
|
|
pkg
|
|
|
apicall
Package apicall defines many useful functions to fetch data by kubernetes api
|
Package apicall defines many useful functions to fetch data by kubernetes api |
|
apiutil/core/v1alpha1
Package coreutil is defined to get/set some fields in complex core/v1alpha1 api structs
|
Package coreutil is defined to get/set some fields in complex core/v1alpha1 api structs |
|
controllers/common
Package common is a generated GoMock package.
|
Package common is a generated GoMock package. |
|
image
Package image is defined to return image of components
|
Package image is defined to return image of components |
|
pdapi/v1
Package pdapi is a generated GoMock package.
|
Package pdapi is a generated GoMock package. |
|
runtime
Package runtime is a generated GoMock package.
|
Package runtime is a generated GoMock package. |
|
runtime/scope
Package scope is defined to minimize specified generic types when call funcs Normally only one type(e.g.
|
Package scope is defined to minimize specified generic types when call funcs Normally only one type(e.g. |
|
timanager/apis/pd/v1
+groupName=pd.pingcap.com +versionName=v1 +k8s:deepcopy-gen=package
|
+groupName=pd.pingcap.com +versionName=v1 +k8s:deepcopy-gen=package |
|
timanager/pd
Package pd is a generated GoMock package.
|
Package pd is a generated GoMock package. |
|
utils/random
Package random is copied from https://stackoverflow.com/questions/22892120/how-to-generate-a-random-string-of-a-fixed-length-in-go
|
Package random is copied from https://stackoverflow.com/questions/22892120/how-to-generate-a-random-string-of-a-fixed-length-in-go |
|
utils/task
Package task is a generated GoMock package.
|
Package task is a generated GoMock package. |
|
utils/tracker
Package tracker provides utilities for tracking and managing instances within groups.
|
Package tracker provides utilities for tracking and managing instances within groups. |
|
volumes
Package volumes is a generated GoMock package.
|
Package volumes is a generated GoMock package. |
|
tests
|
|
|
e2e/utils/data
TODO: migrate to tests/e2e/data pkg
|
TODO: migrate to tests/e2e/data pkg |
|
third_party
|
|
|
kube-openapi/pkg/util/proto
This package is forked from kubernetes/kube-openapi It can be removed after https://github.com/kubernetes/kube-openapi/pull/521 is merged
|
This package is forked from kubernetes/kube-openapi It can be removed after https://github.com/kubernetes/kube-openapi/pull/521 is merged |
Click to show internal directories.
Click to hide internal directories.