Certified Operator Build Guide
Search…
Certified Operator Build Guide
Introduction
What is an Operator?
Pre-Requisites
Helm Operators
Building a Helm Operator
Ansible Operators
Building an Ansible Operator
Golang Operator Gotcha's
Writing to the Status Subresource
OpenShift Deployment
Operator Metadata
Update CRDs from v1beta1
Creating the Metadata Bundle
Adjusting the ClusterServiceVersion
Reviewing your Metadata Bundle
Metadata Bundle Image
Managing OpenShift Versions
Installing an OpenShift Environment
Deploying onto OpenShift
Troubleshooting and Resources
Creating an Ansible Role From a Helm Chart
Security Context Constraints
Connect Metadata Test Results
Red Hat Marketplace Requirements
Appendix
What if I've already published a Community Operator?
Community Operators
AWS OpenShift 4 Cluster Quick Start Guide
Using Third Party Network Operators with OpenShift
Bundle Maintenance After Migration
Frequently Asked Questions (FAQ)
Multi-Arch Operator Certification
Powered By GitBook
Managing OpenShift Versions
This section will show you how to control the listing of your operator in the certified catalog for different versions of OpenShift.
The com.redhat.openshift.versions field, part of the metadata in the operator bundle, is used to determine whether an operator is included in the certified catalog for a given OpenShift version. You must use it to indicate the version(s) of OpenShift supported by your operator.
The value is set through a LABEL in the bundle.Dockerfile. Note that the letter 'v' must be used before the version, and spaces are not allowed.
The syntax is as follows:
  • A single version indicates that the operator is supported on that version of OpenShift or later. The operator will be automatically added to the certified catalog for all subsequent OpenShift releases.
  • A single version preceded by '=' indicates that the operator is supported ONLY on that version of OpenShift. For example, using "=v4.6" will add the operator to the certified catalog for OpenShift 4.6, but not for later OpenShift releases.
  • A range can be used to indicate support only for OpenShift versions within that range. For example, using "v4.5-v4.7" will add the operator to the certified catalog for OpenShift 4.5, 4.6 and 4.7 but not for OpenShift 4.8.
The following table provides some examples of whether an operator is included or not in the catalog for different OpenShift versions, depending on the value of com.redhat.openshift.versions.
OpenShift
"v4.5"
"v4.6"
"=v4.6"
"v4.5-v4.7"
4.5
Included
Not included
Not included
Included
4.6
Included
Included
Included
Included
4.7
Included
Included
Not included
Included
4.8
Included
Included
Not included
Not included
NOTE: Commas are generally not allowed, and should not be used. For historical reasons, there are two special values that are currently allowed, v4.5,v4.6 and v4.6,v4.5. Both behave as just v4.5. The operator is supported on the v4.5 version of OpenShift or later. Any other usage of commas, e.g. v4.6,v4.7, will prevent the operator from being added to the certified catalog.
Previous
Metadata Bundle Image
Next - OpenShift Deployment
Installing an OpenShift Environment
Last modified 7mo ago
Copy link