1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Files
openshift-docs/modules/samples-operator-overview.adoc
2025-11-19 19:48:53 +00:00

42 lines
2.6 KiB
Plaintext

// Module included in the following assemblies:
//
// * openshift_images/configuring_samples_operator.adoc
:_mod-docs-content-type: CONCEPT
[id="samples-operator-overview_{context}"]
= Understanding the Cluster Samples Operator
[role="_abstract"]
During installation, the Operator creates the default configuration object for itself and then creates the sample image streams and templates, including quick start templates.
[NOTE]
====
To facilitate image stream imports from other registries that require credentials, a cluster administrator can create any additional secrets that contain the content of a Docker `config.json` file in the `openshift` namespace needed for image import.
====
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 {product-title} release. When each sample is created or updated, the Cluster Samples Operator includes an annotation that denotes the version of {product-title}. 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.
[NOTE]
====
The Jenkins images are part of the image payload from installation and are tagged into the image streams directly.
====
The Cluster Samples Operator configuration resource includes a finalizer which cleans up the following upon deletion:
* Operator managed image streams.
* Operator managed templates.
* Operator generated configuration resources.
* Cluster status resources.
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:
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/images/samples-operator-alt-registry[Using the Cluster Samples Operator with an alternate registry]
For more information about configuring credentials, see the following link:
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/images/managing-images#using-image-pull-secrets[Using image pull secrets]