Skip to content

Commit a3351d3

Browse files
authored
Merge pull request #31060 from jmencak/nto-docs-4.8-features
NTO 4.8 changes.
2 parents 72e10ec + a889f33 commit a3351d3

6 files changed

+38
-71
lines changed

modules/cluster-node-tuning-operator-verify-profiles.adoc

Lines changed: 16 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -3,62 +3,29 @@
33
// * scalability_and_performance/using-node-tuning-operator.adoc
44

55
[id="verifying-tuned-profiles-are-applied_{context}"]
6-
= Verifying that the Tuned profiles are applied
6+
= Verifying that the TuneD profiles are applied
77

8-
Use this procedure to check which Tuned profiles are applied on every node.
8+
Starting with {product-title} 4.8, it is no longer necessary to check the TuneD pod logs
9+
to find which TuneD profiles are applied on cluster nodes.
910

10-
.Procedure
11-
12-
. Check which Tuned pods are running on each node:
13-
+
1411
[source,terminal]
1512
----
16-
$ oc get pods -n openshift-cluster-node-tuning-operator -o wide
17-
----
18-
+
19-
.Example output
20-
[source,terminal]
21-
----
22-
NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES
23-
cluster-node-tuning-operator-599489d4f7-k4hw4 1/1 Running 0 6d2h 10.129.0.76 ip-10-0-145-113.eu-west-3.compute.internal <none> <none>
24-
tuned-2jkzp 1/1 Running 1 6d3h 10.0.145.113 ip-10-0-145-113.eu-west-3.compute.internal <none> <none>
25-
tuned-g9mkx 1/1 Running 1 6d3h 10.0.147.108 ip-10-0-147-108.eu-west-3.compute.internal <none> <none>
26-
tuned-kbxsh 1/1 Running 1 6d3h 10.0.132.143 ip-10-0-132-143.eu-west-3.compute.internal <none> <none>
27-
tuned-kn9x6 1/1 Running 1 6d3h 10.0.163.177 ip-10-0-163-177.eu-west-3.compute.internal <none> <none>
28-
tuned-vvxwx 1/1 Running 1 6d3h 10.0.131.87 ip-10-0-131-87.eu-west-3.compute.internal <none> <none>
29-
tuned-zqrwq 1/1 Running 1 6d3h 10.0.161.51 ip-10-0-161-51.eu-west-3.compute.internal <none> <none>
13+
$ oc get profile -n openshift-cluster-node-tuning-operator
3014
----
3115

32-
. Extract the profile applied from each pod and match them against the previous list:
33-
+
34-
[source,terminal]
35-
----
36-
$ for p in `oc get pods -n openshift-cluster-node-tuning-operator -l openshift-app=tuned -o=jsonpath='{range .items[*]}{.metadata.name} {end}'`; do printf "\n*** $p ***\n" ; oc logs pod/$p -n openshift-cluster-node-tuning-operator | grep applied; done
37-
----
38-
+
3916
.Example output
4017
[source,terminal]
4118
----
42-
*** tuned-2jkzp ***
43-
2020-07-10 13:53:35,368 INFO tuned.daemon.daemon: static tuning from profile 'openshift-control-plane' applied
44-
45-
*** tuned-g9mkx ***
46-
2020-07-10 14:07:17,089 INFO tuned.daemon.daemon: static tuning from profile 'openshift-node' applied
47-
2020-07-10 15:56:29,005 INFO tuned.daemon.daemon: static tuning from profile 'openshift-node-es' applied
48-
2020-07-10 16:00:19,006 INFO tuned.daemon.daemon: static tuning from profile 'openshift-node' applied
49-
2020-07-10 16:00:48,989 INFO tuned.daemon.daemon: static tuning from profile 'openshift-node-es' applied
50-
51-
*** tuned-kbxsh ***
52-
2020-07-10 13:53:30,565 INFO tuned.daemon.daemon: static tuning from profile 'openshift-node' applied
53-
2020-07-10 15:56:30,199 INFO tuned.daemon.daemon: static tuning from profile 'openshift-node-es' applied
54-
55-
*** tuned-kn9x6 ***
56-
2020-07-10 14:10:57,123 INFO tuned.daemon.daemon: static tuning from profile 'openshift-node' applied
57-
2020-07-10 15:56:28,757 INFO tuned.daemon.daemon: static tuning from profile 'openshift-node-es' applied
58-
59-
*** tuned-vvxwx ***
60-
2020-07-10 14:11:44,932 INFO tuned.daemon.daemon: static tuning from profile 'openshift-control-plane' applied
61-
62-
*** tuned-zqrwq ***
63-
2020-07-10 14:07:40,246 INFO tuned.daemon.daemon: static tuning from profile 'openshift-control-plane' applied
19+
NAME TUNED APPLIED DEGRADED AGE
20+
master-0 openshift-control-plane True False 6h33m
21+
master-1 openshift-control-plane True False 6h33m
22+
master-2 openshift-control-plane True False 6h33m
23+
worker-a openshift-node True False 6h28m
24+
worker-b openshift-node True False 6h28m
6425
----
26+
27+
* `NAME`: Name of the Profile object. There is one Profile object per node and their names match.
28+
* `TUNED`: Name of the desired TuneD profile to apply.
29+
* `APPLIED`: `True` if the TuneD daemon applied the desired profile. (`True/False/Unknown`).
30+
* `DEGRADED`: `True` if any errors were reported during application of the TuneD profile (`True/False/Unknown`).
31+
* `AGE`: Time elapsed since the creation of Profile object.

modules/configuring-huge-pages.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ spec:
5151
<3> Note the order of parameters is important as some platforms support huge pages of various sizes.
5252
<4> Enable machine config pool based matching.
5353

54-
. Create the Tuned `hugepages` profile
54+
. Create the Tuned `hugepages` object
5555
+
5656
[source,terminal]
5757
----
@@ -94,7 +94,7 @@ $ oc get node <node_using_hugepages> -o jsonpath="{.status.allocatable.hugepages
9494

9595
[WARNING]
9696
====
97-
This functionality is currently only supported on {op-system-first} 8.x worker nodes. On {op-system-base-full} 7.x worker nodes the Tuned `[bootloader]` plug-in is currently not supported.
97+
This functionality is currently only supported on {op-system-first} 8.x worker nodes. On {op-system-base-full} 7.x worker nodes the TuneD `[bootloader]` plug-in is currently not supported.
9898
====
9999

100100
////

modules/custom-tuning-example.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ _EOF_
3939

4040
[IMPORTANT]
4141
====
42-
Custom profile writers are strongly encouraged to include the default Tuned
42+
Custom profile writers are strongly encouraged to include the default TuneD
4343
daemon profiles shipped within the default Tuned CR. The example above uses the
4444
default `openshift-control-plane` profile to accomplish this.
4545
====

modules/custom-tuning-specification.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
[id="custom-tuning-specification_{context}"]
77
= Custom tuning specification
88

9-
The custom resource (CR) for the Operator has two major sections. The first section, `profile:`, is a list of Tuned profiles and their names. The second, `recommend:`, defines the profile selection logic.
9+
The custom resource (CR) for the Operator has two major sections. The first section, `profile:`, is a list of TuneD profiles and their names. The second, `recommend:`, defines the profile selection logic.
1010

11-
Multiple custom tuning specifications can co-exist as multiple CRs in the Operator's namespace. The existence of new CRs or the deletion of old CRs is detected by the Operator. All existing custom tuning specifications are merged and appropriate objects for the containerized Tuned daemons are updated.
11+
Multiple custom tuning specifications can co-exist as multiple CRs in the Operator's namespace. The existence of new CRs or the deletion of old CRs is detected by the Operator. All existing custom tuning specifications are merged and appropriate objects for the containerized TuneD daemons are updated.
1212

1313
*Management state*
1414

@@ -20,26 +20,26 @@ The Operator Management state is set by adjusting the default Tuned CR. By defau
2020

2121
*Profile data*
2222

23-
The `profile:` section lists Tuned profiles and their names.
23+
The `profile:` section lists TuneD profiles and their names.
2424

2525
[source,yaml]
2626
----
2727
profile:
2828
- name: tuned_profile_1
2929
data: |
30-
# Tuned profile specification
30+
# TuneD profile specification
3131
[main]
3232
summary=Description of tuned_profile_1 profile
3333
3434
[sysctl]
3535
net.ipv4.ip_forward=1
36-
# ... other sysctl's or other Tuned daemon plugins supported by the containerized Tuned
36+
# ... other sysctl's or other TuneD daemon plugins supported by the containerized TuneD
3737
3838
# ...
3939
4040
- name: tuned_profile_n
4141
data: |
42-
# Tuned profile specification
42+
# TuneD profile specification
4343
[main]
4444
summary=Description of tuned_profile_n profile
4545
@@ -74,7 +74,7 @@ The individual items of the list:
7474
<3> If omitted, profile match is assumed unless a profile with a higher priority matches first or `machineConfigLabels` is set.
7575
<4> An optional list.
7676
<5> Profile ordering priority. Lower numbers mean higher priority (`0` is the highest priority).
77-
<6> A Tuned profile to apply on a match. For example `tuned_profile_1`.
77+
<6> A TuneD profile to apply on a match. For example `tuned_profile_1`.
7878

7979
`<match>` is an optional list recursively defined as follows:
8080

@@ -98,7 +98,7 @@ The list items `match` and `machineConfigLabels` are connected by the logical OR
9898

9999
[IMPORTANT]
100100
====
101-
When using machine config pool based matching, it is advised to group nodes with the same hardware configuration into the same machine config pool. Not following this practice might result in Tuned operands calculating conflicting kernel parameters for two or more nodes sharing the same machine config pool.
101+
When using machine config pool based matching, it is advised to group nodes with the same hardware configuration into the same machine config pool. Not following this practice might result in TuneD operands calculating conflicting kernel parameters for two or more nodes sharing the same machine config pool.
102102
====
103103

104104
.Example: node or pod label based matching
@@ -121,10 +121,10 @@ When using machine config pool based matching, it is advised to group nodes with
121121
profile: openshift-node
122122
----
123123

124-
The CR above is translated for the containerized Tuned daemon into its `recommend.conf` file based on the profile priorities. The profile with the
125-
highest priority (`10`) is `openshift-control-plane-es` and, therefore, it is considered first. The containerized Tuned daemon running on a given node looks to see if there is a pod running on the same node with the `tuned.openshift.io/elasticsearch` label set. If not, the entire `<match>` section evaluates as `false`. If there is such a pod with the label, in order for the `<match>` section to evaluate to `true`, the node label also needs to be `node-role.kubernetes.io/master` or `node-role.kubernetes.io/infra`.
124+
The CR above is translated for the containerized TuneD daemon into its `recommend.conf` file based on the profile priorities. The profile with the
125+
highest priority (`10`) is `openshift-control-plane-es` and, therefore, it is considered first. The containerized TuneD daemon running on a given node looks to see if there is a pod running on the same node with the `tuned.openshift.io/elasticsearch` label set. If not, the entire `<match>` section evaluates as `false`. If there is such a pod with the label, in order for the `<match>` section to evaluate to `true`, the node label also needs to be `node-role.kubernetes.io/master` or `node-role.kubernetes.io/infra`.
126126

127-
If the labels for the profile with priority `10` matched, `openshift-control-plane-es` profile is applied and no other profile is considered. If the node/pod label combination did not match, the second highest priority profile (`openshift-control-plane`) is considered. This profile is applied if the containerized Tuned pod runs on a node with labels `node-role.kubernetes.io/master` or `node-role.kubernetes.io/infra`.
127+
If the labels for the profile with priority `10` matched, `openshift-control-plane-es` profile is applied and no other profile is considered. If the node/pod label combination did not match, the second highest priority profile (`openshift-control-plane`) is considered. This profile is applied if the containerized TuneD pod runs on a node with labels `node-role.kubernetes.io/master` or `node-role.kubernetes.io/infra`.
128128

129129
Finally, the profile `openshift-node` has the lowest priority of `30`. It lacks the `<match>` section and, therefore, will always match. It acts as a profile catch-all to set `openshift-node` profile, if no other profile with higher priority matches on a given node.
130130

modules/node-tuning-operator-supported-tuned-daemon-plug-ins.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
// * post_installation_configuration/node-tasks.adoc
55

66
[id="supported-tuned-daemon-plug-ins_{context}"]
7-
= Supported Tuned daemon plug-ins
7+
= Supported TuneD daemon plug-ins
88

9-
Excluding the `[main]` section, the following Tuned plug-ins are supported when
9+
Excluding the `[main]` section, the following TuneD plug-ins are supported when
1010
using custom profiles defined in the `profile:` section of the Tuned CR:
1111

1212
* audio
@@ -26,7 +26,7 @@ using custom profiles defined in the `profile:` section of the Tuned CR:
2626
* vm
2727

2828
There is some dynamic tuning functionality provided by some of these plug-ins
29-
that is not supported. The following Tuned plug-ins are currently not supported:
29+
that is not supported. The following TuneD plug-ins are currently not supported:
3030

3131
* bootloader
3232
* script
@@ -35,6 +35,6 @@ that is not supported. The following Tuned plug-ins are currently not supported:
3535

3636
See
3737
link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/monitoring_and_managing_system_status_and_performance/customizing-tuned-profiles_monitoring-and-managing-system-status-and-performance#available-tuned-plug-ins_customizing-tuned-profiles[Available
38-
Tuned Plug-ins] and
38+
TuneD Plug-ins] and
3939
link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/monitoring_and_managing_system_status_and_performance/getting-started-with-tuned_monitoring-and-managing-system-status-and-performance[Getting
40-
Started with Tuned] for more information.
40+
Started with TuneD] for more information.

modules/node-tuning-operator.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ ifdef::operators[]
2222
[discrete]
2323
== Purpose
2424
endif::operators[]
25-
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.
25+
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.
2626

27-
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.
27+
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.
2828

29-
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.
29+
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.
3030

3131
The Node Tuning Operator is part of a standard {product-title} installation in version 4.1 and later.
3232
ifdef::operators[]

0 commit comments

Comments
 (0)