Skip to content

Commit a9d1396

Browse files
dmpoplvicoundariavladykina
committed
saptune article (#547)
* saptune as Smart Doc Co-authored-by: lvicoun <[email protected]> Co-authored-by: Daria Vladykina <[email protected]>
1 parent 7d2652d commit a9d1396

12 files changed

+1466
-0
lines changed

‎DC-SAP-saptune‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# This file originates from the project https://github.com/openSUSE/doc-kit
2+
# This file can be edited downstream.
3+
4+
MAIN="saptune.asm.xml"
5+
SRC_DIR="articles"
6+
IMG_SRC_DIR="images"
7+
8+
## Profiling
9+
PROFOS="PRODUCT"
10+
#PROFCONDITION="PRODUCTNUMBER"
11+
# Use the STRUCTID if there are several structures in one assembly file
12+
#STRUCTID="STRUCTURE-ID"
13+
#PROFARCH="x86_64;zseries;power;aarch64"
14+
15+
DOCBOOK5_RNG_URI="urn:x-suse:rng:v2:geekodoc-flat"
16+
17+
STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
18+
FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse-ns"

‎articles/saptune.asm.xml‎

Lines changed: 195 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,195 @@
1+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2+
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
3+
<!-- This file can be edited downstream. -->
4+
<!DOCTYPE assembly
5+
[
6+
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
7+
%entities;
8+
]>
9+
<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
10+
<!-- point back to this document with a similar comment added to your legacy doc piece -->
11+
<!-- refer to README.md for file and id naming conventions -->
12+
<assembly version="5.2" xml:lang="en"
13+
xmlns:xlink="http://www.w3.org/1999/xlink"
14+
xmlns:trans="http://docbook.org/ns/transclusion"
15+
xmlns:its="http://www.w3.org/2005/11/its"
16+
xmlns:xi="http://www.w3.org/2001/XInclude"
17+
xmlns="http://docbook.org/ns/docbook">
18+
<!-- resources section references all topic chunks used in the final article
19+
-->
20+
<!-- R E S O U R C E S -->
21+
22+
<!-- Glues -->
23+
<resources>
24+
<resource xml:id="_glue-saptune-about" href="../glues/saptune-about.xml">
25+
</resource>
26+
</resources>
27+
28+
<!-- Tasks -->
29+
<resources>
30+
<resource xml:id="_task-saptune-install" href="../tasks/saptune-install.xml">
31+
</resource>
32+
<resource xml:id="_task-saptune-configure" href="../tasks/saptune-configure.xml">
33+
</resource>
34+
<resource xml:id="_task-saptune-tuning" href="../tasks/saptune-tuning.xml">
35+
</resource>
36+
<resource xml:id="_task-saptune-manage-sap-notes" href="../tasks/saptune-manage-sap-notes.xml">
37+
</resource>
38+
<resource xml:id="_task-saptune-manage-sap-sols" href="../tasks/saptune-manage-sap-sols.xml">
39+
</resource>
40+
<resource xml:id="_task-saptune-verify" href="../tasks/saptune-verify.xml">
41+
</resource>
42+
<resource xml:id="_task-saptune-staging" href="../tasks/saptune-staging.xml">
43+
</resource>
44+
</resources>
45+
46+
<!-- References -->
47+
48+
<resources>
49+
<resource xml:id="_reference-saptune-json-output" href="../references/saptune-json-output.xml">
50+
</resource>
51+
</resources>
52+
53+
<!-- Legal -->
54+
<resources>
55+
<resource href="../common/legal.xml" xml:id="_legal">
56+
<description>Legal Notice</description>
57+
</resource>
58+
<resource href="../common/license_gfdl1.2.xml" xml:id="_gfdl">
59+
<description>GNU Free Documentation License</description>
60+
</resource>
61+
</resources>
62+
<!-- S T R U C T U R E -->
63+
<structure renderas="article" xml:id="sap-tuning-saptune" xml:lang="en">
64+
<merge>
65+
<title>How to Tune Systems with &saptune;</title>
66+
<!-- Create revision history to enable versioning: adjust the placeholder revhistory ID,
67+
for each entry add the date of when the updated article will be published,
68+
list most recent date/entry at the top -->
69+
<!-- Check https://documentation.suse.com/style/current/single-html/docu_styleguide/#sec-revhistory for detailed instructions-->
70+
<revhistory xml:id="rh-sap-tuning-saptune">
71+
<revision><date>2025-11-04</date>
72+
<revdescription>
73+
<!-- briefly sum up the major changes for the reader-->
74+
<para>
75+
Initial version
76+
</para>
77+
</revdescription>
78+
</revision>
79+
</revhistory>
80+
<!-- TODO: provide a listing of possible and validatable meta entry values. Maybe in our geekodoc repo? -->
81+
<!-- add author's e-mail -->
82+
<meta name="maintainer" content="" its:translate="no"/>
83+
<meta name="architecture">
84+
<phrase>&x86-64;</phrase>
85+
<phrase>&power;</phrase>
86+
</meta>
87+
<!-- enter one or more product names and version -->
88+
<meta name="productname" its:translate="no">
89+
<productname version="16.0">&sles4sap;</productname>
90+
</meta>
91+
<meta name="title" its:translate="yes">How to Tune Systems with &saptune;</meta>
92+
<meta name="description" its:translate="yes">Everything you need to know about how to install, configure and use &saptune; to tune system running &sap; workloads</meta>
93+
<meta name="social-descr" its:translate="yes">Everything you need to know about using &saptune;</meta>
94+
<!-- suitable categories has to be identical with the category selected in the docserv config -->
95+
<meta name="category" its:translate="no">
96+
<phrase>Systems Management</phrase>
97+
</meta>
98+
<!-- Determines "filter by task" filter value -->
99+
<!-- either add link to list or list of tasks-->
100+
<meta name="task" its:translate="no">
101+
<phrase>Configuration</phrase>
102+
<phrase>Installation</phrase>
103+
</meta>
104+
<meta name="series" its:translate="no">Products &amp; Solutions</meta>
105+
<dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
106+
<dm:bugtracker>
107+
<dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>
108+
<dm:component>Documentation</dm:component>
109+
<dm:product><!--Bugzilla product string--></dm:product>
110+
<!--
111+
if the assembly applies to multiple products/productversions, use profiling:
112+
<dm:product os="sles4sap" condition="16.0">SUSE Linux Enterprise Server 16.0</dm:product>
113+
<dm:product os="sles" condition="16.1">SUSE Linux Enterprise Server 16.1</dm:product>
114+
-->
115+
<dm:assignee>[email protected]</dm:assignee>
116+
<!-- replace with your BUGZILLA e-mail address, otherwise this does not work-->
117+
</dm:bugtracker>
118+
<dm:translation>yes</dm:translation>
119+
</dm:docmanager>
120+
<abstract>
121+
<variablelist>
122+
<varlistentry>
123+
<term>WHAT?</term>
124+
<listitem>
125+
<para>
126+
Using &saptune; to tune systems for &netweaver;, &hana;/&bo; and
127+
&s4h; applications.
128+
</para>
129+
</listitem>
130+
</varlistentry>
131+
<varlistentry>
132+
<term>WHY?</term>
133+
<listitem>
134+
<para>
135+
&saptune; simplifies the process of tuning a system for running &sap; workloads.
136+
</para>
137+
</listitem>
138+
</varlistentry>
139+
<varlistentry>
140+
<term>EFFORT</term>
141+
<listitem>
142+
<para>
143+
30 minutes of reading time.
144+
</para>
145+
</listitem>
146+
</varlistentry>
147+
<varlistentry>
148+
<term>GOAL</term>
149+
<listitem>
150+
<para>
151+
Learn how to install, configure and use &saptune;.
152+
</para>
153+
</listitem>
154+
</varlistentry>
155+
<varlistentry>
156+
<term>REQUIREMENTS</term>
157+
<listitem>
158+
<itemizedlist>
159+
<listitem>
160+
<para>
161+
A SLES 16 system designated for running &sap; workloads
162+
</para>
163+
</listitem>
164+
<listitem>
165+
<para>
166+
A SLES 16 subscription
167+
</para>
168+
</listitem>
169+
<listitem>
170+
<para>
171+
Knowledge of which &sap; workload the system is intended to run
172+
</para>
173+
</listitem>
174+
</itemizedlist>
175+
</listitem>
176+
</varlistentry>
177+
</variablelist>
178+
</abstract>
179+
</merge>
180+
<module resourceref="_glue-saptune-about" renderas="section"/>
181+
<module resourceref="_task-saptune-install" renderas="section"/>
182+
<module resourceref="_task-saptune-configure" renderas="section"/>
183+
<module resourceref="_task-saptune-tuning" renderas="section"/>
184+
<module resourceref="_task-saptune-manage-sap-notes" renderas="section"/>
185+
<module resourceref="_task-saptune-manage-sap-sols" renderas="section"/>
186+
<module resourceref="_task-saptune-verify" renderas="section"/>
187+
<module resourceref="_reference-saptune-json-output" renderas="section"/>
188+
<module resourceref="_task-saptune-staging" renderas="section"/>
189+
<module resourceref="_legal"/>
190+
<module resourceref="_gfdl">
191+
<output renderas="appendix"/>
192+
</module>
193+
</structure>
194+
<!-- TODO: second structure! -->
195+
</assembly>

‎common/product-entities.ent‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,42 @@
1818
<!-- RELEASE NOTES URL -->
1919
<!--<!ENTITY rn-url "&sc-rn;/x86_64/[PRODUCT]/[VERSION]">-->
2020

21+
<!-- SAP-SPECIFIC ENTITIES -->
22+
23+
<!ENTITY sapwiz "&sap; Installation Wizard">
24+
<!ENTITY netweaver "&sap; NetWeaver">
25+
<!ENTITY nw "&netweaver;">
26+
<!ENTITY hana "&sap; HANA">
27+
<!ENTITY b1 "&sap; BusinessOne">
28+
<!ENTITY bo "&sap; BusinessObjects">
29+
<!ENTITY ase "&sap; Adaptive Server Enterprise">
30+
<!ENTITY s4h "&sap; S/4HANA">
31+
<!ENTITY s4ha "&sap; S/4HANA Application Server">
32+
<!ENTITY s4hd "&sap; S/4HANA Database Server">
33+
<!ENTITY trex "&sap; TREX">
34+
<!ENTITY wmp "Workload Memory Protection">
35+
36+
<!ENTITY instmaster "Installation Master">
37+
<!-- Almost always using the plural here: one dir to copy from can contain
38+
multiple "CDs": -->
39+
<!ENTITY instmedia "Installation Media">
40+
<!ENTITY mediaset "Media Set">
41+
<!ENTITY supmedia "Supplementary Media">
42+
<!ENTITY sapin "&sap; Installer">
43+
<!ENTITY sapina "&sap;inst">
44+
<!ENTITY saprouter "&sap;router">
45+
<!ENTITY hana-alm "&hana; Application Lifecycle Management">
46+
<!ENTITY thirdmedia "Third-Party Media">
47+
<!ENTITY hana-fw "HANA-Firewall">
48+
<!ENTITY clamsap "ClamSAP">
49+
<!ENTITY clamav "ClamAV">
50+
<!ENTITY cmcu "<command xmlns='http://docbook.org/ns/docbook'>clone-master-clean-up</command>">
51+
<!ENTITY systemd "<systemitem xmlns='http://docbook.org/ns/docbook' class='daemon'>systemd</systemitem>">
52+
<!ENTITY saptune "<command xmlns='http://docbook.org/ns/docbook'>saptune</command>">
53+
<!ENTITY sapconf "<literal xmlns='http://docbook.org/ns/docbook'>sapconf</literal>">
54+
<!ENTITY tuned "<systemitem xmlns='http://docbook.org/ns/docbook' class='daemon'>tuned</systemitem>">
55+
<!ENTITY sapnote "&sap; Note">
56+
<!ENTITY sapsol "&sap; Solution">
2157

2258
<!-- START YEAR OF COPYRIGHT -->
2359
<!ENTITY copyrightstart "2023">

‎glues/saptune-about.xml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
3+
<!-- This file can be edited downstream. -->
4+
<!DOCTYPE topic
5+
[
6+
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
7+
%entities;
8+
]>
9+
<topic xml:id="about-saptune"
10+
role="glue" xml:lang="en"
11+
xmlns="http://docbook.org/ns/docbook" version="5.2"
12+
xmlns:its="http://www.w3.org/2005/11/its"
13+
xmlns:xi="http://www.w3.org/2001/XInclude"
14+
xmlns:xlink="http://www.w3.org/1999/xlink"
15+
xmlns:trans="http://docbook.org/ns/transclusion">
16+
<info>
17+
<title>About &saptune;</title>
18+
<!--add author's e-mail address-->
19+
<meta name="maintainer" content="Dmitri Popov" its:translate="no"/>
20+
<!-- add an abstract/para here, if you need one -->
21+
<!-- can be changed via merge in the assembly -->
22+
</info>
23+
<para>
24+
&saptune; is a tool designed for tuning the operating system for running &sap; workloads. The tool simplifies the mandatory system tuning as described in various &sap; Notes. All the required tuning parameters are added to &saptune; notes and grouped these notes to solutions representing &sap; workloads. This ensures that no parameter is missed, while the &saptune; service applies all notes and solutions after each system reboot, thus keeping the system reliably tuned at all times.
25+
</para>
26+
<important>
27+
<para>
28+
&saptune; is used exclusively for tuning the system for &sap; workloads, and not the &sap; workloads themselves. &saptune; does not make any changes to &sap; configuration files.
29+
</para>
30+
</important>
31+
</topic>

0 commit comments

Comments
 (0)