Skip to content
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
1 change: 1 addition & 0 deletions modules/apply-performance-profile-hosted-cluster.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="apply-performance-profile-hosted-cluster_{context}"]
= Configuring low-latency tuning in a hosted cluster

[role="_abstract"]
To set low latency with the performance profile on the nodes in your hosted cluster, you can use the Node Tuning Operator. In {hcp}, you can configure low-latency tuning by creating config maps that contain `Tuned` objects and referencing those config maps in your node pools. The tuned object in this case is a `PerformanceProfile` object that defines the performance profile you want to apply to the nodes in a node pool.

.Procedure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="gathering-data-about-your-hosted-cluster-using-must-gather_{context}"]
= Gathering data about your hosted control planes cluster for the PPC

[role="_abstract"]
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
Expand Down
39 changes: 22 additions & 17 deletions modules/cnf-running-the-performance-creator-profile-hosted.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="running-the-performance-profile-profile-hosted-cluster-using-podman_{context}"]
= Running the Performance Profile Creator on a hosted cluster using Podman

[role="_abstract"]
As a cluster administrator, you can use Podman with the Performance Profile Creator (PPC) tool to create a performance profile.

For more information about PPC arguments, see "Performance Profile Creator arguments".
Expand Down Expand Up @@ -49,28 +50,31 @@ Password: <password>
[source,terminal,subs="attributes+"]
----
$ podman run --entrypoint performance-profile-creator \
-v /path/to/must-gather:/must-gather:z \// <1>
-v /path/to/must-gather:/must-gather:z \
registry.redhat.io/openshift4/ose-cluster-node-tuning-rhel9-operator:v{product-version} \
--must-gather-dir-path /must-gather \
--reserved-cpu-count=2 \// <2>
--rt-kernel=false \// <3>
--split-reserved-cpus-across-numa=false \ <4>
--topology-manager-policy=single-numa-node \// <5>
--node-pool-name=democluster-us-east-1a \
--power-consumption-mode=ultra-low-latency \// <6>
--offlined-cpu-count=1 \// <7>
--reserved-cpu-count=2 \
--rt-kernel=false \
--split-reserved-cpus-across-numa=false \
--topology-manager-policy=single-numa-node \
--node-pool-name=democluster-us-east-1a \
--power-consumption-mode=ultra-low-latency \
--offlined-cpu-count=1 \
> my-hosted-cp-performance-profile.yaml
----
+
<1> Mounts the local directory where the output of an `oc adm must-gather` was created into the container.
<2> Specifies two reserved CPUs.
<3> Disables the real-time kernel.
<4> Disables reserved CPUs splitting across NUMA nodes.
<5> Specifies the NUMA topology policy. If installing the NUMA Resources Operator, this must be set to `single-numa-node`.
<6> Specifies minimal latency at the cost of increased power consumption.
<7> Specifies one offlined CPU.
where:

`/path/to/must-gather`:: Mounts the local directory where the output of an `oc adm must-gather` was created into the container.
`--reserved-cpu-count=2`:: Specifies two reserved CPUs.
`--rt-kernel=false`:: Disables the real-time kernel.
`--split-reserved-cpus-across-numa=false`:: Disables reserved CPUs splitting across NUMA nodes.
`--topology-manager-policy=single-numa-node`:: Specifies the NUMA topology policy. If installing the NUMA Resources Operator, this must be set to `single-numa-node`.
`--power-consumption-mode=ultra-low-latency`:: Specifies minimal latency at the cost of increased power consumption.
`--offlined-cpu-count=1`:: Specifies one offlined CPU.
+
The output resembles the following example:
+
.Example output
[source,terminal]
----
level=info msg="Nodes names targeted by democluster-us-east-1a pool are: ip-10-0-129-110.ec2.internal "
Expand All @@ -88,7 +92,8 @@ level=info msg="Additional Kernel Args based on configuration: []
----
$ cat my-hosted-cp-performance-profile
----
.Example output
+
The output resembles the following example:
+
[source,yaml]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,13 @@ include::modules/cnf-gathering-data-about-hosted-cluster-using-must-gather.adoc[

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

* xref:../hosted_control_planes/hcp-troubleshooting.adoc#hcp-must-gather-cli[Gathering data for a hosted cluster by using the CLI].
* xref:../hosted_control_planes/hcp-troubleshooting.adoc#hcp-must-gather-cli[Gathering data for a hosted cluster by using the CLI]

include::modules/cnf-running-the-performance-creator-profile-hosted.adoc[leveloffset=+2]

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

* xref:../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#performance-profile-creator-arguments_cnf-low-latency-perf-profile[Performance Profile Creator arguments]

include::modules/apply-performance-profile-hosted-cluster.adoc[leveloffset=+2]