pingcap / pingcap/tiup

Improve command `tiup cluster display` for TiKV cluster

Open
#1,410 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type/feature-request
Dominant language
Go
Stars
466
Forks
338
Avg merge
3d 7h
Merged PRs (30d)
8

Description

Feature Request

Is your feature request related to a problem? Please describe:

I deploy a TiKV cluster with pd and tikv (without tidb) using TiUP.

When I run the command tiup cluster display test_tikv, output is as follows:

Starting component `cluster`: /root/.tiup/components/cluster/v1.4.4/tiup-cluster display test_tikv
Cluster type:       tidb
Cluster name:       test_tikv
Cluster version:    v5.0.1
SSH type:           builtin
Dashboard URL:      http://172.16.5.82:4588/dashboard

Describe the feature you'd like:

Cluster type should be tikv instead of tidb.
Dashboard URL should not be displayed, because it's not for TiKV.

Why the featue is needed:

Describe alternatives you've considered:

Teachability, Documentation, Adoption, Migration Strategy:

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

Start at the tiup cluster display command and reproduce the output for a TiKV cluster containing only pd and tikv. Trace how the cluster type and dashboard URL are selected; done means reporting tikv as the type and omitting the dashboard URL, with tests covering this output.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.