Skip to content

Commit 4434599

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

File tree

2 files changed

+36
-1
lines changed

2 files changed

+36
-1
lines changed

Diff for: disconnected/mirroring/about-installing-oc-mirror-v2.adoc

+2
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]

Diff for: modules/oc-mirror-IDMS-ITMS-about.adoc

+34-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,37 @@ 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.
22+
23+
24+
[IMPORTANT]
25+
====
26+
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.
27+
28+
The following fields must *not* be changed:
29+
30+
[cols="2a,4a", options="header"]
31+
|===
32+
|Resource |Fields that must not be changed
33+
34+
|CatalogSource
35+
|`apiVersion`, `kind`, `spec.image`
36+
37+
|ClusterCatalog
38+
|`apiVersion`, `kind`, `spec.source.image.ref`
39+
40+
|ImageDigestMirrorSet
41+
|`apiVersion`, `kind`, `spec.imageDigestMirrors`
42+
43+
|ImageTagMirrorSet
44+
|`apiVersion`, `kind`, `spec.imageTagMirrors`
45+
46+
|Signature ConfigMap
47+
|`apiVersion`, `kind`, `metadata.namespace`, `binaryData`
48+
49+
|UpdateService
50+
|`apiVersion`, `kind`, `spec.graphDataImage`, `spec.releases`
51+
|===
52+
53+
For more details, refer to the OpenShift API documentation for `CatalogSource`, `ImageDigestMirrorSet`, and `ImageTagMirrorSet`.
54+
====

0 commit comments

Comments
 (0)