mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-06 06:46:26 +01:00
123 lines
4.7 KiB
Plaintext
123 lines
4.7 KiB
Plaintext
// Module included in the following assemblies:
|
||
//
|
||
// * openshift_images/configuring_samples_operator.adoc
|
||
|
||
|
||
[id="samples-operator-configuration_{context}"]
|
||
= Cluster Samples Operator configuration parameters
|
||
|
||
The samples resource offers the following configuration fields:
|
||
|
||
[cols="3a,8a",options="header"]
|
||
|===
|
||
|Parameter |Description
|
||
|
||
|`managementState`
|
||
|`Managed`: The Cluster Samples Operator updates the samples as the configuration
|
||
dictates.
|
||
|
||
`Unmanaged`: The Cluster Samples Operator ignores updates to its configuration
|
||
resource object and any imagestreams or templates in the `openshift` namespace.
|
||
|
||
`Removed`: The Cluster Samples Operator removes the set of `Managed` imagestreams
|
||
and templates in the `openshift` namespace. It ignores new samples created by the
|
||
cluster administrator or any samples in the skipped lists. After the removals are
|
||
complete, the Cluster Samples Operator works like it is in the `Unmanaged` state and ignores
|
||
any watch events on the sample resources, imagestreams, or templates.
|
||
|
||
|`samplesRegistry`
|
||
|Allows you to specify which registry is accessed by imagestreams for their image content. `samplesRegistry` defaults to `registry.redhat.io` for {product-title}.
|
||
|
||
[NOTE]
|
||
====
|
||
Creation or update of RHEL content does not commence if the secret for pull
|
||
access is not in place when either `Samples Registry` is not explicitly set (i.e.,
|
||
the empty string), or when it is set to registry.redhat.io. In both cases, image
|
||
imports will work off of registry.redhat.io, which requires credentials.
|
||
|
||
Creation or update of RHEL content is not gated by the existence of the pull
|
||
secret if the `Samples Registry` is overridden to a value other than the empty
|
||
string or registry.redhat.io.
|
||
====
|
||
|
||
|`architectures`
|
||
|Placeholder to choose an architecture type.
|
||
|
||
|`skippedImagestreams`
|
||
|Imagestreams that are in the Cluster Samples Operator’s inventory but that the cluster
|
||
administrator wants the Operator to ignore or not manage. You can add a list of imagestream names to this parameter. For example, `["httpd","perl"]`.
|
||
|
||
|`skippedTemplates`
|
||
|Templates that are in the Cluster Samples Operator's inventory, but that
|
||
the cluster administrator wants the Operator to ignore or not manage.
|
||
|
||
|===
|
||
|
||
Secret, imagestream, and template watch events can come in before the initial
|
||
samples resource object is created, the Cluster Samples Operator detects and re-queues the
|
||
event.
|
||
|
||
== Configuration restrictions
|
||
|
||
When the Cluster Samples Operator starts supporting multiple architectures, the
|
||
architecture list is not allowed to be changed while in the `Managed` state.
|
||
|
||
To change the architectures values, a cluster administrator must:
|
||
|
||
* Mark the `Management State` as `Removed`, saving the change.
|
||
* In a subsequent change, edit the architecture and change the `Management State`
|
||
back to `Managed`.
|
||
|
||
The Cluster Samples Operator still processes secrets while in `Removed` state. You can
|
||
create the secret before switching to `Removed`, while in `Removed` before
|
||
switching to `Managed`, or after switching to `Managed` state (though there are
|
||
delays in creating the samples until the secret event is processed if you create
|
||
the secret after switching to `Managed`). This helps facilitate the
|
||
changing of the registry, where you choose to remove all the samples before
|
||
switching to insure a clean slate (removing before switching is not required).
|
||
|
||
== Conditions
|
||
|
||
The samples resource maintains the following conditions in its status:
|
||
|
||
[cols="3a,8a",options="header"]
|
||
|===
|
||
|Condition |Description
|
||
|
||
|`SamplesExists`
|
||
|Indicates the samples are created in the `openshift` namespace.
|
||
|
||
|`ImageChangesInProgress`
|
||
|`True` when imagestreams are created or updated, but
|
||
not all of the tag spec generations and tag status generations match.
|
||
|
||
`False` when all of the generations match, or unrecoverable errors occurred during
|
||
import, the last seen error is in the message field. The list of pending
|
||
imagestreams is in the reason field.
|
||
|
||
This condition is deprecated in {product-title}.
|
||
|
||
|`ConfigurationValid`
|
||
|`True` or `False` based on whether any of the restricted changes noted
|
||
previously are submitted.
|
||
|
||
|`RemovePending`
|
||
|Indicator that there is a `Management State: Removed` setting pending, but the
|
||
Cluster Samples Operator is waiting for the deletions to complete.
|
||
|
||
|`ImportImageErrorsExist`
|
||
|Indicator of which imagestreams had errors during the image import phase for
|
||
one of their tags.
|
||
|
||
`True` when an error has occurred. The list of imagestreams with an error is
|
||
in the reason field. The details of each error reported are in the
|
||
message field.
|
||
|
||
|`MigrationInProgress`
|
||
|`True` when the Cluster Samples Operator detects that the version is different than the
|
||
Cluster Samples Operator version with which the current samples set are installed.
|
||
|
||
This condition is deprecated in {product-title}.
|
||
|
||
|===
|