Merge pull request #30639 from kquinn1204/CNF-792

Cnf 792

Author: sagidlow

_topic_map.yml

@@ -1921,6 +1921,10 @@ Topics:
 - Name: Performance Addon Operator for low latency nodes
   File: cnf-performance-addon-operator-for-low-latency-nodes
   Distros: openshift-origin,openshift-enterprise
+  Distros: openshift-origin,openshift-enterprise
+- Name: Creating a performance profile
+  File: cnf-create-performance-profiles
+  Distros: openshift-origin,openshift-enterprise
 - Name: Provisioning and deploying a distributed unit (DU)
   File: cnf-provisioning-and-deploying-a-distributed-unit
   Distros: openshift-webscale

modules/cnf-about-the-profile-creator-tool.adoc

@@ -0,0 +1,15 @@
+// Module included in the following assemblies:
+// Epic CNF-792 (4.8)
+// * scalability_and_performance/cnf-create-performance-profiles.adoc
+
+[id="cnf-about-the-profile-creator-tool_{context}"]
+= About the Performance Profile Creator
+
+The Performance Profile Creator (PPC) is a command-line tool, delivered with the Performance Addon Operator, used to create the performance profile.
+The tool consumes `must-gather` data from the cluster and several user-supplied profile arguments. The PPC generates a performance profile that is appropriate for your hardware and topology.
+
+The tool is run by one of the following methods:
+
+..  Invoking `podman`
+
+.. Calling a wrapper script

modules/cnf-gathering-data-about-cluster-using-must-gather.adoc

@@ -0,0 +1,45 @@
+// Module included in the following assemblies:
+// Epic CNF-792 (4.8)
+// * scalability_and_performance/cnf-create-performance-profiles.adoc
+
+[id="gathering-data-about-your-cluster-using-must-gather_{context}"]
+= Gathering data about your cluster using `must-gather`
+
+The Performance Profile Creator (PPC) tool requires `must-gather` data. As a cluster administrator, run `must-gather` to capture information about your cluster .
+
+.Prerequisites
+
+* Access to the cluster as a user with the `cluster-admin` role.
+* Access to the Performance Addon Operator image.
+* The OpenShift Container Platform CLI (`oc`) installed.
+
+.Procedure
+
+. Navigate to the directory where you want to store the `must-gather` data.
+
+. Run `must-gather` on your cluster:
++
+[source,terminal]
+
+----
+$ oc adm must-gather --image=<PAO image> --dest-dir=<dir>
+----
++
+[NOTE]
+====
+`must-gather` must be run with the `performance-addon-operator-must-gather` image. The output can optionally be compressed. Compressed output is required if you are running the Performance Profile Creator wrapper script.
+====
+
++
+.Example
++
+[source,terminal]
+----
+$ oc adm must-gather --image=quay.io/openshift-kni/performance-addon-operator-must-gather:4.8-snapshot --dest-dir=must-gather
+----
+. Create a compressed file from the `must-gather` directory:
++
+[source,terminal]
+----
+$ tar cvaf must-gather.tar.gz must-gather/
+----

modules/cnf-performance-profile-creator-arguments.adoc

@@ -0,0 +1,102 @@
+// Module included in the following assemblies:
+// Epic CNF-792 (4.8)
+// * scalability_and_performance/cnf-create-performance-profiles.adoc
+
+
+[id="performance-profile-creator-arguments_{context}"]
+=  Performance Profile Creator arguments
+
+.Performance Profile Creator arguments
+["cols="30%,70%",options="header"]
+|===
+| Argument | Description
+
+| `disable-ht`
+a|Disable hyperthreading.
+
+Possible values: `true` or `false`.
+
+Default: `false`.
+
+[WARNING]
+====
+If this argument is set to `true` you should not disable hyperthreading in the BIOS. Disabling hyperthreading is accomplished with a kernel command line argument.
+====
+
+| `info`
+a| This captures cluster information and is used in discovery mode only. Discovery mode also requires the `must-gather-dir-path`. If any other arguments are set they are ignored.
+
+Possible values:
+
+* `log`
+* `JSON`
+
++
+[NOTE]
+====
+These options define the output format with the JSON format being reserved for debugging.
+====
+
+Default: `log`.
+
+| `mcp-name`
+|MCP name for example `worker-cnf` corresponding to the target machines. This parameter is required.
+
+| `must-gather-dir-path`
+| Must gather directory path. This parameter is required.
+
+When the user runs the tool with the wrapper script `must-gather` is supplied by the script itself and the user must not specify it.
+
+| `power-consumption-mode`
+a|The power consumption mode.
+
+Possible values:
+
+* `default`
+* `low-latency`
+* `ultra-low-latency`
+
+Default: `default`.
+
+| `profile-name`
+| Name of the performance profile to create.
+Default: `performance`.
+
+| `reserved-cpu-count`
+a| Number of reserved CPUs. This parameter is required.
+
+[NOTE]
+====
+This must be a natural number. A value of 0 is not allowed.
+====
+
+| `rt-kernel`
+| Enable real-time kernel. This parameter is required.
+
+Possible values: `true` or `false`.
+
+| `split-reserved-cpus-across-numa`
+| Split the reserved CPUs across NUMA nodes.
+
+Possible values: `true` or `false`.
+
+Default: `false`.
+
+| `topology-manager-policy`
+a| Kubelet Topology Manager policy of the performance profile to be created.
+
+Possible values:
+
+* `single-numa-node`
+* `best-effort`
+* `restricted`
+
+Default: `restricted`.
+
+| `user-level-networking`
+| Run with user level networking (DPDK) enabled.
+
+Possible values: `true` or `false`.
+
+Default: `false`.
+|===