Chapter 3. Products managed by an Operator

The Operator bundle must successfully pass the Operator SDK bundle validation.

Red Hat recommends the usage of the SDK to create the Operator, to ensure that the format is correct.

To ensure correct format and compatibility with Operator Lifecycle Manager (OLM).

The Operator must update the status field of each custom resource (CR).

To ensure that users can determine the running state of the CR and identify potential failures.

The cluster service version (CSV) in the Operator bundle must include all the fields indicated in Required CSV fields as well as the following required fields under metadata.annotations:

Other optional annotations can be defined as well, such as for the following Kubernetes plugins:

For more information about required annotations, optional annotations, and example usage in CSVs, see Operator metadata annotations.

Provides detailed information about the product managed by this Operator to users and support organizations.

The Operator bundle must indicate the minor versions of OpenShift that the target product supports by setting the com.redhat.openshift.versions annotation.

Annotation syntax:

a) Restrict to a single RHOCP version: "=v4.17"

b) Restrict to a version range: "v4.16-v4.17"

c) Open-ended version range: "v4.16"

If the open-ended version range listed is deprecated, the operator bundle will only appear in the fully supported and maintained versions.

The version range must include one or more current RHOCP versions, that are in the Full Suport, Maintenance Support, EUS, or EUS Term 2 life cycle phases.

The range may directly or implicitly include one or more future versions of RHOCP. Upon the release of a new RHOCP minor version, Operators with ranges that include the new minor version and are in good standing regarding the lifecycle and recertification policies, will automatically be certified and published for the new minor version of RHOCP.

Red Hat expects and requires that you test and verify your product with new minor releases of Red Hat OpenShift as they become available.

The Operator must not use any APIs that are not present in all versions of Red Hat OpenShift included in this range.

Ensures that any APIs used are available in the targeted versions.

The CSV in the Operator bundle must indicate all the CRDs Owned by the Operator.

To ensure adequate tracking and management of CRD lifecycle.

The CSV in the Operator bundle must indicate all the container images needed to perform its function, using the spec.relatedImages field.

To correctly identify all the dependencies.

The Operator name must be different from any other Operator name already published in the Community, Certified, and Red Hat catalogs. The Operator name must not begin with a Red Hat Mark.

To avoid name conflicts, customer confusion and to follow Red Hat trademark guidelines.