Uploaded image for project: 'OpenShift Container Platform (OCP) Strategy'
  1. OpenShift Container Platform (OCP) Strategy
  2. OCPSTRAT-443

[Phase 1 MVP/Tech Preview] OLM 1.0 - Extension Installation (F7)

    XMLWordPrintable

Details

    • False
    • Hide

      None

      Show
      None
    • False
    • OCPSTRAT-27Operators and Operator Lifecycle Management and Operator Hub
    • 74
    • 74% 74%
    • 0
    • 0
    • Program Call

    Description

      Feature Overview

      • Note: This feature is aimed to track the progress of Phase 1 MVP scope for the OLM 1.0
        • i.e., "IsMVP: YES" in the table of Functional Requirements.
        • Specifically, the Installation in 4.14 release does not support "evaluating constraints before the installation":
          OCPBU-108 OLM 1.0 - Installation and Update preflight checks (F6)

       

      • OLM 1.0 needs a declarative way to install extensions either from a catalog of extensions or directly from an OCI image.
      • Should the installation attempt fail due to unfilled requirements, constraints, preflight checks or dependencies there needs to be an option to force the install.
      • Extensions are cluster-wide singletons, thus they can only be installed once in the cluster and are managed at cluster-scope.

      Goals

      • Simplify the process and interaction points for users of OLM 1.0 to install a specific version extension down to a single, declarative API call at the cluster level
      • Provide a GitOps- and automation-friendly way to install extensions on a cluster
      • Retain the ability to install extensions from catalogs of extensions known as catalogs (OCPBU-107 OLM 1.0 - Extension Catalogs (F1))
      • Provide the ability for accelerated inner loops for extension developers by allowing them to install an extension from a standalone bundle as part in the form of an OCI image as opposed to a catalog

      Requirements

       

      Requirement Notes isMvp?
      Installation of extensions needs to be possible with a single declarative API call   YES
      Failed installations should not leave resources behind beyond the object representing the cluster-scoped extension that was attempted to be installed   YES
      The version and release channel that the extension should be installed from need to be specified   YES
      The absence of the desired version is interpreted as the latest version   YES
      Installations should be processed independently of the update policy of the extension require no additional approval to install an extension with update policy set to manual
      “Update policy” is blocked on progress in OCPBU-614      		 YES NO
      Absence of the desired channel is interpreted as the default channel “default channel” (or the entire default channel concept) is blocked on progress in OCPBU-614 YES
      NO
      Installation requests can be made against catalogs as well as in the form of a single bundle image (Operator API currently only supports dereferencing from catalogs. Currently rukpak would need to be used directly to install a single bundle image) YES
      NO
      Constraints need to be evaluated before the installation is attempted OCPBU-108 OLM 1.0 - Installation and Update preflight checks (F6) YES
      NO
      CI - MUST be running successfully with test automation This is a requirement for ALL features. YES
      Release Technical Enablement Provide necessary release enablement details and documents. YES

      Use Cases

      Main use case:

      • A cluster-admin installs an extension by referencing an entry from a catalog by specifying catalog name, extension name and optionally name of the release channel and desired version
        • Note: (specifying a catalog is currently not supported; the requirement that a catalog must be specified in the Operator API needs further discussion)
      • A cluster admin installs an extension by referencing an OCI image containing a single bundle, specifying a name, channel and desired version is not required

      Definition of Done / Acceptance criteria

      • all use cases discussed above are implemented
      • all requirements marked as MVP are met
      • custom controllers and CRDs (colloquially called operators) should be capable of being installed on the cluster

      Background, and strategic fit

      This is part of a larger effort to re-design vital parts of the OLM APIs and conceptual models to fit the use case of OLM in managed service environments, GitOps-controlled infrastructure and restrictive self-managed deployments in Enterprise environments. You can learn more about it here: https://docs.google.com/document/d/1LX4dJMbSmuIMn98tCiBaONmTunWR6zdUJuH-8uZ8Cno/edit?usp=sharing

      Assumptions

      • Extensions are handled at the cluster scope level

      Documentation Considerations

      • A user needs to understand how to leverage this functionality in order to add extensions at the cluster level
      • The concept of Kubernetes RBAC and its effect on privilege escalation through OLM needs to be explained to the user

       
       
       

       

      Attachments

        Issue Links

          blocks

          Feature - Capability or a well-defined set of functionality that delivers business value. Features can include additions or changes to existing functionality. Features can easily span multiple teams, and potentially multiple releases. OCPSTRAT-199 [Phase 1 MVP/Tech Preview] OLM 1.0 - Cluster-level Operator API (B1)

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed
          depends on

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. OPRUN-2770 [upstream] Deppy/Operator API Integration

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Dev Complete
          is related to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. OPRUN-2369 Custom semantic of namespace manifests

          • Undefined - Priority not specified.
          • To Do

          Feature - Capability or a well-defined set of functionality that delivers business value. Features can include additions or changes to existing functionality. Features can easily span multiple teams, and potentially multiple releases. OCPSTRAT-192 OLM 1.0 - Installation and Update preflight checks (F6)

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Refinement
          split from

          Feature - Capability or a well-defined set of functionality that delivers business value. Features can include additions or changes to existing functionality. Features can easily span multiple teams, and potentially multiple releases. OCPSTRAT-815 [PRD scope] OLM 1.0 - Extension Installation (F7)

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • New

          Feature - Capability or a well-defined set of functionality that delivers business value. Features can include additions or changes to existing functionality. Features can easily span multiple teams, and potentially multiple releases. OCPSTRAT-602 [Phase 2 MVP/Tech Preview] OLM 1.0 - Extension Installation (F7)

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed
          links to

          Web Link Technical Enablement slides

          Activity

            People

              DanielMesser Daniel Messer
              DanielMesser Daniel Messer
              Jian Zhang Jian Zhang
              Matthew Werner Matthew Werner
              Joe Lanford Joe Lanford
              Senthamilarasu S Senthamilarasu S
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: