Feature Overview (aka. Goal Summary)  

Note: This 4.20 ticket aims to integrate the OperatorHub UX into the new Unified Catalog view in the console, leveraging the existing OLM v0 APIs.

The goal is to create a more intuitive and centralized UX within the OpenShift console, allowing users to discover, install, and manage software offerings, including Operator packages previously available only through OperatorHub.

Goals (aka. expected user outcomes)

With the new Unified Catalog UX in the 4.20 release, users will experience a streamlined approach to discovering, evaluating, installing, and managing software packages within the OpenShift console.  Specifically, users will be able to:

• Efficiently discover offerings: Easily find all software packages through a single interface, utilizing integrated browsing, sorting, and filtering capabilities based on criteria like source, type, and features.  This now includes Operator packages previously found only in the OperatorHub

• Make informed decisions: Quickly access detailed metadata for offerings (description, requirements, APIs, etc.) to confidently evaluate suitability before installation.

• Quickly assess installed inventory: Identify and view installed offerings, including Operator packages, through consolidated lists within the Unified Catalog UI, or via dedicated installed views (for those that support Day 2 operations), enabling rapid assessment of the cluster's software state.

Requirements (aka. Acceptance Criteria):

Essentially, the result is feature parity with OperatorHub.

1. Unified Catalog: pre-installation 

• Browse all packages: As an admin, I want to see and filter all available packages from available catalogs through the Unified Catalog UI based on criteria like providers (i.e., from Red Hat or ISVs), valid subscriptions, infrastructure features, etc., so I can quickly understand and narrow down what's available for installation.

• View details of a package: As an admin, once a package is found, I can discover all channels and versions available for the offering/package, select a version from a channel, and see its detailed description, provided APIs, and other metadata before installation
  • (Note: at this phase, only metadata from the latest version is available, based on the OLM v0 API).

2. Unified Catalog: installation

• Install a package: As an admin, I want to select an operator from the desired channel with my desired version, specify configurations such as install namespace (suggested namespace) / watch namespaces, update strategy, and enabling a console dynamic plugin (if applicable), and then install it onto my OpenShift cluster.

• Installation progressing: 
  • As an admin, I want to see the operator installation process, including the installation preview for manual update approval.  
  • I also want to see more detailed messages, including error messages, for troubleshooting during the processing.  
  • If an operator author provides an initialization custom resource to enable the operator’s functionality, I can directly create that resource in the console during this flow, with the help of a custom form view and readily available example YAMLs after the installation is completed.

3. Unified Catalog: post-installation

• Browse all installed packages: As an admin, I want to see all installed packages through the Unified Catalog UI, so I can quickly assess the cluster's current state and inventory.

• View details of an installed package: As an admin, I want to select an installed package from the Unified Catalog UI and directly go to a detailed view of the installed resource page, so I can inspect and manage its configuration.

• (Tile view) View all provided APIs: As an admin/regular user, I want to select an API (i.e., operator-backed service) provided by an installed operator in a dedicated Unified Catalog UI and access a detailed view of that service, so I can learn, create, and manage its instances.

• (Side details view) View details of a provided API: As an admin/regular user, I want to see the provided API’s description and the operator description, as well as example YAMLs, so I can learn how to consume the service.

4. Installed Operators page: post-installation

• View all installed operators: As an admin/regular user, I want to see a list of installed operators, based on their corresponding CSVs, through a dedicated UI, so I can quickly find and manage them.

• View installed operator details: 
  • As an admin/regular user, I want to see a detailed view of a CSV object, showing its version, its installation catalog source, the channel spec of its associated Subscription, and all the provided APIs and their descriptions, so I can effectively manage and troubleshoot the installed version.
  • As an admin/regular user, I want to select a provided API from the Installed Operator Details UI and see its description, along with a custom form view, example YAMLs, so I can learn how to create and consume it.
  • As an admin/regular user, I want to see a list of instances of provided APIs from the Installed Operator Details UI, so I can quickly find and manage them.

• View details of a provided API: As an admin/regular user, I want to see the provided API’s spec, status, and its associated resources, so I can quickly find and manage them.

Use scenario (Optional):

Relevant docs: Unified Catalog UX: User stories for 4.20

Questions to Answer (Optional):

Include a list of refinement / architectural questions that may need to be answered before coding can begin.  Initial completion during Refinement status.

<your text here>

Out of Scope

OLM v1 APIs. 

Background

Provide any additional context is needed to frame the feature.  Initial completion during Refinement status.

<your text here>

Documentation Considerations

Provide information that needs to be considered and planned so that documentation will meet customer needs.  If the feature extends existing functionality, provide a link to its current documentation. Initial completion during Refinement status.

<your text here>

Interoperability Considerations

Which other projects, including ROSA/OSD/ARO, and versions in our portfolio does this feature impact?  What interoperability test scenarios should be factored by the layered products?  Initial completion during Refinement status.

<your text here>