pingcap/docs-tidb-operator

Documentation for TiDB on Kubernetes. TiDB is an open-source, cloud-native, distributed, MySQL-Compatible database for elastic scale and real-time analytics.

stars

1,377

commits

Python

primary language

Aug 17, 2026

updated

docs.pingcap.com/tidb-in-kubernetes/stable/

hacktoberfest

tidb-in-kubernetes

tidb-operator

tidb-operator-documentation

Browse cluster: TiDB distributed database ecosystem →

README

TiDB on Kubernetes Documentation

This repository stores all the source files of TiDB on Kubernetes documentation at the PingCAP website. That is, the documentation for TiDB Operator.

Currently, the official documentation supports two languages:

en: documentation in English
zh: documentation in Chinese

You can use Google Translate to view the documentation in different languages. For example:

Documentation versions

Currently, we maintain the following versions for TiDB on Kubernetes documentation, each with a separate branch:

Branch name	Version description
`main`	the latest development version for v2.x
`release-2.0`	the 2.0 version
`release-1.x`	the latest development version for v1.x
`release-1.6`	the 1.6 version (latest stable)
`release-1.5`	the 1.5 version
`release-1.4`	the 1.4 version
`release-1.3`	the 1.3 version
`release-1.2`	the 1.2 version (archived)
`release-1.1`	the 1.1 version (archived)
`release-1.0`	the 1.0 version (archived)

Note:

Previously, we maintain the TiDB on Kubernetes documentation in the docs and docs-cn repository.

Since March 31, 2020, all the TiDB on Kubernetes documentation has been moved to this repository, and maintained based on versions in the branches above.

License

All documentation starting from TiDB Operator v1.5 is available under the terms of CC BY-SA 3.0.

Contributors

(top 30 of 90)

271 commits

132 commits

103 commits

92 commits

Similar repos

pingcap/tidb-operator

TiDB operator creates and manages TiDB clusters running in Kubernetes.

1,336

shared contributors

pingcap/docs

TiDB database documentation. TiDB is an open-source, cloud-native, distributed, MySQL-Compatible…

616

shared contributors

pingcap/docs-cn

TiDB/TiKV/PD 中文文档

1,832

shared contributors

pingcap/community

TiDB community content

268

shared contributors

pingcap/tiup

A component manager for TiDB

466

shared contributors

pingcap/tiflow

This repo maintains DM (a data migration platform) and TiCDC (change data capture for TiDB)

464

shared contributors

pingcap/tikv

Distributed transactional key-value database, originally created to complement TiDB

16,838

shared contributors

pingcap/tidb-binlog

A tool used to collect and merge tidb's binlog for real-time data backup and synchronization.

291

shared contributors

Languages

Python

42.4%

TeX

38.4%

Shell

16.2%

Smarty

3.0%

pingcap/docs-tidb-operator

Documentation for TiDB on Kubernetes. TiDB is an open-source, cloud-native, distributed, MySQL-Compatible database for elastic scale and real-time analytics.

stars

1,377

commits

Python

primary language

Aug 17, 2026

updated

docs.pingcap.com/tidb-in-kubernetes/stable/

hacktoberfest

tidb-in-kubernetes

tidb-operator

tidb-operator-documentation

Browse cluster: TiDB distributed database ecosystem →

README

TiDB on Kubernetes Documentation

This repository stores all the source files of TiDB on Kubernetes documentation at the PingCAP website. That is, the documentation for TiDB Operator.

Currently, the official documentation supports two languages:

en: documentation in English
zh: documentation in Chinese

You can use Google Translate to view the documentation in different languages. For example:

Documentation versions

Currently, we maintain the following versions for TiDB on Kubernetes documentation, each with a separate branch:

Branch name	Version description
`main`	the latest development version for v2.x
`release-2.0`	the 2.0 version
`release-1.x`	the latest development version for v1.x
`release-1.6`	the 1.6 version (latest stable)
`release-1.5`	the 1.5 version
`release-1.4`	the 1.4 version
`release-1.3`	the 1.3 version
`release-1.2`	the 1.2 version (archived)
`release-1.1`	the 1.1 version (archived)
`release-1.0`	the 1.0 version (archived)

Note:

Previously, we maintain the TiDB on Kubernetes documentation in the docs and docs-cn repository.

Since March 31, 2020, all the TiDB on Kubernetes documentation has been moved to this repository, and maintained based on versions in the branches above.