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

Operator Hub outputs can be more user friendly than what they are right now #3197

Closed
Tracked by #4242
dharmit opened this issue May 18, 2020 · 6 comments
Closed
Tracked by #4242
Labels
area/refactoring Issues or PRs related to code refactoring lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. triage/needs-information Indicates an issue needs more information in order to work on it. v2 Issue or PR that applies to the v2 of odo

Comments

@dharmit
Copy link
Member

dharmit commented May 18, 2020

After looking at odo & Operator Hub integration documentation, @jorgemoralespou pointed out that outputs for Operator Hub integration are not really user friendly. For example, why do we use --crd flag to start a service? CRD is a k8s concept that we should ideally abstract that for users since that's the goal of odo.

Based on the discussion, IMO, we could change it to --service. But there's a scope for further improvement. We should change the output starting from odo catalog list services and instead of below output:

odo catalog list services                                       
Operators available in the cluster
NAME                                    CRDs
etcdoperator.v0.9.4                     EtcdCluster, EtcdBackup, EtcdRestore
mongodb-enterprise.v1.5.2               MongoDB, MongoDBUser, MongoDBOpsManager
service-binding-operator.v0.1.1-282     ServiceBindingRequest

we should consider presenting below to the user:

odo catalog list services                                       
OPERATOR NAME                           SERVICES PROVIDED
etcdoperator.v0.9.4                     EtcdCluster, EtcdBackup, EtcdRestore
mongodb-enterprise.v1.5.2               MongoDB, MongoDBUser, MongoDBOpsManager
service-binding-operator.v0.1.1-282     ServiceBindingRequest

/kind code-refactoring
/area service-operators
/area component

@jorgemoralespou
Copy link
Contributor

I would not name it "Operator Name" And "Services Provided" but something more along the lines of:
provider and services, and maybe remove the version out, as that's also implementation details. In an ideal world, services could still come from the service catalog. Maybe no longer in OpenShift, but still in k8s world.

odo catalog list services                                       
PROVIDER                         SERVICES
etcdoperator                     EtcdCluster, EtcdBackup, EtcdRestore
mongodb-enterprise               MongoDB, MongoDBUser, MongoDBOpsManager
service-binding-operator         ServiceBindingRequest

Maybe worth considering not using the CSV name but rather the api-group (e.g. etcd.database.coreos.com)

@dharmit dharmit added kind/discussion triage/needs-information Indicates an issue needs more information in order to work on it. labels May 19, 2020
@openshift-bot
Copy link

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

@openshift-ci-robot openshift-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 13, 2020
@girishramnani girishramnani added this to the Post v2.0 milestone Oct 20, 2020
@openshift-bot
Copy link

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

@openshift-ci-robot openshift-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Nov 19, 2020
@dharmit
Copy link
Member Author

dharmit commented Nov 25, 2020

This is still valid and important. Should be addressed through #4242 but needs to be kept open.

/remove-lifecycle rotten
/lifecycle frozen

@openshift-ci-robot openshift-ci-robot added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. labels Nov 25, 2020
@rm3l rm3l added this to odo Project Oct 3, 2022
@rm3l rm3l moved this to To Do 📝 in odo Project Oct 3, 2022
@rm3l rm3l removed the status in odo Project Oct 3, 2022
@rm3l rm3l removed this from the Post v2.0 milestone Oct 3, 2022
@kadel
Copy link
Member

kadel commented Feb 6, 2023

odo catalog was removed from v3.

tagging #5523 in case we decide to implement again in future

/close

@openshift-ci
Copy link

openshift-ci bot commented Feb 6, 2023

@kadel: Closing this issue.

In response to this:

odo catalog was removed from v3.

tagging #5523 in case we decide to implement again in future

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-ci openshift-ci bot closed this as completed Feb 6, 2023
@github-project-automation github-project-automation bot moved this to Done ✅ in odo Project Feb 6, 2023
@rm3l rm3l added v2 Issue or PR that applies to the v2 of odo area/refactoring Issues or PRs related to code refactoring labels Jun 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/refactoring Issues or PRs related to code refactoring lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. triage/needs-information Indicates an issue needs more information in order to work on it. v2 Issue or PR that applies to the v2 of odo
Projects
Archived in project
Development

No branches or pull requests

7 participants