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

Implement tink-cli describe command #426

Closed
gianarb opened this issue Jan 27, 2021 · 7 comments
Closed

Implement tink-cli describe command #426

gianarb opened this issue Jan 27, 2021 · 7 comments
Assignees
Labels
area/tink-cli kind/feature Categorizes issue or PR as related to a new feature. priority/backlog Higher priority than priority/awaiting-more-evidence.

Comments

@gianarb
Copy link
Contributor

gianarb commented Jan 27, 2021

As part of #425 #406, we would like to have a describe command.

Similar requirements as #425

  1. The Describe command should be only one inside a new cmd/tink-cli/command/describe package and it should follow the same structure we have for get, and I mean Options if necessary for example
  2. Tests, tests, tests

Use case

The get command can be used to quickly discover resources but describe will show a single one AND it will work as a troubleshooting tool to know everything we can about that specific resource.

It will work this way:

tink hardware|template|... describe <ID>

It accepts only one ID.

Flags (the one I can think about):

  • --format as for get will switch the format. I think we can use "human" as the default one having as alternative JSON and YAML.
  • --show-events=true: If true, display events related to the described object. (directly from kubectl)

I am gonna describe the output with something that looks like JSON only for my simplicity:

{
   "data": {}, # the actual resource
   "events": [] # list of events for that resource
}
@mazzy89
Copy link

mazzy89 commented Jan 27, 2021

I'm going to grab and work on this.

@mazzy89
Copy link

mazzy89 commented Feb 5, 2021

@gianarb how do we want to make it look like the output of a describe in the "human" format whenshow-events flag is set to True?

@gianarb
Copy link
Contributor Author

gianarb commented Feb 5, 2021 via email

@mazzy89
Copy link

mazzy89 commented Feb 5, 2021

My suggestion here is to leave behind the table format for the describe and have as "human" format same as Kubernetes does and include Events at the bottom as you said.

@gianarb
Copy link
Contributor Author

gianarb commented Feb 5, 2021

I agree 100%, avoid any use of table!!

@tstromberg tstromberg added the kind/feature Categorizes issue or PR as related to a new feature. label Jul 27, 2021
@tstromberg tstromberg added the priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. label Aug 27, 2021
@tstromberg
Copy link
Contributor

@mazzy89 - are you still working on this? I think it would be a great addition to Tinkerbell.

@mmlb mmlb added priority/backlog Higher priority than priority/awaiting-more-evidence. and removed priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. labels Feb 8, 2022
@jacobweinstock
Copy link
Member

closed by #654

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/tink-cli kind/feature Categorizes issue or PR as related to a new feature. priority/backlog Higher priority than priority/awaiting-more-evidence.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants