Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Dummy PR for a new peer reviewer to practice #87384

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions modules/dummy-module-gather-data.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
= Gathering data about your cluster using the `must-gather` command
xenolinux marked this conversation as resolved.
Show resolved Hide resolved

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]
----
$ oc label mcp _<mcp-name>_ _<mcp_name>_=""
----

. 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.
====

For more information on machine sets, see xref:/machine_management/manually-scaling-machineset.adoc#machineset-manually-scaling_manually-scaling-machineset[About machine sets].
16 changes: 16 additions & 0 deletions modules/dummy-module-ppc.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// Module included in the following assemblies:
// * scalability_and_performance/cnf-create-performance-profiles.adoc

:_content-type: CONCEPT
[id="dummy-module-ppc"]

= 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.
23 changes: 23 additions & 0 deletions scalability_and_performance/dummy-assembly.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[id="dummy-assemblies-ppc-data]
= Creating a performance profile
include::_attributes/common-attributes.adoc


You can use the PPC 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 enabled. Enabling cgroup v2 is not recommended if you are using performace profiles.
====

include::modules/dummy-module-gather-data.adoc[leveloffset=+1]

include::modules/dummy-module-ppc.adoc[leveloffset=]

include::modules/dummy-module-ppcc.adoc[leveloffset=+2]

[role="_additional-resources"]
= Additional Resources

* xref:../support/gathering-cluster-data.adoc#nodes-nodes-managing[Gathering data about your cluster].