updates for telcodocs-1013

Author: aireilly

_topic_maps/_topic_map.yml

@@ -2394,7 +2394,7 @@ Topics:
 - Name: Creating a performance profile
   File: cnf-create-performance-profiles
   Distros: openshift-origin,openshift-enterprise
-- Name: Workload partitioning on single-node OpenShift
+- Name: Workload partitioning in single-node OpenShift
   File: sno-du-enabling-workload-partitioning-on-single-node-openshift
   Distros: openshift-origin,openshift-enterprise
 - Name: Requesting CRI-O and Kubelet profiling data by using the Node Observability Operator

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

@@ -393,8 +393,8 @@ spec:
   - rcupdate.rcu_normal_after_boot=0
   - efi=runtime
   cpu:
-    isolated: 2-51,54-103
-    reserved: 0-1,52-53
+    isolated: 4-103
+    reserved: 0-3
   hugepages:
     defaultHugepagesSize: 1G
     pages:
@@ -564,7 +564,7 @@ $ oc get performanceprofile -o jsonpath="{ .items[0].spec.cpu.reserved }"
 .Example output
 [source,terminal]
 ----
-0-1,52-53
+0-3
 ----
 +
 [NOTE]

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

@@ -0,0 +1,20 @@
+// Module included in the following assemblies:
+//
+// * scalability_and_performance/ztp_far_edge/ztp-reference-cluster-configuration-for-vdu.adoc
+
+:_content-type: CONCEPT
+[id="ztp-workload-partitioning-sno_{context}"]
+= Workload partitioning in {sno} with GitOps ZTP
+
+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 GitOps ZTP, you specify cluster management CPU resources using the `cpuset` field of the `SiteConfig` CR and the `reserved` field of the group `PolicyGenTemplate` CR.
+The GitOps 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.
+
+* 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.
+
+[IMPORTANT]
+====
+The value for the `reserved` field specified in the `PerformanceProfile` custom resource (CR) must match the `cpuset` field in the workload partitioning `MachineConfig` CR.
+====

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

@@ -24,7 +24,7 @@ include::snippets/ztp-02-master-workload-partitioning.adoc[leveloffset=+1]
 [crio.runtime.workloads.management]
 activation_annotation = "target.workload.openshift.io/management"
 annotation_prefix = "resources.workload.openshift.io"
-resources = { "cpushares" = 0, "cpuset" = "0-1,52-53" } <1>
+resources = { "cpushares" = 0, "cpuset" = "0-3" } <1>
 ----
 <1> The `CPUs` value varies based on the installation.
 +
@@ -36,8 +36,54 @@ If Hyper-Threading is enabled, specify both threads for each core. The `CPUs` va
 ----
 {
   "management": {
-    "cpuset": "0-1,52-53" <1>
+    "cpuset": "0-3" <1>
   }
 }
 ----
 <1> The `cpuset` must match the `CPUs` value in `/etc/crio/crio.conf.d/01-workload-partitioning`.
+
+.Verification
+
+Check that the applications and cluster system CPU pinning is correct. Run the following commands:
+
+. Open a remote shell connection to the managed cluster:
++
+[source,terminal]
+----
+$ oc debug node/example-sno-1
+----
+
+. Check that the user applications CPU pinning is correct:
++
+[source,terminal]
+----
+sh-4.4# pgrep ovn | while read i; do taskset -cp $i; done
+----
++
+.Example output
+[source,terminal]
+----
+pid 8481's current affinity list: 0-3
+pid 8726's current affinity list: 0-3
+pid 9088's current affinity list: 0-3
+pid 9945's current affinity list: 0-3
+pid 10387's current affinity list: 0-3
+pid 12123's current affinity list: 0-3
+pid 13313's current affinity list: 0-3
+----
+
+. Check that the system applications CPU pinning is correct:
++
+[source,terminal]
+----
+sh-4.4# pgrep systemd | while read i; do taskset -cp $i; done
+----
++
+.Example output
+[source,terminal]
+----
+pid 1's current affinity list: 0-3
+pid 938's current affinity list: 0-3
+pid 962's current affinity list: 0-3
+pid 1197's current affinity list: 0-3
+----

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

@@ -1,6 +1,6 @@
 :_content-type: ASSEMBLY
 [id="sno-du-enabling-workload-partitioning-on-single-node-openshift"]
-= Workload partitioning on {sno}
+= Workload partitioning in {sno}
 include::_attributes/common-attributes.adoc[]
 :context: sno-du-enabling-workload-partitioning-on-single-node-openshift
 
@@ -23,4 +23,7 @@ When applying workload partitioning, use the Node Tuning Operator to implement t
 Workload partitioning introduces a new extended resource of `<workload-type>.workload.openshift.io/cores`
 for each defined CPU pool, or workload-type. Kubelet advertises these new resources and CPU requests by pods allocated to the pool are accounted for within the corresponding resource rather than the typical `cpu` resource. When workload partitioning is enabled, the `<workload-type>.workload.openshift.io/cores` resource allows access to the CPU capacity of the host, not just the default CPU pool.
 
-include::modules/sno-du-enabling-workload-partitioning.adoc[leveloffset=+1]
+[role="_additional-resources"]
+.Additional resources
+
+* For the recommended workload partitioning configuration for {sno} clusters, see xref:../scalability_and_performance/ztp_far_edge/ztp-reference-cluster-configuration-for-vdu.adoc#ztp-sno-du-enabling-workload-partitioning_sno-configure-for-vdu[Workload partitioning].

scalability_and_performance/sno-du-enabling-workload-partitioning-on-single-node-openshift.adoc

@@ -23,7 +23,7 @@ include::modules/ztp-generating-install-and-config-crs-manually.adoc[leveloffset
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../scalability_and_performance/ztp_far_edge/ztp-manual-install.adoc#ztp-manually-install-a-single-managed-cluster_ztp-manual-install[Installing a single managed cluster]
+* xref:../../scalability_and_performance/ztp_far_edge/ztp-reference-cluster-configuration-for-vdu.adoc#ztp-sno-du-enabling-workload-partitioning_sno-configure-for-vdu[Workload partitioning]
 
 * xref:../../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#bmc-addressing_ipi-install-installation-workflow[BMC addressing]
 

scalability_and_performance/ztp_far_edge/ztp-manual-install.adoc

@@ -23,6 +23,13 @@ include::modules/ztp-du-host-firmware-requirements.adoc[leveloffset=+1]
 
 include::modules/ztp-managed-cluster-network-prereqs.adoc[leveloffset=+1]
 
+include::modules/ztp-enabling-workload-partitioning-sno.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+* For the recommended {sno} workload partitioning configuration, see xref:../../scalability_and_performance/ztp_far_edge/ztp-reference-cluster-configuration-for-vdu.adoc#ztp-sno-du-enabling-workload-partitioning_sno-configure-for-vdu[Workload partitioning].
+
 [id="ztp-sno-install-time-cluster-config"]
 == Recommended installation-time cluster configurations
 

scalability_and_performance/ztp_far_edge/ztp-reference-cluster-configuration-for-vdu.adoc

@@ -15,14 +15,14 @@ spec:
     storage:
       files:
       - contents:
-          source: data:text/plain;charset=utf-8;base64,W2NyaW8ucnVudGltZS53b3JrbG9hZHMubWFuYWdlbWVudF0KYWN0aXZhdGlvbl9hbm5vdGF0aW9uID0gInRhcmdldC53b3JrbG9hZC5vcGVuc2hpZnQuaW8vbWFuYWdlbWVudCIKYW5ub3RhdGlvbl9wcmVmaXggPSAicmVzb3VyY2VzLndvcmtsb2FkLm9wZW5zaGlmdC5pbyIKcmVzb3VyY2VzID0geyAiY3B1c2hhcmVzIiA9IDAsICJjcHVzZXQiID0gIjAtMSw1Mi01MyIgfQo=
+          source: data:text/plain;charset=utf-8;base64,W2NyaW8ucnVudGltZS53b3JrbG9hZHMubWFuYWdlbWVudF0KYWN0aXZhdGlvbl9hbm5vdGF0aW9uID0gInRhcmdldC53b3JrbG9hZC5vcGVuc2hpZnQuaW8vbWFuYWdlbWVudCIKYW5ub3RhdGlvbl9wcmVmaXggPSAicmVzb3VyY2VzLndvcmtsb2FkLm9wZW5zaGlmdC5pbyIKcmVzb3VyY2VzID0geyAiY3B1c2hhcmVzIiA9IDAsICJjcHVzZXQiID0gIjAtMyIgfQ==
         mode: 420
         overwrite: true
         path: /etc/crio/crio.conf.d/01-workload-partitioning
         user:
           name: root
       - contents:
-          source: data:text/plain;charset=utf-8;base64,ewogICJtYW5hZ2VtZW50IjogewogICAgImNwdXNldCI6ICIwLTEsNTItNTMiCiAgfQp9Cg==
+          source: data:text/plain;charset=utf-8;base64,ewogICJtYW5hZ2VtZW50IjogewogICAgImNwdXNldCI6ICIwLTMiCiAgfQp9
         mode: 420
         overwrite: true
         path: /etc/kubernetes/openshift-workload-pinning

snippets/ztp-02-master-workload-partitioning.adoc

@@ -43,8 +43,8 @@ spec:
         bootMode: "UEFI" <10>
         rootDeviceHints:
           wwn: "0x11111000000asd123"
-        cpuset: "0-1,52-53"
-        nodeNetwork: <11>
+        cpuset: "0-3"  <11>
+        nodeNetwork: <12>
           interfaces:
             - name: eno1
               macAddress: "AA:BB:CC:DD:EE:11"
@@ -56,7 +56,7 @@ spec:
                 macAddress: "AA:BB:CC:DD:EE:11"
                 ipv4:
                   enabled: false
-                ipv6: <12>
+                ipv6: <13>
                   enabled: true
                   address:
                   - ip: 1111:2222:3333:4444::aaaa:1
@@ -84,5 +84,6 @@ spec:
 <8> Applies to all cluster types. Specifies the BMC address. ZTP supports iPXE and virtual media booting by using Redfish or IPMI protocols.
 <9> Create the `bmh-secret` CR that specifies the BMC credentials. Use the same namespace as the `SiteConfig` CR.
 <10> Use `UEFISecureBoot` to enable secure boot on the host.
-<11> Specifies the network settings for the node.
-<12> Configures the IPv6 address for the host. For {sno} clusters with static IP addresses, the node-specific API and Ingress IPs should be the same.
+<11> `cpuset` should match the value set in the cluster `PerformanceProfile` CR `.spec.cpu.reserved` field for workload partitioning.
+<12> Specifies the network settings for the node.
+<13> Configures the IPv6 address for the host. For {sno} clusters with static IP addresses, the node-specific API and Ingress IPs should be the same.