From 89d3e4473c71220a4085cd3f9e83cacf26fba0e8 Mon Sep 17 00:00:00 2001 From: Avani Bhatt Date: Wed, 2 Aug 2023 23:31:34 +0100 Subject: [PATCH 1/2] Dummy content for a new peer reviewer to practice --- modules/dummy-module-abc.adoc | 57 +++++++++++++++++++ modules/dummy-module-xyz.adoc | 16 ++++++ .../dummy-assembly.adoc | 23 ++++++++ 3 files changed, 96 insertions(+) create mode 100644 modules/dummy-module-abc.adoc create mode 100644 modules/dummy-module-xyz.adoc create mode 100644 scalability_and_performance/dummy-assembly.adoc diff --git a/modules/dummy-module-abc.adoc b/modules/dummy-module-abc.adoc new file mode 100644 index 000000000000..594d52ce8569 --- /dev/null +++ b/modules/dummy-module-abc.adoc @@ -0,0 +1,57 @@ +// Module included in the following assemblies: +// Epic CNF-792 (4.8) + +:_content-type: PROCEDURE +[id="gathering-data-about-your-cluster-using-must-gather_{context}"] += 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. +==== 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..a2e9cb9c2e8f --- /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[] +:context: cnf-create-performance-profiles +toc::[] + +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=+2] + + +[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]. From cc0fce00ae2c7f49c90a5fb40317d4d8cd7ab85a Mon Sep 17 00:00:00 2001 From: Avani Bhatt Date: Wed, 18 Oct 2023 12:03:26 +0100 Subject: [PATCH 2/2] testing a CI failure --- _topic_maps/_topic_map.yml | 2 +- modules/dummy-module-abc.adoc | 6 ++++-- scalability_and_performance/dummy-assembly.adoc | 8 ++++---- 3 files changed, 9 insertions(+), 7 deletions(-) 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 index 594d52ce8569..a3cb5ccbea94 100644 --- a/modules/dummy-module-abc.adoc +++ b/modules/dummy-module-abc.adoc @@ -1,8 +1,6 @@ // Module included in the following assemblies: // Epic CNF-792 (4.8) -:_content-type: PROCEDURE -[id="gathering-data-about-your-cluster-using-must-gather_{context}"] = 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. @@ -55,3 +53,7 @@ $ tar cvaf must-gather.tar.gz must-gather/ ==== 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/scalability_and_performance/dummy-assembly.adoc b/scalability_and_performance/dummy-assembly.adoc index a2e9cb9c2e8f..7d409d2ebc6c 100644 --- a/scalability_and_performance/dummy-assembly.adoc +++ b/scalability_and_performance/dummy-assembly.adoc @@ -1,8 +1,8 @@ [id="cnf-create-performance-profiles] = Creating a performance profile -include::_attributes/common-attributes.adoc[] -:context: cnf-create-performance-profiles -toc::[] +include::_attributes/common-attributes.adoc + + Learn about the PPC and how you can use it to create a performance profile. @@ -14,7 +14,7 @@ you might not get the desired behavior from performance profiles if you have cgr include::modules/dummy-module-xyz.adoc[leveloffset=+1] -include::modules/dummy-module-abc.adoc[leveloffset=+2] +include::modules/dummy-module-abc.adoc[leveloffset=] [role="_additional-resources"]