mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-06 15:46:57 +01:00
66 lines
3.1 KiB
Plaintext
66 lines
3.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.
|
|
|
|
[NOTE]
|
|
====
|
|
The Jenkins images are 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.
|
|
|
|
[id="samples-operator-bootstrapped"]
|
|
== Samples Operator's use of management state
|
|
|
|
The Samples Operator is bootstrapped as `Managed` by default or if global proxy is configured. In the `Managed` state, the Samples Operator is actively managing its resources and keeping the component active in order to pull sample imagestreams and images from the registry and ensure that the requisite sample templates are installed.
|
|
|
|
Certain circumstances will result in the Samples Operator bootstrapping itself as `Removed` including:
|
|
|
|
* If the Samples Operator cannot reach link:https://registry.redhat.io[registry.redhat.io] after three minutes on initial start-up after a clean installation.
|
|
* If the Samples Operator detects it is on an IPv6 network.
|
|
* If the Samples Operator detects it is installed on ppc64le and S390x.
|
|
|
|
[IMPORTANT]
|
|
====
|
|
IPv6 installations are not currently supported by link:https://registry.redhat.io[registry.redhat.io]. The Samples Operator pulls most of the sample imagestreams and images from link:https://registry.redhat.io[registry.redhat.io].
|
|
====
|