Merge pull request #60679 from aireilly/telcodocs-1321-update-reference-config

TELCODOCS-1321 - 4.13 vDU reference config updates

Author: opayne1

.vale/styles/Vocab/OpenShiftDocs/accept.txt

@@ -8,4 +8,7 @@ custom resource
 custom resources
 MetalLB
 Operator
-Operators
+Operators
+[Ff]ronthaul
+[Mm]idhaul
+[Rr]ealtime

modules/ztp-deploying-a-site.adoc

@@ -51,8 +51,7 @@ $ oc create namespace $CLUSTERNS
 +
 [NOTE]
 ====
-The secrets are referenced from the `SiteConfig` custom resource (CR) by name. The namespace
-must match the `SiteConfig` namespace.
+The secrets are referenced from the `SiteConfig` custom resource (CR) by name. The namespace must match the `SiteConfig` namespace.
 ====
 
 . Create a `SiteConfig` CR for your cluster in your local clone of the Git repository:
@@ -66,7 +65,16 @@ The folder includes example files for single node, three-node, and standard clus
 
 .. Change the cluster and host details in the example file to match the type of cluster you want. For example:
 +
-include::snippets/ztp-example-siteconfig.adoc[]
+.Example {sno} SiteConfig CR
+[source,yaml]
+----
+include::snippets/ztp_example-sno.yaml[]
+----
++
+[NOTE]
+====
+For more information about BMC addressing, see the "Additional resources" section.
+====
 
 .. You can inspect the default set of extra-manifest `MachineConfig` CRs in `out/argocd/extra-manifest`. It is automatically applied to the cluster when it is installed.
 
@@ -77,7 +85,7 @@ include::snippets/ztp-example-siteconfig.adoc[]
 ====
 For optimal cluster performance, enable crun for master and worker nodes in {sno}, {sno} with additional worker nodes, {3no}, and standard clusters.
 
-Enable crun in a `ContainerRuntimeConfig` CR as an additional day-0 install-time manifest to avoid the cluster having to reboot.
+Enable crun in a `ContainerRuntimeConfig` CR as an additional Day 0 install-time manifest to avoid the cluster having to reboot.
 
 The `enable-crun-master.yaml` and `enable-crun-worker.yaml` CR files are in the `out/source-crs/optional-extra-manifest/` folder that you can extract from the `ztp-site-generate` container.
 For more information, see "Customizing extra installation manifests in the {ztp} pipeline".

modules/ztp-du-cluster-config-reference.adoc

@@ -2,7 +2,7 @@
 //
 // * scalability_and_performance/ztp_far_edge/ztp-vdu-validating-cluster-tuning.adoc
 
-:_module-type: REFERENCE
+:_content-type: REFERENCE
 [id="ztp-du-firmware-config-reference_{context}"]
 = Recommended firmware configuration for vDU cluster hosts
 
@@ -93,4 +93,4 @@ Enable global SR-IOV and VT-d settings in the firmware for the host. These setti
 [NOTE]
 ====
 Enable both `C-states` and OS-controlled `P-States` to allow per pod power management.
-====
+====

modules/ztp-du-firmware-config-reference.adoc

@@ -8,18 +8,27 @@
 
 Workload partitioning configures {product-title} services, cluster management workloads, and infrastructure pods to run on a reserved number of host CPUs.
 
-To configure workload partitioning with {ztp-first}, you specify cluster management CPU resources with the `cpuset` field of the `SiteConfig` custom resource (CR) and the `reserved` field of the group `PolicyGenTemplate` CR.
-The {ztp} pipeline uses these values to populate the required fields in the workload partitioning `MachineConfig` CR (`cpuset`) and the `PerformanceProfile` CR (`reserved`) that configure the {sno} cluster.
+To configure workload partitioning with {ztp-first}, you configure a `cpuPartitioningMode` field in the `SiteConfig` custom resource (CR) that you use to install the cluster and you apply a `PerformanceProfile` CR that configures the `isolated` and `reserved` CPUs on the host.
+
+Configuring the `SiteConfig` CR enables workload partitioning at cluster installation time and applying the `PerformanceProfile` CR configures the specific allocation of CPUs to reserved and isolated sets.
+Both of these steps happen at different points during cluster provisioning.
 
 [NOTE]
 ====
-For maximum performance, ensure that the `reserved` and `isolated` CPU sets do not share CPU cores across NUMA zones.
+Configuring workload partitioning by using the `cpuPartitioningMode` field in the `SiteConfig` CR is a Tech Preview feature in {product-title} 4.13.
+
+Alternatively, you can specify cluster management CPU resources with the `cpuset` field of the `SiteConfig` custom resource (CR) and the `reserved` field of the group `PolicyGenTemplate` CR.
+The {ztp} pipeline uses these values to populate the required fields in the workload partitioning `MachineConfig` CR (`cpuset`) and the `PerformanceProfile` CR (`reserved`) that configure the {sno} cluster.
+This method is a General Availability feature in {product-title} 4.14.
 ====
 
-* The workload partitioning `MachineConfig` CR pins the {product-title} infrastructure pods to a defined `cpuset` configuration.
-* The `PerformanceProfile` CR pins the systemd services to the reserved CPUs.
+The workload partitioning configuration pins the {product-title} infrastructure pods to the `reserved` CPU set.
+Platform services such as systemd, CRI-O, and kubelet run on the `reserved` CPU set.
+The `isolated` CPU sets are exclusively allocated to your container workloads.
+Isolating CPUs ensures that the workload has guaranteed access to the specified CPUs without contention from other applications running on the same node.
+All CPUs that are not isolated should be reserved.
 
 [IMPORTANT]
 ====
-The value for the `reserved` field specified in the `PerformanceProfile` CR must match the `cpuset` field in the workload partitioning `MachineConfig` CR.
+Ensure that `reserved` and `isolated` CPU sets do not overlap with each other.
 ====

modules/ztp-enabling-workload-partitioning-sno.adoc

@@ -60,13 +60,16 @@ $ mkdir -p ./site-install
 
 . Modify the example `SiteConfig` CR for the cluster type that you want to install. Copy `example-sno.yaml` to `site-1-sno.yaml` and modify the CR to match the details of the site and bare-metal host that you want to install, for example:
 +
-include::snippets/ztp-example-siteconfig.adoc[]
+[source,yaml]
+----
+include::snippets/ztp_example-sno.yaml[]
+----
 
-. Generate the day-0 installation CRs by processing the modified `SiteConfig` CR `site-1-sno.yaml` by running the following command:
+. Generate the Day 0 installation CRs by processing the modified `SiteConfig` CR `site-1-sno.yaml` by running the following command:
 +
 [source,terminal,subs="attributes+"]
 ----
-$ podman run -it --rm -v `pwd`/out/argocd/example/siteconfig:/resources:Z -v `pwd`/site-install:/output:Z,U registry.redhat.io/openshift4/ztp-site-generate-rhel8:v{product-version}.1 generator install site-1-sno.yaml /output
+$ podman run -it --rm -v `pwd`/out/argocd/example/siteconfig:/resources:Z -v `pwd`/site-install:/output:Z,U registry.redhat.io/openshift4/ztp-site-generate-rhel8:v{product-version} generator install site-1-sno.yaml /output
 ----
 +
 .Example output
@@ -88,7 +91,7 @@ site-install
     └── site-1-sno_nmstateconfig_example-node1.example.com.yaml
 ----
 
-. Optional: Generate just the day-0 `MachineConfig` installation CRs for a particular cluster type by processing the reference `SiteConfig` CR with the `-E` option. For example, run the following commands:
+. Optional: Generate just the Day 0 `MachineConfig` installation CRs for a particular cluster type by processing the reference `SiteConfig` CR with the `-E` option. For example, run the following commands:
 
 .. Create an output folder for the `MachineConfig` CRs:
 +
@@ -101,7 +104,7 @@ $ mkdir -p ./site-machineconfig
 +
 [source,terminal,subs="attributes+"]
 ----
-$ podman run -it --rm -v `pwd`/out/argocd/example/siteconfig:/resources:Z -v `pwd`/site-machineconfig:/output:Z,U registry.redhat.io/openshift4/ztp-site-generate-rhel8:v{product-version}.1 generator install -E site-1-sno.yaml /output
+$ podman run -it --rm -v `pwd`/out/argocd/example/siteconfig:/resources:Z -v `pwd`/site-machineconfig:/output:Z,U registry.redhat.io/openshift4/ztp-site-generate-rhel8:v{product-version} generator install -E site-1-sno.yaml /output
 ----
 +
 .Example output
@@ -114,20 +117,20 @@ site-machineconfig
     └── site-1-sno_machineconfig_predefined-extra-manifests-worker.yaml
 ----
 
-. Generate and export the day-2 configuration CRs using the reference `PolicyGenTemplate` CRs from the previous step. Run the following commands:
+. Generate and export the Day 2 configuration CRs using the reference `PolicyGenTemplate` CRs from the previous step. Run the following commands:
 
-.. Create an output folder for the day-2 CRs:
+.. Create an output folder for the Day 2 CRs:
 +
 [source,terminal]
 ----
 $ mkdir -p ./ref
 ----
 
-.. Generate and export the day-2 configuration CRs:
+.. Generate and export the Day 2 configuration CRs:
 +
 [source,terminal,subs="attributes+"]
 ----
-$ podman run -it --rm -v `pwd`/out/argocd/example/policygentemplates:/resources:Z -v `pwd`/ref:/output:Z,U registry.redhat.io/openshift4/ztp-site-generate-rhel8:v{product-version}.1 generator config -N . /output
+$ podman run -it --rm -v `pwd`/out/argocd/example/policygentemplates:/resources:Z -v `pwd`/ref:/output:Z,U registry.redhat.io/openshift4/ztp-site-generate-rhel8:v{product-version} generator config -N . /output
 ----
 +
 The command generates example group and site-specific `PolicyGenTemplate` CRs for {sno}, three-node clusters, and standard clusters in the `./ref` folder.

modules/ztp-generating-install-and-config-crs-manually.adoc

@@ -22,7 +22,7 @@ The following table lists the installation CRs that are automatically applied by
 
 |`BareMetalHost`
 |Contains the connection information for the Baseboard Management Controller (BMC) of the target bare-metal host.
-|Provides access to the BMC to load and start the discovery image on the target server. {ztp-first} supports iPXE and virtual media booting by using Redfish or IPMI protocols. To use iPXE booting, you must use {rh-rhacm} 2.8 or later.
+|Provides access to the BMC to load and start the discovery image on the target server by using the Redfish protocol.
 
 |`InfraEnv`
 |Contains information for installing {product-title} on the target bare-metal host.

modules/ztp-installation-crs.adoc

@@ -2,7 +2,7 @@
 //
 // * scalability_and_performance/ztp_far_edge/ztp-precaching-tool.adoc
 
-:_module-type: PROCEDURE
+:_content-type: PROCEDURE
 [id="ztp-booting-from-live-os_{context}"]
 = Booting from a live operating system image
 
@@ -61,4 +61,4 @@ $ curl --globoff -L -w "%{http_code} %{url_effective}\\n" -ku ${username_passwor
 $ curl --globoff  -L -w "%{http_code} %{url_effective}\\n"  -ku ${username_password}  -H "Content-Type: application/json" -H "Accept: application/json" -d '{"Boot":{ "BootSourceOverrideEnabled": "Once", "BootSourceOverrideTarget": "Cd", "BootSourceOverrideMode": "UEFI"}}' -X PATCH https://$BMC_ADDRESS/redfish/v1/Systems/Self
 ----
 
-. Reboot and ensure that the server is booting from virtual media.
+. Reboot and ensure that the server is booting from virtual media.

modules/ztp-precaching-booting-from-live-os.adoc

@@ -2,7 +2,7 @@
 //
 // * scalability_and_performance/ztp_far_edge/ztp-precaching-tool.adoc
 
-:_module-type: PROCEDURE
+:_content-type: PROCEDURE
 [id="ztp-getting-tool_{context}"]
 = Getting the {factory-prestaging-tool}
 
@@ -33,4 +33,4 @@ If you are working in a disconnected environment or have a private registry, you
 [source,terminal]
 ----
 factory-precaching-cli version 20221018.120852+main.feecf17
-----
+----

modules/ztp-precaching-getting-tool.adoc

@@ -2,7 +2,7 @@
 //
 // * scalability_and_performance/ztp_far_edge/ztp-precaching-tool.adoc
 
-:_module-type: PROCEDURE
+:_content-type: PROCEDURE
 [id="ztp-pre-staging-troubleshooting_{context}"]
 = Troubleshooting
 
@@ -44,7 +44,7 @@ error: error rendering new refs: render reference "eko4.cloud.lab.eng.bos.redhat
 # cp /tmp/eko4-ca.crt /etc/pki/ca-trust/source/anchors/.
 ----
 
-. Update the certificates trust store:
+. Update the certificates truststore:
 +
 [source,terminal]
 ----
@@ -59,4 +59,4 @@ error: error rendering new refs: render reference "eko4.cloud.lab.eng.bos.redhat
 factory-precaching-cli download -r 4.11.5 --acm-version 2.5.4 \
    --mce-version 2.0.4 -f /mnt \--img quay.io/custom/repository
    --du-profile -s --skip-imageset
-----
+----