Chapter 2. Overview of the Cluster Samples Operator

During installation, the Operator creates the default configuration object for itself and then creates the sample image streams and templates, including quick start templates.

The Cluster Samples Operator configuration is a cluster-wide resource. The deployment of the Operator is within the openshift-cluster-samples-operator namespace.

The image for the Cluster Samples Operator has image stream and template definitions for the associated OpenShift Dedicated release. When each sample is created or updated, the Cluster Samples Operator includes an annotation that denotes the version of OpenShift Dedicated. The Operator uses this annotation to ensure that each sample matches the release version. Samples outside of its inventory are ignored, as are skipped samples. Modifications to any samples that are managed by the Operator, where that version annotation is modified or deleted, are reverted automatically.

The Cluster Samples Operator configuration resource includes a finalizer which cleans up the following upon deletion:

Upon deletion of the samples resource, the Cluster Samples Operator recreates the resource by using the default configuration.

If the Cluster Samples Operator is removed during installation, you can use the Cluster Samples Operator with an alternate registry so that content can be imported. Then you can set the Cluster Samples Operator to Managed to get the samples. Use the following instructions:

For more information about configuring credentials, see the following link:

The Cluster Samples Operator is bootstrapped as Managed by default or if global proxy is configured.

In the Managed state, the Cluster Samples Operator is actively managing its resources and keeping the component active to pull sample image streams and images from the registry and ensure that the requisite sample templates are installed.

Certain circumstances result in the Cluster Samples Operator bootstrapping itself as Removed including:

However, if the Cluster Samples Operator detects that it is on an IPv6 network and an OpenShift Dedicated global proxy is configured, then the IPv6 check supersedes all the checks. As a result, the Cluster Samples Operator bootstraps itself as Removed.

After creation or update of a samples image stream, the Cluster Samples Operator monitors the progress of each image stream tag’s image import.

If an import fails, the Cluster Samples Operator retries the import through the image stream image import API at a rate of about every 15 minutes until either one of the following occurs:

The Cluster Samples Operator leaves deprecated image stream tags in an image stream because users can have deployments that use the deprecated image stream tags.

You can remove deprecated image stream tags by editing the image stream with the oc tag command.