This repo is the canonical source for Kubernetes Operators that appear on OperatorHub.io.
The solutions merged on this repository are distributed via the OLM index catalog quay.io/operatorhubio/catalog.
Users can install OLM in any Kubernetes or vendor such as Openshift to consume this content by adding a new CatalogSource for the index image quay.io/operatorhubio/catalog. (more info)
NOTE If you are looking to distribute solutions on Openshift/OKD catalog then, you also should publish them into the repository Community Operators.
Full documentation is generated via mkdoc and is located at https://k8s-operatorhub.github.io/community-operators/
Some APIs versions are deprecated and are OR will no longer be served on the Kubernetes version
1.22/1.25/1.26 and consequently on vendors like Openshift 4.9/4.12/4.13.
What does it mean for you?
Operator bundle versions using the removed APIs can not work successfully from the respective releases.
Therefore, it is recommended to check if your solutions are failing in these scenarios to let its users be aware.
Note that you can inform via the CSV the minimal (spec.minKubeVersion) and the max Kubernetes
version (metadata.annotation operatorhub.io/ui-metadata-max-k8s-version) where your solution can
successfully work. This information can be checked on the details of each release on OperatorHub.io.
Please, make sure you check the following announcements:
- How to deal with removal of v1beta1 CRD removals in Kubernetes 1.22
- Kubernetes API removals on 1.25/1.26 might impact your Operator. How to deal with it?
NOTE If you have been distributing solutions on Openshift you might be aware of the property
"olm.properties": '[{"type": "olm.maxOpenShiftVersion", "value": "<OCP version>"}]'which can be used to block cluster admins upgrades when they have Operator versions installed that can not work well in OCP versions higher than the value informed. Nothing prevents you from using this property here, however, be aware that it is ignored on OperatorHub.io and that the index catalog built from this repository is not part of the Openshift catalog. So that, it can be useful only for those who are creating a new Source Catalog on Openshift using the index image:quay.io/operatorhubio/catalog:latest.
Use the issue tracker in this repository to report bugs.