odo icon indicating copy to clipboard operation
odo copied to clipboard

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

Open dharmit opened this issue 5 years ago • 4 comments

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

dharmit avatar May 18 '20 11:05 dharmit

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)

jorgemoralespou avatar May 18 '20 12:05 jorgemoralespou

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-bot avatar Oct 13 '20 00:10 openshift-bot

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-bot avatar Nov 19 '20 14:11 openshift-bot

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

/remove-lifecycle rotten /lifecycle frozen

dharmit avatar Nov 25 '20 13:11 dharmit

odo catalog was removed from v3.

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

/close

kadel avatar Feb 06 '23 15:02 kadel

@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[bot] avatar Feb 06 '23 15:02 openshift-ci[bot]