Skip to content

cluster: add JSON output option for display#1358

Merged
ti-chi-bot merged 1 commit into
pingcap:masterfrom
dveeden:display_json
May 12, 2021
Merged

cluster: add JSON output option for display#1358
ti-chi-bot merged 1 commit into
pingcap:masterfrom
dveeden:display_json

Conversation

@dveeden
Copy link
Copy Markdown
Contributor

@dveeden dveeden commented May 11, 2021 •
edited
Loading

What problem does this PR solve?

This adds JSON output for the tiup cluster display command. This makes it easier to parse the output and use it in other programs.

#1355

What is changed and how it works?

This puts the info in a struct and uses encoding/json to format this as JSON

Check List

Tests

  • Manual test (add detailed scripts or steps below)

tiup cluster display mycluster
tiup cluster display --json mycluster

Side effects

  • Increased code complexity

Related changes

  • Need to update the documentation

Release notes:

Support JSON output for the `tiup cluster display` command

@ti-chi-bot ti-chi-bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 11, 2021
@ti-chi-bot ti-chi-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 11, 2021
@dveeden dveeden changed the title cluster: fix wrong data_dir for imported drainer instances (#1346) cluster: add JSON output option for display May 11, 2021
@dveeden dveeden force-pushed the display_json branch 2 times, most recently from 8d19108 to 5e7f8ed Compare May 11, 2021 06:53
@dveeden dveeden marked this pull request as ready for review May 11, 2021 06:54
@ti-chi-bot ti-chi-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 11, 2021
@AstroProfundis
Copy link
Copy Markdown
Contributor

AstroProfundis commented May 11, 2021 •
edited
Loading

releated to #1208

might be releated to #1172 as well

AstroProfundis
AstroProfundis reviewed May 11, 2021
View reviewed changes
Comment thread pkg/cluster/manager/display.go
@AstroProfundis AstroProfundis added this to the v1.5.0 milestone May 11, 2021
@ti-chi-bot ti-chi-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 11, 2021
AstroProfundis
AstroProfundis reviewed May 11, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@AstroProfundis AstroProfundis left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There seems to be an empty file with no filename added in the PR, and need to be removed if it's not by intend.

And the tests are failing, you may use make check and make test to run static checks and unit tests at your local environment.

Comment thread pkg/cluster/manager/display.go Outdated
TLSCACert string `json:"tls_ca_cert"`
TLSClientCert string `json:"tls_client_cert"`
TLSClientKey string `json:"tls_client_key"`
URL string `json:"url"`
Copy link
Copy Markdown
Contributor

@AstroProfundis AstroProfundis May 11, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's better be dashboard_url, as it's the URL of our builtin dashboard in PD, we may have other URLs or links to something else. (there is no such thing as a general "URL" for a TiDB cluster)

@ti-chi-bot
Copy link
Copy Markdown
Member

ti-chi-bot commented May 12, 2021

[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.

Details

Reviewer can indicate their review by writing /lgtm in a comment.
Reviewer can cancel approval by writing /lgtm cancel in a comment.

@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label May 12, 2021
@AstroProfundis
Copy link
Copy Markdown
Contributor

AstroProfundis commented May 12, 2021

/merge

@ti-chi-bot
Copy link
Copy Markdown
Member

ti-chi-bot commented May 12, 2021

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

DetailsCommit hash: 42ee4cf

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label May 12, 2021
@ti-chi-bot ti-chi-bot merged commit 5abe200 into pingcap:master May 12, 2021
@dveeden dveeden mentioned this pull request May 12, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lucklove lucklove Awaiting requested review from lucklove

1 more reviewer

@AstroProfundis AstroProfundis AstroProfundis approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

size/L Denotes a PR that changes 100-499 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

Milestone

v1.5.0

Development

Successfully merging this pull request may close these issues.

3 participants

@dveeden @AstroProfundis @ti-chi-bot