Skip to content

Commit 522823b

Browse files
committed
TELCODOCS-627: updating operator reference to include PA controller
1 parent a42db66 commit 522823b

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

modules/node-tuning-operator.adoc

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,25 @@ ifdef::operators[]
2323
[discrete]
2424
== Purpose
2525
endif::operators[]
26-
The Node Tuning Operator helps you manage node-level tuning by orchestrating the TuneD daemon. The majority of high-performance applications require some level of kernel tuning. The Node Tuning Operator provides a unified management interface to users of node-level sysctls and more flexibility to add custom tuning specified by user needs.
26+
The Node Tuning Operator helps you manage node-level tuning by orchestrating the TuneD daemon and achieves low latency performance by using the Performance Profile controller. The majority of high-performance applications require some level of kernel tuning. The Node Tuning Operator provides a unified management interface to users of node-level sysctls and more flexibility to add custom tuning specified by user needs.
2727

2828
The Operator manages the containerized TuneD daemon for {product-title} as a Kubernetes daemon set. It ensures the custom tuning specification is passed to all containerized TuneD daemons running in the cluster in the format that the daemons understand. The daemons run on all nodes in the cluster, one per node.
2929

3030
Node-level settings applied by the containerized TuneD daemon are rolled back on an event that triggers a profile change or when the containerized TuneD daemon is terminated gracefully by receiving and handling a termination signal.
3131

32+
The Node Tuning Operator uses the Performance Profile controller to implement automatic tuning to achieve low latency performance for {product-title} applications. The cluster administrator configures a performance profile to define node-level settings such as the following:
33+
34+
* Updating the kernel to kernel-rt.
35+
* Choosing CPUs for housekeeping.
36+
* Choosing CPUs for running workloads.
37+
3238
The Node Tuning Operator is part of a standard {product-title} installation in version 4.1 and later.
39+
40+
[NOTE]
41+
====
42+
In earlier versions of {product-title}, the Performance Addon Operator was used to implement automatic tuning to achieve low latency performance for OpenShift applications. In {product-title} 4.11, these functions are part of the Node Tuning Operator.
43+
====
44+
3345
ifdef::operators[]
3446
[discrete]
3547
== Project

operators/operator-reference.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,14 @@ include::modules/machine-api-operator.adoc[leveloffset=+1]
5656
include::modules/machine-config-operator.adoc[leveloffset=+1]
5757
include::modules/operator-marketplace.adoc[leveloffset=+1]
5858
include::modules/node-tuning-operator.adoc[leveloffset=+1]
59+
60+
[discrete]
61+
[role="_additional-resources"]
62+
[id="platform-operators-ref-nto-addtl-resources"]
63+
=== Additional resources
64+
65+
* xref:../scalability_and_performance/cnf-performance-addon-operator-for-low-latency-nodes.adoc#cnf-understanding-low-latency_cnf-master[Low latency tuning of OCP nodes]
66+
5967
include::modules/openshift-apiserver-operator.adoc[leveloffset=+1]
6068
include::modules/cluster-openshift-controller-manager-operators.adoc[leveloffset=+1]
6169

0 commit comments

Comments
 (0)