Uploaded image for project: 'Operator Ecosystem'
  1. Operator Ecosystem
  2. OPECO-3008

[Catalogd] Polling remote registries for update to images' content


    • Icon: Epic Epic
    • Resolution: Done
    • Icon: Major Major
    • openshift-4.15
    • None
    • None
    • None
    • Catalogd Polling
    • False
    • None
    • False
    • Not Selected
    • Done
    • OCPSTRAT-429 - [Phase 2 MVP/Tech Preview] OLM 1.0 - Extension Catalogs (F1)
    • OCPSTRAT-429[Phase 2 MVP/Tech Preview] OLM 1.0 - Extension Catalogs (F1)
    • 0% To Do, 0% In Progress, 100% Done

      Epic Goal

      • Satisfy this piece of the Extension Catalogs feature [1]:

      “Changes or updates to the catalog source images should be reconciled and made available on the catalog representation on the cluster.”

      [1] OCPSTRAT-429 [Phase 2 MVP/Tech Preview] OLM 1.0 - Extension Catalogs (F1)

      Why is this important?

      The design of OLM is such that catalog data is expected to be updated regularly and be pushed repeatedly to the location already specified in a Catalog object (e.g. spec.source.image.ref) such that users of the catalogs can consume updates without having to explicitly ask for a different catalog image.

      In order to support this use case, catalogd needs to support an API to enable polling the catalog's source to check to see if new data is available, and if so, to pull it and make it available on the cluster.

      If a catalog source is content-addressable (e.g. if the spec.source.image.ref is digest-based), polling should be disabled. We should discuss what (if anything) should happen if a user attempts to configure polling when they have specified a content-addressable catalog source.


      Relevant Links

      RFC: https://docs.google.com/document/d/1iWSrWL9pYRJ5Ua3VYErkK1Q2lAusBUeDCh66Ew4lDbQ/edit#heading=h.x3tfh25grvnv 

      Upstream epic issue: https://github.com/operator-framework/catalogd/issues/164 

      Acceptance Criteria

      • CI - MUST be running successfully with tests automated

      Done Checklist

      • CI - CI is running, tests are automated and merged.
      • DEV - Upstream code and tests merged: <link to meaningful PR or GitHub Issue>
      • DEV - Upstream documentation merged: <link to meaningful PR or GitHub Issue>

            rh-ee-cchantse Catherine Chan-Tse
            rh-ee-cchantse Catherine Chan-Tse
            Jia Fan Jia Fan
            0 Vote for this issue
            2 Start watching this issue