OperatorHub and RedHat Community Catalog (from OCP 4.11+) will adopt a new format
Camila Macedo
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.
š 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
Cheers,Ā
CAMILAĀ MACEDO
SR. SOFTWARE ENGINEERĀ
RED HAT Operator framework
She / Her / Hers
IM:Ā cmacedo
 |
Camila Macedo
Hi Everybody,Ā
Ā (Reminder) The FBC changes are planned to roll out soon.Ā
This is a reminder that:
On Feb. 1st: The latest tag of OperatorHub catalog index image (quay.io/operatorhubio/catalog:latest) will be using the file-based catalogs[0] format.
On Feb. 8th: The v4.11 tag of the RedHat Community index image (https://registry.redhat.io/redhat/community-operator-index:v4.11) will be using the file-based catalogs[0]. (All other tags will keep using the existing SQLite format)
āØ 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:Ā
For OperatorHub: Ā https://github.com/k8s-operatorhub/community-operators/discussions/505
For RedHat Community: https://github.com/redhat-openshift-ecosystem/community-operators-prod/discussions/512
Ā
[0] - https://olm.operatorframework.io/docs/reference/file-based-catalogs/
Ā
Cheers,
CAMILAĀ MACEDO
SR. SOFTWARE ENGINEERĀ
RED HAT Operator framework
She / Her / Hers
IM:Ā cmacedo
|