-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #25 from angelabriel/master
Final changes from the tests of our Alliance team
- Loading branch information
Showing
21 changed files
with
1,313 additions
and
891 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| .\"/* | ||
| .\" * Copyright (c) 2017-2019 SUSE LLC. | ||
| .\" * All rights reserved | ||
| .\" * Authors: Howard Guo, Angela Briel | ||
| .\" * Authors: Soeren Schmidt, Angela Briel | ||
| .\" * | ||
| .\" * This program is free software; you can redistribute it and/or | ||
| .\" * modify it under the terms of the GNU General Public License | ||
|
|
@@ -14,7 +14,7 @@ | |
| .\" * GNU General Public License for more details. | ||
| .\" */ | ||
| .\" | ||
| .TH saptune "8" "May 2019" "" "System Optimisation For SAP" | ||
| .TH saptune "8" "June 2019" "" "System Optimisation For SAP" | ||
| .SH NAME | ||
| saptune \- Comprehensive system optimisation management for SAP solutions (\fBVersion 2\fP) | ||
|
|
||
|
|
@@ -154,6 +154,18 @@ If a Note definition contains a '\fB[reminder]\fP' section, this section will be | |
| .B customise | ||
| This allows to customize the values of the saptune Note definitions. The Note definition file will be copied from \fI/usr/share/saptune/notes\fP or \fI/etc/saptune/extra\fP to the override location at \fI/etc/saptune/override\fP, if the file does not exist already. After that an editor will be launched to allow changing the Note definitions. | ||
| The editor is defined by the \fBEDITOR\fP environment variable. If not set editor defaults to /usr/bin/vim. | ||
|
|
||
| You can only change the value from already available parameters of the note. But you are not able to add new parameters. | ||
|
|
||
| If you want to use new parameters to tune the system, please create your own custom Note definition file in \fI/etc/saptune/extra\fP. | ||
|
|
||
| You can prevent a parameter from being changed by leaving the parameter value in the override file empty. The parameter will be marked as 'untouched' in the override column of the verify table. | ||
|
|
||
| The values from the override files will take precedence over the values from \fI/usr/share/saptune/notes\fP or \fI/etc/saptune/extra\fP. In such case you will not lose your customized Notes between saptune or vendor updates. | ||
| .br | ||
| The saptune options 'list', 'verify' and 'simulate' will mark the existence of an override file and the contained values. | ||
|
|
||
| When creating an override file for an already applied SAP Note definition, please do a 'revert all' and then apply the Notes again, to get the changes take effect. | ||
| .TP | ||
| .B create | ||
| This allows to create own Note definition files in \fI/etc/saptune/extra\fP. The Note definition file will be created from a template file into the location \fI/etc/saptune/extra\fP, if the file does not exist already. After that an editor will be launched to allow changing the Note definitions. | ||
|
|
@@ -178,7 +190,11 @@ It's not possible to combine solutions, there can only be\fBone\fP solution enab | |
| Apply optimisation settings recommended by the SAP solution. These settings will be automatically activated upon system boot if the daemon is enabled. | ||
| .TP | ||
| .B list | ||
| List all SAP solution names that saptune is capable of implementing. The marked ones are currently implemented. | ||
| List all SAP solution names that saptune is capable of implementing. | ||
| .br | ||
| The currently implemented solution is marked with '\fB*\fP' and is highlighted with green color. A deprecated solution is marked with '\fBD\fP'. | ||
| .br | ||
| If an \fBoverride\fP file exists for a solution, the solution is marked with '\fBO\fP'. | ||
| .TP | ||
| .B simulate | ||
| Show all notes that are associated with the specified SAP solution, and all changes that will be applied once the solution is activated. | ||
|
|
@@ -207,7 +223,7 @@ Will display the syntax of saptune | |
| .SH VENDOR SUPPORT | ||
| To support vendor or customer specific tuning values, saptune supports 'drop-in' files residing in \fI/etc/saptune/extra\fP. All files found in \fI/etc/saptune/extra\fP are listed when running '\fBsaptune note list\fP'. All \fBnote options\fP are available for these files. | ||
|
|
||
| We simplify the file name syntax for these vendor files. But the old file names still valid and supported. | ||
| We simplified the file name syntax for these vendor files. But the old file names are still valid and supported. | ||
| .br | ||
| Related to this we add 'header' support (see description of section [version] in saptune-note(5)) for the vendor files as already available for the Note definition files in /usr/share/saptune/notes to get a proper description during saptune option 'list' | ||
|
|
||
|
|
@@ -263,16 +279,6 @@ the saptune Note definition override location. | |
| If you need to customize the Note definitions found in \fI/usr/share/saptune/notes\fP or \fI/etc/saptune/extra\fP, you can copy them to \fI/etc/saptune/override\fP and modify them as you need. Please stay with the original name of the Note definition (the NoteID) and do \fBNOT\fP rename it. | ||
|
|
||
| Or use '\fBsaptune note customize NoteID\fP' to do the job for you. | ||
|
|
||
| You can only change the value from already available parameters of the note. But you are not able to add new parameters. If you want to use new parameters to tune the system, please create your own custom Note definition file in \fI/etc/saptune/extra\fP. | ||
|
|
||
| You can prevent a parameter from being changed by leaving the parameter value in the override file empty. The parameter will be marked as 'untouched' in the override column of the verify table. | ||
|
|
||
| The values from the override files will take precedence over the values from \fI/usr/share/saptune/notes\fP or \fI/etc/saptune/extra\fP. In such case you will not lose your customized Notes between saptune or vendor updates. | ||
| .br | ||
| The saptune options 'list', 'verify' and 'simulate' will mark the existence of an override file and the contained values. | ||
|
|
||
| When creating an override file for an already applied SAP Note definition, please do a 'revert all' and then apply the Notes again, to get the changes take effect. | ||
| .RE | ||
| .PP | ||
| \fI/usr/share/saptune/solutions\fP | ||
|
|
@@ -310,4 +316,4 @@ saptune-note(5) saptune-migrate(7) saptune(8) saptune_v1(8) tuned(8) tuned-adm(8 | |
|
|
||
| .SH AUTHOR | ||
| .NF | ||
| Howard Guo <hguo@suse.com>, Angela Briel <[email protected]> | ||
| Soeren Schmidt <soeren.schmidt@suse.com>, Angela Briel <[email protected]> | ||
104 changes: 104 additions & 0 deletions
104
ospackage/usr/share/doc/packages/saptune/sapconf2saptune.1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
|
|
||
| .TH sapconf2saptune 1 "March 2019" "1.0" "sapconf configuration conversion" | ||
|
|
||
| .SH NAME | ||
| sapconf2saptune \- converts a sapconf configuration into a saptune v2 configuration | ||
| .SH SYNOPSIS | ||
| .B sapconf2saptune \fB | ||
| [ | ||
| .IR PROFILE | ||
| ] | ||
|
|
||
| .B sapconf2saptune \fB | ||
| .IR SAPCONF_SYCONFIG | ||
| .IR TUNED_CONFIG | ||
|
|
||
| .B sapconf2saptune\fB | ||
| -h|--help | ||
| .SH DESCRIPTION | ||
| The tool sapconf2saptune converts a sapconf configuration into a drop-in file for saptune v2 to aid a move from sapconf to saptune. | ||
|
|
||
| The tool expects either the sapconf sysconfig file as first and the sapconf tuned.conf as second parameter or the sapconf profile. | ||
| Without any parameters sapconf2saptune tries to determine the sapoconf profile by reading '/etc/tuned/active_profile'. | ||
|
|
||
| The generated saptune configuration is printed on stdout. | ||
| To use it, redirect the output to a file which has to be placed into '/etc/saptune/extra/' (See EXAMPLES below). | ||
| The new configuration should be visible by 'saptune note list' and is ready to use. | ||
|
|
||
| During conversion the tool is writing information, warning and error messages to stderr. This is the case for: | ||
|
|
||
| \(bu Problems reading the configuration files. | ||
| \(bu Possible wrong configuration files. | ||
| \(bu Unknown variables or options. This indicates manual added configurations typically. | ||
| \(bu Data type conversion issues. This would indicate a broken sapconf/tuned configuration. | ||
| \(bu Parameters not supported by saptune. This is the case for min_perf_pct. | ||
|
|
||
| .TP | ||
| .B PROFILE \fB | ||
| The saponf profile to convert. | ||
| .TP | ||
| .B SAPCONF_SYCONFIG \fB | ||
| Path to the sapconf sysconfig file, usually /etc/sysconfig/sapconf. | ||
| .TP | ||
| .B TUNED_CONFIG \fB | ||
| Path to the tuned.conf file of a sapconf proifle. Usually this is /usr/lib/tuned/<profile>/tuned.conf or /etc/tuned/<profile>/tuned.conf. | ||
| .TP | ||
| .B -h|--help \fB | ||
| Displays some help information. | ||
|
|
||
| .SH IMPORTANT | ||
| Please notice: | ||
| .IP \[bu] 2 | ||
| A current sapconf has to be used! If this is not the case, update first! | ||
| .IP \[bu] | ||
| The sapconf configuration has to be correct! Please verify /etc/sysconfig/sapconf and the used tuned.conf. Also check the logs of sapconf (/var/log/sapconf.log) and tuned (/var/log/tuned/). Keep in mind that there can be an override file '/etc/tuned/<profile>/tuned.conf! | ||
| .IP \[bu] | ||
| Double-check your sapconf configuration and the converted result. sapconf2saptune is a simple conversion tool and does | ||
| \(bu no checks for multiple parameters, | ||
| \(bu no checks for the sanity of values, | ||
| \(bu no checks to detect any misconfguration, | ||
| \(bu not convert manual added parameters. | ||
| .IP \[bu] | ||
| Read the info, warn and error messages printed on stderr during conversion. | ||
| .IP \[bu] | ||
| min_perf_pct is not supported by saptune and is not moved. | ||
| .IP \[bu] | ||
| Use the generated configuration as the only note for saptune! Combine them with others | ||
| .B *ONLY IF YOU KNOW WHAT YOU ARE DOING*\fB | ||
| ! | ||
| .SH EXIT STATUS | ||
| On success, 0 is returned, 1 otherwise. The error messages on stderr should tell the cause. | ||
| .SH EXAMPLE | ||
| To convert a configuration on SLES 15 (no tuned overwrite configuration): | ||
|
|
||
| .RS | ||
| .B sapconf2saptune /etc/sysconfig/sapconf /usr/lib/tuned/sapconf/tuned.conf | ||
| .RE | ||
|
|
||
| To convert a configuration (sap-hana profile) on SLES 12 (no tuned overwrite configuration): | ||
|
|
||
| .RS | ||
| .B sapconf2saptune /etc/sysconfig/sapconf /usr/lib/tuned/sap-hana/tuned.conf | ||
| .RE | ||
|
|
||
| Convert and write the configuration to an extra file for saptune. | ||
|
|
||
| .RS | ||
| .B sapconf2saptune /etc/sysconfig/sapconf /usr/lib/tuned/sap-hana/tuned.conf > /etc/saptune/extra/sapconf.conf | ||
| .RE | ||
| .SH FILES | ||
| .TP | ||
| .B /etc/sysconfig/sapconf \fB | ||
| Main configuration file for sapconf. | ||
| .TP | ||
| .B /usr/lib/tuned/<profile>/tuned.conf, /etc/tuned/<profile>/tuned.conf \fB | ||
| The tuned configuration. Either the default configuration ('/usr/lib/tuned') or the overwrite file ('/etc/tuned/') is used! | ||
| .TP | ||
| .B /etc/tuned/active_profile \fB | ||
| Current tuned profile. Used by sapconf2saptune to determine the used sapconf profile. | ||
| .SH SEE ALSO | ||
| sapconf(8), sapconf(5), sapconf(7), saptune(8) | ||
| .SH BUGS | ||
| No known bugs. | ||
| .SH AUTHOR | ||
| Sören Schmidt <[email protected]> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.