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. Try AI-powered Chat2Query free at : https://www.pingcap.com/tidb-serverless/
https://docs.pingcap.com/tidb-in-kubernetes
Other
47 stars 120 forks source link

Add doc about how to stop the components temporarily #1245

Closed DanielZhangQD closed 2 years ago

DanielZhangQD commented 3 years ago

Change Request

This repository is ONLY used to solve issues related to TiDB Operator documentation. For other issues (related to TiDB, PD, etc), please move to other repositories.

Please answer the following questions before submitting your issue. Thanks!

  1. Describe what you find is inappropriate or missing in the existing docs. Sometimes users want to stop the TiDB components temporarily, we can leverage the runmode: debug annotation to do this, we can add a new section in the doc https://docs.pingcap.com/tidb-in-kubernetes/dev/tips. The annotation can be configured in spec.annotations or spec.xx.annotations, please note that only support for PD, TiKV, and TiDB now.

  2. Describe your suggestion or addition.

  3. Provide some reference materials (documents, websites, etc) if you could.

DanielZhangQD commented 3 years ago

For PD, you have to force upgrade it following the doc https://docs.pingcap.com/tidb-in-kubernetes/dev/upgrade-a-tidb-cluster#force-an-upgrade-of-tidb-cluster-using-tidbcluster-cr when you have to recover from the debug mode. So to stop multiple components, the order should be:

To recover:

KanShiori commented 2 years ago

It's unsupported to stop the components temporarily by debug mode, so just add a tip to stop a Pod temporarily.