odo catalog describe service doesn't work if provided with just top level operator type

kadel commented 3 years ago

/kind bug

What versions of software are you using?

Operating System:

Output of odo version:

How did you run odo exactly?

Sevice exists I can see it in catalog, but it fails to describe it

▶ odo catalog list services
Services available through Operators
NAME                                CRDs
rhsso-operator.7.4.7                Keycloak, KeycloakRealm, KeycloakBackup, KeycloakClient, KeycloakUser
service-binding-operator.v0.7.1     ServiceBinding

▶ odo catalog describe service rhsso-operator.7.4.7
 ✗  unable to search classes by name (clusterserviceclasses.servicecatalog.k8s.io is forbidden: User "developer" cannot list resource "clusterserviceclasses" in API group "servicecatalog.k8s.io" at the cluster scope)

Actual behavior

▶ odo catalog describe service rhsso-operator.7.4.7
 ✗  unable to search classes by name (clusterserviceclasses.servicecatalog.k8s.io is forbidden: User "developer" cannot list resource "clusterserviceclasses" in API group "servicecatalog.k8s.io" at the cluster scope)

Expected behavior

I should be able to see some details about the operator service

▶ odo catalog describe service rhsso-operator.7.4.7

Name: Red Hat Single Sign-On Operator

Description:
A Kubernetes Operator based on the Operator SDK for installing and managing Red Hat Single Sign-On.

Red Hat Single Sign-On lets you add authentication to applications and secure services with minimum fuss. No need to deal with storing users or authenticating users. It's all available out of the box.

The operator can deploy and manage Keycloak instances on Kubernetes and OpenShift. The following features are supported:

Install Keycloak to a namespace
Import Keycloak Realms
Import Keycloak Clients
Import Keycloak Users
Create scheduled backups of the database

CRDs:
Name            Description
Keycloak        Represents a Red Hat Single Sign-On Instance
KeycloakRealm   Represents a Red Hat Single Sign-On Realm
KeycloakBackup  Represents a Red Hat Single Sign-On Backup
KeycloakClient  Represents a Red Hat Single Sign-On Client
KeycloakUser    Represents a Red Hat Single Sign-On User

For detailed information run 'odo catalog describe service rhsso-operator.7.4.7/<CRD-name>'

I would also expect the same information, but in json format

▶ odo catalog describe service rhsso-operator.7.4.7 -o json

above information is taken from oc get csv rhsso-operator.7.4.7 -o yaml

Any logs, error output, etc?

/kind bug /area service /area service-operators /priority high

dharmit commented 3 years ago

IMO, this is a feature and not a bug. We didn't scope/think of this when implementing.

Besides that, for Operator backed services we expect the users to provide <operator-name>/<cr-name> instead of just <operator-name>. That's our basis for differentiating if user wants details about Operator backed service or Service Catalog backed service.

PTAL https://github.com/openshift/odo/issues/2615#issuecomment-829145664.

Moreover, I don't think this should be high priority; medium at best, because odo catalog describe service -h clearly states that a user should provide <operator>/<cr-name> for Operator backed service.

kadel commented 3 years ago

Moreover, I don't think this should be high priority; medium at best, because odo catalog describe service -h clearly states that a user should provide <operator>/<cr-name> for Operator backed service.

This is really confusing for the user. I think that if someone runs odo catalog describe service with the argument that matches the operator name it should show a description and list of CRDs..

IMO, this is a feature and not a bug. We didn't scope/think of this when implementing.

ok, maybe overacted to this. But I still feel that this should be relatively high priority as the is a big usability problem.

/remove-kind bug /kind feature

girishramnani commented 3 years ago

I can work on this, can we finalise the json output as well @kadel

girishramnani commented 3 years ago

renamed the title to match the feature

girishramnani commented 3 years ago

should we add this to milestone 2.3 @dharmit ?

dharmit commented 3 years ago

should we add this to milestone 2.3 @dharmit ?

IMO, no. We should pick this up in 2.4 IMO.

kadel commented 3 years ago

I can work on this, can we finalise the json output as well @kadel

feel free to start with initial proposal of how the output could look like

valaparthvi commented 3 years ago

We need to fix the odo catalog service describe <operator>/<cr_name> output as well. It is not at all readable.

valaparthvi commented 3 years ago

{
        "kind":       "ClusterServiceVersion",
        "apiVersion": "operators.coreos.com/v1alpha1",
        "metadata": {
            "name": "redis-operator.v0.8.0",
        },
        "spec": {
            "displayName": "Redis Operator",
            "description": "A Golang based redis operator that will make/oversee Redis\nstandalone/cluster mode setup on top of the Kubernetes. It can create a\nredis cluster setup with best practices on Cloud as well as the Bare metal\nenvironment. Also, it provides an in-built monitoring capability using\nredis-exporter.\n\n### Supported Features\n\nHere the features which are supported by this operator:-\n- Redis cluster/standalone mode setup\n- Redis cluster failover and recovery\n- Inbuilt monitoring with prometheus exporter\n- Dynamic storage provisioning with pvc template\n- Resources restrictions with k8s requests and limits\n- Password/Password-less setup\n- External configuration support for leader and follower\n- Node selector and affinity for follower and leader\n- Priority class to manage setup priority\n- SecurityContext to manipulate kernel parameters\n\n### Documentation\n\n[Documentation](https://ot-container-kit.github.io/redis-operator/)\n\n### Getting Help\nThis project is managed by OpsTree Solutions. If you have any queries or\nsuggestions, mail us at opensource@opstree.com.\n\n### Contributing\n\nYou can contribute to this project by:-\n- Raising Bugs and Feature Requests\n- Fixing issue by opening a Pull Request\n- Improving Documentation\n\n### License\n\nLogging Operator is licensed under [Apache License, Version\n2.0](https://github.com/OT-CONTAINER-KIT/redis-operator/blob/master/LICENSE)\n",
            "customresourcedefinitions": [
                {
                    "displayName": "RedisCluster",
                    "description": "Redis Cluster",
                },
                {
                    "displayName": "Redis",
                    "description": "Redis",
                },
            ],
        },
    }

valaparthvi commented 3 years ago

Acceptance Criteria:

- [ ] odo catalog service describe <operator_name> should work.
- [ ] odo catalog service describe <operator_name> -o json should work.
- [ ] Add integration tests.
- [ ] Add unit tests.
- [ ] Add documentation to Command Reference > odo catalog describe service
- [ ] Add documentation to Command REference > JSON Output

The JSON output can look similar to the Human Readable Output, example -

➜  ~ odo catalog describe service redis-operator.v0.8.0 -o json
{
    "kind": "OperatorCatalogService",
    "apiVersion": "odo.dev/v1alpha1",
    "metadata": {
        "name": "redis-operator.v0.8.0",
        "creationTimestamp": null
    },
    "spec": {
        "displayName": "Redis Operator",
        "description": "A Golang based redis operator that will make/oversee Redis\nstandalone/cluster mode setup on top of the Kubernetes. It can create a\nredis cluster setup with best practices on Cloud as well as the Bare metal\nenvironment. Also, it provides an in-built monitoring capability using\nredis-exporter.\n\n### Supported Features\n\nHere the features which are supported by this operator:-\n- Redis cluster/standalone mode setup\n- Redis cluster failover and recovery\n- Inbuilt monitoring with prometheus exporter\n- Dynamic storage provisioning with pvc template\n- Resources restrictions with k8s requests and limits\n- Password/Password-less setup\n- External configuration support for leader and follower\n- Node selector and affinity for follower and leader\n- Priority class to manage setup priority\n- SecurityContext to manipulate kernel parameters\n\n### Documentation\n\n[Documentation](https://ot-container-kit.github.io/redis-operator/)\n\n### Getting Help\nThis project is managed by OpsTree Solutions. If you have any queries or\nsuggestions, mail us at opensource@opstree.com.\n\n### Contributing\n\nYou can contribute to this project by:-\n- Raising Bugs and Feature Requests\n- Fixing issue by opening a Pull Request\n- Improving Documentation\n\n### License\n\nLogging Operator is licensed under [Apache License, Version\n2.0](https://github.com/OT-CONTAINER-KIT/redis-operator/blob/master/LICENSE)\n",
        "crds": [
            {
                "Kind": "RedisCluster",
                "Description": "Redis Cluster"
            },
            {
                "Kind": "Redis",
                "Description": "Redis"
            }
        ]
    }
}

➜  ~ odo catalog describe service redis-operator.v0.8.0      
Name:redis-operator.v0.8.0
Description:A Golang based redis operator that will make/oversee Redis
standalone/cluster mode setup on top of the Kubernetes. It can create a
redis cluster setup with best practices on Cloud as well as the Bare metal
environment. Also, it provides an in-built monitoring capability using
redis-exporter.

### Supported Features

Here the features which are supported by this operator:-
- Redis cluster/standalone mode setup
- Redis cluster failover and recovery
- Inbuilt monitoring with prometheus exporter
- Dynamic storage provisioning with pvc template
- Resources restrictions with k8s requests and limits
- Password/Password-less setup
- External configuration support for leader and follower
- Node selector and affinity for follower and leader
- Priority class to manage setup priority
- SecurityContext to manipulate kernel parameters

### Documentation

[Documentation](https://ot-container-kit.github.io/redis-operator/)

### Getting Help
This project is managed by OpsTree Solutions. If you have any queries or
suggestions, mail us at opensource@opstree.com.

### Contributing

You can contribute to this project by:-
- Raising Bugs and Feature Requests
- Fixing issue by opening a Pull Request
- Improving Documentation

### License

Logging Operator is licensed under [Apache License, Version
2.0](https://github.com/OT-CONTAINER-KIT/redis-operator/blob/master/LICENSE)

CRDs:
Name                Description
RedisCluster    Redis Cluster
Redis                   Redis

There are existing structs such as CRDDescriptionRepr that can be used. I have created a POC that showcases potential changes that needs to be done - https://github.com/openshift/odo/compare/main...valaparthvi:catservdesci?expand=1