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

odo describe component #5661

Closed
4 tasks
Tracked by #5522
kadel opened this issue Apr 13, 2022 · 1 comment · Fixed by #5725
Closed
4 tasks
Tracked by #5522

odo describe component #5661

kadel opened this issue Apr 13, 2022 · 1 comment · Fixed by #5725
Assignees
Labels
kind/user-story An issue of user-story kind

Comments

@kadel
Copy link
Member

kadel commented Apr 13, 2022

/kind user-story

User Story

  • As an odo user
  • I want to be able to get detailed information about my component
  • So that
    • I know what commands/odo features are supported by given devfile
    • I know what are the parts that my application (devfile) is composed of

Acceptance Criteria

  • when user executes the odo describe component it should display detailed information about the devfile.yaml in the current directory
  • when user executed the odo describe component with --name flag it should display detailed information about the component existing on the cluster. Note that in this case the information is not extracted from devfile, but rather from Kubernetes resources. Some information might not be available (like supported odo features), in this case it should show unknown
  • --namespace is optional and can be used only with --name flag
  • forwarded ports are displayed only when odo dev is currently running. the format is <local-address>:<local-port> -> <container-name>:<container-port> this request to implement odo dev - should store information about currently forwarded ports. #5676 first

/kind user-story

Json output for this command is part of #5660

example

$ odo describe component

Name: python
Display name: Python
Project Type: python
Language: python
Version: 1.0.0
Description: Python Stack with Python 3.7
Tags: Python, pip

Running in: Dev,Deploy

Forwarded ports:
   - localhost:40001 -> py-web:8080 

Supported odo features:
  - dev: true
  - deploy: false
  - debug: true

Container components:
 - py-web

Kubernetes components:
  - binding-mysql
$ odo describe component --name myspring

Name: myspring
Display name: 
Project Type: springboot
Language: java
Version: 1.0.0
Description: unknown
Tags: unknown

Supported odo features:
  - dev: unknown
  - deploy: unknown
  - debug: unknown

Running in: Dev,Deploy

Container components: unknown

Kubernetes components: unknown
@kadel kadel added the triage/needs-information Indicates an issue needs more information in order to work on it. label Apr 13, 2022
@kadel kadel added this to the v3.0.0-beta1 milestone Apr 19, 2022
@kadel kadel added kind/user-story An issue of user-story kind and removed triage/needs-information Indicates an issue needs more information in order to work on it. labels Apr 19, 2022
@kadel kadel moved this to Todo in odo v3-beta1 Apr 27, 2022
@feloy
Copy link
Contributor

feloy commented Apr 27, 2022

In both situtation (with or without name), where are "Container components" and "Kubernetes components" coming from?

For the command without name (and with devfile), this info can come from the devfile content.

But for the command with name (and without devfile), we cannot get this info from devfile. In think that we could gather this information from the cluster, but in this case, where do we want to store this information in the JSON output?

@kadel kadel mentioned this issue May 5, 2022
20 tasks
@feloy feloy moved this from Todo to In Progress in odo v3-beta1 May 6, 2022
@feloy feloy moved this from In Progress to For Review in odo v3-beta1 May 11, 2022
Repository owner moved this from For Review to Done in odo v3-beta1 May 12, 2022
@rm3l rm3l added the v3 label Oct 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/user-story An issue of user-story kind
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants