Merge pull request openshift#11 from aireilly/amolnar-rh_consolidated-ZTP_review-comments

Updates for final ZTP reviews

Author: amolnar-rh

modules/about-ztp-and-distributed-units-on-openshift-clusters.adoc

@@ -22,4 +22,4 @@ With ZTP and AI, you can provision {product-title} clusters to run your DUs at s
 
 ** Network connectivity - including DNS for your network. Hosts should be reachable through the hub and managed spoke clusters. Ensure there is layer 3 connectivity between the hub and the host where you want to install your hub cluster.
 
-* Baseboard Management Controller (BMC) details for each host - ZTP uses BMC details to connect the URL and credentials for accessing the BMC. ZTP manages the spoke cluster definition CRs, with the exception of the `BMCSecret` CR, which you create manually. These define the relevant elements for the managed clusters.
+** Baseboard Management Controller (BMC) details for each host - ZTP uses BMC details to connect the URL and credentials for accessing the BMC. ZTP manages the spoke cluster definition CRs, with the exception of the `BMCSecret` CR, which you create manually. These define the relevant elements for the managed clusters.

modules/ztp-configuring-ptp-fast-events.adoc

@@ -66,7 +66,7 @@ You can configure PTP fast events for vRAN clusters that are deployed using the
       maxOffsetThreshold: 100  #nano secs
       minOffsetThreshold: -100 #nano secs
 ----
-<1> Can be one `PtpConfigMaster.yaml`, `PtpConfigSlave.yaml`, or `PtpConfigSlaveCvl.yaml` depending on your requirements. `PtpConfigSlaveCvl.yaml` configes `linuxptp` services for an Intel E810 Columbiaville NIC.
+<1> Can be one `PtpConfigMaster.yaml`, `PtpConfigSlave.yaml`, or `PtpConfigSlaveCvl.yaml` depending on your requirements. `PtpConfigSlaveCvl.yaml` configures `linuxptp` services for an Intel E810 Columbiaville NIC. For configurations based on `group-du-sno-ranGen.yaml` or `group-du-3node-ranGen.yaml`, use `PtpConfigSlave.yaml`.
 <2> Device specific interface name.
 <3> You must append the `--summary_interval -4` value to `ptp4lOpts` in `.spec.sourceFiles.spec.profile` to enable PTP fast events.
 <4> `ptpClockThreshold` configues how long the clock stays in clock holdover state. Holdover state is the period between local and master clock synchronizations. Offset is the time difference between the local and master clock.

modules/ztp-preparing-the-hub-cluster-for-ztp.adoc

@@ -18,13 +18,6 @@ You can configure your hub cluster with a set of ArgoCD applications that genera
 
 . Install the Topology Aware Lifecycle Operator, which coordinates with any new sites added by ZTP and manages application of the `PolicyGenTemplate`-generated policies.
 
-. Patch the ArgoCD instance in the hub cluster using the patch files previously extracted into the `out/argocd/deployment/` directory:
-+
-[source,terminal]
-----
-$ oc patch argocd openshift-gitops -n openshift-gitops  --type=merge --patch-file out/argocd/deployment/argocd-openshift-gitops-patch.json
-----
-
 . Prepare the ArgoCD pipeline configuration:
 +
 .. Create a Git repository with the directory structure similar to the example directory. For more information, see "Preparing the ZTP Git repository".

modules/ztp-using-pgt-to-update-source-crs.adoc

@@ -8,14 +8,14 @@
 
 `PolicyGenTemplate` CRs allow you to overlay additional configuration details on top of the base source CRs provided in the `ztp-site-generate` container. You can think of `PolicyGenTemplate` CRs as a logical merge or patch to the base CR. Use `PolicyGenTemplate` CRs to update a single field of the base CR, or overlay the entire contents of the base CR. You can update values and insert fields that are not in the base CR.
 
+The following example procedure describes how to update fields in the generated `PerformanceProfile` CR for the reference configuration based on the `PolicyGenTemplate` CR in the `group-du-sno-ranGen.yaml` file. Use the procedure as a basis for modifying other parts of the `PolicyGenTemplate` based on your requirements.
+
 .Prerequisites
 
 * Create a Git repository where you manage your custom site configuration data. The repository must be accessible from the hub cluster and be defined as a source repository for Argo CD.
 
 .Procedure
 
-The following example procedure describes how to update fields in the generated `PerformanceProfile` CR. Other CRs, generated with the `PolicyGenTemplate` CR, can be similarly modified.
-
 . Review the baseline source CR for existing content. You can review the source CRs listed in the reference `PolicyGenTemplate` CRs by extracting them from the zero touch provisioning (ZTP) container.
 
 .. Create an `/out` folder:
@@ -32,12 +32,7 @@ $ mkdir -p ./out
 $ podman run --log-driver=none --rm registry.redhat.io/openshift4/ztp-site-generate-rhel8:v4.10 extract /home/ztp --tar | tar x -C ./out
 ----
 
-. The baseline `PerformanceProfile` CR is found in `./out/source-crs/PerformanceProfile.yaml`.
-+
-[NOTE]
-====
-Any fields in the source CR which contain `$...` are removed from the generated CR if not provided in the `PolicyGenTemplate` CR.
-====
+. Review the baseline `PerformanceProfile` CR in `./out/source-crs/PerformanceProfile.yaml`:
 +
 [source,yaml]
 ----
@@ -71,8 +66,13 @@ spec:
   realTimeKernel:
     enabled: true
 ----
++
+[NOTE]
+====
+Any fields in the source CR which contain `$...` are removed from the generated CR if they are not provided in the `PolicyGenTemplate` CR.
+====
 
-. The `PolicyGenTemplate` entry for `PerformanceProfile` is found in the `group-du-sno-ranGen.yaml` reference file. The following example entry in that `PolicyGenTemplate` can be specified to supply appropriate CPU specifications, hugepage configuration, and add a new field that sets `globallyDisableIrqLoadBalancing` to false.
+. Update the `PolicyGenTemplate` entry for `PerformanceProfile` in the `group-du-sno-ranGen.yaml` reference file. The following example `PolicyGenTemplate` CR stanza supplies appropriate CPU specifications, sets the `hugepages` configuration, and adds a new field that sets `globallyDisableIrqLoadBalancing` to false.
 +
 [source,yaml]
 ----
@@ -93,8 +93,13 @@ spec:
     globallyDisableIrqLoadBalancing: false
 ----
 
-. Commit the `PolicyGenTemplate` change in Git, and then push to the Git repository being monitored by the GitOps ZTP argo CD application. The ZTP application generates an ACM policy that contains the generated `PerformanceProfile` CR. The contents of that CR are derived by merging the `metadata` and `spec` contents from the `PerformanceProfile` entry in the `PolicyGenTemplate` onto the source CR. The resulting CR has the following content:
-+
+. Commit the `PolicyGenTemplate` change in Git, and then push to the Git repository being monitored by the GitOps ZTP argo CD application.
+
+
+.Example output
+
+The ZTP application generates an ACM policy that contains the generated `PerformanceProfile` CR. The contents of that CR are derived by merging the `metadata` and `spec` contents from the `PerformanceProfile` entry in the `PolicyGenTemplate` onto the source CR. The resulting CR has the following content:
+
 [source,yaml]
 ----
 ---

scalability_and_performance/ztp-deploying-disconnected.adoc

@@ -80,8 +80,6 @@ Scaling the hub cluster to managing large numbers of spoke clusters is affected
 
 include::modules/ztp-creating-the-policygentemplate-cr.adoc[leveloffset=+1]
 
-include::modules/ztp-generating-ran-policies.adoc[leveloffset=+1]
-
 include::modules/ztp-creating-ztp-custom-resources-for-multiple-managed-clusters.adoc[leveloffset=+1]
 
 include::modules/ztp-using-pgt-to-update-source-crs.adoc[leveloffset=+2]
@@ -199,11 +197,14 @@ include::modules/ztp-configuring-the-cluster-for-a-disconnected-environment.adoc
 
 include::modules/ztp-configuring-ipv6.adoc[leveloffset=+2]
 
+include::modules/ztp-generating-ran-policies.adoc[leveloffset=+1]
+
 include::modules/ztp-troubleshooting-the-managed-cluster.adoc[leveloffset=+2]
 
 // TALO
 
 include::modules/cnf-topology-aware-lifecycle-operator.adoc[leveloffset=+1]
+
 [role="_additional-resources"]
 .Additional resources
 
@@ -227,12 +228,14 @@ include::modules/cnf-topology-aware-lifecycle-operator-preparing-for-updates.ado
 * For more information about update channels and releases, see xref:../updating/understanding-upgrade-channels-release.adoc[Understanding upgrade channels and releases].
 
 include::modules/cnf-topology-aware-lifecycle-operator-platform-update.adoc[leveloffset=+2]
+
 [role="_additional-resources"]
 .Additional resources
 
 * For more information about mirroring the images in a disconnected environment, xref:../scalability_and_performance/ztp-deploying-disconnected.adoc#ztp-acm-preparing-to-install-disconnected-acm_ztp-deploying-disconnected[Preparing the disconnected environment]
 
 include::modules/cnf-topology-aware-lifecycle-operator-operator-update.adoc[leveloffset=+2]
+
 [role="_additional-resources"]
 .Additional resources