Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 2. Overview of the Cluster Samples Operator

The Cluster Samples Operator, which operates in the openshift namespace, installs and updates the Red Hat OpenShift Service on AWS image streams and Red Hat OpenShift Service on AWS templates.

Important

  • The Cluster Samples Operator is deprecated. No new templates, samples, or non-Source-to-Image (Non-S2I) image streams are added to the Cluster Samples Operator. However, the existing S2I builder image streams and templates will continue to receive updates until the Cluster Samples Operator is removed in a future release. S2I image streams and templates include:

    • Ruby
    • Python
    • Node.js
    • Perl
    • PHP
    • HTTPD
    • Nginx
    • EAP
    • Java
    • Webserver
    • .NET
    • Go

  • The Cluster Samples Operator will stop managing and providing support to the non-S2I samples (image streams and templates). You can contact the image stream or template owner for any requirements and future plans. In addition, refer to the following link:

2.1. Understanding the Cluster Samples Operator
Copy link

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 Red Hat OpenShift Service on AWS release. When each sample is created or updated, the Cluster Samples Operator includes an annotation that denotes the version of Red Hat OpenShift Service on AWS. 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:

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:

  • If the Cluster Samples Operator cannot reach the registry after three minutes on initial startup after a clean installation.
  • If the Cluster Samples Operator detects that it is on an IPv6 network.
Note

For Red Hat OpenShift Service on AWS, the default image registry is registry.access.redhat.com or quay.io.

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

Important

IPv6 installations are not currently supported by the registry. The Cluster Samples Operator pulls most of the sample image streams and images from the registry.

2.2.1. Restricted network installation
Copy link

The Cluster Samples Operator boostrapping itself as Removed when unable to access registry.redhat.io facilitates restricted network installations when the network restriction is already in place.

As a cluster administrator, you have more time to decide if samples are needed when the Operator is boostrapped Removed. This is because the Cluster Samples Operator does not submit alerts that sample image stream imports are failing when the management state is Removed. When the Cluster Samples Operator management state is Managed, and the Operator attempts to install sample image streams, failing-import alerts start two hours after initial installation.

If a cluster that eventually runs on a restricted network is first installed while network access exists, the Cluster Samples Operator installs content from registry.redhat.io.

In this case, you can defer samples installation until you have decided which samples are needed by overriding the default configuration of Managed for a connected installation.

If you want the Cluster Samples Operator to bootstrap with the management state as Removed during an installation that has initial network access, override the Cluster Samples Operator default configuration by using the following instructions:

To host samples in your restricted environment, use the following instructions:

You must also put the following additional YAML file in the openshift directory created by the openshift-install create manifest process:

Example Cluster Samples Operator YAML file with managementState: Removed

apiVersion: samples.operator.openshift.io/v1
kind: Config
metadata:
  name: cluster
spec:
  architectures:
  - x86_64
  managementState: Removed
Copy to Clipboard Toggle word wrap

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 import succeeds.
  • The Cluster Samples Operator configuration is changed such that either the image stream is added to the skippedImagestreams list, or the management state is changed to Removed.

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.

Note

Deprecated image stream tags that the samples providers have removed from their image streams are not included on initial installations.

Prerequisites

  • You installed the OpenShift CLI (oc).

Procedure

  • Remove deprecated image stream tags by editing the image stream with the following oc tag command: 

    $ oc tag -d <image_stream_name:tag>
    Copy to Clipboard Toggle word wrap

    Example output

    Deleted tag default/<image_stream_name:tag>.
    Copy to Clipboard Toggle word wrap

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat