Skip to content

Commit

Permalink
draft
Browse files Browse the repository at this point in the history
  • Loading branch information
@sounix000
sounix000 committed Jul 24, 2024
1 parent 1c91adc commit d8cbe30
Showing 1 changed file with 90 additions and 42 deletions.
132 changes: 90 additions & 42 deletions xml/tuning_tuned.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,9 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="cha-tuning-tune
<para>
A &tuned; <emphasis>profile</emphasis> is a collection of settings for system
components that you can apply to tune the system. System administrators can either use
the standard profiles that are installed at <filename>/usr/lib/tuned/</filename> as
part of the <package>tuned</package> package, or apply customized profiles by creating
them at <filename>/etc/tuned/</filename>. If the filenames for a custom and a standard
the default profiles that are installed at <filename>/usr/lib/tuned/</filename> as part
of the <package>tuned</package> package, or apply customized profiles by creating them
at <filename>/etc/tuned/</filename>. If the filenames for a custom and a default
profile matches, the custom profile takes precedence when applied.
</para>
</listitem>
Expand Down Expand Up @@ -241,9 +241,9 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="cha-tuning-tune
<para>
Once activated, &tuned; starts tuning the system based on the default profile
that is appropriate for the system, or the currently active profile. To change
it, use the <command>tuned-adm</command> command. For more information, see the
it, use the <command>tuned-adm</command> command. <!--For more information, see the
sections <xref linkend="sec-tuning-tuned-profiles"></xref> and
<xref linkend="sec-tuning-tuned-plugins"></xref>.
<xref linkend="sec-tuning-tuned-plugins"></xref>-->.
</para>
</note>
</listitem>
Expand Down Expand Up @@ -271,12 +271,6 @@ 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 @@ -334,19 +328,9 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="cha-tuning-tune

<sect2 xml:id="sec-supported-tuned-profiles">
<title>Supported TuneD profiles</title>
<para></para>
<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:
&sles; supports the following profiles:
</para>
<variablelist>
<varlistentry>
Expand Down Expand Up @@ -444,18 +428,6 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="cha-tuning-tune
</listitem>
</varlistentry>
</variablelist>
<para>
To understand more about the <filename>tuned.conf</filename> configuration file, read its
man page:
</para>
<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 xml:id="sec-manage-tuned-profiles">
Expand Down Expand Up @@ -540,20 +512,96 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="cha-tuning-tune
<screen><command>man tuned-adm</command></screen>
</sect2>
</sect1>
<sect1 xml:id="sec-tuning-tuned-plugins">
<title>TuneD plug-ins</title>
<sect1 xml:id="sec-understanding-tuned-configuration">
<title>Understanding TuneD configuration</title>

<para>
Lorem Ipsum
At the core of a TuneD are it configuration files. In &sles;, the
<filename>/etc/tuned/tuned-main.conf</filename> file is the main configuration file for the
TuneD daemon. This file contains global settings that affect the overall behavior of TuneD.
Also, each TuneD profile has its <filename>tuned.conf</filename> configuration file which
allows administrators to specify system tuning parameters across different subsystems such as
CPU, disk and network. The profile-specific configuration files are divided into sections,
each corresponding to a specific TuneD plug-in or a group of related settings.
</para>

<sect2 xml:id="sec-global-tuned-configuration">
<title>Global TuneD configuration</title>
<para>
When &tuned; starts running (as a daemon, by default), the settings in the
<filename>/etc/tuned/tuned-main.conf</filename> global configuration file is applied on the
system. This action prepares the system to apply additional profile-specific tuning in the
subsequent stages. For an overview of the main TuneD configuration file, read its man page:
</para>
<screen><command>man 5 tuned-main.conf</command></screen>
</sect2>

<sect2 xml:id="sec-default-tuned-profile-configuration">
<title>Default TuneD profile configuration</title>
<para>
The <emphasis role="strong">default</emphasis> 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. For example, the
<literal>balanced</literal> profile has its configuration file at
<filename>/usr/lib/tuned/balanced/tuned.conf</filename>. For an overview of the TuneD
configuration files, read its man page:
</para>
<screen><command>man 5 tuned.conf</command></screen>
</sect2>

<sect2 xml:id="sec-custom-tuned-profile-configuration">
<title>Custom TuneD profile configuration</title>
<para>
Also, you can define <emphasis role="strong">custom</emphasis> profiles. For each custom
profile, create a <replaceable>PROFILE_NAME</replaceable> directory in
<filename>/etc/tuned/</filename>, and place it configuration file within its own directory.
For example, the configuration file for a custom profile can be at the path
<filename>/etc/tuned/<replaceable>PROFILE_NAME</replaceable>/tuned.conf</filename>.
However, if there is a match between <replaceable>PROFILE_NAME</replaceable> in the default
<filename>/usr/lib/tuned/<replaceable>PROFILE_NAME</replaceable></filename> and the custom
<filename>/etc/tuned/<replaceable>PROFILE_NAME</replaceable></filename>, the custom profile
configuration is prioritized and applied. As a best practice for customizing a default
profile, copy it from <filename>/usr/lib/tuned/</filename> to
<filename>/etc/tuned/</filename> and then modify it. This preserves the original profile
and separates custom configurations.
</para>
<note>
<title>Path to TuneD profile configuration files</title>
<para>
Although <emphasis>not recommended</emphasis>, you can specify paths in the
<filename>/etc/tuned/tuned-main.conf</filename> other than the standard paths for default
and custom profiles:
</para>
<screen>profile_dirs=/etc/tuned/,/usr/lib/tuned/,<replaceable>/PATH/TO/CUSTOM/DIRECTORY/</replaceable></screen>
<para>
The directories are searched for profiles according to the order of their listing. In the
above example, <filename>/etc/tuned/</filename> is searched first, followed by
<filename>/usr/lib/tuned/</filename> and
<replaceable>/PATH/TO/CUSTOM/DIRECTORY/</replaceable>.
</para>
</note>
<warning>
<para>
&suse; does not support any profile that are not part of the default 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>
</sect1>
<sect1 xml:id="sec-tuning-profile-hooks">
<!--sect1 xml:id="sec-tuning-tuned-plugins">
<title>TuneD plug-ins</title>
<para>
Lorem Ipsum
</para>
</sect1>
<sect1 xml:id="sec-tuning-profile-hooks">
<title>Extension scripts</title>

<para>
Lorem Ipsum
Lorem Ipsum
</para>
</sect1>
</sect1-->
<sect1 xml:id="sec-tuning-tuned-more">
<title>More information</title>

Expand Down

0 comments on commit d8cbe30

Please sign in to comment.