pingcap / pingcap/tiup

show the download speed and progress at download step when deploy a cluster using tiup-cluster

Open
#684 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

category/usability help wanted 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:

when deploy a cluster, run tiup cluster deploy tidb-test v4.0.0 ./topology.yaml ref: https://docs.pingcap.com/tidb/stable/production-deployment-using-tiup#step-4-execute-the-deployment-command

It may take a long time to download components while deploy a cluster
Screen Shot 2020-08-15 at 11 16 44 AM

user can not know the speed and progress.

Mainly need to update the code at:
https://github.com/pingcap/tiup/blob/3988f6f0adef7303b63b7bee1994352e145a941c/pkg/cluster/task/download.go#L53

Describe the feature you'd like:

show download speed and progress
may be useful: https://github.com/vbauerster/mpb

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 in pkg/cluster/task/download.go at the referenced download code and trace how component downloads are reported during tiup cluster deploy. Review the suggested mpb library for progress and speed display. Done means the download step visibly reports both progress and download speed to the user.

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.