tidb-onebox

Deploy and manage TiDB-X clusters on AWS EKS with Terraform and Kubernetes.

Updated Jun 3, 2026
One-click install
npx skills add https://github.com/alex-quan-001/nutshell-skills --skill tidb-onebox
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: tidb-onebox
Source: https://github.com/alex-quan-001/nutshell-skills/tree/main/skills/ops/tidb-onebox
Command: npx skills add https://github.com/alex-quan-001/nutshell-skills --skill tidb-onebox

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pymysql, rich.

What problem does it solve?

Manually provisioning and managing TiDB-X development and test clusters on AWS EKS requires coordinating Terraform, AWS IAM, Kubernetes, and TiDB-specific configurations, which is time-consuming, error-prone, and difficult to reproduce across team members.

Core Features & Use Cases

  • End-to-end cluster lifecycle management: Deploy, validate, scale, pause/resume, and destroy TiDB-X dev environments with a single Python script that wraps all Terraform and Kubernetes operations.
  • Automated failure remediation: Handles common teardown blockers like S3 bucket locks, classic ELB remnants, Helm release timeouts, and stuck Kubernetes finalizers without manual intervention.
  • Use case: Development and QA teams can spin up isolated TiDB-X test environments in minutes for SQL validation, performance testing, and feature development, then tear them down cleanly to avoid unnecessary cloud costs.

Quick Start

Use the tidb-onebox skill to deploy a fully configured TiDB-X development cluster on AWS EKS, run health checks and SQL pushdown verification tests, and safely destroy the environment when you are finished.

Frequently Asked Questions about tidb-onebox

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate TiDB cluster deployment on AWS EKS using Terraform?

Automating TiDB cluster deployment on AWS EKS involves wrapping Terraform and Kubernetes operations into a single script to handle provisioning and configuration. This eliminates manual infrastructure setup and configuration drift.

What is the best way to manage TiDB development environments for SQL pushdown validation?

Managing TiDB development environments for SQL pushdown validation requires reproducible clusters on AWS EKS. Automating the lifecycle ensures isolated test environments are spun up quickly and torn down cleanly to avoid cloud costs.

How do I resolve stuck Kubernetes finalizers and Helm release timeouts when destroying TiDB clusters?

Resolving stuck Kubernetes finalizers and Helm release timeouts during TiDB cluster teardown requires automated failure remediation. This handles common blockers like S3 bucket locks and classic ELB remnants without manual intervention.

Can I pause and resume AWS EKS TiDB test clusters to save cloud costs?

You can pause and resume AWS EKS TiDB test clusters to save cloud costs through end-to-end cluster lifecycle management. This supports runtime scaling and health validation for development workflows.

Does the automated TiDB EKS deployment handle classic ELB remnants and S3 bucket locks?

Automated TiDB EKS deployment handles classic ELB remnants and S3 bucket locks through built-in failure remediation. It removes common teardown blockers automatically to ensure clean environment destruction.

Why does manually provisioning TiDB on Kubernetes lead to configuration drift?

Manually provisioning TiDB on Kubernetes leads to configuration drift because coordinating AWS IAM, Terraform, and Kubernetes configurations is error-prone. Automating these operations ensures reproducible environments across team members.