- About TiDB Operator
- Get Started
- Release Notes
You are viewing the documentation for an older major version of the TiDB Operator tool (TiDB Operator v1.0).
TiDB Operator is an automatic operation system for TiDB clusters in 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.
You can only deploy one TiDB Operator in a Kubernetes cluster.
The corresponding relationship between TiDB Operator and TiDB versions is as follows:
|TiDB versions||Compatible TiDB Operator versions|
|TiDB >= 5.4||1.3|
|5.1 <= TiDB < 5.4||1.3 (Recommended), 1.2|
|3.0 <= TiDB < 5.1||1.3 (Recommended), 1.2, 1.1|
|2.1 <= TiDB < v3.0||1.0 (End of support)|
TidbCluster is a custom resource defined by CRD (
CustomResourceDefinition) and is used to describe the desired state of the TiDB cluster. The following components are responsible for the orchestration and scheduling logic in a TiDB cluster:
tidb-controller-manageris a set of custom controllers in Kubernetes. These controllers constantly compare the desired state recorded in the
TidbClusterobject with the actual state of the TiDB cluster. They adjust the resources in Kubernetes to drive the TiDB cluster to meet the desired state;
tidb-scheduleris a Kubernetes scheduler extension that injects the TiDB specific scheduling policies to the Kubernetes scheduler.
In addition, TiDB Operator also provides
tkctl, the command-line interface for TiDB clusters in Kubernetes. It is used for cluster operations and troubleshooting cluster issues.
The diagram above is the analysis of the control flow of TiDB Operator. Because TiDB clusters also need components such as monitoring, initialization, scheduled backup, Binlog and so on, TiDB Operator encapsulates the definition of these components in the Helm chart. The overall control process is as follows:
- The user creates a
TidbClusterobject and a corresponding series of Kubernetes-native objects through Helm, such as a
CronJobthat performs scheduled backups;
- TiDB Operator watches
TidbClusterand other related objects, and constantly adjust the
Serviceobjects of PD, TiKV, and TiDB based on the actual state of the cluster;
- Kubernetes' native controller creates, updates, and deletes the corresponding
Podbased on objects such as
- In the
Poddeclaration of PD, TiKV, and TiDB, the
tidb-schedulerscheduler is specified.
tidb-schedulerapplies the specific scheduling logic of TiDB when scheduling the corresponding
Based on the above declarative control flow, TiDB Operator automatically performs health check and fault recovery for the cluster nodes. You can easily modify the
TidbCluster object declaration to perform operations such as deployment, upgrade and scaling.
TiDB Operator provides several ways to deploy TiDB clusters in Kubernetes:
For test environment:
For production environment:
In an existing Kubernetes cluster:
You also need to adjust the configuration of the Kubernetes cluster based on Prerequisites for TiDB in Kubernetes and configure the local PV for your Kubernetes cluster to achieve low latency of local storage for TiKV according to Local PV Configuration.
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 in Kubernetes:
- Access the TiDB Cluster
- Scale TiDB Cluster
- Upgrade TiDB Cluster
- Change the Configuration of TiDB Cluster
- Backup and Restore using Helm Charts
- Automatic Failover
- Monitor a TiDB Cluster in Kubernetes
- Collect TiDB Logs in Kubernetes
- Maintain Kubernetes Nodes that Hold the TiDB Cluster
When a problem occurs and the cluster needs diagnosis, you can:
- See TiDB FAQs in Kubernetes for any available solution;
- See Troubleshoot TiDB in Kubernetes to shoot troubles.
TiDB in Kubernetes provides a dedicated command-line tool
tkctl for cluster management and auxiliary diagnostics. Meanwhile, some of TiDB's tools are used differently in Kubernetes. You can:
- See Tools in Kubernetes to understand how TiDB tools are used in Kubernetes.
Finally, when a new version of TiDB Operator is released, you can refer to Upgrade TiDB Operator to upgrade to the latest version.