pingcap / tidb-operator

TiDB operator creates and manages TiDB clusters running in Kubernetes.

TiDB Operator

• Stack Overflow
• Community Slack Channel
• Reddit
• 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.

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, support the following features:

  • Monitoring multiple clusters across multiple namespaces.
  • Multiple replicas.
  • Targets sharding.
  • Updating configurations and rules dynamically.
  • Thanos framework integration.

• Heterogeneous cluster

  Users can deploy a heterogeneous cluster join existing cluster.

Quick Start

You can follow our Get Started guide to quickly start a testing Kubernetes cluster and play with TiDB Operator on your own machine.

Documentation

You can see our documentation at PingCAP website for more in-depth installation and instructions for production:

• English
• 简体中文

All the TiDB Operator documentation is maintained in the docs-tidb-operator repository.

Blog

• English
• 简体中文

Community

Feel free to reach out if you have any questions. The maintainers of this project are reachable via:

• TiDB Community Slack in the #sig-k8s channel
• Filing an issue against this repo

Pull Requests are welcome! Check the issue tracker for status/help-wanted issues if you're unsure where to start.

If you're planning a new feature, please file an issue or join #sig-k8s channel to discuss first.

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.