Skip to content

Commit ddaf2eb

Browse files
bmcelveebmcelvee
authored
Merge pull request #28456 from bmcelvee/OSDOCS-1616
OSDOCS-1616 using Cluster Samples Operator disconnected mirroring assistance
2 parents 9d17db4 + d391450 commit ddaf2eb

6 files changed

+83
-11
lines changed

‎installing/install_config/installing-restricted-networks-preparations.adoc‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,12 @@ include::modules/installation-preparing-restricted-cluster-to-gather-support-dat
5353

5454
include::modules/installation-restricted-network-samples.adoc[leveloffset=+1]
5555

56+
include::modules/installation-images-samples-disconnected-mirroring-assist.adoc[leveloffset=+2]
57+
58+
See xref:../install_config/installing-restricted-networks-preparations.adoc#installation-restricted-network-samples_installing-restricted-networks-preparations[Using Cluster Samples Operator image streams with alternate or mirrored registries] for a detailed procedure.
59+
60+
61+
5662
== Next steps
5763

5864
//* TODO need to add the registry secret to the machines, which is different

‎modules/images-samples-operator-deprecated-image-stream.adoc‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * openshift_images/configuring-samples-operator.adoc
4+
5+
6+
[id="images-samples-operator-deprecated-image-stream_{context}"]
7+
= Removing deprecated image stream tags from the Cluster Samples Operator
8+
9+
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.
10+
11+
You can remove deprecated image stream tags by editing the image stream with the `oc tag` command.
12+
13+
[NOTE]
14+
====
15+
Deprecated image stream tags that the samples providers have removed from their image streams are not included on initial installations.
16+
====
17+
18+
.Prerequisites
19+
20+
* You installed the `oc` CLI.
21+
22+
.Procedure
23+
24+
* Remove deprecated image stream tags by editing the image stream with the `oc tag` command.
25+
+
26+
[source,terminal]
27+
----
28+
$ oc tag -d <image_stream_name:tag>
29+
----
30+
+
31+
.Example output
32+
[source,terminal]
33+
----
34+
Deleted tag default/<image_stream_name:tag>.
35+
----
36+
37+
//Similar procedure in images-imagestreams-remove-tag.adoc

‎modules/installation-images-samples-disconnected-mirroring-assist.adoc‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/install_config/installing-restricted-networks-preparations.adoc
4+
// * openshift_images/samples-operator-alt-registry.adoc
5+
// * openshift_images/configuring-samples-operator.adoc
6+
7+
[id="installation-images-samples-disconnected-mirroring-assist_{context}"]
8+
= Cluster Samples Operator assistance for mirroring
9+
10+
During installation, {product-title} creates a config map named `imagestreamtag-to-image` in the `openshift-cluster-samples-operator` namespace. The `imagestreamtag-to-image` config map contains an entry, the populating image, for each image stream tag.
11+
12+
The format of the key for each entry in the data field in the config map is `<image_stream_name>_<image_stream_tag_name>`.
13+
14+
During a disconnected installation of {product-title}, the status of the Cluster Samples Operator is set to `Removed`. If you choose to change it to `Managed`, it installs samples.
15+
16+
You can use this config map as a reference for which images need to be mirrored for your image streams to import.
17+
18+
* While the Cluster Samples Operator is set to `Removed`, you can create your mirrored registry, or determine which existing mirrored registry you want to use.
19+
* Mirror the samples you want to the mirrored registry using the new config map as your guide.
20+
* Add any of the image streams you did not mirror to the `skippedImagestreams` list of the Cluster Samples Operator configuration object.
21+
* Set `samplesRegistry` of the Cluster Samples Operator configuration object to the mirrored registry.
22+
* Then set the Cluster Samples Operator to `Managed` to install the image streams you have mirrored.

‎openshift_images/configuring-samples-operator.adoc‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,27 @@ include::modules/common-attributes.adoc[]
44
:context: configuring-samples-operator
55
toc::[]
66

7-
The Cluster Samples Operator, which operates in the `openshift` namespace, installs and
8-
updates the Red Hat Enterprise Linux (RHEL)-based {product-title} imagestreams
9-
and {product-title} templates.
10-
11-
== Prerequisites
12-
* Deploy an {product-title} cluster.
13-
14-
//Add any other prereqs that are always valid before you modify the CRD.
15-
//If you must configure a different resource before you configure this one, point it out here.
7+
The Cluster Samples Operator, which operates in the `openshift` namespace, installs and updates the {op-system-base-full}-based {product-title} image streams and {product-title} templates.
168

179
include::modules/samples-operator-overview.adoc[leveloffset=+1]
1810

11+
[discrete]
1912
== Additional resources
2013

21-
* If the Cluster Samples Operator is removed during installation, you can xref:../openshift_images/samples-operator-alt-registry.adoc#samples-operator-alt-registry[use the Cluster Samples Operator with an alternate registry].
22-
* To ensure the Cluster Samples Operator bootstraps as `Removed` in a restricted network installation with initial network access in order to defer samples installation until you have decided which samples are desired, follow the instructions for xref:../openshift_images/samples-operator-alt-registry.adoc#samples-operator-alt-registry[using the Cluster Samples Operator with an alternate registry] and xref:../installing/install_config/installing-customizing.adoc#installing-customizing[Customizing nodes], to override the Cluster Samples Operator default configuration and initially come up as `Removed`.
14+
* If the Cluster Samples Operator is removed during installation, you can xref:../openshift_images/samples-operator-alt-registry.adoc#samples-operator-alt-registry[use the Cluster Samples Operator with an alternate registry] so content can be imported, and then set the Cluster Samples Operator to `Managed` to get the samples.
15+
* To ensure the Cluster Samples Operator bootstraps as `Removed` in a restricted network installation with initial network access to defer samples installation until you have decided which samples are desired, follow the instructions for xref:../installing/install_config/installing-customizing.adoc#installing-customizing[customizing nodes] to override the Cluster Samples Operator default configuration and initially come up as `Removed`.
16+
** To host samples in your disconnected environment, follow the instructions for xref:../openshift_images/samples-operator-alt-registry.adoc#samples-operator-alt-registry[using the Cluster Samples Operator with an alternate registry].
17+
18+
include::modules/installation-images-samples-disconnected-mirroring-assist.adoc[leveloffset=+2]
19+
20+
See xref:../openshift_images/samples-operator-alt-registry.adoc#installation-restricted-network-samples_samples-operator-alt-registry[Using Cluster Samples Operator image streams with alternate or mirrored registries] for a detailed procedure.
2321

2422
include::modules/samples-operator-configuration.adoc[leveloffset=+1]
2523

2624
include::modules/samples-operator-crd.adoc[leveloffset=+1]
2725

26+
include::modules/images-samples-operator-deprecated-image-stream.adoc[leveloffset=+1]
27+
2828
[discrete]
2929
== Additional resources
3030

‎openshift_images/image-streams-manage.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ include::modules/images-imagestream-adding-tags.adoc[leveloffset=+2]
2929
include::modules/images-imagestream-external-image-tags.adoc[leveloffset=+2]
3030
include::modules/images-imagestream-update-tag.adoc[leveloffset=+2]
3131
include::modules/images-imagestream-remove-tag.adoc[leveloffset=+2]
32+
33+
See xref:../openshift_images/configuring-samples-operator.adoc#images-samples-operator-deprecated-image-stream_configuring-samples-operator[Removing deprecated image stream tags from the Cluster Samples Operator] for more information on how the Cluster Samples Operator handles deprecated image stream tags.
34+
3235
include::modules/images-imagestream-import.adoc[leveloffset=+2]
3336

3437
include::modules/images-imagestream-import-images-private-registry.adoc[leveloffset=+1]

‎openshift_images/samples-operator-alt-registry.adoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,7 @@ include::modules/installation-adding-registry-pull-secret.adoc[leveloffset=+1]
2929
include::modules/installation-mirror-repository.adoc[leveloffset=+1]
3030

3131
include::modules/installation-restricted-network-samples.adoc[leveloffset=+1]
32+
33+
include::modules/installation-images-samples-disconnected-mirroring-assist.adoc[leveloffset=+2]
34+
35+
See xref:../openshift_images/samples-operator-alt-registry.adoc#installation-restricted-network-samples_samples-operator-alt-registry[Using Cluster Samples Operator image streams with alternate or mirrored registries] for a detailed procedure.

0 commit comments

Comments
 (0)