pingcap / pingcap/docs-tidb-operator

Why is the tkctl tool deprecated?

Open
#1,030 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

lifecycle/frozen
Dominant language
Python
Stars
52
Forks
129
Avg merge
12m
Merged PRs (30d)
2

Description

Question

Hi, I have deployed a TiDB cluster in K8S. During the deployment process, I found following difficulties in using the bare kubectl commands.

  1. context settings: There will be numerous pods in a Kubernetes cluster if the number of nodes is huge. To get the information of a pod in a specific TiDB cluster, I need to use -n xxx every time(or there will be lots of other pods managing dns or kube-system). Even though, there are still other components and the discovery pod in the result. If there is a tool helping me set the context, the commands to get components(tidb,pd and tikv) will be a lot easier to use)
  2. pv management: Managing local pvs with bare kubectl commands is the real disaster. When I want to know the corresponding relations between pvs and nodes, and pvs' paths on nodes, I need to use many describe commands and locate the information among irregular words and numbers.
  3. debug & ctop: I've read the docs of the deprecated tkctl. The docs about debug function is kind of opaque, I'm not sure the exact function of them(but I think it was probably useful). Besides, I think combining the information provided by ctop and spec.resources will largely help the management of mem and cpu resource on nodes.

I think problems I mentioned above can be easily solved with a tool like tkctl(and the cost won't be so high).
Therefore, I want to know is there just not enough people and resource to maintain the tkctl? Or are there some better tools or solutions to the difficulties?(I don't think using bare tkctl commands is a better choice)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the deprecated tkctl documentation referenced in the issue and review the described Kubernetes context, local PV, debug, and resource-management workflows. The issue does not name files or tests; a useful outcome would need to explain the deprecation and identify supported alternatives or document the relevant limitations.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
cli, devops, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.