# TiDB on Kubernetes

> Using TiDB Operator provided by PingCAP, you can run and maintain TiDB seamlessly on the Kubernetes clusters deployed on a public cloud or in a self-managed environment.

- [TiDB on Kubernetes Docs](https://docs.pingcap.com/tidb-in-kubernetes/v1.6/)
- Introduction
  - [Overview](https://docs.pingcap.com/tidb-in-kubernetes/stable/tidb-operator-overview.md): Learn the overview of TiDB Operator.
  - [What's New in v1.6](https://docs.pingcap.com/tidb-in-kubernetes/stable/whats-new-in-v1.6.md): Learn about new features in TiDB Operator 1.6.0.
- [Get Started](https://docs.pingcap.com/tidb-in-kubernetes/stable/get-started.md): Learn how to quickly deploy a TiDB cluster on Kubernetes using TiDB Operator.
- Deploy
  - On Self-Managed Kubernetes
    - [Prerequisites](https://docs.pingcap.com/tidb-in-kubernetes/stable/prerequisites.md): Learn the prerequisites for TiDB on Kubernetes.
    - [Configure Storage Class](https://docs.pingcap.com/tidb-in-kubernetes/stable/configure-storage-class.md): Learn how to configure local PVs and network PVs.
    - [Deploy TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tidb-operator.md): Learn how to deploy TiDB Operator on Kubernetes.
    - [Configure a TiDB Cluster](https://docs.pingcap.com/tidb-in-kubernetes/stable/configure-a-tidb-cluster.md): Learn how to configure a TiDB cluster on Kubernetes.
    - [Deploy a TiDB Cluster](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-on-general-kubernetes.md): Learn how to deploy a TiDB cluster on general Kubernetes.
    - [Initialize a TiDB Cluster](https://docs.pingcap.com/tidb-in-kubernetes/stable/initialize-a-cluster.md): Learn how to initialize a TiDB cluster in K8s.
    - [Access a TiDB Cluster](https://docs.pingcap.com/tidb-in-kubernetes/stable/access-tidb.md): Learn how to access the TiDB cluster on Kubernetes.
  - On Public Cloud Kubernetes
    - [Amazon EKS](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-on-aws-eks.md): Learn how to deploy a TiDB cluster on AWS Elastic Kubernetes Service (EKS).
    - [Google Cloud GKE](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-on-gcp-gke.md): Learn how to deploy a TiDB cluster on Google Cloud GKE.
    - [Azure AKS](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-on-azure-aks.md): Learn how to deploy a TiDB cluster on Azure Kubernetes Service (AKS).
  - [Deploy TiDB on ARM64 Machines](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-cluster-on-arm64.md): Learn how to deploy a TiDB cluster on ARM64 machines.
  - [Deploy TiFlash to Explore TiDB HTAP](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tiflash.md): Learn how to deploy TiFlash, the TiDB HTAP storage engine, on Kubernetes for an existing TiDB cluster.
  - [Deploy TiProxy Load Balancer](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tiproxy.md): Learn how to deploy TiProxy for an existing TiDB cluster on Kubernetes.
  - Deploy TiDB Across Multiple Kubernetes Clusters
    - [Build Multiple Interconnected AWS EKS Clusters](https://docs.pingcap.com/tidb-in-kubernetes/stable/build-multi-aws-eks.md): Learn how to build multiple interconnected AWS EKS clusters and prepare for deploying a TiDB cluster across multiple EKS clusters.
    - [Build Multiple Interconnected GKE Clusters](https://docs.pingcap.com/tidb-in-kubernetes/stable/build-multi-gcp-gke.md): Learn how to build multiple interconnected Google Cloud GKE clusters and prepare for deploying a TiDB cluster across multiple GKE clusters.
    - [Deploy TiDB Across Multiple Kubernetes Clusters](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tidb-cluster-across-multiple-kubernetes.md): Learn how to deploy a TiDB cluster across multiple Kubernetes clusters.
  - [Deploy a Heterogeneous TiDB Cluster](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-heterogeneous-tidb-cluster.md): Learn how to deploy a heterogeneous cluster for an existing TiDB cluster.
  - [Deploy TiCDC](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-ticdc.md): Learn how to deploy TiCDC on Kubernetes.
  - [Deploy TiDB Binlog](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tidb-binlog.md): Learn how to deploy TiDB Binlog for a TiDB cluster on Kubernetes.
- Monitor and Alert
  - [Deploy Monitoring and Alerts for TiDB](https://docs.pingcap.com/tidb-in-kubernetes/stable/monitor-a-tidb-cluster.md): Learn how to monitor a TiDB cluster on Kubernetes.
  - [Monitor and Diagnose TiDB Using TiDB Dashboard](https://docs.pingcap.com/tidb-in-kubernetes/stable/access-dashboard.md): Learn how to access TiDB Dashboard on Kubernetes.
  - [Aggregate Monitoring Data of Multiple TiDB Clusters](https://docs.pingcap.com/tidb-in-kubernetes/stable/aggregate-multiple-cluster-monitor-data.md): Learn how to aggregate monitoring data of multiple TiDB clusters by Thanos query.
  - [Monitor a TiDB Cluster across Multiple Kubernetes Clusters](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tidb-monitor-across-multiple-kubernetes.md): Learn how to monitor a TiDB cluster across multiple Kubernetes clusters and aggregate the monitoring data into the common Prometheus multi-cluster monitoring systems.
  - [Enable Dynamic Configuration for TidbMonitor](https://docs.pingcap.com/tidb-in-kubernetes/stable/enable-monitor-dynamic-configuration.md): This document describes how to enable dynamic configuration for TidbMonitor.
  - [Enable Shards for TidbMonitor](https://docs.pingcap.com/tidb-in-kubernetes/stable/enable-monitor-shards.md): Learn how to use shards for TidbMonitor.
- Migrate
  - [Import Data](https://docs.pingcap.com/tidb-in-kubernetes/stable/restore-data-using-tidb-lightning.md): Learn how to quickly import data with TiDB Lightning.
  - Migrate from MySQL
    - [Deploy DM](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tidb-dm.md): Learn how to deploy TiDB DM cluster on Kubernetes.
    - [Migrate to TiDB Using DM](https://docs.pingcap.com/tidb-in-kubernetes/stable/use-tidb-dm.md): Learn how to migrate MySQL data to TiDB cluster using DM on Kubernetes.
  - [Migrate TiDB to Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/stable/migrate-tidb-to-kubernetes.md): Learn how to migrate a TiDB cluster deployed in the physical or virtual machine to a Kubernetes cluster.
- Manage
  - Secure
    - [Enable TLS for the MySQL Client](https://docs.pingcap.com/tidb-in-kubernetes/stable/enable-tls-for-mysql-client.md): Learn how to enable TLS for MySQL client of the TiDB cluster on Kubernetes.
    - [Enable TLS between TiDB Components](https://docs.pingcap.com/tidb-in-kubernetes/stable/enable-tls-between-components.md): Learn how to enable TLS between TiDB components on Kubernetes.
    - [Enable TLS for DM](https://docs.pingcap.com/tidb-in-kubernetes/stable/enable-tls-for-dm.md): Learn how to enable TLS for DM on Kubernetes.
    - [Replicate Data to TLS-enabled Downstream Services](https://docs.pingcap.com/tidb-in-kubernetes/stable/enable-tls-for-ticdc-sink.md): Learn how to replicate data to TLS-enabled downstream services.
    - [Renew and Replace the TLS Certificate](https://docs.pingcap.com/tidb-in-kubernetes/stable/renew-tls-certificate.md): Learn how to renew and replace TLS certificates between TiDB components.
    - [Run Containers as a Non-root User](https://docs.pingcap.com/tidb-in-kubernetes/stable/containers-run-as-non-root-user.md): Learn how to make TiDB Operator related containers run as a non-root user.
  - [Scale](https://docs.pingcap.com/tidb-in-kubernetes/stable/scale-a-tidb-cluster.md): Learn how to manually scale a TiDB cluster on Kubernetes.
  - Upgrade
    - [Upgrade a TiDB Cluster](https://docs.pingcap.com/tidb-in-kubernetes/stable/upgrade-a-tidb-cluster.md): Learn how to upgrade a TiDB cluster on Kubernetes.
    - Upgrade TiDB Operator
      - [Normal Upgrade](https://docs.pingcap.com/tidb-in-kubernetes/stable/upgrade-tidb-operator.md): Learn how to perform online upgrade and offline upgrade to TiDB Operator in the Kubernetes cluster.
      - [Canary Upgrade](https://docs.pingcap.com/tidb-in-kubernetes/stable/canary-upgrade-tidb-operator.md): Learn how to perform a canary upgrade on TiDB Operator on Kubernetes. Canary upgrade avoids the unpredictable impact of a TiDB Operator upgrade on all TiDB clusters in the entire Kubernetes cluster.
  - Backup and Restore
    - [Overview](https://docs.pingcap.com/tidb-in-kubernetes/stable/backup-restore-overview.md): Learn how to perform backup and restore on the TiDB cluster on Kubernetes using BR, Dumpling, and TiDB Lightning.
    - [Backup and Restore Custom Resources](https://docs.pingcap.com/tidb-in-kubernetes/stable/backup-restore-cr.md): Learn the fields in the Backup and Restore custom resources (CR).
    - [Grant Permissions to Remote Storage](https://docs.pingcap.com/tidb-in-kubernetes/stable/grant-permissions-to-remote-storage.md): Learn how to grant permissions to access remote storage for backup and restore.
    - Amazon S3 Compatible Storage
      - [Back Up Data Using BR](https://docs.pingcap.com/tidb-in-kubernetes/stable/backup-to-aws-s3-using-br.md): Learn how to back up data to Amazon S3-compatible storage using BR.
      - [Restore Data Using BR](https://docs.pingcap.com/tidb-in-kubernetes/stable/restore-from-aws-s3-using-br.md): Learn how to restore data from Amazon S3-compatible storage using BR.
      - [Back Up Data Using Dumpling](https://docs.pingcap.com/tidb-in-kubernetes/stable/backup-to-s3-using-job.md): Learn how to use Dumpling to back up TiDB cluster data to Amazon S3-compatible storage.
      - [Restore Data Using TiDB Lightning](https://docs.pingcap.com/tidb-in-kubernetes/stable/restore-from-s3-using-job.md): Learn how to use TiDB Lightning to restore backup data stored in Amazon S3-compatible storage to a TiDB cluster.
      - [Back Up Data Using Dumpling (Deprecated)](https://docs.pingcap.com/tidb-in-kubernetes/stable/backup-to-s3.md): Learn how to back up the TiDB cluster to the S3-compatible storage using Dumpling.
      - [Restore Data Using TiDB Lightning (Deprecated)](https://docs.pingcap.com/tidb-in-kubernetes/stable/restore-from-s3.md): Learn how to restore data from the S3-compatible storage.
    - Google Cloud Storage
      - [Back Up Data Using BR](https://docs.pingcap.com/tidb-in-kubernetes/stable/backup-to-gcs-using-br.md): Learn how to back up data to Google Cloud Storage (GCS) using BR.
      - [Restore Data Using BR](https://docs.pingcap.com/tidb-in-kubernetes/stable/restore-from-gcs-using-br.md): Learn how to restore data from Google Cloud Storage (GCS) using BR.
      - [Back Up Data Using Dumpling](https://docs.pingcap.com/tidb-in-kubernetes/stable/backup-to-gcs-using-job.md): Learn how to use Dumpling to back up TiDB cluster data to Google Cloud Storage (GCS).
      - [Restore Data Using TiDB Lightning](https://docs.pingcap.com/tidb-in-kubernetes/stable/restore-from-gcs-using-job.md): Learn how to use TiDB Lightning to restore backup data stored in Google Cloud Storage (GCS) to a TiDB cluster.
      - [Back Up Data Using Dumpling (Deprecated)](https://docs.pingcap.com/tidb-in-kubernetes/stable/backup-to-gcs.md): Learn how to use Helm to back up the TiDB cluster to GCS (Google Cloud Storage) using Dumpling.
      - [Restore Data Using TiDB Lightning (Deprecated)](https://docs.pingcap.com/tidb-in-kubernetes/stable/restore-from-gcs.md): Learn how to restore the backup data from GCS.
    - Azure Blob Storage
      - [Back Up Data Using BR](https://docs.pingcap.com/tidb-in-kubernetes/stable/backup-to-azblob-using-br.md): Learn how to back up data to Azure Blob Storage using BR.
      - [Restore Data Using BR](https://docs.pingcap.com/tidb-in-kubernetes/stable/restore-from-azblob-using-br.md): Learn how to restore data from Azure Blob Storage using BR.
      - [Back Up Data Using Dumpling](https://docs.pingcap.com/tidb-in-kubernetes/stable/backup-to-blob-using-job.md): Learn how to use Dumpling to back up TiDB cluster data to Azure Blob Storage.
      - [Restore Data Using TiDB Lightning](https://docs.pingcap.com/tidb-in-kubernetes/stable/restore-from-blob-using-job.md): Learn how to use TiDB Lightning to restore backup data stored in Azure Blob Storage to a TiDB cluster.
    - Persistent Volumes
      - [Back Up Data](https://docs.pingcap.com/tidb-in-kubernetes/stable/backup-to-pv-using-br.md): Learn how to back up cluster data to Persistent Volume (PV) using BR.
      - [Restore Data](https://docs.pingcap.com/tidb-in-kubernetes/stable/restore-from-pv-using-br.md): Learn how to restore data from Persistent Volume (PV) using BR.
    - Snapshot Backup and Restore across Multiple Kubernetes
      - [BR Federation Architecture](https://docs.pingcap.com/tidb-in-kubernetes/stable/br-federation-architecture.md): Learn the architecture of backup and restore based on EBS volume snapshots in TiDB cluster deployed across multiple Kubernetes.
      - [Deploy BR Federation](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-br-federation.md): Learn how to deploy BR Federation on Kubernetes.
      - [Back Up Data Using EBS Snapshots](https://docs.pingcap.com/tidb-in-kubernetes/stable/backup-by-ebs-snapshot-across-multiple-kubernetes.md): Learn how to back up TiDB cluster data across multiple Kubernetes to S3 based on EBS volume snapshots using BR Federation.
      - [Restore Data from EBS Snapshots](https://docs.pingcap.com/tidb-in-kubernetes/stable/restore-from-ebs-snapshot-across-multiple-kubernetes.md): Learn how to restore a TiDB cluster across multiple Kubernetes from EBS Volume Snapshots.
      - [FAQs](https://docs.pingcap.com/tidb-in-kubernetes/stable/backup-restore-by-ebs-snapshot-faq.md): Learn about the common questions and solutions for EBS snapshot backup and restore across multiple Kubernetes.
  - Maintain
    - [Restart a TiDB Cluster](https://docs.pingcap.com/tidb-in-kubernetes/stable/restart-a-tidb-cluster.md): Learn how to restart a TiDB cluster in the Kubernetes cluster.
    - [Destroy a TiDB Cluster](https://docs.pingcap.com/tidb-in-kubernetes/stable/destroy-a-tidb-cluster.md): Learn how to delete TiDB Cluster on Kubernetes.
    - [View TiDB Logs](https://docs.pingcap.com/tidb-in-kubernetes/stable/view-logs.md): Learn how to view TiDB slow logs and application logs on Kubernetes.
    - [Modify TiDB Cluster Configuration](https://docs.pingcap.com/tidb-in-kubernetes/stable/modify-tidb-configuration.md): Learn how to modify the configuration of TiDB clusters deployed on Kubernetes.
    - [Configure Automatic Failover](https://docs.pingcap.com/tidb-in-kubernetes/stable/use-auto-failover.md): Learn the automatic failover policies of TiDB cluster components on Kubernetes.
    - [Pause Sync of a TiDB Cluster](https://docs.pingcap.com/tidb-in-kubernetes/stable/pause-sync-of-tidb-cluster.md): Introduce how to pause sync of a TiDB cluster on Kubernetes
    - [Suspend a TiDB Cluster](https://docs.pingcap.com/tidb-in-kubernetes/stable/suspend-tidb-cluster.md): Learn how to suspend the TiDB cluster on Kubernetes through configuration.
    - [Maintain Different TiDB Clusters Separately Using Multiple TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-multiple-tidb-operator.md): Learn how to deploy multiple sets of TiDB Operator to manage different TiDB clusters.
    - [Maintain Kubernetes Nodes](https://docs.pingcap.com/tidb-in-kubernetes/stable/maintain-a-kubernetes-node.md): Learn how to maintain Kubernetes nodes that hold the TiDB cluster.
    - [Migrate from Helm 2 to Helm 3](https://docs.pingcap.com/tidb-in-kubernetes/stable/migrate-to-helm3.md): Learn how to migrate from Helm 2 to Helm 3.
    - Replace Nodes for a TiDB Cluster
      - [Replace Nodes on Cloud Disks](https://docs.pingcap.com/tidb-in-kubernetes/stable/replace-nodes-for-cloud-disk.md): Learn how to replace and upgrade nodes without downtime for a TiDB cluster that uses cloud storage.
      - [Replace Nodes on Local Disks](https://docs.pingcap.com/tidb-in-kubernetes/stable/replace-nodes-for-local-disk.md): Learn how to replace and upgrade nodes without downtime for a TiDB cluster that uses local storage.
  - Disaster Recovery
    - [Recover a Deleted TiDB Cluster](https://docs.pingcap.com/tidb-in-kubernetes/stable/recover-deleted-cluster.md): Learn how to recover a TiDB cluster that has been deleted mistakenly.
    - [Recover a PD Cluster](https://docs.pingcap.com/tidb-in-kubernetes/stable/pd-recover.md): Learn how to use PD Recover to recover the PD cluster.
- Troubleshoot
  - [Troubleshooting Tips](https://docs.pingcap.com/tidb-in-kubernetes/stable/tips.md): Learn the commonly used tips for troubleshooting TiDB on Kubernetes.
  - [Deployment Failures](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-failures.md): Learn the common deployment failures of TiDB on Kubernetes and their solutions.
  - [Cluster Exceptions](https://docs.pingcap.com/tidb-in-kubernetes/stable/exceptions.md): Learn the common exceptions during the operation of TiDB clusters on Kubernetes and their solutions.
  - [Network Issues](https://docs.pingcap.com/tidb-in-kubernetes/stable/network-issues.md): Learn the common network issues of TiDB on Kubernetes and their solutions.
  - [Troubleshoot TiDB Cluster Using PingCAP Clinic](https://docs.pingcap.com/tidb-in-kubernetes/stable/clinic-user-guide.md): Learn how to install PingCAP Clinic on a TiDB cluster deployed using TiDB Operator and how to use PingCAP Clinic to collect data from the cluster and check the cluster health.
- [FAQs](https://docs.pingcap.com/tidb-in-kubernetes/stable/faq.md): Learn about TiDB FAQs on Kubernetes.
- Reference
  - Architecture
    - [TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/stable/architecture.md): Learn the architecture of TiDB Operator and how it works.
    - [TiDB Scheduler](https://docs.pingcap.com/tidb-in-kubernetes/stable/tidb-scheduler.md): Learn what is TiDB Scheduler and how it works.
    - [Advanced StatefulSet Controller](https://docs.pingcap.com/tidb-in-kubernetes/stable/advanced-statefulset.md): Learn how to enable and use the advanced StatefulSet controller.
    - [Admission Controller](https://docs.pingcap.com/tidb-in-kubernetes/stable/enable-admission-webhook.md): Learn how to enable the admission controller in TiDB Operator and the functionality of the admission controller.
  - [Sysbench Performance Test](https://docs.pingcap.com/tidb-in-kubernetes/stable/benchmark-sysbench.md): Learn the Sysbench performance test of TiDB on Kubernetes.
  - [API References](<https://github.com/pingcap/tidb-operator/blob/v1.6.5/docs/api-references/docs.md>)
  - [Cheat Sheet](https://docs.pingcap.com/tidb-in-kubernetes/stable/cheat-sheet.md): Learn the commonly used commands for managing TiDB clusters.
  - [Required RBAC Rules](https://docs.pingcap.com/tidb-in-kubernetes/stable/tidb-operator-rbac.md): Introduces the RBAC rules required by TiDB Operator.
  - Tools
    - [TiDB Toolkit](https://docs.pingcap.com/tidb-in-kubernetes/stable/tidb-toolkit.md): Learn about operation tools for TiDB on Kubernetes.
  - Configure
    - [Configure tidb-drainer Chart](https://docs.pingcap.com/tidb-in-kubernetes/stable/configure-tidb-binlog-drainer.md): Learn the configurations of a TiDB Binlog Drainer on Kubernetes.
  - [Log Collection](https://docs.pingcap.com/tidb-in-kubernetes/stable/logs-collection.md): Learn the methods of collecting logs of TiDB and its related components.
  - [Monitoring and Alert on Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/stable/monitor-kubernetes.md): Learn the monitoring and alerts on Kubernetes.
  - [PingCAP Clinic Diagnostic Data](https://docs.pingcap.com/tidb-in-kubernetes/stable/clinic-data-collection.md): Learn what diagnostic data can be collected by PingCAP Clinic Diagnostic Service on a TiDB cluster deployed using TiDB Operator.