odo list

[kadel]

odo list

/kind user-story

User Story

• As an odo user
• I want to be able to list all components (created by odo and other tools as well) that are running on the cluster
• So that
  • I know what I have running on the cluster

Acceptance Criteria

• odo list should list every component running in the currently active namespace (as set in KUBECONFIG
• users should be able to list components from a different namespace using --namespace flag
• The list of the component should be formatted as a table
• List of the component should mark which component from the list is the component in the current directory (if the command is executed in the directory with devfile.yaml)
• The output should have MANGAED BY column that indicates what tool is "responsible" for the component. app.kubernetes.io/managed-by label should be used to determine the tool.
• The output should have NAME column that shows the name of the component \
• The output should have RUNNING IN column that indicates in what modes the component is running. Dev means the component is running in development mode (odo dev). Deploy indicates that the component is running in deploy mode (odo deploy), None means that the component is currently not running on cluster. Unknown indicates that odo can't detect in what mode is component running. Unknown will also be used for components that are running on the cluster but are not managed by odo.
• The output should have TYPE column that corresponds to the language field in devfile.yaml tools, this should also correspond to odo.dev/project-type label.
• The listing logic, should not make any assumption about the Kubernetes Kinds for the components. The implementation should be generic enough that it doesn't really on any particular Kind. odo v2 listing has problems that it assumes that there will always be Deployment which is not correct. This is especially true for odo deploy

example

$ odo list
Components in the "mynamspace" namespace:

  NAME              TYPE         MANAGED BY       RUNNING IN
* frontend          nodejs       odo              Dev,Deploy
  backend           springboot   odo              Deploy
  created-by-odc    python       Unknown          Unknown

[cdrage]

@kadel When you describe:

PATH column is displayed only if the command was executed with --path flag. It shows the path in which the component "lives". This is relative path to a given --path.

Are you talking about this scenario?

$ odo list --path
Components in the "mynamspace" namespace:

  NAME              TYPE         MANAGED BY       RUNNING IN       PATH 
* frontend          nodejs       odo              Dev,Deploy      ~/frontend
  backend           springboot   odo              Deploy          ~/backend
  created-by-odc    python       Unknown          Unknown

Like.. is --path a boolean asking to show where everything is? Or --path more of odo list --path ~/dev/mydevfileproject/ ? So it'll list all devfile components on the cluster as well as whatever is in that folder?

[dharmit]

@kadel

NAMESPACE indicates in what namespace the component is. This is mainly intended for when user

But there's no column for namespace in the example odo list you originally created. Since odo list lists stuff based on namespace, should we have a column for it?

@cdrage

Like.. is --path a boolean asking to show where everything is? Or --path more of odo list --path ~/dev/mydevfileproject/ ? So it'll list all devfile components on the cluster as well as whatever is in that folder?

I'm pretty sure it's the latter - odo list --path ~/dev/mydevfileproject/.

[cdrage]

@kadel What do you suggest for keeping track if a deployment is in "Dev" or "Deploy" mode, perhaps a label when you deploy?

[kadel]

Originally this command had a lot more flags like --path, but as @dharmit requested I removed most of them, but I forgot to remove it from the flag description :-/, now the description should be in a better shape

[cdrage]

It has been implemented like so:

▶ odo list
NAME                  TYPE       MODE       MANAGED   URLS                        PORTS               STATUS   AGE  
digitalocean-dyndns   <unknown>  <unknown>  Helm                                                      Running  22d
duplicati             <unknown>  <unknown>  Helm      https://duplicati.k8s.land  8200                Running  42d
hass                  <unknown>  <unknown>  Helm      https://hass.k8s.land       8123                Running  22d
hostpath-provisioner  <unknown>  <unknown>  Helm                                                      Running  42d
syncthing             <unknown>  <unknown>  Helm      https://syncthing.k8s.land  21027, 22000, 8384  Running  44d

Currently I am working my way through tests to make sure that it works correctly 👍