Skip to content

Optional error description field to show the error custom error message when an operator installation fails #1814

Open
@sruthakeerthikotla

Description

@sruthakeerthikotla

Feature Request

Is your feature request related to a problem? Please describe.
We have an operator that depends on an another operator from a different catalog source. In a scenario where the other catalog source is not installed, the operator installation is stuck in an "Upgrade Pending" state without any clue on why the operator installation is not being completed

Describe the solution you'd like
It would be nice to give an optional field in the CSV to provide a custom error message at different important steps in the installation process that could be displayed to the end user like in the picture below. As an example in our scenario, the required CRD definition in the CSV could have a field for the error description like :

 customresourcedefinitions:
    owned:
    - description: my CRD is amazing
      displayName: mycrd
      kind: sample
      name: crdsample
      version: v1
      errorDescription: Installation of myCRD failed. Verify that you have installed catalog source X.

And if at this point the installation fails, the content of the "errorDescription" can be shown like in the picture below or at least logged as an event that shows up in the cluster "Events".

Screenshot 2020-10-15

Metadata

Metadata

Assignees

No one assigned

    Labels

    triage/unresolvedIndicates an issue that can not or will not be resolved.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions