From c450b97d3df8d37a0eb46d7ac8b62a7507afd136 Mon Sep 17 00:00:00 2001 From: Ronan Hennessy Date: Fri, 31 Jan 2025 14:10:53 +0000 Subject: [PATCH] TELCODOCS-2178: Refactoring TOC to accomodate the problem of 4th level TOCs that exists on docs.redhat.com --- _topic_maps/_topic_map.yml | 24 +++++++---------- .../ztp-advanced-policygenerator-config.adoc | 4 +-- .../ztp-advanced-policy-config.adoc | 4 +-- .../installing-openstack-nfv-preparing.adoc | 2 +- installing/overview/installing-preparing.adoc | 2 +- .../using-dpdk-and-rdma.adoc | 10 +++---- operators/operator-reference.adoc | 2 +- ...f-debugging-low-latency-tuning-status.adoc | 26 +++++++++++++++++++ .../cnf-numa-aware-scheduling.adoc | 2 +- ...g-platform-verification-latency-tests.adoc | 2 +- ...nf-provisioning-low-latency-workloads.adoc | 10 +++---- ...g-low-latency-nodes-with-perf-profile.adoc | 10 +++---- .../cnf-understanding-low-latency.adoc | 2 +- .../enabling-workload-partitioning.adoc | 2 +- scalability_and_performance/index.adoc | 2 +- .../low_latency_tuning/_attributes | 1 - ...f-debugging-low-latency-tuning-status.adoc | 26 ------------------- .../low_latency_tuning/images | 1 - .../low_latency_tuning/modules | 1 - .../low_latency_tuning/snippets | 1 - .../telco-core-ref-design-components.adoc | 6 ++--- .../ran/telco-ran-ref-du-components.adoc | 4 +-- ...onfiguring-cluster-realtime-workloads.adoc | 4 +-- 23 files changed, 70 insertions(+), 78 deletions(-) create mode 100644 scalability_and_performance/cnf-debugging-low-latency-tuning-status.adoc rename scalability_and_performance/{low_latency_tuning => }/cnf-performing-platform-verification-latency-tests.adoc (88%) rename scalability_and_performance/{low_latency_tuning => }/cnf-provisioning-low-latency-workloads.adoc (67%) rename scalability_and_performance/{low_latency_tuning => }/cnf-tuning-low-latency-nodes-with-perf-profile.adoc (80%) rename scalability_and_performance/{low_latency_tuning => }/cnf-understanding-low-latency.adoc (79%) delete mode 120000 scalability_and_performance/low_latency_tuning/_attributes delete mode 100644 scalability_and_performance/low_latency_tuning/cnf-debugging-low-latency-tuning-status.adoc delete mode 120000 scalability_and_performance/low_latency_tuning/images delete mode 120000 scalability_and_performance/low_latency_tuning/modules delete mode 120000 scalability_and_performance/low_latency_tuning/snippets diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index e7e9815ade..9d9dc52005 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -3336,20 +3336,16 @@ Topics: - Name: What huge pages do and how they are consumed by apps File: what-huge-pages-do-and-how-they-are-consumed-by-apps Distros: openshift-origin,openshift-enterprise -- Name: Low latency tuning - Dir: low_latency_tuning - Distros: openshift-origin,openshift-enterprise - Topics: - - Name: Understanding low latency - File: cnf-understanding-low-latency - - Name: Tuning nodes for low latency with the performance profile - File: cnf-tuning-low-latency-nodes-with-perf-profile - - Name: Provisioning real-time and low latency workloads - File: cnf-provisioning-low-latency-workloads - - Name: Debugging low latency tuning - File: cnf-debugging-low-latency-tuning-status - - Name: Performing latency tests for platform verification - File: cnf-performing-platform-verification-latency-tests +- Name: Understanding low latency + File: cnf-understanding-low-latency +- Name: Tuning nodes for low latency with the performance profile + File: cnf-tuning-low-latency-nodes-with-perf-profile +- Name: Provisioning real-time and low latency workloads + File: cnf-provisioning-low-latency-workloads +- Name: Debugging low latency tuning + File: cnf-debugging-low-latency-tuning-status +- Name: Performing latency tests for platform verification + File: cnf-performing-platform-verification-latency-tests - Name: Improving cluster stability in high latency environments using worker latency profiles File: scaling-worker-latency-profiles Distros: openshift-origin,openshift-enterprise diff --git a/edge_computing/policygenerator_for_ztp/ztp-advanced-policygenerator-config.adoc b/edge_computing/policygenerator_for_ztp/ztp-advanced-policygenerator-config.adoc index 9250769a57..8fc5e0bbd1 100644 --- a/edge_computing/policygenerator_for_ztp/ztp-advanced-policygenerator-config.adoc +++ b/edge_computing/policygenerator_for_ztp/ztp-advanced-policygenerator-config.adoc @@ -45,7 +45,7 @@ include::modules/ztp-using-pgt-to-configure-power-states.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#configuring-workload-hints_cnf-low-latency-perf-profile[Configuring node power consumption and realtime processing with workload hints] +* xref:../../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#configuring-workload-hints_cnf-low-latency-perf-profile[Configuring node power consumption and realtime processing with workload hints] include::modules/ztp-using-pgt-to-configure-performance-mode.adoc[leveloffset=+2] @@ -56,7 +56,7 @@ include::modules/ztp-using-pgt-to-configure-power-saving-mode.adoc[leveloffset=+ [role="_additional-resources"] .Additional resources -* xref:../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-configuring-power-saving-for-nodes_cnf-low-latency-perf-profile[Configuring power saving for nodes that run colocated high and low priority workloads] +* xref:../../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-configuring-power-saving-for-nodes_cnf-low-latency-perf-profile[Configuring power saving for nodes that run colocated high and low priority workloads] * xref:../../edge_computing/ztp-reference-cluster-configuration-for-vdu.adoc#ztp-du-configuring-host-firmware-requirements_sno-configure-for-vdu[Configuring host firmware for low latency and high performance] diff --git a/edge_computing/policygentemplate_for_ztp/ztp-advanced-policy-config.adoc b/edge_computing/policygentemplate_for_ztp/ztp-advanced-policy-config.adoc index eda85b1db6..d0eaeb9592 100644 --- a/edge_computing/policygentemplate_for_ztp/ztp-advanced-policy-config.adoc +++ b/edge_computing/policygentemplate_for_ztp/ztp-advanced-policy-config.adoc @@ -41,7 +41,7 @@ include::modules/ztp-using-pgt-to-configure-power-states.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#configuring-workload-hints_cnf-low-latency-perf-profile[Configuring node power consumption and realtime processing with workload hints] +* xref:../../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#configuring-workload-hints_cnf-low-latency-perf-profile[Configuring node power consumption and realtime processing with workload hints] include::modules/ztp-using-pgt-to-configure-performance-mode.adoc[leveloffset=+2] @@ -54,7 +54,7 @@ include::modules/ztp-using-pgt-to-configure-power-saving-mode.adoc[leveloffset=+ [role="_additional-resources"] .Additional resources -* xref:../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-configuring-power-saving-for-nodes_cnf-low-latency-perf-profile[Configuring power saving for nodes that run colocated high and low priority workloads] +* xref:../../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-configuring-power-saving-for-nodes_cnf-low-latency-perf-profile[Configuring power saving for nodes that run colocated high and low priority workloads] * xref:../../edge_computing/ztp-reference-cluster-configuration-for-vdu.adoc#ztp-du-configuring-host-firmware-requirements_sno-configure-for-vdu[Configuring host firmware for low latency and high performance] diff --git a/installing/installing_openstack/installing-openstack-nfv-preparing.adoc b/installing/installing_openstack/installing-openstack-nfv-preparing.adoc index a30dd5ae18..e57c44736c 100644 --- a/installing/installing_openstack/installing-openstack-nfv-preparing.adoc +++ b/installing/installing_openstack/installing-openstack-nfv-preparing.adoc @@ -45,5 +45,5 @@ After you perform preinstallation tasks, install your cluster by following the m * Consult the following references after you deploy your cluster to improve its performance: ** xref:../../networking/hardware_networks/using-dpdk-and-rdma.adoc#nw-openstack-ovs-dpdk-testpmd-pod_using-dpdk-and-rdma[A test pod template for clusters that use OVS-DPDK on OpenStack]. ** xref:../../networking/hardware_networks/add-pod.adoc#nw-openstack-sr-iov-testpmd-pod_add-pod[A test pod template for clusters that use SR-IOV on OpenStack]. -** xref:../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#installation-openstack-ovs-dpdk-performance-profile_cnf-low-latency-perf-profile[A performance profile template for clusters that use OVS-DPDK on OpenStack] +** xref:../../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#installation-openstack-ovs-dpdk-performance-profile_cnf-low-latency-perf-profile[A performance profile template for clusters that use OVS-DPDK on OpenStack] . diff --git a/installing/overview/installing-preparing.adoc b/installing/overview/installing-preparing.adoc index 46aa5551e1..faf36c8dfd 100644 --- a/installing/overview/installing-preparing.adoc +++ b/installing/overview/installing-preparing.adoc @@ -115,7 +115,7 @@ For a production cluster, you must configure the following integrations: [id="installing-preparing-cluster-for-workloads"] == Preparing your cluster for workloads -Depending on your workload needs, you might need to take extra steps before you begin deploying applications. For example, after you prepare infrastructure to support your application xref:../../cicd/builds/build-strategies.adoc#build-strategies[build strategy], you might need to make provisions for xref:../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-low-latency-perf-profile[low-latency] workloads or to xref:../../nodes/pods/nodes-pods-secrets.adoc#nodes-pods-secrets[protect sensitive workloads]. You can also configure xref:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[monitoring] for application workloads. +Depending on your workload needs, you might need to take extra steps before you begin deploying applications. For example, after you prepare infrastructure to support your application xref:../../cicd/builds/build-strategies.adoc#build-strategies[build strategy], you might need to make provisions for xref:../../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-low-latency-perf-profile[low-latency] workloads or to xref:../../nodes/pods/nodes-pods-secrets.adoc#nodes-pods-secrets[protect sensitive workloads]. You can also configure xref:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[monitoring] for application workloads. If you plan to run xref:../../windows_containers/enabling-windows-container-workloads.adoc#enabling-windows-container-workloads[Windows workloads], you must enable xref:../../networking/ovn_kubernetes_network_provider/configuring-hybrid-networking.adoc#configuring-hybrid-networking[hybrid networking with OVN-Kubernetes] during the installation process; hybrid networking cannot be enabled after your cluster is installed. [id="supported-installation-methods-for-different-platforms"] diff --git a/networking/hardware_networks/using-dpdk-and-rdma.adoc b/networking/hardware_networks/using-dpdk-and-rdma.adoc index a2e9e8614f..9d85bf1e52 100644 --- a/networking/hardware_networks/using-dpdk-and-rdma.adoc +++ b/networking/hardware_networks/using-dpdk-and-rdma.adoc @@ -24,7 +24,7 @@ include::modules/nw-running-dpdk-rootless-tap.adoc[leveloffset=+1] // I can't seem to find this in 4.16 or 4.15 * xr3f:../../networking/multiple_networks/configuring-additional-network.adoc#nw-multus-enable-container_use_devices_configuring-additional-network[Enabling the container_use_devices boolean] -* xref:../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-create-performance-profiles[Creating a performance profile] +* xref:../../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-create-performance-profiles[Creating a performance profile] * xref:../../networking/hardware_networks/configuring-sriov-device.adoc#configuring-sriov-device[Configuring an SR-IOV network device] @@ -59,17 +59,17 @@ include::modules/nw-openstack-hw-offload-testpmd-pod.adoc[leveloffset=+1] * xref:../../networking/hardware_networks/about-sriov.adoc#supported-devices_about-sriov[Supported devices] -* xref:../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-create-performance-profiles[Creating a performance profile] +* xref:../../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-create-performance-profiles[Creating a performance profile] -* xref:../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#adjusting-nic-queues-with-the-performance-profile_cnf-low-latency-perf-profile[Adjusting the NIC queues with the performance profile] +* xref:../../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#adjusting-nic-queues-with-the-performance-profile_cnf-low-latency-perf-profile[Adjusting the NIC queues with the performance profile] -* xref:../../scalability_and_performance/low_latency_tuning/cnf-provisioning-low-latency-workloads.adoc#cnf-provisioning-low-latency-workloads[Provisioning real-time and low latency workloads] +* xref:../../scalability_and_performance/cnf-provisioning-low-latency-workloads.adoc#cnf-provisioning-low-latency-workloads[Provisioning real-time and low latency workloads] * xref:../../networking/networking_operators/sr-iov-operator/installing-sriov-operator.adoc#installing-sriov-operator[Installing the SR-IOV Network Operator] * xref:../../networking/hardware_networks/configuring-sriov-device.adoc#nw-sriov-networknodepolicy-object_configuring-sriov-device[Configuring an SR-IOV network device] * xref:../../networking/multiple_networks/secondary_networks/configuring-ip-secondary-nwt.adoc#nw-multus-whereabouts_configuring-additional-network[Dynamic IP address assignment configuration with Whereabouts] -* xref:../../scalability_and_performance/low_latency_tuning/cnf-provisioning-low-latency-workloads.adoc#disabling-interrupt-processing-for-individual-pods_cnf-provisioning-low-latency[Disabling interrupt processing for individual pods] +* xref:../../scalability_and_performance/cnf-provisioning-low-latency-workloads.adoc#disabling-interrupt-processing-for-individual-pods_cnf-provisioning-low-latency[Disabling interrupt processing for individual pods] * xref:../../networking/hardware_networks/configuring-sriov-net-attach.adoc#configuring-sriov-net-attach[Configuring an SR-IOV Ethernet network attachment] diff --git a/operators/operator-reference.adoc b/operators/operator-reference.adoc index 7511a3b076..2072519460 100644 --- a/operators/operator-reference.adoc +++ b/operators/operator-reference.adoc @@ -128,7 +128,7 @@ include::modules/node-tuning-operator.adoc[leveloffset=+1] [role="_additional-resources"] [id="cluster-operators-ref-nto-addtl-resources"] === Additional resources -* xref:../scalability_and_performance/low_latency_tuning/cnf-understanding-low-latency.adoc#cnf-understanding-low-latency_cnf-understanding-low-latency[About low latency] +* xref:../scalability_and_performance/cnf-understanding-low-latency.adoc#cnf-understanding-low-latency_cnf-understanding-low-latency[About low latency] include::modules/openshift-apiserver-operator.adoc[leveloffset=+1] diff --git a/scalability_and_performance/cnf-debugging-low-latency-tuning-status.adoc b/scalability_and_performance/cnf-debugging-low-latency-tuning-status.adoc new file mode 100644 index 0000000000..09248f04a1 --- /dev/null +++ b/scalability_and_performance/cnf-debugging-low-latency-tuning-status.adoc @@ -0,0 +1,26 @@ +:_mod-docs-content-type: ASSEMBLY +[id="cnf-debugging-low-latency-tuning-status"] += Debugging low latency node tuning status +include::_attributes/common-attributes.adoc[] +:context: cnf-debugging-low-latency + +toc::[] + +Use the `PerformanceProfile` custom resource (CR) status fields for reporting tuning status and debugging latency issues in the cluster node. + +include::modules/cnf-debugging-low-latency-cnf-tuning-status.adoc[leveloffset=+1] + +include::modules/cnf-collecting-low-latency-tuning-debugging-data-for-red-hat-support.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources + +* xref:../support/gathering-cluster-data.adoc#gathering-cluster-data[Gathering data about your cluster with the `must-gather` tool] + +* xref:../nodes/nodes/nodes-nodes-managing.adoc#nodes-nodes-managing[Managing nodes with MachineConfig and KubeletConfig CRs] + +* xref:../scalability_and_performance/using-node-tuning-operator.adoc#using-node-tuning-operator[Using the Node Tuning Operator] + +* xref:../scalability_and_performance/what-huge-pages-do-and-how-they-are-consumed-by-apps.adoc#configuring-huge-pages_huge-pages[Configuring huge pages at boot time] + +* xref:../scalability_and_performance/what-huge-pages-do-and-how-they-are-consumed-by-apps.adoc#how-huge-pages-are-consumed-by-apps_huge-pages[How huge pages are consumed by apps] diff --git a/scalability_and_performance/cnf-numa-aware-scheduling.adoc b/scalability_and_performance/cnf-numa-aware-scheduling.adoc index 7561f35e6e..b59ffd6d30 100644 --- a/scalability_and_performance/cnf-numa-aware-scheduling.adoc +++ b/scalability_and_performance/cnf-numa-aware-scheduling.adoc @@ -45,7 +45,7 @@ include::modules/cnf-configuring-single-numa-policy.adoc[leveloffset=+2] * xref:../disconnected/updating/disconnected-update.adoc#images-configuration-registry-mirror-configuring_updating-disconnected-cluster[Configuring image registry repository mirroring] -* xref:../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-about-the-profile-creator-tool_cnf-low-latency-perf-profile[About the Performance Profile Creator] +* xref:../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-about-the-profile-creator-tool_cnf-low-latency-perf-profile[About the Performance Profile Creator] include::modules/cnf-sample-single-numa-policy-from-pp.adoc[leveloffset=+2] diff --git a/scalability_and_performance/low_latency_tuning/cnf-performing-platform-verification-latency-tests.adoc b/scalability_and_performance/cnf-performing-platform-verification-latency-tests.adoc similarity index 88% rename from scalability_and_performance/low_latency_tuning/cnf-performing-platform-verification-latency-tests.adoc rename to scalability_and_performance/cnf-performing-platform-verification-latency-tests.adoc index 33dcc00b37..dc010048b9 100644 --- a/scalability_and_performance/low_latency_tuning/cnf-performing-platform-verification-latency-tests.adoc +++ b/scalability_and_performance/cnf-performing-platform-verification-latency-tests.adoc @@ -22,7 +22,7 @@ Your cluster must meet the following requirements before you can run the latency [role="_additional-resources"] .Additional resources -* xref:../../scalability_and_performance/low_latency_tuning/cnf-provisioning-low-latency-workloads.adoc#cnf-scheduling-workload-onto-worker-with-real-time-capabilities_cnf-provisioning-low-latency[Scheduling a workload onto a worker with real-time capabilities] +* xref:../scalability_and_performance/cnf-provisioning-low-latency-workloads.adoc#cnf-scheduling-workload-onto-worker-with-real-time-capabilities_cnf-provisioning-low-latency[Scheduling a workload onto a worker with real-time capabilities] include::modules/cnf-measuring-latency.adoc[leveloffset=+1] diff --git a/scalability_and_performance/low_latency_tuning/cnf-provisioning-low-latency-workloads.adoc b/scalability_and_performance/cnf-provisioning-low-latency-workloads.adoc similarity index 67% rename from scalability_and_performance/low_latency_tuning/cnf-provisioning-low-latency-workloads.adoc rename to scalability_and_performance/cnf-provisioning-low-latency-workloads.adoc index c213461c65..b13a680b42 100644 --- a/scalability_and_performance/low_latency_tuning/cnf-provisioning-low-latency-workloads.adoc +++ b/scalability_and_performance/cnf-provisioning-low-latency-workloads.adoc @@ -20,14 +20,14 @@ When writing your applications, follow the general recommendations described in [role="_additional-resources"] .Additional resources -* xref:../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-create-performance-profiles[Creating a performance profile] +* xref:../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-create-performance-profiles[Creating a performance profile] include::modules/cnf-scheduling-workload-onto-worker-with-real-time-capabilities.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../../nodes/scheduling/nodes-scheduler-node-selectors.adoc#nodes-pods-node-selectors[Placing pods on specific nodes using node selectors] +* xref:../nodes/scheduling/nodes-scheduler-node-selectors.adoc#nodes-pods-node-selectors[Placing pods on specific nodes using node selectors] * link:https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node[Assigning pods to nodes] @@ -40,18 +40,18 @@ include::modules/cnf-configuring-high-priority-workload-pods.adoc[leveloffset=+1 [role="_additional-resources"] .Additional resources -xref:../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-configuring-power-saving-for-nodes_cnf-low-latency-perf-profile[Configuring power saving for nodes that run colocated high and low priority workloads] +xref:../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-configuring-power-saving-for-nodes_cnf-low-latency-perf-profile[Configuring power saving for nodes that run colocated high and low priority workloads] include::modules/cnf-disabling-cpu-cfs-quota.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../../edge_computing/ztp-vdu-validating-cluster-tuning.adoc#ztp-du-firmware-config-reference_vdu-config-ref[Recommended firmware configuration for vDU cluster hosts] +* xref:../edge_computing/ztp-vdu-validating-cluster-tuning.adoc#ztp-du-firmware-config-reference_vdu-config-ref[Recommended firmware configuration for vDU cluster hosts] include::modules/cnf-disabling-interrupt-processing-for-individual-pods.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile#managing-device-interrupt-processing-for-guaranteed-pod-isolated-cpus_cnf-low-latency-perf-profile[Managing device interrupt processing for guaranteed pod isolated CPUs] +* xref:../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile#managing-device-interrupt-processing-for-guaranteed-pod-isolated-cpus_cnf-low-latency-perf-profile[Managing device interrupt processing for guaranteed pod isolated CPUs] diff --git a/scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc b/scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc similarity index 80% rename from scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc rename to scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc index 719d1b382a..cf390f5f67 100644 --- a/scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc +++ b/scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc @@ -45,7 +45,7 @@ include::modules/cnf-gathering-data-about-cluster-using-must-gather.adoc[levelof .Additional resources * For more information about the `must-gather` tool, -see xref:../../support/gathering-cluster-data.adoc#nodes-nodes-managing[Gathering data about your cluster]. +see xref:../support/gathering-cluster-data.adoc#nodes-nodes-managing[Gathering data about your cluster]. include::modules/cnf-running-the-performance-creator-profile.adoc[leveloffset=+2] @@ -73,11 +73,11 @@ include::modules/cnf-configuring-power-saving-for-nodes.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-about-the-profile-creator-tool_cnf-low-latency-perf-profile[About the Performance Profile Creator] +* xref:../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-about-the-profile-creator-tool_cnf-low-latency-perf-profile[About the Performance Profile Creator] -* xref:../../scalability_and_performance/low_latency_tuning/cnf-provisioning-low-latency-workloads.adoc#cnf-configuring-high-priority-workload-pods_cnf-provisioning-low-latency[Disabling power saving mode for high priority pods] +* xref:../scalability_and_performance/cnf-provisioning-low-latency-workloads.adoc#cnf-configuring-high-priority-workload-pods_cnf-provisioning-low-latency[Disabling power saving mode for high priority pods] -* xref:../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#managing-device-interrupt-processing-for-guaranteed-pod-isolated-cpus_cnf-low-latency-perf-profile[Managing device interrupt processing for guaranteed pod isolated CPUs] +* xref:../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#managing-device-interrupt-processing-for-guaranteed-pod-isolated-cpus_cnf-low-latency-perf-profile[Managing device interrupt processing for guaranteed pod isolated CPUs] include::modules/cnf-cpu-infra-container.adoc[leveloffset=+1] @@ -104,7 +104,7 @@ include::modules/cnf-adjusting-nic-queues-with-the-performance-profile.adoc[leve [role="_additional-resources"] .Additional resources -* xref:../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-create-performance-profiles[Creating a performance profile]. +* xref:../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-create-performance-profiles[Creating a performance profile]. include::modules/cnf-verifying-queue-status.adoc[leveloffset=+2] diff --git a/scalability_and_performance/low_latency_tuning/cnf-understanding-low-latency.adoc b/scalability_and_performance/cnf-understanding-low-latency.adoc similarity index 79% rename from scalability_and_performance/low_latency_tuning/cnf-understanding-low-latency.adoc rename to scalability_and_performance/cnf-understanding-low-latency.adoc index e528aee325..1b119359a7 100644 --- a/scalability_and_performance/low_latency_tuning/cnf-understanding-low-latency.adoc +++ b/scalability_and_performance/cnf-understanding-low-latency.adoc @@ -17,4 +17,4 @@ include::modules/cnf-about-hyperthreading-for-low-latency-and-real-time-applicat [role="_additional-resources"] .Additional resources -* xref:../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-configuring-hyperthreading-for-a-cluster_cnf-low-latency-perf-profile[Configuring Hyper-Threading for a cluster] +* xref:../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-configuring-hyperthreading-for-a-cluster_cnf-low-latency-perf-profile[Configuring Hyper-Threading for a cluster] diff --git a/scalability_and_performance/enabling-workload-partitioning.adoc b/scalability_and_performance/enabling-workload-partitioning.adoc index 02f8fe590f..fd0302823b 100644 --- a/scalability_and_performance/enabling-workload-partitioning.adoc +++ b/scalability_and_performance/enabling-workload-partitioning.adoc @@ -30,7 +30,7 @@ include::modules/create-perf-profile-workload-partitioning.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-about-the-profile-creator-tool_cnf-low-latency-perf-profile[About the Performance Profile Creator] +* xref:../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-about-the-profile-creator-tool_cnf-low-latency-perf-profile[About the Performance Profile Creator] == Sample performance profile configuration diff --git a/scalability_and_performance/index.adoc b/scalability_and_performance/index.adoc index 2336cb384a..c246ab9659 100644 --- a/scalability_and_performance/index.adoc +++ b/scalability_and_performance/index.adoc @@ -50,7 +50,7 @@ xref:../scalability_and_performance/managing-bare-metal-hosts.adoc#managing-bare xref:../scalability_and_performance/what-huge-pages-do-and-how-they-are-consumed-by-apps.adoc#what-huge-pages-do-and-how-they-are-consumed[What are huge pages and how are they used by apps] -xref:../scalability_and_performance/low_latency_tuning/cnf-understanding-low-latency.adoc#cnf-understanding-low-latency[Low latency tuning for improving cluster stability and partitioning workload] +xref:../scalability_and_performance/cnf-understanding-low-latency.adoc#cnf-understanding-low-latency[Low latency tuning for improving cluster stability and partitioning workload] xref:../scalability_and_performance/scaling-worker-latency-profiles.adoc#scaling-worker-latency-profiles[Improving cluster stability in high latency environments using worker latency profiles] diff --git a/scalability_and_performance/low_latency_tuning/_attributes b/scalability_and_performance/low_latency_tuning/_attributes deleted file mode 120000 index 20cc1dcb77..0000000000 --- a/scalability_and_performance/low_latency_tuning/_attributes +++ /dev/null @@ -1 +0,0 @@ -../../_attributes/ \ No newline at end of file diff --git a/scalability_and_performance/low_latency_tuning/cnf-debugging-low-latency-tuning-status.adoc b/scalability_and_performance/low_latency_tuning/cnf-debugging-low-latency-tuning-status.adoc deleted file mode 100644 index 297cfd533f..0000000000 --- a/scalability_and_performance/low_latency_tuning/cnf-debugging-low-latency-tuning-status.adoc +++ /dev/null @@ -1,26 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="cnf-debugging-low-latency-tuning-status"] -= Debugging low latency node tuning status -include::_attributes/common-attributes.adoc[] -:context: cnf-debugging-low-latency - -toc::[] - -Use the `PerformanceProfile` custom resource (CR) status fields for reporting tuning status and debugging latency issues in the cluster node. - -include::modules/cnf-debugging-low-latency-cnf-tuning-status.adoc[leveloffset=+1] - -include::modules/cnf-collecting-low-latency-tuning-debugging-data-for-red-hat-support.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* xref:../../support/gathering-cluster-data.adoc#gathering-cluster-data[Gathering data about your cluster with the `must-gather` tool] - -* xref:../../nodes/nodes/nodes-nodes-managing.adoc#nodes-nodes-managing[Managing nodes with MachineConfig and KubeletConfig CRs] - -* xref:../../scalability_and_performance/using-node-tuning-operator.adoc#using-node-tuning-operator[Using the Node Tuning Operator] - -* xref:../../scalability_and_performance/what-huge-pages-do-and-how-they-are-consumed-by-apps.adoc#configuring-huge-pages_huge-pages[Configuring huge pages at boot time] - -* xref:../../scalability_and_performance/what-huge-pages-do-and-how-they-are-consumed-by-apps.adoc#how-huge-pages-are-consumed-by-apps_huge-pages[How huge pages are consumed by apps] diff --git a/scalability_and_performance/low_latency_tuning/images b/scalability_and_performance/low_latency_tuning/images deleted file mode 120000 index 847b03ed05..0000000000 --- a/scalability_and_performance/low_latency_tuning/images +++ /dev/null @@ -1 +0,0 @@ -../../images/ \ No newline at end of file diff --git a/scalability_and_performance/low_latency_tuning/modules b/scalability_and_performance/low_latency_tuning/modules deleted file mode 120000 index 36719b9de7..0000000000 --- a/scalability_and_performance/low_latency_tuning/modules +++ /dev/null @@ -1 +0,0 @@ -../../modules/ \ No newline at end of file diff --git a/scalability_and_performance/low_latency_tuning/snippets b/scalability_and_performance/low_latency_tuning/snippets deleted file mode 120000 index 5a3f5add14..0000000000 --- a/scalability_and_performance/low_latency_tuning/snippets +++ /dev/null @@ -1 +0,0 @@ -../../snippets/ \ No newline at end of file diff --git a/scalability_and_performance/telco_ref_design_specs/core/telco-core-ref-design-components.adoc b/scalability_and_performance/telco_ref_design_specs/core/telco-core-ref-design-components.adoc index 7583c18ed6..8108423725 100644 --- a/scalability_and_performance/telco_ref_design_specs/core/telco-core-ref-design-components.adoc +++ b/scalability_and_performance/telco_ref_design_specs/core/telco-core-ref-design-components.adoc @@ -14,7 +14,7 @@ include::modules/telco-core-cpu-partitioning-performance-tune.adoc[leveloffset=+ [role="_additional-resources"] .Additional resources -* xref:../../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-create-performance-profiles[Creating a performance profile] +* xref:../../../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-create-performance-profiles[Creating a performance profile] * xref:../../../edge_computing/ztp-reference-cluster-configuration-for-vdu.adoc#ztp-du-configuring-host-firmware-requirements_sno-configure-for-vdu[Configuring host firmware for low latency and high performance] @@ -78,9 +78,9 @@ include::modules/telco-core-power-management.adoc[leveloffset=+1] * xref:../../../rest_api/node_apis/performanceprofile-performance-openshift-io-v2.adoc#spec-workloadhints[Performance Profile] -* xref:../../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-configuring-power-saving-for-nodes_cnf-low-latency-perf-profile[Configuring power saving for nodes] +* xref:../../../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-configuring-power-saving-for-nodes_cnf-low-latency-perf-profile[Configuring power saving for nodes] -* xref:../../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-configuring-power-saving-for-nodes_cnf-low-latency-perf-profile[Configuring power saving for nodes that run colocated high and low priority workloads] +* xref:../../../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-configuring-power-saving-for-nodes_cnf-low-latency-perf-profile[Configuring power saving for nodes that run colocated high and low priority workloads] include::modules/telco-core-storage.adoc[leveloffset=+1] diff --git a/scalability_and_performance/telco_ref_design_specs/ran/telco-ran-ref-du-components.adoc b/scalability_and_performance/telco_ref_design_specs/ran/telco-ran-ref-du-components.adoc index 8249fb0247..49126d9665 100644 --- a/scalability_and_performance/telco_ref_design_specs/ran/telco-ran-ref-du-components.adoc +++ b/scalability_and_performance/telco_ref_design_specs/ran/telco-ran-ref-du-components.adoc @@ -18,14 +18,14 @@ include::modules/telco-ran-bios-tuning.adoc[leveloffset=+1] * xref:../../../edge_computing/ztp-reference-cluster-configuration-for-vdu.adoc#ztp-du-configuring-host-firmware-requirements_sno-configure-for-vdu[Configuring host firmware for low latency and high performance] -* xref:../../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-create-performance-profiles[Creating a performance profile] +* xref:../../../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-create-performance-profiles[Creating a performance profile] include::modules/telco-ran-node-tuning-operator.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#about_irq_affinity_setting_cnf-low-latency-perf-profile[Finding the effective IRQ affinity setting for a node] +* xref:../../../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#about_irq_affinity_setting_cnf-low-latency-perf-profile[Finding the effective IRQ affinity setting for a node] include::modules/telco-ran-ptp-operator.adoc[leveloffset=+1] diff --git a/virt/managing_vms/advanced_vm_management/virt-configuring-cluster-realtime-workloads.adoc b/virt/managing_vms/advanced_vm_management/virt-configuring-cluster-realtime-workloads.adoc index 8b39cbb299..578bcdcd23 100644 --- a/virt/managing_vms/advanced_vm_management/virt-configuring-cluster-realtime-workloads.adoc +++ b/virt/managing_vms/advanced_vm_management/virt-configuring-cluster-realtime-workloads.adoc @@ -17,5 +17,5 @@ include::modules/virt-configuring-vm-real-time.adoc[leveloffset=+1] == Additional resources * xref:../../../../scalability_and_performance/using-node-tuning-operator.adoc#using-node-tuning-operator[Using the Node Tuning Operator] -* xref:../../../../scalability_and_performance/low_latency_tuning/cnf-provisioning-low-latency-workloads.adoc#cnf-provisioning-low-latency-workloads[Provisioning real-time and low latency workloads] -* xref:../../../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-reducing-nic-queues-with-nto[Reducing NIC queues using the Node Tuning Operator] +* xref:../../../../scalability_and_performance/cnf-provisioning-low-latency-workloads.adoc#cnf-provisioning-low-latency-workloads[Provisioning real-time and low latency workloads] +* xref:../../../../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-reducing-nic-queues-with-nto[Reducing NIC queues using the Node Tuning Operator]