tidb-operator

module

v1.1.0-rc.3 Latest Latest Go to latest Published: Apr 30, 2020 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

README ¶

TiDB Operator

TiDB Operator manages TiDB clusters on Kubernetes and automates tasks related to operating a TiDB cluster. It makes TiDB a truly cloud-native database.

TiDB Operator Architecture

Features

Safely scaling the TiDB cluster

TiDB Operator empowers TiDB with horizontal scalability on the cloud.
Rolling update of the TiDB cluster

Gracefully perform rolling updates for the TiDB cluster in order, achieving zero-downtime of the TiDB cluster.
Multi-tenant support

Users can deploy and manage multiple TiDB clusters on a single Kubernetes cluster easily.
Automatic failover

TiDB Operator automatically performs failover for your TiDB cluster when node failures occur.
Kubernetes package manager support

By embracing Kubernetes package manager Helm, users can easily deploy TiDB clusters with only one command.
Automatically monitoring TiDB cluster at creating

Automatically deploy Prometheus, Grafana for TiDB cluster monitoring.

Roadmap

Read the Roadmap.

Quick start

Read the Quick Start Guide, which includes all the guides for managing TiDB clusters in Kubernetes.

Documentation

All the TiDB Operator documentation is maintained in the docs-tidb-operator repository. You can also see the documentation at PingCAP website:

Contributing

Contributions are welcome and greatly appreciated. See CONTRIBUTING.md for details on submitting patches and the contribution workflow.

License

TiDB is under the Apache 2.0 license. See the LICENSE file for details.

Directories ¶

Path	Synopsis
cmd
admission-webhook
apiserver
backup-manager
backup-manager/app
backup-manager/app/backup
backup-manager/app/clean
backup-manager/app/cmd
backup-manager/app/constants
backup-manager/app/export
backup-manager/app/import
backup-manager/app/restore
backup-manager/app/util
controller-manager
discovery
scheduler
tkctl
to-crdgen
misc
cmd/debug-launcher
pkg
apis/pingcap/v1alpha1 Package v1alpha1 is the v1alpha1 version of the API.	Package v1alpha1 is the v1alpha1 version of the API.
apis/pingcap/v1alpha1/defaulting
apis/pingcap/v1alpha1/validation
apiserver/apis Package apis hosts all apis of aa +domain=pingcap.com	Package apis hosts all apis of aa +domain=pingcap.com
apiserver/apis/tidb Package tidb is the internal version of the tidb.pingcap.com api group.	Package tidb is the internal version of the tidb.pingcap.com api group.
apiserver/apis/tidb/install
apiserver/apis/tidb/v1alpha1 Package v1alpha1 the v1alpha1 version of the tidb.pingcap.com api group.	Package v1alpha1 the v1alpha1 version of the tidb.pingcap.com api group.
apiserver/cmd
apiserver/openapi
apiserver/storage
autoscaler
autoscaler/autoscaler
autoscaler/autoscaler/calculate
backup
backup/backup
backup/backupschedule
backup/constants
backup/restore
backup/util
client/clientset/versioned This package has the automatically generated clientset.	This package has the automatically generated clientset.
client/clientset/versioned/fake This package has the automatically generated fake clientset.	This package has the automatically generated fake clientset.
client/clientset/versioned/scheme This package contains the scheme of the automatically generated clientset.	This package contains the scheme of the automatically generated clientset.
client/clientset/versioned/typed/pingcap/v1alpha1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
client/clientset/versioned/typed/pingcap/v1alpha1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
client/informers/externalversions
client/informers/externalversions/internalinterfaces
client/informers/externalversions/pingcap
client/informers/externalversions/pingcap/v1alpha1
client/listers/pingcap/v1alpha1
controller
controller/autoscaler
controller/backup
controller/backupschedule
controller/periodicity Package periodicity dedicate the periodicity controller.	Package periodicity dedicate the periodicity controller.
controller/restore
controller/tidbcluster
controller/tidbinitializer
controller/tidbmonitor
discovery
discovery/server
features
httputil
label
manager
manager/member
manager/meta
monitor
monitor/monitor
pdapi
plugin/admission/install
registry
scheduler
scheduler/predicates
scheduler/server
scheme
tkctl Package tkctl provides the functions used by the `tkc` command line tool.	Package tkctl provides the functions used by the `tkc` command line tool.
tkctl/alias
tkctl/cmd
tkctl/cmd/completion
tkctl/cmd/ctop
tkctl/cmd/debug
tkctl/cmd/diagnose
tkctl/cmd/get
tkctl/cmd/info
tkctl/cmd/list
tkctl/cmd/pdctl
tkctl/cmd/upinfo
tkctl/cmd/use
tkctl/cmd/version
tkctl/config Package config wraps kubectl config (namely, ~/.kube/config by default) and incorporate tidb cluster specific configurations setted by 'tkc use'.	Package config wraps kubectl config (namely, ~/.kube/config by default) and incorporate tidb cluster specific configurations setted by 'tkc use'.
tkctl/debug
tkctl/executor
tkctl/readable Package readable provides types and utils for human readable output	Package readable provides types and utils for human readable output
tkctl/streams
tkctl/util
to-crdgen/cmd
to-crdgen/cmd/generate
upgrader
util
util/config
util/crypto
util/discovery
version
webhook
webhook/pod
webhook/statefulset
webhook/strategy
webhook/util
apis Module
client Module
tests
apiserver
cmd/apiserver
cmd/blockwriter
cmd/fault-trigger
cmd/mock-monitor
cmd/stability
cmd/webhook
e2e
e2e/config
e2e/tidbcluster
e2e/util
e2e/util/cloud
e2e/util/image
e2e/util/node
e2e/util/operator
e2e/util/pod
e2e/util/portforward
e2e/util/proxiedpdclient
e2e/util/proxiedtidbclient
e2e/util/statefulset
e2e/util/tidb
e2e/util/tikv
pkg/apimachinery
pkg/apiserver/apis
pkg/apiserver/apis/example Package example is the internal version of the example.pingcap.com api group for e2e testing +k8s:deepcopy-gen=package,register +groupName=example.pingcap.com	Package example is the internal version of the example.pingcap.com api group for e2e testing +k8s:deepcopy-gen=package,register +groupName=example.pingcap.com
pkg/apiserver/apis/example/install
pkg/apiserver/apis/example/v1alpha1 Package v1alpha1 the v1alpha1 version of the example.pingcap.com api group.	Package v1alpha1 the v1alpha1 version of the example.pingcap.com api group.
pkg/apiserver/apis/example/v1beta1 Package v1beta1 is the v1beta1 version of the example.pingcap.com api group.	Package v1beta1 is the v1beta1 version of the example.pingcap.com api group.
pkg/apiserver/client/clientset/internalversion This package has the automatically generated clientset.	This package has the automatically generated clientset.
pkg/apiserver/client/clientset/internalversion/fake This package has the automatically generated fake clientset.	This package has the automatically generated fake clientset.
pkg/apiserver/client/clientset/internalversion/scheme This package contains the scheme of the automatically generated clientset.	This package contains the scheme of the automatically generated clientset.
pkg/apiserver/client/clientset/internalversion/typed/example/internalversion This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
pkg/apiserver/client/clientset/internalversion/typed/example/internalversion/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
pkg/apiserver/client/clientset/versioned This package has the automatically generated clientset.	This package has the automatically generated clientset.
pkg/apiserver/client/clientset/versioned/fake This package has the automatically generated fake clientset.	This package has the automatically generated fake clientset.
pkg/apiserver/client/clientset/versioned/scheme This package contains the scheme of the automatically generated clientset.	This package contains the scheme of the automatically generated clientset.
pkg/apiserver/client/clientset/versioned/typed/example/v1alpha1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
pkg/apiserver/client/clientset/versioned/typed/example/v1alpha1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
pkg/apiserver/client/clientset/versioned/typed/example/v1beta1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
pkg/apiserver/client/clientset/versioned/typed/example/v1beta1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
pkg/apiserver/client/informers/externalversions
pkg/apiserver/client/informers/externalversions/example
pkg/apiserver/client/informers/externalversions/example/v1alpha1
pkg/apiserver/client/informers/externalversions/example/v1beta1
pkg/apiserver/client/informers/externalversions/internalinterfaces
pkg/apiserver/client/informers/internalversion
pkg/apiserver/client/informers/internalversion/example
pkg/apiserver/client/informers/internalversion/example/internalversion
pkg/apiserver/client/informers/internalversion/internalinterfaces
pkg/apiserver/client/listers/example/internalversion
pkg/apiserver/client/listers/example/v1alpha1
pkg/apiserver/client/listers/example/v1beta1
pkg/apiserver/openapi
pkg/blockwriter
pkg/client
pkg/fault-trigger/api
pkg/fault-trigger/client
pkg/fault-trigger/manager
pkg/fixture
pkg/metrics
pkg/mock
pkg/ops
pkg/plugin/admission/install
pkg/util
pkg/webhook
slack

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL