From 207ae6f84b9136fe43bdc7bbff39bc195a86fed0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jaroslav=20=C5=A0karvada?= Date: Wed, 15 Feb 2023 18:03:41 +0100 Subject: [PATCH] man: updated manual pages to be more consistent MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jaroslav Škarvada --- man/tuned-adm.8 | 3 + man/tuned-profiles-atomic.7 | 1 + man/tuned-profiles-compat.7 | 3 + ...uned-profiles-cpu-partitioning-powersave.7 | 67 ------------------- man/tuned-profiles-cpu-partitioning.7 | 57 +++++++++++++--- man/tuned-profiles-mssql.7 | 12 +++- man/tuned-profiles-nfv-guest.7 | 1 + man/tuned-profiles-nfv-host.7 | 1 + man/tuned-profiles-openshift.7 | 5 +- man/tuned-profiles-oracle.7 | 3 +- man/tuned-profiles-postgresql.7 | 5 +- man/tuned-profiles-realtime.7 | 1 + man/tuned-profiles-sap-hana.7 | 3 +- man/tuned-profiles-sap.7 | 1 + man/tuned-profiles-spectrumscale-ece.7 | 2 +- man/tuned-profiles.7 | 5 ++ tuned.spec | 1 - 17 files changed, 83 insertions(+), 88 deletions(-) delete mode 100644 man/tuned-profiles-cpu-partitioning-powersave.7 diff --git a/man/tuned-adm.8 b/man/tuned-adm.8 index 7b7b9eda..a6875ada 100644 --- a/man/tuned-adm.8 +++ b/man/tuned-adm.8 @@ -124,13 +124,16 @@ Unload tunings. .BR tuned\-profiles\-atomic (7) .BR tuned\-profiles\-sap (7) .BR tuned\-profiles\-sap\-hana (7) +.BR tuned\-profiles\-mssql (7) .BR tuned\-profiles\-oracle (7) .BR tuned\-profiles\-realtime (7) .BR tuned\-profiles\-nfv\-host (7) .BR tuned\-profiles\-nfv\-guest (7) +.BR tuned\-profiles\-cpu\-partitioning (7) .BR tuned\-profiles\-compat (7) .BR tuned\-profiles\-postgresql (7) .BR tuned\-profiles\-openshift (7) +.BR tuned\-profiles\-spectrumscale\-ece (7) .SH AUTHOR .nf Jaroslav Škarvada diff --git a/man/tuned-profiles-atomic.7 b/man/tuned-profiles-atomic.7 index b939e3e7..9a3cd239 100644 --- a/man/tuned-profiles-atomic.7 +++ b/man/tuned-profiles-atomic.7 @@ -61,6 +61,7 @@ netfilter connections tracking. .BR tuned\-profiles\-compat (7) .BR tuned\-profiles\-postgresql (7) .BR tuned\-profiles\-openshift (7) +.BR tuned\-profiles\-spectrumscale\-ece (7) .SH AUTHOR .nf Jaroslav Škarvada diff --git a/man/tuned-profiles-compat.7 b/man/tuned-profiles-compat.7 index aba832f2..f9651529 100644 --- a/man/tuned-profiles-compat.7 +++ b/man/tuned-profiles-compat.7 @@ -91,6 +91,9 @@ CPU governor is set to performance. .BR tuned\-profiles\-nfv\-host (7) .BR tuned\-profiles\-nfv\-guest (7) .BR tuned\-profiles\-cpu\-partitioning (7) +.BR tuned\-profiles\-postgresql (7) +.BR tuned\-profiles\-openshift (7) +.BR tuned\-profiles\-spectrumscale\-ece (7) .SH AUTHOR .nf Jaroslav Škarvada diff --git a/man/tuned-profiles-cpu-partitioning-powersave.7 b/man/tuned-profiles-cpu-partitioning-powersave.7 deleted file mode 100644 index 5048fa5f..00000000 --- a/man/tuned-profiles-cpu-partitioning-powersave.7 +++ /dev/null @@ -1,67 +0,0 @@ -.\"/* -.\" * All rights reserved -.\" * Copyright (C) 2022 Red Hat, Inc. -.\" * Authors: Christophe Fontaine -.\" * -.\" * This program is free software; you can redistribute it and/or -.\" * modify it under the terms of the GNU General Public License -.\" * as published by the Free Software Foundation; either version 2 -.\" * of the License, or (at your option) any later version. -.\" * -.\" * This program is distributed in the hope that it will be useful, -.\" * but WITHOUT ANY WARRANTY; without even the implied warranty of -.\" * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.\" * GNU General Public License for more details. -.\" * -.\" * You should have received a copy of the GNU General Public License -.\" * along with this program; if not, write to the Free Software -.\" * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -.\" */ -.\" -.TH TUNED_PROFILES_CPU_PARTITIONING "7" "22 Nov 2022" "TuneD" -.SH NAME -tuned\-profiles\-cpu\-partitioning\-powersave - Partition CPUs into isolated and housekeeping with C-States enabled - -.SH DESCRIPTION -The cpu\-partitioning\-powersave profile is similar to cpu\-partitioning profile, -but gives more flexibility on the C-States configuration. - -.SH CONFIGURATION -The cpu-partitioning-powersave profile is configured by editing the -.I /etc/tuned/cpu-partitioning-powersave-variables.conf -file. There are three configuration options: - -.TP -.B isolated_cores= -List of CPUs to isolate. This option is mandatory. Any CPUs not in this list -is automatically considered a housekeeping CPU. -.TP -.B no_balance_cores= -List of CPUs not be considered by the kernel when doing system wide -process load\-balancing. Usually, this list should be the same as -isolated_cores=. This option is optional. -.TP -.B max_power_state= -Maximum c-state the cores are allowed to enter. Can be expressed as it's name (C1E) -or minimum wake-up latency, in micro-seconds. -This parameter is provided as-is to `force_latency`. -Default is set to "cstate.name:C1|10" to behave as cpu\-partitioning profile. - - -.SH IMPORTANT NOTES - -.IP * -Same recommendations as tuned\-profiles\-cpu\-partitioning (7) apply. - -.SH "FILES" -.nf -.I /etc/tuned/cpu\-partitioning\-variables.conf -.I /etc/tuned/tuned\-main.conf - -.SH "SEE ALSO" -.BR tuned (8) -.BR tuned\-adm (8) -.BR tuned\-profiles\-cpu\-partitioning (7) -.SH AUTHOR -.nf -Christophe Fontaine diff --git a/man/tuned-profiles-cpu-partitioning.7 b/man/tuned-profiles-cpu-partitioning.7 index 03f1fc20..fbf26c2a 100644 --- a/man/tuned-profiles-cpu-partitioning.7 +++ b/man/tuned-profiles-cpu-partitioning.7 @@ -23,8 +23,8 @@ tuned\-profiles\-cpu\-partitioning - Partition CPUs into isolated and housekeeping. .SH DESCRIPTION -The cpu\-partitioning profile partitions the system CPUs into isolated and -housekeeping CPUs. This profile is intended to be used for latency\-sensitive +The cpu\-partitioning* profiles partition the system CPUs into isolated and +housekeeping CPUs. These profiles are intended for latency\-sensitive workloads. An isolated CPU incurs reduced jitter and reduced interruptions by the @@ -42,9 +42,21 @@ run all daemons, shell processes, kernel threads, interruption handlers and work that can be dispatched from isolated CPUs such as disk I/O, RCU work, timers, etc. +.SH PROFILES +The following profiles are provided: + +.TP +.BI "cpu\-partitioning" +Profile partitioning the system CPUs into isolated and housekeeping CPUs. + +.TP +.BI "cpu\-partitioning\-powersave" +Profile similar to the cpu\-partitioning profile, but with more flexibility +on the C\-states configuration. + .SH CONFIGURATION -The cpu-partitioning profile is configured by editing the -.I /etc/tuned/cpu-partitioning-variables.conf +The cpu\-partitioning profile is configured by editing the +.I /etc/tuned/cpu\-partitioning\-variables.conf file. There are two configuration options: .TP @@ -57,26 +69,39 @@ List of CPUs not be considered by the kernel when doing system wide process load\-balancing. Usually, this list should be the same as isolated_cores=. This option is optional. +.LP +The cpu\-partitioning\-powersave profile is configured by editing the +.I /etc/tuned/cpu\-partitioning\-powersave\-variables.conf +file. It supports the same options as the cpu\-partitioning profile and +one additional option: + +.TP +.B max_power_state= +Maximum c-state the cores are allowed to enter. Can be expressed as it's name (C1E) +or minimum wake-up latency, in micro-seconds. +This parameter is provided as-is to `force_latency`. +Default is set to "cstate.name:C1|10" to behave as cpu\-partitioning profile. + .SH IMPORTANT NOTES .IP * 2 -The system should be rebooted after applying the cpu\-partitioning profile +The system should be rebooted after applying the cpu\-partitioning* profiles for the first time or changing its configuration .IP * -The cpu\-partitioning profile can be used in bare\-metal and virtual machines +The cpu\-partitioning* profiles can be used in bare\-metal and virtual machines .IP * -When using the cpu\-partitioning profile in bare\-metal, it is strongly +When using the cpu\-partitioning* profiles in bare\-metal, it is strongly recommended to "mask" the ksm and ksmtuned services in systemd (if they are installed). This can be done with the following command: # systemctl mask ksm ksmtuned .IP * -The cpu\-partitioning profile does not use the kernel's isolcpus= feature +The cpu\-partitioning* profiles do not use the kernel's isolcpus= feature .IP * On a NUMA system, it is recommended to have at least one housekeeping CPU per NUMA node .IP * -The cpu\-partitioning profile does not support isolating the L3 cache. This +The cpu\-partitioning* profiles do not support isolating the L3 cache. This means that a housekeeping CPU can still thrash cache entries pertaining to isolated CPUs. It is recommended to use cache isolation technologies to remedy this problem, such as Intel's Cache Allocation Technology @@ -87,24 +112,34 @@ Please, consult the nohz_full documentation in the kernel to learn more .IP * The Linux real\-time project has put together a document on the best practices for writing real\-time applications. Even though the -cpu\-partitioning profile does not guarantee real\-time response time, much +cpu\-partitioning* profiles do not guarantee real\-time response time, much of the techniques for writing real\-time applications also apply for -applications intended to run under the cpu\-partitioning profile. Please, +applications intended to run under the cpu\-partitioning* profiles. Please, refer to this document at .I https://rt.wiki.kernel.org .SH "FILES" .nf .I /etc/tuned/cpu\-partitioning\-variables.conf +.I /etc/tuned/cpu\-partitioning\-powersave\-variables.conf .I /etc/tuned/tuned\-main.conf .SH "SEE ALSO" .BR tuned (8) .BR tuned\-adm (8) .BR tuned\-profiles (7) +.BR tuned\-profiles\-atomic (7) +.BR tuned\-profiles\-sap (7) +.BR tuned\-profiles\-sap\-hana (7) +.BR tuned\-profiles\-mssql (7) +.BR tuned\-profiles\-oracle (7) .BR tuned\-profiles\-realtime (7) .BR tuned\-profiles\-nfv\-host (7) .BR tuned\-profiles\-nfv\-guest (7) +.BR tuned\-profiles\-compat (7) +.BR tuned\-profiles\-postgresql (7) +.BR tuned\-profiles\-openshift (7) +.BR tuned\-profiles\-spectrumscale\-ece (7) .SH AUTHOR .nf Jaroslav Škarvada diff --git a/man/tuned-profiles-mssql.7 b/man/tuned-profiles-mssql.7 index e56edf02..b2552f36 100644 --- a/man/tuned-profiles-mssql.7 +++ b/man/tuned-profiles-mssql.7 @@ -23,7 +23,14 @@ tuned\-profiles\-mssql - description of profile provided for the MS SQL Server .SH DESCRIPTION -This profile is provided for the MS SQL Server. It's based on the +The profile is provided for the MS SQL Server. + +.SH PROFILES +The following profile is provided: + +.TP +.BI "mssql" +Profile optimized for the MS SQL Server. It's based on the throughput-performance profile. .SH "FILES" @@ -35,10 +42,10 @@ throughput-performance profile. .BR tuned (8) .BR tuned\-adm (8) .BR tuned\-profiles (7) +.BR tuned\-profiles\-atomic (7) .BR tuned\-profiles\-sap (7) .BR tuned\-profiles\-sap\-hana (7) .BR tuned\-profiles\-oracle (7) -.BR tuned\-profiles\-atomic (7) .BR tuned\-profiles\-realtime (7) .BR tuned\-profiles\-nfv\-host (7) .BR tuned\-profiles\-nfv\-guest (7) @@ -46,6 +53,7 @@ throughput-performance profile. .BR tuned\-profiles\-compat (7) .BR tuned\-profiles\-postgresql (7) .BR tuned\-profiles\-openshift (7) +.BR tuned\-profiles\-spectrumscale\-ece (7) .SH AUTHOR .nf Jaroslav Škarvada diff --git a/man/tuned-profiles-nfv-guest.7 b/man/tuned-profiles-nfv-guest.7 index 6706867b..633ce2e3 100644 --- a/man/tuned-profiles-nfv-guest.7 +++ b/man/tuned-profiles-nfv-guest.7 @@ -52,6 +52,7 @@ Profile optimized for virtual guests based on realtime profile. .BR tuned\-profiles\-compat (7) .BR tuned\-profiles\-postgresql (7) .BR tuned\-profiles\-openshift (7) +.BR tuned\-profiles\-spectrumscale\-ece (7) .SH AUTHOR .nf Jaroslav Škarvada diff --git a/man/tuned-profiles-nfv-host.7 b/man/tuned-profiles-nfv-host.7 index d483dc26..9a18f3e2 100644 --- a/man/tuned-profiles-nfv-host.7 +++ b/man/tuned-profiles-nfv-host.7 @@ -52,6 +52,7 @@ Profile optimized for virtual hosts based on realtime profile. .BR tuned\-profiles\-compat (7) .BR tuned\-profiles\-postgresql (7) .BR tuned\-profiles\-openshift (7) +.BR tuned\-profiles\-spectrumscale\-ece (7) .SH AUTHOR .nf Jaroslav Škarvada diff --git a/man/tuned-profiles-openshift.7 b/man/tuned-profiles-openshift.7 index 4497826c..22fe967c 100644 --- a/man/tuned-profiles-openshift.7 +++ b/man/tuned-profiles-openshift.7 @@ -49,17 +49,18 @@ Profile optimized for general workloads on OpenShift worker nodes. .BR tuned (8) .BR tuned\-adm (8) .BR tuned\-profiles (7) +.BR tuned\-profiles\-atomic (7) .BR tuned\-profiles\-sap (7) .BR tuned\-profiles\-sap\-hana (7) -.BR tuned\-profiles\-oracle (7) .BR tuned\-profiles\-mssql (7) -.BR tuned\-profiles\-atomic (7) +.BR tuned\-profiles\-oracle (7) .BR tuned\-profiles\-realtime (7) .BR tuned\-profiles\-nfv\-host (7) .BR tuned\-profiles\-nfv\-guest (7) .BR tuned\-profiles\-cpu\-partitioning (7) .BR tuned\-profiles\-compat (7) .BR tuned\-profiles\-postgresql (7) +.BR tuned\-profiles\-spectrumscale\-ece (7) .SH AUTHOR .nf Jaroslav Škarvada diff --git a/man/tuned-profiles-oracle.7 b/man/tuned-profiles-oracle.7 index 94a42a47..5df6666d 100644 --- a/man/tuned-profiles-oracle.7 +++ b/man/tuned-profiles-oracle.7 @@ -43,10 +43,10 @@ performance related kernel parameters. .BR tuned (8) .BR tuned\-adm (8) .BR tuned\-profiles (7) +.BR tuned\-profiles\-atomic (7) .BR tuned\-profiles\-sap (7) .BR tuned\-profiles\-sap\-hana (7) .BR tuned\-profiles\-mssql (7) -.BR tuned\-profiles\-atomic (7) .BR tuned\-profiles\-realtime (7) .BR tuned\-profiles\-nfv\-host (7) .BR tuned\-profiles\-nfv\-guest (7) @@ -54,6 +54,7 @@ performance related kernel parameters. .BR tuned\-profiles\-compat (7) .BR tuned\-profiles\-postgresql (7) .BR tuned\-profiles\-openshift (7) +.BR tuned\-profiles\-spectrumscale\-ece (7) .SH AUTHOR .nf Jaroslav Škarvada diff --git a/man/tuned-profiles-postgresql.7 b/man/tuned-profiles-postgresql.7 index 7e24ee1f..7af17441 100644 --- a/man/tuned-profiles-postgresql.7 +++ b/man/tuned-profiles-postgresql.7 @@ -45,17 +45,18 @@ performance related kernel parameters. .BR tuned (8) .BR tuned\-adm (8) .BR tuned\-profiles (7) +.BR tuned\-profiles\-atomic (7) .BR tuned\-profiles\-sap (7) .BR tuned\-profiles\-sap\-hana (7) -.BR tuned\-profiles\-oracle (7) .BR tuned\-profiles\-mssql (7) -.BR tuned\-profiles\-atomic (7) +.BR tuned\-profiles\-oracle (7) .BR tuned\-profiles\-realtime (7) .BR tuned\-profiles\-nfv\-host (7) .BR tuned\-profiles\-nfv\-guest (7) .BR tuned\-profiles\-cpu\-partitioning (7) .BR tuned\-profiles\-compat (7) .BR tuned\-profiles\-openshift (7) +.BR tuned\-profiles\-spectrumscale\-ece (7) .SH AUTHOR .nf Jaroslav Škarvada diff --git a/man/tuned-profiles-realtime.7 b/man/tuned-profiles-realtime.7 index 6c27bfb7..8385c64b 100644 --- a/man/tuned-profiles-realtime.7 +++ b/man/tuned-profiles-realtime.7 @@ -52,6 +52,7 @@ Profile optimized for realtime. .BR tuned\-profiles\-compat (7) .BR tuned\-profiles\-postgresql (7) .BR tuned\-profiles\-openshift (7) +.BR tuned\-profiles\-spectrumscale\-ece (7) .SH AUTHOR .nf Jaroslav Škarvada diff --git a/man/tuned-profiles-sap-hana.7 b/man/tuned-profiles-sap-hana.7 index 9fa250d5..c490ec75 100644 --- a/man/tuned-profiles-sap-hana.7 +++ b/man/tuned-profiles-sap-hana.7 @@ -53,10 +53,11 @@ semaphores. .BR tuned\-profiles\-realtime (7) .BR tuned\-profiles\-nfv\-host (7) .BR tuned\-profiles\-nfv\-guest (7) -.BR tuned\-profiles\-cpu-partitioning (7) +.BR tuned\-profiles\-cpu\-partitioning (7) .BR tuned\-profiles\-compat (7) .BR tuned\-profiles\-postgresql (7) .BR tuned\-profiles\-openshift (7) +.BR tuned\-profiles\-spectrumscale\-ece (7) .SH AUTHOR .nf Jaroslav Škarvada diff --git a/man/tuned-profiles-sap.7 b/man/tuned-profiles-sap.7 index 64111995..35303f44 100644 --- a/man/tuned-profiles-sap.7 +++ b/man/tuned-profiles-sap.7 @@ -55,6 +55,7 @@ areas a process may have. .BR tuned\-profiles\-compat (7) .BR tuned\-profiles\-postgresql (7) .BR tuned\-profiles\-openshift (7) +.BR tuned\-profiles\-spectrumscale\-ece (7) .SH AUTHOR .nf Jaroslav Škarvada diff --git a/man/tuned-profiles-spectrumscale-ece.7 b/man/tuned-profiles-spectrumscale-ece.7 index 6594ea59..57005276 100644 --- a/man/tuned-profiles-spectrumscale-ece.7 +++ b/man/tuned-profiles-spectrumscale-ece.7 @@ -43,10 +43,10 @@ performance related kernel parameters. .BR tuned (8) .BR tuned\-adm (8) .BR tuned\-profiles (7) +.BR tuned\-profiles\-atomic (7) .BR tuned\-profiles\-sap (7) .BR tuned\-profiles\-sap\-hana (7) .BR tuned\-profiles\-mssql (7) -.BR tuned\-profiles\-atomic (7) .BR tuned\-profiles\-oracle (7) .BR tuned\-profiles\-realtime (7) .BR tuned\-profiles\-nfv\-host (7) diff --git a/man/tuned-profiles.7 b/man/tuned-profiles.7 index 8b3a3444..10cad7bd 100644 --- a/man/tuned-profiles.7 +++ b/man/tuned-profiles.7 @@ -136,6 +136,11 @@ This profile is intended to be used as an overlay on other profiles (e.g. throughput\-performance profile), example: .B tuned\-adm profile throughput\-performance optimize\-serial\-console +.TP +.BI "aws" +Profile optimized for AWS EC2 instances. It is based on the +throughput\-performance profile. + .SH "FILES" .nf .I /etc/tuned/* diff --git a/tuned.spec b/tuned.spec index a1350a38..51f258c3 100644 --- a/tuned.spec +++ b/tuned.spec @@ -530,7 +530,6 @@ fi %{_prefix}/lib/tuned/cpu-partitioning %{_prefix}/lib/tuned/cpu-partitioning-powersave %{_mandir}/man7/tuned-profiles-cpu-partitioning.7* -%{_mandir}/man7/tuned-profiles-cpu-partitioning-powersave.7* %files profiles-spectrumscale %{_prefix}/lib/tuned/spectrumscale-ece