Skip to content

Commit 3d8d502

Browse files
committed
Updated the catalog resources for oc-mirror v2
1 parent 9f8fd7c commit 3d8d502

File tree

3 files changed

+35
-1
lines changed

3 files changed

+35
-1
lines changed

disconnected/mirroring/about-installing-oc-mirror-v2.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ include::modules/oc-mirror-IDMS-ITMS-about.adoc[leveloffset=+1]
6666
[role="_additional-resources"]
6767
.Additional resources
6868

69+
* xref:../../rest_api/operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.html[CatalogSource]
70+
6971
* xref:../../rest_api/config_apis/imagedigestmirrorset-config-openshift-io-v1.adoc#imagedigestmirrorset-config-openshift-io-v1[ImageDigestMirrorSet]
7072

7173
* xref:../../rest_api/config_apis/imagetagmirrorset-config-openshift-io-v1.adoc#imagetagmirrorset-config-openshift-io-v1[ImageTagMirrorSet]

modules/oc-mirror-IDMS-ITMS-about.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ The oc-mirror plugin v2 automatically generates the following custom resources:
1818

1919
`ClusterCatalog`:: Retrieves information about the available cluster extensions (which includes Operators) in the mirror registry. Used by {olmv1}.
2020

21-
`UpdateService`:: Provides update graph data to the disconnected environment. Used by the OpenShift Update Service.
21+
`UpdateService`:: Provides update graph data to the disconnected environment. Used by the OpenShift Update Service.

modules/oc-mirror-updating-cluster-manifests-v2.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,38 @@ In oc-mirror plugin v2, the IDMS and ITMS files cover the entire image set, unli
2828
----
2929
$ oc apply -f <path_to_oc_mirror_workspace>/working-dir/cluster-resources
3030
----
31+
+
32+
[IMPORTANT]
33+
====
34+
When using resources generated by the oc-mirror plugin v2 to configure your cluster, do not change specific fields. Changing them can cause errors and is not supported.
35+
36+
The following fields must *not* be changed:
37+
38+
[cols="2a,4a", options="header"]
39+
|===
40+
|Resource |Fields that must not be changed
41+
42+
|CatalogSource
43+
|`apiVersion`, `kind`, `spec.image`
44+
45+
|ClusterCatalog
46+
|`apiVersion`, `kind`, `spec.source.image.ref`
47+
48+
|ImageDigestMirrorSet
49+
|`apiVersion`, `kind`, `spec.imageDigestMirrors`
50+
51+
|ImageTagMirrorSet
52+
|`apiVersion`, `kind`, `spec.imageTagMirrors`
53+
54+
|Signature ConfigMap
55+
|`apiVersion`, `kind`, `metadata.namespace`, `binaryData`
56+
57+
|UpdateService
58+
|`apiVersion`, `kind`, `spec.graphDataImage`, `spec.releases`
59+
|===
60+
61+
For more details, refer to the OpenShift API documentation for `CatalogSource`, `ImageDigestMirrorSet`, and `ImageTagMirrorSet`.
62+
====
3163

3264
. If you mirrored release images, apply the release image signatures to the cluster by running the following command:
3365
+

0 commit comments

Comments
 (0)