TiDB in Kubernetes Documentation

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.

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

TiDB versions	Compatible TiDB Operator versions
dev	dev
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)

About TiDB Operator

• TiDB Operator Overview
• What's New in v1.2

Quick Start

• kind
• Minikube
• GKE

Deploy TiDB

• On AWS EKS
• On GCP GKE
• On Alibaba ACK
• On Self-managed Kubernetes
• Deploy TiFlash
• Deploy Monitoring Services

Secure

• Enable TLS for the MySQL Client
• Enable TLS between TiDB Components
• Run TiDB Operator and TiDB Clusters as a Non-root User

Maintain

• Upgrade a TiDB Cluster
• Upgrade TiDB Operator
• Scale a TiDB Cluster
• Backup and Restore
• Maintain Kubernetes Nodes
• Use Automatic Failover

Reference

• TiDB Scheduler
• API Docs
• Use tkctl
• Configure TiDB Binlog Drainer