Merge pull request #71724 from amolnar-rh/OCPBUGS-24557

OCPBUGS-24557: Explain spec.clusterImageSetNameRef and spec.clusters.clusterImageSetNameRef in SiteConfig CR

Author: skrthomas

modules/ztp-precaching-ztp-config.adoc

@@ -25,11 +25,11 @@ spec:
   baseDomain: "example.domain.redhat.com"
   pullSecretRef:
     name: "assisted-deployment-pull-secret"
-  clusterImageSetNameRef: "img4.9.10-x86-64-appsub"
+  clusterImageSetNameRef: "img4.9.10-x86-64-appsub" <1>
   sshPublicKey: "ssh-rsa ..."
   clusters:
   - clusterName: "sno-worker-0"
-    clusterImageSetNameRef: "eko4-img4.11.5-x86-64-appsub"
+    clusterImageSetNameRef: "eko4-img4.11.5-x86-64-appsub" <2>
     clusterLabels:
       group-du-sno: ""
       common-411: true
@@ -75,6 +75,8 @@ spec:
             - name: "ens1f0"
               macAddress: "AA:BB:CC:11:22:33"
 ----
+<1> Specifies the cluster image set used for deployment, unless you specify a different image set in the `spec.clusters.clusterImageSetNameRef` field.
+<2> Specifies the cluster image set used to deploy an individual cluster. If defined, it overrides the `spec.clusterImageSetNameRef` at the site level.
 
 [id="ztp-pre-caching-config-clusters-ignitionconfigoverride_{context}"]
 == Understanding the clusters.ignitionConfigOverride field

modules/ztp-sno-siteconfig-config-reference.adoc

@@ -24,8 +24,8 @@ Configuring workload partitioning by using the `cpuPartitioningMode` field in th
 |`metadata.name`
 |Set `name` to `assisted-deployment-pull-secret` and create the `assisted-deployment-pull-secret` CR in the same namespace as the `SiteConfig` CR.
 
-|`clusterImageSetNameRef`
-|Configure the image set available on the hub cluster.
+|`spec.clusterImageSetNameRef`
+|Configure the image set available on the hub cluster for all the clusters in the site.
 To see the list of supported versions on your hub cluster, run `oc get clusterimagesets`.
 
 |`installConfigOverrides`
@@ -36,6 +36,9 @@ Use the reference configuration as specified in the example `SiteConfig` CR.
 Adding additional components back into the system might require additional reserved CPU capacity.
 ====
 
+|`spec.clusters.clusterImageSetNameRef`
+|Specifies the cluster image set used to deploy an individual cluster. If defined, it overrides the `spec.clusterImageSetNameRef` at site level.
+
 |`spec.clusters.clusterLabels`
 |Configure cluster labels to correspond to the `bindingRules` field in the `PolicyGenTemplate` CRs that you define.
 For example, `policygentemplates/common-ranGen.yaml` applies to all clusters with `common: true` set, `policygentemplates/group-du-sno-ranGen.yaml` applies to all clusters with `group-du-sno: ""` set.