Skip to content

Commit fd7a60d

Browse files
author
Dmitri Popov
committed
Update SAP Solutions content
1 parent 6bb1b48 commit fd7a60d

File tree

1 file changed

+91
-19
lines changed

1 file changed

+91
-19
lines changed

xml/s4s_tune.xml

Lines changed: 91 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ S4HANA-APP+DB Solution for running both &sap; S/4HANA application servers and &s
102102
</listitem>
103103
<listitem>
104104
<para>
105-
S4HANA-DBSERVER Solution for running the $sap; HANA database of an &sap; S/4HANA installation
105+
S4HANA-DBSERVER Solution for running the &sap; HANA database of an &sap; S/4HANA installation
106106
</para>
107107
</listitem>
108108
<listitem>
@@ -172,7 +172,7 @@ It is possible to combine Solutions and Notes by reverting Notes from an applied
172172
</para>
173173

174174
<para>
175-
In rare cases, notes can have conflicting options or parameters. Arrange your notes carefully to avoid conflicts. The last note always takes priority over conflicting options or parameters of previous notes. In this situations, create your own Solution (link:[8.5.1 Creating a new SAP Solution]) or customize the applied Solution (link:[8.5.x Customizing a SAP Solution]).
175+
In rare cases, notes can have conflicting options or parameters. Arrange your notes carefully to avoid conflicts. The last note always takes priority over conflicting options or parameters of previous notes. In this situation, create your own Solution (see <xref linkend="sec-saptune-create"/>) or customize the applied Solution (see <xref linkend="sec-saptune-customize"/>).
176176
</para>
177177
</note>
178178
</sect1>
@@ -192,14 +192,14 @@ In rare cases, notes can have conflicting options or parameters. Arrange your no
192192
</para>
193193
<screen>&prompt.root;<command>saptune note customise <replaceable>NOTE</replaceable></command></screen>
194194
<para>
195-
The command opens the default editor (defined in the environment variable <literal>EDITOR</literal>) with a copy of the Note configuration. Remove everything, except the parameters you want to change or disable as well as the header of the section the parameter belongs to.
195+
The command opens the default editor (defined in the environment variable <literal>EDITOR</literal>) with a copy of the Note configuration. Remove everything, except the parameters you want to change or disable as well as the header of the section the parameter belongs to.
196196
</para>
197197
<para>
198198
To change or set the parameter value, change or add the value of the parameter. To disable a parameter, remove the value, but leave the parameter and the <literal>=</literal> character. &saptune; lists the parameter, but it does not change it or checks it for the compliance status.
199199
For more information, refer to the <literal>saptune-note(5)</literal> manpage.
200200
</para>
201201
<para>
202-
This creates a <filename>/etc/saptune/override/<replaceable>NOTE</replaceable></filename>. It is possible to create the file elsewhere and place it in <filename>/etc/saptune/override/</filename>.
202+
This creates a <filename>/etc/saptune/override/<replaceable>NOTE</replaceable></filename> file. It is possible to create the file elsewhere and place it in <filename>/etc/saptune/override/</filename>.
203203
</para>
204204
<para>
205205
Configuration sections can be conditional. This is called tagging. Refer to the <literal>saptune-note(5)</literal> for further information.
@@ -223,7 +223,6 @@ For more information, refer to the <literal>saptune-note(5)</literal> manpage.
223223
</para>
224224
<para>
225225
Configuration sections can be conditional. This is called tagging. Refer to the <literal>saptune-note(5)</literal> for further information.
226-
****
227226
</para>
228227
</sect2>
229228

@@ -235,13 +234,8 @@ For more information, refer to the <literal>saptune-note(5)</literal> manpage.
235234
<screen>&prompt.root;<command>saptune note edit <replaceable>NOTE</replaceable></command></screen>
236235

237236
<para>
238-
The command opens the default editor (<literal>EDITOR</literal>)) with the Note configuration. When you are done editing a Note, restart the &saptune; service to apply the changes.
237+
The command opens the default editor (<literal>EDITOR</literal>) with the Note configuration. When you are done editing a Note, restart the &saptune; service to apply the changes. Custom Notes can be customized like shipped Notes.
239238
</para>
240-
<note>
241-
<para>
242-
Custom Notes can be customized like shipped Notes.
243-
</para>
244-
</note>
245239
</sect2>
246240

247241
<sect2 xml:id="sec-saptune-delete">
@@ -281,7 +275,7 @@ Do you really want to delete this Note (test2)? [y/n]: y</screen>
281275
<title>Renaming an &sapnote;</title>
282276
<para>
283277
This command allows renaming a created note to a new name. If a
284-
corresponding override file is available, this file is renamed, too:
278+
corresponding override file is available, this file is renamed as well:
285279
</para>
286280
<screen>&prompt.root;<command>saptune note rename test test2</command>
287281
Note to rename is a customer/vendor specific Note.
@@ -329,7 +323,7 @@ For information about the output of the command and verifying the entire tuning
329323
</sect2>
330324

331325
<sect2 xml:id="sec-saptune-simulate">
332-
<title>Simulating the application of an &sapnote;</title>
326+
<title>Performing a dry run of an &sapnote;</title>
333327
<para>
334328
To show each parameter of a Note, use the following command:
335329
</para>
@@ -376,22 +370,67 @@ The <command>simulate</command> command is deprecated since version 3.1 and is r
376370
<para>
377371
This chapter explains how to work with &sapsol;s.
378372
</para>
373+
<para>
374+
A &sapsol; is a combination of &sapnote; configurations grouped together logically. A &sapsol; generally represents a &sap; product or combination. Applying &sapsol; effectively applies all &sapnote; configurations listed in it. How to list and set a &sapsol; is described in <xref linkend="sec-saptune-configure-tuning"/>.
375+
</para>
376+
377+
<sect2 xml:id="sec-saptune-customize-solution">
378+
<title>Customizing an &sapsol;</title>
379+
<para>A &sapsol; can be customized using the following command:</para>
380+
<screen>&prompt.root;<command>saptune solution customise <replaceable>SOLUTION</replaceable></command></screen>
381+
<para>
382+
The command opens the default editor (defined in the environment variable <literal>EDITOR</literal>) with a copy of the Solution configuration. Change the Note list for the architecture to your liking. For more informaion, refer to the <literal>saptune-note(5)</literal> manpage.
383+
</para>
384+
<para>
385+
This creates an override file <filename>/etc/saptune/override/<replaceable>SOLUTION.sol</replaceable></filename>. It is possible to create the file elsewhere and place it in <filename>/etc/saptune/override/</filename>.
386+
</para>
387+
<para>
388+
When you are done customizing a &sapsol;, restart the saptune service to apply the changes.
389+
</para>
390+
</sect2>
379391

380392
<sect2 xml:id="sec-saptune-create-solution">
381393
<title>Creating a new &sapsol;</title>
382-
<para>To create a new &sapsol;, run:</para>
383-
<screen>&prompt.root;<command>saptune solution create <replaceable>SOLUTION</replaceable></command></screen>
394+
<para>To create a new &sapsol;, run the following command:</para>
395+
<screen>&prompt.root;<command>saptune solution create <replaceable>SOLUTION</replaceable></command></screen>
396+
<para>
397+
The command opens the default editor (defined in the environment variable <literal>EDITOR</literal>) with a Solution configuration template. Fill in the template.
398+
</para>
399+
<para>
400+
This creates a Solution configuration file <filename>/etc/saptune/extra/<replaceable>SOLUTION.sol</replaceable></filename>. It is possible to create the file elsewhere and place it in <filename>/etc/saptune/extra/</filename>.
401+
</para>
402+
</sect2>
403+
404+
<sect2 xml:id="sec-saptune-edit-solution">
405+
<title>Editing a custom &sapsol;</title>
406+
<para>
407+
To edit a custom &sapsol; use the following command:
408+
</para>
409+
410+
<screen>&prompt.root;<command>saptune solution edit <replaceable>NOTE</replaceable></command></screen>
411+
412+
<para>
413+
The command opens the default editor (defined in the environment variable <literal>EDITOR</literal>) with the Solution configuration.
414+
</para>
415+
<para>
416+
When you are done editing a &sapsol;, restart the saptune service to apply the changes.
417+
</para>
418+
<para>
419+
Custom Solution can be customized like shipped Solutions.
420+
</para>
384421
</sect2>
385422

386423
<sect2 xml:id="sec-saptune-delete-solution">
387424
<title>Deleting &sapsol;</title>
388-
<para>To delete an &sapsol;, run the following command:</para>
389-
<screen>&prompt.root;<command>saptune solution delete myHANA</command>
425+
<para>
426+
The following command deletes a created Solution, including the corresponding override file or the override file of a shipped Solution, if available:
427+
</para>
428+
<screen>&prompt.root;<command>saptune solution delete <replaceable>SOLUTION</replaceable></command>
390429

391430
Solution to delete is a customer/vendor specific Solution.
392431
Do you really want to delete this Solution 'myHANA'? [y/n]: y</screen>
393432
<para>
394-
The &sapsol; may not be applied at the time. Keep in mind the following points:
433+
The &sapsol; may not be applied at the time. Keep in mind the following:
395434
</para>
396435
<itemizedlist>
397436
<listitem>
@@ -401,7 +440,7 @@ Do you really want to delete this Solution 'myHANA'? [y/n]: y</screen>
401440
</listitem>
402441
<listitem>
403442
<para>
404-
&sapsol;s shipped by &saptune; cannot be deleted.
443+
&sapsol;s shipped by &saptune; cannot be deleted. Only the override file is removed, if available.
405444
</para>
406445
</listitem>
407446
<listitem>
@@ -464,6 +503,36 @@ Do you really want to rename this Solution 'myHANA' to the new name 'myHANA2'? [
464503
</para>
465504
</sect2>
466505

506+
<sect2 xml:id="sec-saptune-verify-solution">
507+
<title>Verifying an &sapsol;</title>
508+
<para>
509+
To verify the tuning of a Solution, use the following command:
510+
</para>
511+
<screen>&prompt.root;<command>saptune solution verify <replaceable>SOLUTION</replaceable></command></screen>
512+
<para>
513+
For information about the output of the <command>verify</command> command and how to verify the entire tuning instead of a single Solution, refer to <xref linkend="sec-saptune-verify-and-troubleshooting"/>.
514+
</para>
515+
</sect2>
516+
517+
<sect2 xml:id="sec-saptune-simulate-solution">
518+
<title>Performing a dry run of an SAP Solution</title>
519+
<para>
520+
To show all parameters of all Notes belonging to a Solution, use the following command:
521+
</para>
522+
<screen>&prompt.root;<command>saptune solution simulate <replaceable>SOLUTION</replaceable></command></screen>
523+
524+
<para>
525+
The command lists the current system value and the expected values (default and override).
526+
</para>
527+
528+
<note>
529+
<title>Deprecation notice</title>
530+
<para>
531+
The <command>simulate</command> command is deprecated since 3.1, and it is removed in all &saptune; versions in &sles4sap; 16.
532+
</para>
533+
</note>
534+
</sect2>
535+
467536
<sect2 xml:id="sec-saptune-revert-solution">
468537
<title>Reverting an &sapsol;</title>
469538
<para>To revert an &sapsol;, run the following command:</para>
@@ -489,6 +558,9 @@ Do you really want to rename this Solution 'myHANA' to the new name 'myHANA2'? [
489558
If &sapnote;s from an applied &sapsol; have been reverted, the string <literal>(partial)</literal>
490559
has been added to the solution name.
491560
</para>
561+
<para>
562+
Both commands are primarily meant for use in scripts.
563+
</para>
492564
</sect2>
493565
</sect1>
494566

0 commit comments

Comments
 (0)