From b3cd564d04e5d3d83e79ab676dbb83d78bc779ac Mon Sep 17 00:00:00 2001 From: srir Date: Wed, 6 Aug 2025 16:03:02 +0530 Subject: [PATCH] OSDOCS#13457: Added restrictions on modifying the oc-mirror-generated resources --- .../about-installing-oc-mirror-v2.adoc | 5 +++ modules/oc-mirror-restricted-fields.adoc | 38 +++++++++++++++++++ 2 files changed, 43 insertions(+) create mode 100644 modules/oc-mirror-restricted-fields.adoc diff --git a/disconnected/mirroring/about-installing-oc-mirror-v2.adoc b/disconnected/mirroring/about-installing-oc-mirror-v2.adoc index d0c8e29eea..ba0c3740b9 100644 --- a/disconnected/mirroring/about-installing-oc-mirror-v2.adoc +++ b/disconnected/mirroring/about-installing-oc-mirror-v2.adoc @@ -66,12 +66,17 @@ include::modules/oc-mirror-IDMS-ITMS-about.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources +* xref:../../rest_api/operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.html[CatalogSource] + * xref:../../rest_api/config_apis/imagedigestmirrorset-config-openshift-io-v1.adoc#imagedigestmirrorset-config-openshift-io-v1[ImageDigestMirrorSet] * xref:../../rest_api/config_apis/imagetagmirrorset-config-openshift-io-v1.adoc#imagetagmirrorset-config-openshift-io-v1[ImageTagMirrorSet] * xref:../../extensions/catalogs/managing-catalogs.adoc#olmv1-about-catalogs_managing-catalogs[About catalogs in {olmv1}] +// Restrictions on modifying oc-mirror-generated resources +include::modules/oc-mirror-restricted-fields.adoc[leveloffset=+2] + // Configuring your cluster to use the resources generated by oc-mirror include::modules/oc-mirror-updating-cluster-manifests-v2.adoc[leveloffset=+2] diff --git a/modules/oc-mirror-restricted-fields.adoc b/modules/oc-mirror-restricted-fields.adoc new file mode 100644 index 0000000000..e6ba9802cf --- /dev/null +++ b/modules/oc-mirror-restricted-fields.adoc @@ -0,0 +1,38 @@ +// Module included in the following assemblies: +// +// * installing/disconnected_install/installing-mirroring-disconnected-v2.adoc +// * updating/updating_a_cluster/updating_disconnected_cluster/mirroring-image-repository.adoc + +:_mod-docs-content-type: CONCEPT +[id="oc-mirror-restricted-fields_{context}"] += Restrictions on modifying resources that are generated by the oc-mirror plugin + +When using resources that are generated by the oc-mirror plugin v2 to configure your cluster, you must not change certain fields. Modifying these fields can cause errors and is not supported. + +The following table lists the resources and their fields that must remain unchanged: + +.Fields that must not be modified in the resources generated by oc-mirror +[cols="2a,4a", options="header"] +|=== +|Resource |Fields that must not be changed + +|`CatalogSource` +|`apiVersion`, `kind`, `spec.image` + +|`ClusterCatalog` +|`apiVersion`, `kind`, `spec.source.image.ref` + +|`ImageDigestMirrorSet` +|`apiVersion`, `kind`, `spec.imageDigestMirrors` + +|`ImageTagMirrorSet` +|`apiVersion`, `kind`, `spec.imageTagMirrors` + +|Signature `ConfigMap` +|`apiVersion`, `kind`, `metadata.namespace`, `binaryData` + +|`UpdateService` +|`apiVersion`, `kind`, `spec.graphDataImage`, `spec.releases` +|=== + +For more information about these resources, see the OpenShift API documentation for `CatalogSource`, `ImageDigestMirrorSet`, and `ImageTagMirrorSet`.