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.

Sign up for GitHub

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

Jump to bottom

OSDOCS-3976: Add NodeTuning capability and Capability set v4.13 #57602

Merged
merged 1 commit into from
Mar 27, 2023
Merged

OSDOCS-3976: Add NodeTuning capability and Capability set v4.13 #57602

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions installing/cluster-capabilities.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,12 @@ include::modules/operator-marketplace.adoc[leveloffset=+2]
.Additional resources
* xref:../operators/understanding/olm-rh-catalogs.adoc#olm-rh-catalogs[Red Hat-provided Operator catalogs]

include::modules/node-tuning-operator.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources
* xref:../scalability_and_performance/using-node-tuning-operator.adoc#using-node-tuning-operator[Using the Node Tuning Operator]

include::modules/cluster-samples-operator.adoc[leveloffset=+2]

[role="_additional-resources"]
Expand Down
21 changes: 19 additions & 2 deletions modules/node-tuning-operator.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ endif::[]
ifeval::["{context}" == "node-tuning-operator"]
:perf:
endif::[]
ifeval::["{context}" == "cluster-capabilities"]
:cluster-caps:
endif::[]


:_content-type: CONCEPT
[id="about-node-tuning-operator_{context}"]
Expand All @@ -19,12 +23,24 @@ endif::operators[]
ifdef::perf[]
= About the Node Tuning Operator
endif::perf[]
ifdef::operators[]
ifdef::cluster-caps[= Node Tuning capability]

ifndef::perf[]
[discrete]
== Purpose
endif::operators[]
endif::perf[]

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the other sections in this doc still have this Purpose title like here. I think that title should be added for consistency. It should just be something like

 [discrete]
== Purpose

on line 32. It might work adding your parameter cluster-caps to the ifdef thats there, but we'd have to check that the title size is consistent. You could also look at the other modules that do this for reference, ex: https://raw.githubusercontent.com/openshift/openshift-docs/main/modules/operator-marketplace.adoc

ifdef::cluster-caps[]
The Node Tuning Operator provides features for the `NodeTuning` capability.
endif::cluster-caps[]

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.

ifdef::cluster-caps[]
If you disable the NodeTuning capability, some default tuning settings will not be applied to the control-plane nodes. This might limit the scalability and performance of large clusters with over 900 nodes or 900 routes.
endif::[]

ifndef::cluster-caps[]
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.

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.
Expand All @@ -41,6 +57,7 @@ The Node Tuning Operator is part of a standard {product-title} installation in v
====
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 and later, this functionality is part of the Node Tuning Operator.
====
endif::cluster-caps[]

ifdef::operators[]
[discrete]
Expand Down
3 changes: 3 additions & 0 deletions snippets/capabilities-table.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ The following table describes the `baselineCapabilitySet` values.
|`v4.12`
|Specify when you want the capabilities recommended in {product-title} 4.12 and not automatically enable capabilities, which might be introduced in later versions. The capabilities recommended in {product-title} 4.12 are `baremetal`, `marketplace`, `openshift-samples`, `Console`, `Insights`, `Storage` and `CSISnapshot`.

|`v4.13`
|Specify when you want the capabilities recommended in {product-title} 4.13 and not automatically enable capabilities, which might be introduced in later versions. The capabilities recommended in {product-title} 4.12 are `baremetal`, `marketplace`, `openshift-samples`, `Console`, `Insights`, `Storage`, `CSISnapshot` and `NodeTuning`.

|`None`
|Specify when the other sets are too large, and you do not need any capabilities or want to fine-tune via `additionalEnabledCapabilities`.

Expand Down