Safe Haskell	Safe-Inferred
Language	Haskell2010

Ganeti.HTools.CLI

Contents

The options

Description

Implementation of command-line functions.

This module holds the common command-line related functions for the binaries, separated into this module since Ganeti.Utils is used in many other places and this is more IO oriented.

Synopsis

data Options = Options {
- optDataFile :: Maybe FilePath
- optDiskMoves :: Bool
- optInstMoves :: Bool
- optDiskTemplate :: Maybe DiskTemplate
- optSpindleUse :: Maybe Int
- optDynuFile :: Maybe FilePath
- optIgnoreDynu :: Bool
- optIgnoreSoftErrors :: Bool
- optIndependentGroups :: Bool
- optAcceptExisting :: Bool
- optMonD :: Bool
- optMonDFile :: Maybe FilePath
- optMonDXen :: Bool
- optMonDExitMissing :: Bool
- optEvacMode :: Bool
- optRestrictedMigrate :: Bool
- optExInst :: [String]
- optExTags :: Maybe [String]
- optExecJobs :: Bool
- optDryRun :: Bool
- optFirstJobGroup :: Bool
- optForce :: Bool
- optFullEvacuation :: Bool
- optGroup :: Maybe GroupID
- optIAllocSrc :: Maybe FilePath
- optIgnoreNonRedundant :: Bool
- optSelInst :: [String]
- optLuxi :: Maybe FilePath
- optJobDelay :: Double
- optMachineReadable :: Bool
- optMaster :: String
- optMaxLength :: Int
- optMcpu :: Maybe Double
- optMdsk :: Double
- optMinGain :: Score
- optMinGainLim :: Score
- optMinResources :: Double
- optMinScore :: Score
- optNoHeaders :: Bool
- optNoSimulation :: Bool
- optNodeSim :: [String]
- optNodeTags :: Maybe [String]
- optOffline :: [String]
- optRestrictToNodes :: Maybe [String]
- optOfflineMaintenance :: Bool
- optOneStepOnly :: Bool
- optOutPath :: FilePath
- optPrintMoves :: Bool
- optReason :: Maybe String
- optSaveCluster :: Maybe FilePath
- optShowCmds :: Maybe FilePath
- optShowHelp :: Bool
- optShowComp :: Bool
- optShowInsts :: Bool
- optShowNodes :: Maybe [String]
- optShowVer :: Bool
- optSkipNonRedundant :: Bool
- optStaticKvmNodeMemory :: Int
- optStdSpec :: Maybe RSpec
- optTargetResources :: Double
- optTestCount :: Maybe Int
- optTieredSpec :: Maybe RSpec
- optReplay :: Maybe String
- optVerbose :: Int
- optPriority :: Maybe OpSubmitPriority
- optCapacity :: Bool
}
type OptType = GenericOptType Options
defaultOptions :: Options
parseOpts :: [String] -> String -> [OptType] -> [ArgCompletion] -> IO (Options, [String])
parseOptsInner :: StandardOptions a => a -> [String] -> String -> [GenericOptType a] -> [ArgCompletion] -> Either (ExitCode, String) (a, [String])
parseYesNo :: Bool -> Maybe String -> Result Bool
parseISpecString :: String -> String -> Result RSpec
shTemplate :: String
maybeSaveCommands :: String -> Options -> String -> IO ()
maybePrintNodes :: Maybe [String] -> String -> ([String] -> String) -> IO ()
maybePrintInsts :: Bool -> String -> String -> IO ()
maybeShowWarnings :: [String] -> IO ()
printKeys :: String -> [(String, String)] -> IO ()
printFinal :: String -> Bool -> IO ()
setNodeStatus :: Options -> List -> IO List
oDataFile :: OptType
oDiskMoves :: OptType
oDiskTemplate :: OptType
oDryRun :: OptType
oSpindleUse :: OptType
oDynuFile :: OptType
oMonD :: OptType
oMonDDataFile :: OptType
oMonDXen :: OptType
oEvacMode :: OptType
oMonDExitMissing :: OptType
oFirstJobGroup :: OptType
oRestrictedMigrate :: OptType
oExInst :: OptType
oExTags :: OptType
oExecJobs :: OptType
oForce :: OptType
oFullEvacuation :: OptType
oGroup :: OptType
oIAllocSrc :: OptType
oIgnoreDyn :: OptType
oIgnoreNonRedundant :: OptType
oIgnoreSoftErrors :: OptType
oIndependentGroups :: OptType
oAcceptExisting :: OptType
oInstMoves :: OptType
oJobDelay :: OptType
genOLuxiSocket :: String -> OptType
oLuxiSocket :: IO OptType
oMachineReadable :: OptType
oMaxCpu :: OptType
oMaxSolLength :: OptType
oMinDisk :: OptType
oMinGain :: OptType
oMinGainLim :: OptType
oMinResources :: OptType
oMinScore :: OptType
oNoHeaders :: OptType
oNoSimulation :: OptType
oNodeSim :: OptType
oNodeTags :: OptType
oOfflineMaintenance :: OptType
oOfflineNode :: OptType
oOneStepOnly :: OptType
oOutputDir :: OptType
oPrintCommands :: OptType
oPrintInsts :: OptType
oPrintMoves :: OptType
oPrintNodes :: OptType
oQuiet :: OptType
oRapiMaster :: OptType
oReason :: OptType
oRestrictToNodes :: OptType
oSaveCluster :: OptType
oSelInst :: OptType
oShowHelp :: StandardOptions a => GenericOptType a
oShowVer :: StandardOptions a => GenericOptType a
oShowComp :: StandardOptions a => GenericOptType a
oSkipNonRedundant :: OptType
oStaticKvmNodeMemory :: OptType
oStdSpec :: OptType
oTargetResources :: OptType
oTieredSpec :: OptType
oVerbose :: OptType
oPriority :: OptType
oNoCapacityChecks :: OptType
genericOpts :: [GenericOptType Options]

Documentation

data Options #

Command line options structure.

Constructors

Options

Fields

optDataFile :: Maybe FilePath
Path to the cluster data file
optDiskMoves :: Bool
Allow disk moves
optInstMoves :: Bool
Allow instance moves
optDiskTemplate :: Maybe DiskTemplate
Override for the disk template
optSpindleUse :: Maybe Int
Override for the spindle usage
optDynuFile :: Maybe FilePath
Optional file with dynamic use data
optIgnoreDynu :: Bool
Do not use dynamic use data
optIgnoreSoftErrors :: Bool
Ignore soft errors in balancing moves
optIndependentGroups :: Bool
consider groups independently
optAcceptExisting :: Bool
accept existing N+1 violations
optMonD :: Bool
Query MonDs
optMonDFile :: Maybe FilePath
Optional file with data provided by MonDs
optMonDXen :: Bool
Should Xen-specific collectors be considered (only if MonD is queried)
optMonDExitMissing :: Bool
If the program should exit on missing MonD data
optEvacMode :: Bool
Enable evacuation mode
optRestrictedMigrate :: Bool
Disallow replace-primary moves
optExInst :: [String]
Instances to be excluded
optExTags :: Maybe [String]
Tags to use for exclusion
optExecJobs :: Bool
Execute the commands via Luxi
optDryRun :: Bool
Only do a dry run
optFirstJobGroup :: Bool
Only execute the first group of jobs
optForce :: Bool
Force the execution
optFullEvacuation :: Bool
Fully evacuate nodes to be rebooted
optGroup :: Maybe GroupID
The UUID of the group to process
optIAllocSrc :: Maybe FilePath
The iallocation spec
optIgnoreNonRedundant :: Bool
Ignore non-redundant instances
optSelInst :: [String]
Instances to be excluded
optLuxi :: Maybe FilePath
Collect data from Luxi
optJobDelay :: Double
Delay before executing first job
optMachineReadable :: Bool
Output machine-readable format
optMaster :: String
Collect data from RAPI
optMaxLength :: Int
Stop after this many steps
optMcpu :: Maybe Double
Override max cpu ratio for nodes
optMdsk :: Double
Max disk usage ratio for nodes
optMinGain :: Score
Min gain we aim for in a step
optMinGainLim :: Score
Limit below which we apply mingain
optMinResources :: Double
Minimal resources for hsqueeze
optMinScore :: Score
The minimum score we aim for
optNoHeaders :: Bool
Do not show a header line
optNoSimulation :: Bool
Skip the rebalancing dry-run
optNodeSim :: [String]
Cluster simulation mode
optNodeTags :: Maybe [String]
List of node tags to restrict to
optOffline :: [String]
Names of offline nodes
optRestrictToNodes :: Maybe [String]
if not Nothing, restrict allocation to those nodes
optOfflineMaintenance :: Bool
Pretend all instances are offline
optOneStepOnly :: Bool
Only do the first step
optOutPath :: FilePath
Path to the output directory
optPrintMoves :: Bool
Whether to show the instance moves
optReason :: Maybe String
The reason to be passed when submitting jobs
optSaveCluster :: Maybe FilePath
Save cluster state to this file
optShowCmds :: Maybe FilePath
Whether to show the command list
optShowHelp :: Bool
Just show the help
optShowComp :: Bool
Just show the completion info
optShowInsts :: Bool
Whether to show the instance map
optShowNodes :: Maybe [String]
Whether to show node status
optShowVer :: Bool
Just show the program version
optSkipNonRedundant :: Bool
Skip nodes with non-redundant instance
optStaticKvmNodeMemory :: Int
Use static value for node memory ^ on KVM
optStdSpec :: Maybe RSpec
Requested standard specs
optTargetResources :: Double
Target resources for squeezing
optTestCount :: Maybe Int
Optional test count override
optTieredSpec :: Maybe RSpec
Requested specs for tiered mode
optReplay :: Maybe String
Unittests: RNG state
optVerbose :: Int
Verbosity level
optPriority :: Maybe OpSubmitPriority
OpCode submit priority
optCapacity :: Bool
Also do capacity-related checks

Instances

Instances details

Show Options #
Instance details Defined in Ganeti.HTools.CLI Methods showsPrec :: Int -> Options -> ShowS show :: Options -> String showList :: [Options] -> ShowS
StandardOptions Options #
Instance details Defined in Ganeti.HTools.CLI Methods helpRequested :: Options -> Bool # verRequested :: Options -> Bool # compRequested :: Options -> Bool # requestHelp :: Options -> Options # requestVer :: Options -> Options # requestComp :: Options -> Options #

type OptType = GenericOptType Options #

Abbreviation for the option type.

defaultOptions :: Options #

Default values for the command line options.

parseOpts #

Arguments

:: [String]	The command line arguments
-> String	The program name
-> [OptType]	The supported command line options
-> [ArgCompletion]	The supported command line arguments
-> IO (Options, [String])	The resulting options and leftover arguments

Wrapper over parseOpts with our custom options.

parseOptsInner :: StandardOptions a => a -> [String] -> String -> [GenericOptType a] -> [ArgCompletion] -> Either (ExitCode, String) (a, [String]) #

Inner parse options. The arguments are similar to parseOpts, but it returns either a Left composed of exit code and message, or a Right for the success case.

parseYesNo #

Arguments