OperatorHub and RedHat Community Catalog (from OCP 4.11+) will adopt a new format

84 views
Skip to first unread message

Camila Macedo

unread,
Dec 16, 2021, 5:19:51 PM12/16/21
to Operator Framework

Hi Everybody, 

The RedHat Community Operator and OperatorHub catalogs will transition to a new internal format, which is referred to as file-based catalogs[0]. This is mostly a transparent change for users of the Operator Lifecycle Manager[1]. This change impacts you if you use the OPM[2] CLI tool to interact with the index images to filter out operators or add new Operators to it as part of release automation. New commands have been introduced to the OPM[2] utility, which you will need to adopt.

🚀 What does that mean for you?

The conversion to file-based catalogs[0] impacts the following actions:

  • build new catalogs from scratch and/or modify and re-publish catalogs using OPM.

  • filter catalogs for content via OPM or scripts.

  • directly interact with the SQLite database inside the catalog image such as doing SQL queries or running OPM commands.

  • prune catalogs for disconnected usage.

  • query catalog content outside the cluster.

  • debug the index catalog images.

⚠️ If you perform any of the above actions, you will be impacted.

If you are a consumer of RedHat Community Catalog (registry.redhat.io/redhat/community-operator-index) or any index[5] used to distribute solutions in OCP/OLM catalog (from OCP 4.11+)


Please, ensure that you check the topic: RedHat Community Catalog will adopt a new format[3].


If you are a consumer of OperatorHub Catalog (quay.io/operatorhubio/catalog): 


Please, ensure that you check the topic: K8S Community Catalog will adopt a new format[4]

💁 Note that in the above links, you will find command details, migration steps and additional background and also what is specific for each index catalog. 

Otherwise, you are NOT impacted.

You are likely not impacted if you are only using catalog images to:

  • mirror them for disconnected clusters using $ oc adm catalog mirror

  • create catalog sources for OLM (to consume the RedHat Index catalog via OLM on the clusters)

Or if you only distribute your Operators by creating a PR in its repositories. Nothing will change for you at the first moment. You will still be publishing your projects as you have been using the PR-based contribution process in this project.

[0] - https://olm.operatorframework.io/docs/reference/file-based-catalogs/

[1] - https://github.com/operator-framework/operator-lifecycle-manager

[2] - https://github.com/operator-framework/operator-registry

[3] - https://github.com/redhat-openshift-ecosystem/community-operators-prod/discussions/512

[4] - https://github.com/k8s-operatorhub/community-operators/discussions/505

[5] - https://docs.openshift.com/container-platform/4.9/operators/understanding/olm-rh-catalogs.html#olm-rh-catalogs_olm-rh-catalogs 


Cheers, 


CAMILA MACEDO

SR. SOFTWARE ENGINEER 

RED HAT Operator framework

Red Hat UK

She / Her / Hers

IM: cmacedo



Camila Macedo

unread,
Jan 21, 2022, 2:08:17 PMJan 21
to Operator Framework, Daniel Messer, Lance Galletti, Martin Vala, Joe Lanford, Jozef Breza

Hi Everybody, 

 🚀(Reminder) The FBC changes are planned to roll out soon. 

This is a reminder that:


The change to file-based catalogs[0] is a largely transparent change:

  • There are no changes to the bundle format.

  • Workflows for publishing operators to these catalogs will not change.

  • Connected install workflows will not change.

 

⚠️ The impact is limited to the following workflows:

  • building new catalogs by modifying and re-publishing catalogs using OPM.

  • filtering catalogs for content via OPM or scripts (such as opm index prune)

  • directly interacting with the SQLite database inside the catalog image such as doing SQL queries against it.

  • mirroring catalogs for disconnected usage.

For more details, please see the following announcements: 

 

[0] - https://olm.operatorframework.io/docs/reference/file-based-catalogs/

 

Cheers,


CAMILA MACEDO

SR. SOFTWARE ENGINEER 

RED HAT Operator framework

Red Hat UK

She / Her / Hers

IM: cmacedo

I respect your work-life balance. Therefore there is no need to answer this email out of your office hours.

Reply all
Reply to author
Forward
0 new messages