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
2019-05-31 16:18:33 -04:00

45 lines
2.1 KiB
Plaintext

// Module included in the following assemblies:
//
// * openshift_images/configuring_samples_operator.adoc
[id="samples-operator-overview_{context}"]
= Understanding the Samples Operator
During installation, the Operator creates the default configuration object for
itself and then creates the sample imagestreams and templates, including
quickstart templates.
The Samples Operator copies the pull secret that is captured by the installation
program into the OpenShift namespace and names the secret,
`samples-registry-credentials`, to facilitate imagestream imports from
`registry.redhat.io`. Additionally, to facilitate imagestream 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 to facilitate image import.
The Samples Operator configuration is a cluster-wide resource, and the deployment
is contained within the `openshift-cluster-samples-operator` namespace.
The image for the Samples Operator contains imagestream and template definitions
for the associated {product-title} release. When each sample is created or updated,
the 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, will be reverted
automatically. The Jenkins images are actually part of the image payload from
installation and are tagged into the imagestreams directly.
The Samples Operator configuration resource includes a finalizer which cleans up
the following upon deletion:
* Operator managed imagestreams.
* Operator managed templates.
* Operator generated configuration resources.
* Cluster status resources.
* The `samples-registry-credentials` secret.
Upon deletion of the samples resource, the Samples Operator recreates the
resource using the default configuration.