Introduction

The POC Guide is a set of hands-on guides for TiDB. Its goal is to guide users through step-by-step instructions to familiarize themselves with the basic operations of TiDB and experience many aspects of daily maintenance of TiDB cluster.

The guide consists of multiple articles, each of which is dedicated to a specific topic. For the smoothness of the overall experience, separate articles are intrinsically connected. Therefore, we suggest that users operate sequentially through the guide in article order. Some of these articles are marked as Optional, meaning that the content of these chapters is unnecessary for some useres and can be skipped without affecting subsequent chapters.

For the sake of repeatability, we use fixed TiDB version, fixed tidb-operator version, and fixed tools versions in the process of composing this guide. The user should confirm that they use matching when testing. For the same reason, the only supported deployment platform for this guide is EKS on AWS.

The guide contains many verify and troubleshooting sections. The former is usually some commands used to verify whether the previous operation is successfully executed, and the latter is a list of common problems and corresponding methods to resolve them. If any abnormal condition occurs and cannot be resolved by referring to troubleshooting, the easiest way is to Destroy the Kubernetes Cluster to fully clean up all resources and start over again.

If you find errors with this guide, please Submit a request.