Feature Overview (aka. Goal Summary)  

Users can get information about what updates are available for their cluster extensions, including previewing details of what changes would occur when the update is applied.

Goals (aka. expected user outcomes)

• Users can discover/learn new cluster extension versions that respect the vendor-supplied update path and update channel via the top-level API without checking the catalog.

• Users can preview the details of the changes in the newer version without making any changes to the currently installed extension in the cluster.

• This gives users better control over the pace of updates: in addition to easy-to-use automatic updates, they can opt for manual processes with more due diligence.

Requirements (aka. Acceptance Criteria):

• For a given operator, a user can see a list of possible versions to which the operator can be upgraded.
  • Filter: show all updates in a z stream
  • Filter: by channel
  • If the user has specified a specific channel for their operator, only show available updates from that channel by default; but, you can opt to show updates from all/other channels

• A user can preview and inspect manifests from an available update for an operator without making any changes to the operator in the cluster.

• After seeing the set of available versions and previewing/inspecting the manifests, a user can select one of those versions (or a range of those versions) to upgrade to and direct the system to proceed.

Anyone reviewing this Feature needs to know which deployment configurations that the Feature will apply to (or not) once it's been completed.  Describe specific needs (or indicate N/A) for each of the following deployment scenarios. For specific configurations that are out-of-scope for a given release, ensure you provide the OCPSTRAT (for the future to be supported configuration) as well.

Use Cases (Optional):

Include use case diagrams, main success scenarios, alternative flow scenarios.  Initial completion during Refinement status.

Example scenario:

1. You ask OLM to install cert-manager 1.1.x and indicate you don’t want OLM to perform any automatic updates
2. OLM resolves 1.1.x to 1.1.5 and installs it
3. Time passes, 1.1.6 and 1.1.7 are released, as well as potentially various 1.2.x, 1.3.x, etc.
4. You ask what available updates exist for your installed cert-manager operator
5. You see 1.1.6, 1.1.7, 1.2.0, etc.
6. You ask to preview the changes for 1.1.7
7. You are happy with the previewed changes

You ask OLM to update cert-manager to 1.1.7

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

High-level list of items that are out of scope.  Initial completion during Refinement status.

<your text here>

Background

In OLM 1.0, there is currently no easy way for a user to see what updates are available for a given cluster extension and no tooling for previewing an update before installing it.

We want to provide a list of possible updates to the users. This will make it easier to discover new cluster extension versions that respect the vendor-supplied update path.

Users will get a simplified way to perform manual upgrades from one specific version to another due to eliminating the need to browse content catalogs available on the cluster in search of the next version.

All of the above gives users better control over the pace of updates: in addition to easy-to-use automatic updates, they can opt for manual processes with more due diligence.

Upstream engineering brief: https://docs.google.com/document/d/1BED6MBhBthFrXxb0QEc10dYVBg9n8gubVGD3Bwg3w4Y/edit?usp=sharing

Customer Considerations

Provide any additional customer-specific considerations that must be made when designing and delivering 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>