diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 38719b6f1a47..acda1788accb 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -26,7 +26,7 @@ Name: About Dir: welcome Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-online,openshift-dpu Topics: -- Name: Welcome + File: index - Name: Learn more about OpenShift Container Platform File: learn_more_about_openshift diff --git a/modules/dummy-module-abc.adoc b/modules/dummy-module-abc.adoc new file mode 100644 index 000000000000..a3cb5ccbea94 --- /dev/null +++ b/modules/dummy-module-abc.adoc @@ -0,0 +1,59 @@ +// Module included in the following assemblies: +// Epic CNF-792 (4.8) + += Gathering data about your cluster using the must-gather command + +The Performance Profile Creator (PPC) tool requires `must-gather` data. As a cluster administrator, run the must-gather command to capture information about your cluster. + +.Prerequisites + +* Access to the cluster as a user with the `cluster-admin` role. +* The OpenShift CLI installed. + +.Procedure + +. Optional: Verify that a matching machine config pool exists with a label: ++ +[source,terminal] +---- +oc describe mcp/worker-rt +---- ++ +[source,bash] +---- +Name: worker-rt +Namespace: +Labels: machineconfiguration.openshift.io/role=worker-rt +---- + +. If a matching label does not exist add a label for a machine config pool (MCP) that matches with the MCP name: ++ +[source,terminal,subs="+quotes"] +---- +$ oc label mcp __ __="" +---- + +. Navigate to the directory where you want to store the `must-gather` data. + +. Collect cluster information by running the following command. ++ +[source,terminal] +---- +oc adm must-gather +---- + +. (Optional)- Create a compressed file from the must-gather directory: ++ +[source,terminal] +---- +$ tar cvaf must-gather.tar.gz must-gather/ +---- ++ +[NOTE] +==== +Compressed output is required if you are running the Performance Profile Creator wrapper script. +==== + +xref:/machine_management/manually-scaling-machineset.adoc#machineset-manually-scaling_manually-scaling-machineset[test] + +xref:modules/about-administrator-perspective.adoc \ No newline at end of file diff --git a/modules/dummy-module-xyz.adoc b/modules/dummy-module-xyz.adoc new file mode 100644 index 000000000000..87391edfe9d7 --- /dev/null +++ b/modules/dummy-module-xyz.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// Epic CNF-792 (4.8) +// * scalability_and_performance/cnf-create-performance-profiles.adoc + +:_content-type: CONCEPT +[id="cnf-about-the-profile-creator-tool"] += About the Performance Profile Creator + +The PPC is a command-line tool, delivered with the Node Tuning 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 executed by one of the following methods: + +* Invoking `podman`. + +* Calling a wrapper script. diff --git a/scalability_and_performance/dummy-assembly.adoc b/scalability_and_performance/dummy-assembly.adoc new file mode 100644 index 000000000000..7d409d2ebc6c --- /dev/null +++ b/scalability_and_performance/dummy-assembly.adoc @@ -0,0 +1,23 @@ +[id="cnf-create-performance-profiles] += Creating a performance profile +include::_attributes/common-attributes.adoc + + + +Learn about the PPC and how you can use it to create a performance profile. + +[NOTE] +==== +Currently, disabling CPU load balancing is not supported by cgroup v2. As a result, +you might not get the desired behavior from performance profiles if you have cgroup v2 enabeld. Enabling cgroup v2 is not recommended if you are using performace profiles. +==== + +include::modules/dummy-module-xyz.adoc[leveloffset=+1] + +include::modules/dummy-module-abc.adoc[leveloffset=] + + +[role="_additional-resources"] += 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].