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

Provide the way to get list of starter projects with id/display name/description for specific component type #4129

Closed
dgolovin opened this issue Oct 21, 2020 · 5 comments
Labels
kind/feature Categorizes issue as a feature request. For PRs, that means that the PR is the implementation

Comments

@dgolovin
Copy link
Contributor

/kind feature

Which functionality do you think we should add?

odo create provides a --starter option to create component based on simple working project. --starter option also allows to use project name listed inside devfiles' starterProjects node. Considering that usually remote registry is going to be used, there is no easy way to get list of starter projects form devfile for specific component type. The only way right now is to go to remote registry's repository and look inside devfile.yaml.

There should be ether odo command to list starter projects for specific component type as a table consists of ID, Name, Display Name, Description or information about starter projects should be part of `odo catalog list components' output.

Why is this needed?

  • To speed up creating and deploying first application on Kubernetes or OpenShift
  • To improve odo integration with IDEs and allow to create IDEs specific UI to create starter projects
@openshift-ci-robot openshift-ci-robot added the kind/feature Categorizes issue as a feature request. For PRs, that means that the PR is the implementation label Oct 21, 2020
@adisky
Copy link
Contributor

adisky commented Oct 27, 2020

The only way right now is to go to remote registry's repository and look inside devfile.yaml.

@dgolovin starter projects of a component could be listed using odo catalog describe component <component-name>

$ odo catalog describe component java-quarkus
Devfile Component(s):

* Registry: DefaultDevfileRegistry

Starter Projects:
---
name: quarkus-ex
git:
  remotes:
    origin: https://github.com/odo-devfiles/quarkus-ex

Though odo catalog describe component <component-name> -o json contains whole devfile, the output could be improved.

@dgolovin
Copy link
Contributor Author

dgolovin commented Oct 27, 2020

@adisky Thank you for info 👍 That is what needed. Could it have description property with short basic info about the project?

@girishramnani girishramnani added this to For consideration in Sprint 192 via automation Oct 29, 2020
@girishramnani girishramnani moved this from For consideration to To do in Sprint 192 Oct 29, 2020
@girishramnani
Copy link
Contributor

We currently dont have any description for starter projects @dgolovin

@girishramnani girishramnani removed this from To do in Sprint 192 Oct 29, 2020
@adisky
Copy link
Contributor

adisky commented Oct 29, 2020

@dgolovin It prints the whole starter projects struct from devfile, https://github.com/odo-devfiles/registry/blob/master/devfiles/java-quarkus/devfile.yaml#L6, Its just that we do not have starter project description in odo devfile registry. We need to update the devfiles there

@dgolovin
Copy link
Contributor Author

@girishramnani @adisky Sounds like devfile does have description attribute for starter project. It just not used. That attribute only makes sense when there are more than one starter project though.

Thanks! Closing the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue as a feature request. For PRs, that means that the PR is the implementation
Projects
None yet
Development

No branches or pull requests

4 participants