Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added tiup cluster template --local #1404

Merged
merged 2 commits into from
Jun 7, 2021

Conversation

kolbe
Copy link
Contributor

@kolbe kolbe commented Jun 3, 2021

What problem does this PR solve?

Fixes #1403

What is changed and how it works?

Adds a new local.yaml topology file and tiup cluster template --local option to print a template that will deploy a cluster entirely to the local machine.

Check List

Tests

  • Manual test (add detailed scripts or steps below)
    I used the template output file to successfully deploy a cluster.

Code changes

n/a

Side effects

n/a

Related changes

  • Need to cherry-pick to the release branch
  • Need to update the documentation

https://docs.pingcap.com/tidb/stable/tiup-component-cluster-template should be updated to describe the existence of this new type of template.

Release notes:

Add a new `--local` option to `tiup cluster template`. This prints a simple topology template that will deploy a very basic cluster, with one instance of each component, to the user's local machine.

@ti-chi-bot ti-chi-bot requested review from july2993 and lucklove June 3, 2021 22:02
@ti-chi-bot ti-chi-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jun 3, 2021
@ti-chi-bot
Copy link
Member

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • AstroProfundis

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Jun 4, 2021
@AstroProfundis AstroProfundis added category/usability Categorizes issue or PR as a usability enhancement. component/cluster Issues about the tiup-cluster component labels Jun 4, 2021
@AstroProfundis AstroProfundis added this to the v1.5.0 milestone Jun 4, 2021
@codecov-commenter
Copy link

codecov-commenter commented Jun 4, 2021

Codecov Report

Merging #1404 (a16659f) into master (3c716a3) will increase coverage by 10.42%.
The diff coverage is 8.33%.

❗ Current head a16659f differs from pull request most recent head 3d999a1. Consider uploading reports for the commit 3d999a1 to get more accurate results
Impacted file tree graph

@@             Coverage Diff             @@
##           master    #1404       +/-   ##
===========================================
+ Coverage   25.33%   35.76%   +10.42%     
===========================================
  Files         266      226       -40     
  Lines       20611    17838     -2773     
===========================================
+ Hits         5222     6379     +1157     
+ Misses      14586    10317     -4269     
- Partials      803     1142      +339     
Flag Coverage Δ
cluster 35.76% <8.33%> (?)
integrate 35.76% <8.33%> (+20.26%) ⬆️
tiup ?
unittest ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
components/cluster/command/template.go 25.00% <8.33%> (-5.00%) ⬇️
pkg/utils/regexp.go 0.00% <0.00%> (-100.00%) ⬇️
pkg/repository/store/store.go 0.00% <0.00%> (-100.00%) ⬇️
pkg/repository/utils/hash.go 0.00% <0.00%> (-81.82%) ⬇️
pkg/meta/err.go 0.00% <0.00%> (-81.25%) ⬇️
pkg/utils/semver.go 5.21% <0.00%> (-80.00%) ⬇️
pkg/cluster/api/error.go 0.00% <0.00%> (-80.00%) ⬇️
pkg/telemetry/telemetry.go 0.00% <0.00%> (-80.00%) ⬇️
pkg/repository/store/local.go 0.00% <0.00%> (-76.48%) ⬇️
pkg/telemetry/node_info.go 0.00% <0.00%> (-73.34%) ⬇️
... and 240 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3c716a3...3d999a1. Read the comment docs.

@AstroProfundis
Copy link
Contributor

/merge

@ti-chi-bot
Copy link
Member

This pull request has been accepted and is ready to merge.

Commit hash: 3d999a1

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Jun 7, 2021
@ti-chi-bot ti-chi-bot merged commit 1139f5d into pingcap:master Jun 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category/usability Categorizes issue or PR as a usability enhancement. component/cluster Issues about the tiup-cluster component size/M Denotes a PR that changes 30-99 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT1 Indicates that a PR has LGTM 1.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add tiup cluster template --local option
4 participants