Documentation
¶
Index ¶
- Constants
- Variables
- func DaemonAction(writer io.Writer, actionName, saptuneVersion string, tuneApp *app.App)
- func NoteAction(writer io.Writer, actionName, noteID, newNoteID string, tuneApp *app.App)
- func NoteActionApplied(writer io.Writer, tuneApp *app.App)
- func NoteActionApply(writer io.Writer, noteID string, tuneApp *app.App)
- func NoteActionCreate(writer io.Writer, noteID string, tuneApp *app.App)
- func NoteActionCustomise(writer io.Writer, noteID string, tuneApp *app.App)
- func NoteActionDelete(reader io.Reader, writer io.Writer, noteID string, tuneApp *app.App)
- func NoteActionEdit(writer io.Writer, noteID string, tuneApp *app.App)
- func NoteActionEnabled(writer io.Writer, tuneApp *app.App)
- func NoteActionList(writer io.Writer, tuneApp *app.App)
- func NoteActionRename(reader io.Reader, writer io.Writer, noteID, newNoteID string, tuneApp *app.App)
- func NoteActionRevert(writer io.Writer, noteID string, tuneApp *app.App)
- func NoteActionShow(writer io.Writer, noteID string, tuneApp *app.App)
- func NoteActionSimulate(writer io.Writer, noteID string, tuneApp *app.App)
- func NoteActionVerify(writer io.Writer, noteID string, tuneApp *app.App)
- func PrintHelpAndExit(writer io.Writer, exitStatus int)
- func PrintNoteFields(writer io.Writer, header string, ...)
- func PrintStageFields(writer io.Writer, stageName string, comparison map[string]stageComparison)
- func RevertAction(writer io.Writer, actionName string, tuneApp *app.App)
- func SelectAction(writer io.Writer, stApp *app.App, saptuneVers string)
- func ServiceAction(writer io.Writer, actionName, saptuneVersion string, tApp *app.App)
- func ServiceActionApply(tuneApp *app.App)
- func ServiceActionDisable()
- func ServiceActionEnable()
- func ServiceActionRestart(tuneApp *app.App)
- func ServiceActionRevert(tuneApp *app.App)
- func ServiceActionStart(enableService bool, tuneApp *app.App)
- func ServiceActionStatus(writer io.Writer, tuneApp *app.App, saptuneVersion string)
- func ServiceActionStop(disableService bool)
- func ServiceActionTakeover(tuneApp *app.App)
- func SolutionAction(writer io.Writer, actionName, solName, newSolName string, tuneApp *app.App)
- func SolutionActionApplied(writer io.Writer, tuneApp *app.App)
- func SolutionActionApply(writer io.Writer, solName string, tuneApp *app.App)
- func SolutionActionChange(reader io.Reader, writer io.Writer, solName string, tuneApp *app.App)
- func SolutionActionCreate(writer io.Writer, customSol string)
- func SolutionActionCustomise(writer io.Writer, customSol string, tuneApp *app.App)
- func SolutionActionDelete(reader io.Reader, writer io.Writer, solName string, tuneApp *app.App)
- func SolutionActionEdit(writer io.Writer, customSol string, tuneApp *app.App)
- func SolutionActionEnabled(writer io.Writer, tuneApp *app.App)
- func SolutionActionList(writer io.Writer, tuneApp *app.App)
- func SolutionActionRename(reader io.Reader, writer io.Writer, solName, newSolName string, ...)
- func SolutionActionRevert(writer io.Writer, solName string, tuneApp *app.App)
- func SolutionActionShow(writer io.Writer, solName string)
- func SolutionActionSimulate(writer io.Writer, solName string, tuneApp *app.App)
- func SolutionActionVerify(writer io.Writer, solName string, tuneApp *app.App)
- func StagingAction(actionName string, stageName []string, tuneApp *app.App)
- func VerifyAllParameters(writer io.Writer, tuneApp *app.App)
Constants ¶
const ( SaptuneService = "saptune.service" SapconfService = "sapconf.service" TunedService = "tuned.service" )
define constants and variables for the whole package
Variables ¶
var ExtraTuningSheets = "/etc/saptune/extra/"
ExtraTuningSheets is a directory located on file system for external parties to place their tuning option files.
var NoteTuningSheets = "/var/lib/saptune/working/notes/"
NoteTuningSheets is the working directory of available sap notes
var OverrideTuningSheets = "/etc/saptune/override/"
OverrideTuningSheets is the directory for the override files
var PackageArea = "/usr/share/saptune/"
PackageArea is the package area with all notes and solutions shipped by the current installed saptune rpm
var RPMDate = "undef"
RPMDate is the date of package build only used in individual build test packages, but NOT in our official built and released packages (not possible because of 'reproducible' builds)
var RPMVersion = "undef"
RPMVersion is the package version from package build process
var SolutionSheets = "/var/lib/saptune/working/sols/"
SolutionSheets is the working directory of available sap solutions
var StagingArea = "/var/lib/saptune/staging/"
StagingArea is the staging area
var StagingSheets = "/var/lib/saptune/staging/latest/"
StagingSheets is the staging directory of the latest notes
var WorkingArea = "/var/lib/saptune/working/"
WorkingArea is the working directory
Functions ¶
func DaemonAction ¶
DaemonAction handles daemon actions like start, stop, status asm. still available for compatibility reasons
func NoteAction ¶
NoteAction Note actions like apply, revert, verify asm.
func NoteActionApplied ¶
NoteActionApplied lists all applied Note definitions as list separated by blanks
func NoteActionApply ¶
NoteActionApply applies Note parameter settings to the system
func NoteActionCreate ¶
NoteActionCreate helps the customer to create an own Note definition
func NoteActionCustomise ¶
NoteActionCustomise creates an override file and allows to editing the Note definition override file
func NoteActionDelete ¶
NoteActionDelete deletes a custom Note definition file and the corresponding override file
func NoteActionEdit ¶
NoteActionEdit allows to editing the custom/vendor specific Note definition file and NOT the override file
func NoteActionEnabled ¶
NoteActionEnabled lists all enabled Note definitions as list separated by blanks
func NoteActionList ¶
NoteActionList lists all available Note definitions
func NoteActionRename ¶
func NoteActionRename(reader io.Reader, writer io.Writer, noteID, newNoteID string, tuneApp *app.App)
NoteActionRename renames a custom Note definition file and the corresponding override file
func NoteActionRevert ¶
NoteActionRevert reverts all parameter settings of a Note back to the state before 'apply'
func NoteActionShow ¶
NoteActionShow shows the content of the Note definition file
func NoteActionSimulate ¶
NoteActionSimulate shows all changes that will be applied to the system if the Note will be applied.
func NoteActionVerify ¶
NoteActionVerify compares all parameter settings from a Note definition against the system settings
func PrintHelpAndExit ¶
PrintHelpAndExit prints the usage and exit
func PrintNoteFields ¶
func PrintNoteFields(writer io.Writer, header string, noteComparisons map[string]map[string]note.FieldComparison, printComparison bool, result *system.JPNotes)
PrintNoteFields Print mismatching fields in the note comparison result.
func PrintStageFields ¶
PrintStageFields prints mismatching parameters between Notes in staging and working area
func RevertAction ¶
RevertAction Revert all notes and solutions
func SelectAction ¶
SelectAction selects the chosen action depending on the first command line argument
func ServiceAction ¶
ServiceAction handles service actions like start, stop, status, enable, disable it controls the systemd saptune.service
func ServiceActionApply ¶
ServiceActionApply is only used by saptune service, hence it is not advertised to the end user. It is used to tune the system after reboot
func ServiceActionDisable ¶
func ServiceActionDisable()
ServiceActionDisable disables the saptune service
func ServiceActionEnable ¶
func ServiceActionEnable()
ServiceActionEnable enables the saptune service
func ServiceActionRestart ¶
ServiceActionRestart is only used by saptune service, hence it is not advertised to the end user. It is used to restart the saptune service
func ServiceActionRevert ¶
ServiceActionRevert is only used by saptune service, hence it is not advertised to the end user. It is used to revert all the tuned parameters right before a system reboot
func ServiceActionStart ¶
ServiceActionStart starts the saptune service enable service before start, if enableService is true
func ServiceActionStatus ¶
ServiceActionStatus checks the status of the saptune service
func ServiceActionStop ¶
func ServiceActionStop(disableService bool)
ServiceActionStop stops the saptune service disable service before stop, if disableService is true
func ServiceActionTakeover ¶
ServiceActionTakeover starts and enables the saptune service even if competing services (sapconf, tuned) are active. These services will be disabled and stopped disable and stop sapconf.service and tuned.service
func SolutionAction ¶
SolutionAction Solution actions like apply, revert, verify asm.
func SolutionActionApplied ¶
SolutionActionApplied prints out the applied solution
func SolutionActionApply ¶
SolutionActionApply applies parameter settings defined by the solution to the system
func SolutionActionChange ¶
SolutionActionChange switches to a new solution even that another solution was already applied It's basically a 'revert OLDSOLUTION' && 'apply NEWSOLUTION'. This will change the Note order in case of additional applied Notes, but this is intended and accepted. The confirmation can be suppressed by '--force'
func SolutionActionCreate ¶
SolutionActionCreate helps the customer to create an own solution definition
func SolutionActionCustomise ¶
SolutionActionCustomise creates an override file and allows to editing the solution definition override file
func SolutionActionDelete ¶
SolutionActionDelete deletes a custom solution definition file and the corresponding override file
func SolutionActionEdit ¶
SolutionActionEdit allows to editing the custom/vendor specific solution definition file and NOT the override file
func SolutionActionEnabled ¶
SolutionActionEnabled prints out the enabled solution definition
func SolutionActionList ¶
SolutionActionList lists all available solution definitions
func SolutionActionRename ¶
func SolutionActionRename(reader io.Reader, writer io.Writer, solName, newSolName string, tuneApp *app.App)
SolutionActionRename renames a custom Solution definition file and the corresponding override file
func SolutionActionRevert ¶
SolutionActionRevert reverts all parameter settings of a solution back to the state before 'apply'
func SolutionActionShow ¶
SolutionActionShow shows the content of the Solution definition file
func SolutionActionSimulate ¶
SolutionActionSimulate shows all changes that will be applied to the system if the solution will be applied.
func SolutionActionVerify ¶
SolutionActionVerify compares all parameter settings from a solution definition against the system settings
func StagingAction ¶
StagingAction Staging actions like apply, revert, verify asm.
Types ¶
This section is empty.
Source Files