Skip to content

Commit

Permalink
interim push for backup
Browse files Browse the repository at this point in the history
  • Loading branch information
@sounix000
sounix000 committed Jul 24, 2024
1 parent 36c93d5 commit 57f4ea2
Showing 1 changed file with 205 additions and 58 deletions.
263 changes: 205 additions & 58 deletions xml/tuning_tuned.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,56 +85,11 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="cha-tuning-tune
<term>tuned-adm</term>
<listitem>
<para>
A command-line utility to manage or administer the &tuned; daemon. You can use the
A command-line utility to manage or administer the &tuned; daemon. To understand the
basics of managing &tuned; using <command>tuned-adm</command>, see the
<xref linkend="sec-manage-tuned-profiles"></xref> section. You can use the
<command>tuned-adm</command> command to perform the following tasks:
</para>
<itemizedlist>
<listitem>
<para>
List all available profiles.
</para>
</listitem>
<listitem>
<para>
Display information about the current or specified profile.
</para>
</listitem>
<listitem>
<para>
Display the current profile selection mode.
</para>
</listitem>
<listitem>
<para>
Recommend a profile based on the current system usage.
</para>
</listitem>
<listitem>
<para>
Select a profile automatically, and switch to the recommended profile.
</para>
</listitem>
<listitem>
<para>
List active profile.
</para>
</listitem>
<listitem>
<para>
Manually switch to a specified profile.
</para>
</listitem>
<listitem>
<para>
Verify a profile.
</para>
</listitem>
<listitem>
<para>
Turn off all tunings.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
Expand Down Expand Up @@ -316,6 +271,12 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="cha-tuning-tune
<screen>&prompt.sudo;<command>systemctl enable --now tuned</command></screen>
</step>
</procedure>
<para>
When &tuned; starts running, the settings of the
<filename>/etc/tuned/tuned-main.conf</filename> global configuration file is applied on the
system. Other useful information are also available in the files of the
<filename>/etc/tuned/</filename> directory.
</para>
</sect2>

<sect2 xml:id="sec-tuning-tuned-disable">
Expand Down Expand Up @@ -371,26 +332,212 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="cha-tuning-tune
the basics of managing, creating and customizing TuneD profiles.
</para>

<warning>
<sect2 xml:id="sec-supported-tuned-profiles">
<title>Supported TuneD profiles</title>
<para>
The TuneD profiles that are part of the standard installation of &tuned; are available in
the <filename>/usr/lib/tuned/</filename> directory. Each installed profile has its own
directory, which contains the <filename>tuned.conf</filename> configuration file. The
settings mentioned in the profile specific <filename>tuned.conf</filename> configuration
file is applied on top of the settings of the
<filename>/etc/tuned/tuned-main.conf</filename> global configuration file. In case of
contradiction, the profile specific configuration is prioritized.
</para>
<para>
The profiles are primarily a set of optimizations of three types&mdash;performance, power
consumption and deployment use-case. Currently, &sles; officially supports the following
profiles:
</para>
<variablelist>
<varlistentry>
<term>balanced</term>
<listitem>
<para>
General non-specialized tuned profile.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>cpu-partitioning</term>
<listitem>
<para>
Optimize for CPU partitioning, based on the variables mentioned in
<filename>/etc/tuned/cpu-partitioning-variables.conf</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>desktop</term>
<listitem>
<para>
Optimize for the desktop use-case.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>latency-performance</term>
<listitem>
<para>
Optimize for deterministic performance at the cost of increased power consumption.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>mssql</term>
<listitem>
<para>
Optimize for MS SQL Server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>network-latency</term>
<listitem>
<para>
Optimize for deterministic performance at the cost of increased power consumption,
focused on low latency network performance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>network-throughput</term>
<listitem>
<para>
Optimize for streaming network throughput, generally only necessary on older CPUs or
40G+ networks.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>powersave</term>
<listitem>
<para>
Optimize for low power consumption. While using this configuration as a stand-alone
or merged profile, carefully analyze the deployment use case and ensure that it saves
more power than the <literal>balanced</literal> profile.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>throughput-performance</term>
<listitem>
<para>
Broadly applicable tuning that provides good performance across a variety of common
server workloads.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>virtual-guest</term>
<listitem>
<para>
Optimize for running inside a virtual guest.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>virtual-host</term>
<listitem>
<para>
Optimize for running KVM guests.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
&suse; does not support any profile that are not part of the standard profiles supplied
with the <package>tuned</package> from official &sles; repositories. Create and apply a
custom profile on a production system only if you are sure of its effect.
To understand more about the <filename>tuned.conf</filename> configuration file, read its
man page:
</para>
</warning>
<screen><command>man 5 tuned.conf</command></screen>
<warning>
<para>
&suse; does not support any profile that are not part of the standard profiles supplied
with the <package>tuned</package> from official &sles; repositories. Create and apply a
custom profile on a production system only if you are sure of its effect.
</para>
</warning>
</sect2>

<sect2>
<sect2 xml:id="sec-manage-tuned-profiles">
<title>Managing TuneD profiles</title>
<para>
If you are sure of the exact profile you want to activate, pass it as an argument to the
If you just want to activate a profile, pass the profile name as an argument to the
<option>--profile</option> while invoking the <command>tuned</command> command:
</para>
<screen>&prompt.sudo;<command>tuned --profile
<replaceable>PROFILE_NAME</replaceable></command></screen>
<screen>&prompt.sudo;<command>tuned --profile <replaceable>PROFILE_NAME</replaceable></command></screen>
<para>
However, the best practice for managing the lifecyle of TuneD profiles is to use the
<command>tuned-adm</command> command-line tool.
<command>tuned-adm</command> command-line tool. You can use the
<command>tuned-adm</command> command to perform the following tasks:
</para>
<itemizedlist>
<listitem>
<para>
List all available profiles.
</para>
<screen>&prompt.sudo;<command>tuned-adm list</command></screen>
</listitem>
<listitem>
<para>
List active profile.
</para>
<screen>&prompt.sudo;<command>tuned-adm active</command></screen>
</listitem>
<listitem>
<para>
Display information about the current profile.
</para>
<screen>&prompt.sudo;<command>tuned-adm profile_info</command></screen>
</listitem>
<listitem>
<para>
Display information about a specified profile.
</para>
<screen>&prompt.sudo;<command>tuned-adm profile_info <replaceable>PROFILE_NAME</replaceable></command></screen>
</listitem>
<listitem>
<para>
Recommend a profile based on the current system usage.
</para>
<screen>&prompt.sudo;<command>tuned-adm recommend</command></screen>
</listitem>
<listitem>
<para>
Display the current profile selection mode.
</para>
<screen>&prompt.sudo;<command>tuned-adm profile_mode</command></screen>
</listitem>
<listitem>
<para>
Select a profile automatically, and switch to the recommended profile.
</para>
<screen>&prompt.sudo;<command>tuned-adm auto_profile</command></screen>
</listitem>
<listitem>
<para>
Manually switch to a specified profile.
</para>
<screen>&prompt.sudo;<command>tuned-adm profile <replaceable>PROFILE_NAME</replaceable></command></screen>
</listitem>
<listitem>
<para>
Verify that a profile has been successfully applied, and the system state matches the
profile's configurations.
</para>
<screen>&prompt.sudo;<command>tuned-adm verify</command></screen>
</listitem>
<listitem>
<para>
Turn off all tunings.
</para>
<screen>&prompt.sudo;<command>tuned-adm off</command></screen>
</listitem>
</itemizedlist>
<para>
For more information on <command>tuned-adm</command>, see its help information or man page.
</para>
<screen><command>tuned-adm --help</command></screen>
<screen><command>man tuned-adm</command></screen>
</sect2>
</sect1>
<sect1 xml:id="sec-tuning-tuned-plugins">
Expand Down

0 comments on commit 57f4ea2

Please sign in to comment.