TiDB operator creates and manages TiDB clusters running in Kubernetes
Clone or download
weekface refactoring pd failover (#211)
* update go.mod, remove code-generator and other unused packages
* refactor pd failover
* remove Replicas attribute
* copy and modify generate-groups.sh from code-generator
* adjust the related unit tests
Latest commit 4c18342 Dec 17, 2018


TiDB Operator

Build Status

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

Warning: Currently, TiDB Operator is work in progress [WIP] and is NOT ready for production. Use at your own risk.


  • 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.


Read the Roadmap.

Quick start

Choose one of the following tutorials:

User guide

Read the user guide.


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


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