【Tidb·专家必看】tkctl 使用指南

[伍六七叭酒]

tkctl (TiDB Kubernetes Control) 是为 TiDB in Kubernetes 设计的命令行工具，用于运维集群和诊断集群问题。

注意

PingCAP 从 v1.1.x 开始不再维护 tkctl，以下部分功能可能不可用，请直接使用对应的 kubectl 命令。

安装

安装 tkctl 时，可以直接下载预编译的可执行文件，也可以自行从源码进行编译。

下载预编译的可执行文件

• MacOS
• Linux
• Windows

下载解压后，将 tkctl 可执行文件加入到可执行文件路径 (PATH) 中即完成安装。

源码编译

要求：Go 版本 1.11 及以上

Copy

git clone https://github.com/pingcap/tidb-operator.git && \
GOOS=${YOUR_GOOS} make cli && \
mv tkctl /usr/local/bin/tkctl

命令自动补全

你可以配置 tkctl 的自动补全以简化使用。

为 BASH 配置自动补全（需要预先安装 bash-completion）的方法如下。

在当前 shell 中设置自动补全：

Copy

source <(tkctl completion bash)

永久设置自动补全：

Copy

echo "if hash tkctl 2>/dev/null; then source <(tkctl completion bash); fi" >> ~/.bashrc

为 ZSH 配置自动补全的方法如下。

在当前 shell 中设置自动补全：

Copy

source <(tkctl completion zsh)

永久设置自动补全：

Copy

echo "if hash tkctl 2>/dev/null; then source <(tkctl completion zsh); fi" >> ~/.zshrc

Kubernetes 配置

tkctl 复用了 kubeconfig 文件（默认位置是 ~/.kube/config）来连接 Kubernetes 集群。你可以通过下面的命令来验证 kubeconfig 是否设置正确：

Copy

tkctl version

假如上面的命令正确输出服务端的 TiDB Operator 版本，则 kubeconfig 配置正确。

·····

更多内容可见：https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/use-tkctl