pingcap / pingcap/docs

TiDB on kind failing to start if following the docs

Open
#8,750 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/tidb-in-k8s-v1.0
Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 10h
Merged PRs (30d)
223

Description

Error Report

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

  1. What is the URL/path of the document related to this issue?
    https://docs.pingcap.com/tidb-in-kubernetes/v1.0/deploy-tidb-from-kubernetes-kind

  2. How would you like to improve it?
    The current value of hack/kind-cluster-build.sh script on item #2 is no longer valid for kind kind version 0.14.0

I'd suggest replacing by apiVersion: kind.x-k8s.io/v1alpha4, perhaps I should open a ticket on tidb operator?

Contributor guide

Open the contributing guide

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

Open the linked deploy-tidb-from-kubernetes-kind documentation and inspect item #2, especially the referenced hack/kind-cluster-build.sh script value. Compare the documented apiVersion with kind 0.14.0, then update the documentation so the kind deployment instructions work as described.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.