Sign InTry Free

TiDB Operator Overview

TiDB Operator is an automatic operation system for TiDB clusters on Kubernetes. It provides a full management life-cycle for TiDB including deployment, upgrades, scaling, backup, fail-over, and configuration changes. With TiDB Operator, TiDB can run seamlessly in the Kubernetes clusters deployed on a public or private cloud.

The corresponding relationship between TiDB Operator and TiDB versions is as follows:

TiDB versionsCompatible TiDB Operator versions
devdev
TiDB >= 5.41.4, 1.3 (Recommended)
5.1 <= TiDB < 5.41.4, 1.3 (Recommended), 1.2
3.0 <= TiDB < 5.11.4, 1.3 (Recommended), 1.2, 1.1
2.1 <= TiDB < v3.01.0 (End of support)

Manage TiDB clusters using TiDB Operator

TiDB Operator provides several ways to deploy TiDB clusters on Kubernetes:

Before deploying TiDB on any of the above two environments, you can always refer to TiDB Cluster Configuration Document to customize TiDB configurations.

After the deployment is complete, see the following documents to use, operate, and maintain TiDB clusters on Kubernetes:

When a problem occurs and the cluster needs diagnosis, you can:

TiDB on Kubernetes provides a dedicated command-line tool tkctl for cluster management and auxiliary diagnostics. Meanwhile, some of TiDB's tools are used differently on Kubernetes. You can:

Finally, when a new version of TiDB Operator is released, you can refer to Upgrade TiDB Operator to upgrade to the latest version.

Download PDFRequest docs changesEdit this page
Was this page helpful?
Open Source Ecosystem
TiDB
TiKV
TiSpark
Chaos Mesh
© 2022 PingCAP. All Rights Reserved.