, parseOpts
, shTemplate
-- * The options
- , oPrintNodes
- , oPrintInsts
- , oPrintCommands
- , oOneline
- , oNoHeaders
- , oOutputDir
- , oNodeFile
- , oInstFile
- , oNodeSim
- , oRapiMaster
- , oLuxiSocket
+ , oDataFile
+ , oDiskMoves
+ , oDynuFile
+ , oEvacMode
+ , oExTags
, oExecJobs
- , oMaxSolLength
- , oVerbose
- , oQuiet
- , oOfflineNode
- , oMinScore
- , oIMem
, oIDisk
- , oIVcpus
+ , oIMem
, oINodes
+ , oIVcpus
+ , oLuxiSocket
, oMaxCpu
+ , oMaxSolLength
, oMinDisk
- , oDiskMoves
- , oDynuFile
- , oShowVer
+ , oMinScore
+ , oNoHeaders
+ , oNodeSim
+ , oOfflineNode
+ , oOneline
+ , oOutputDir
+ , oPrintCommands
+ , oPrintInsts
+ , oPrintNodes
+ , oQuiet
+ , oRapiMaster
, oShowHelp
+ , oShowVer
+ , oTieredSpec
+ , oVerbose
) where
import Data.Maybe (fromMaybe)
import qualified Ganeti.HTools.Version as Version(version)
import Ganeti.HTools.Types
+import Ganeti.HTools.Utils
-- | The default value for the luxi socket
defaultLuxiSocket :: FilePath
-- | Command line options structure.
data Options = Options
- { optShowNodes :: Bool -- ^ Whether to show node status
- , optShowInsts :: Bool -- ^ Whether to show the instance map
- , optShowCmds :: Maybe FilePath -- ^ Whether to show the command list
- , optOneline :: Bool -- ^ Switch output to a single line
- , optOutPath :: FilePath -- ^ Path to the output directory
- , optNoHeaders :: Bool -- ^ Do not show a header line
- , optNodeFile :: FilePath -- ^ Path to the nodes file
- , optNodeSet :: Bool -- ^ The nodes have been set by options
- , optInstFile :: FilePath -- ^ Path to the instances file
- , optInstSet :: Bool -- ^ The insts have been set by options
- , optNodeSim :: Maybe String -- ^ Cluster simulation mode
- , optMaxLength :: Int -- ^ Stop after this many steps
- , optMaster :: String -- ^ Collect data from RAPI
- , optLuxi :: Maybe FilePath -- ^ Collect data from Luxi
- , optExecJobs :: Bool -- ^ Execute the commands via Luxi
- , optOffline :: [String] -- ^ Names of offline nodes
- , optIMem :: Int -- ^ Instance memory
- , optIDsk :: Int -- ^ Instance disk
- , optIVCPUs :: Int -- ^ Instance VCPUs
- , optINodes :: Int -- ^ Nodes required for an instance
- , optMinScore :: Score -- ^ The minimum score we aim for
- , optMcpu :: Double -- ^ Max cpu ratio for nodes
- , optMdsk :: Double -- ^ Max disk usage ratio for nodes
- , optDiskMoves :: Bool -- ^ Allow disk moves
- , optDynuFile :: Maybe FilePath -- ^ Optional file with dynamic use data
- , optVerbose :: Int -- ^ Verbosity level
- , optShowVer :: Bool -- ^ Just show the program version
- , optShowHelp :: Bool -- ^ Just show the help
+ { optDataFile :: Maybe FilePath -- ^ Path to the cluster data file
+ , optDiskMoves :: Bool -- ^ Allow disk moves
+ , optDynuFile :: Maybe FilePath -- ^ Optional file with dynamic use data
+ , optEvacMode :: Bool -- ^ Enable evacuation mode
+ , optExTags :: Maybe [String] -- ^ Tags to use for exclusion
+ , optExecJobs :: Bool -- ^ Execute the commands via Luxi
+ , optINodes :: Int -- ^ Nodes required for an instance
+ , optISpec :: RSpec -- ^ Requested instance specs
+ , optLuxi :: Maybe FilePath -- ^ Collect data from Luxi
+ , optMaster :: String -- ^ Collect data from RAPI
+ , optMaxLength :: Int -- ^ Stop after this many steps
+ , optMcpu :: Double -- ^ Max cpu ratio for nodes
+ , optMdsk :: Double -- ^ Max disk usage ratio for nodes
+ , optMinScore :: Score -- ^ The minimum score we aim for
+ , optNoHeaders :: Bool -- ^ Do not show a header line
+ , optNodeSim :: Maybe String -- ^ Cluster simulation mode
+ , optOffline :: [String] -- ^ Names of offline nodes
+ , optOneline :: Bool -- ^ Switch output to a single line
+ , optOutPath :: FilePath -- ^ Path to the output directory
+ , optShowCmds :: Maybe FilePath -- ^ Whether to show the command list
+ , optShowHelp :: Bool -- ^ Just show the help
+ , optShowInsts :: Bool -- ^ Whether to show the instance map
+ , optShowNodes :: Maybe [String] -- ^ Whether to show node status
+ , optShowVer :: Bool -- ^ Just show the program version
+ , optTieredSpec :: Maybe RSpec -- ^ Requested specs for tiered mode
+ , optVerbose :: Int -- ^ Verbosity level
} deriving Show
-- | Default values for the command line options.
defaultOptions :: Options
defaultOptions = Options
- { optShowNodes = False
- , optShowInsts = False
- , optShowCmds = Nothing
- , optOneline = False
- , optNoHeaders = False
- , optOutPath = "."
- , optNodeFile = "nodes"
- , optNodeSet = False
- , optInstFile = "instances"
- , optInstSet = False
- , optNodeSim = Nothing
- , optMaxLength = -1
- , optMaster = ""
- , optLuxi = Nothing
- , optExecJobs = False
- , optOffline = []
- , optIMem = 4096
- , optIDsk = 102400
- , optIVCPUs = 1
- , optINodes = 2
- , optMinScore = 1e-9
- , optMcpu = -1
- , optMdsk = -1
- , optDiskMoves = True
- , optDynuFile = Nothing
- , optVerbose = 1
- , optShowVer = False
- , optShowHelp = False
+ { optDataFile = Nothing
+ , optDiskMoves = True
+ , optDynuFile = Nothing
+ , optEvacMode = False
+ , optExTags = Nothing
+ , optExecJobs = False
+ , optINodes = 2
+ , optISpec = RSpec 1 4096 102400
+ , optLuxi = Nothing
+ , optMaster = ""
+ , optMaxLength = -1
+ , optMcpu = -1
+ , optMdsk = -1
+ , optMinScore = 1e-9
+ , optNoHeaders = False
+ , optNodeSim = Nothing
+ , optOffline = []
+ , optOneline = False
+ , optOutPath = "."
+ , optShowCmds = Nothing
+ , optShowHelp = False
+ , optShowInsts = False
+ , optShowNodes = Nothing
+ , optShowVer = False
+ , optTieredSpec = Nothing
+ , optVerbose = 1
}
-- | Abrreviation for the option type
-type OptType = OptDescr (Options -> Options)
+type OptType = OptDescr (Options -> Result Options)
-oPrintNodes :: OptType
-oPrintNodes = Option "p" ["print-nodes"]
- (NoArg (\ opts -> opts { optShowNodes = True }))
- "print the final node list"
+oDataFile :: OptType
+oDataFile = Option "t" ["text-data"]
+ (ReqArg (\ f o -> Ok o { optDataFile = Just f }) "FILE")
+ "the cluster data FILE"
-oPrintInsts :: OptType
-oPrintInsts = Option "" ["print-instances"]
- (NoArg (\ opts -> opts { optShowInsts = True }))
- "print the final instance map"
+oDiskMoves :: OptType
+oDiskMoves = Option "" ["no-disk-moves"]
+ (NoArg (\ opts -> Ok opts { optDiskMoves = False}))
+ "disallow disk moves from the list of allowed instance changes,\
+ \ thus allowing only the 'cheap' failover/migrate operations"
-oPrintCommands :: OptType
-oPrintCommands = Option "C" ["print-commands"]
- (OptArg ((\ f opts -> opts { optShowCmds = Just f }) .
- fromMaybe "-")
- "FILE")
- "print the ganeti command list for reaching the solution,\
- \ if an argument is passed then write the commands to a\
- \ file named as such"
+oDynuFile :: OptType
+oDynuFile = Option "U" ["dynu-file"]
+ (ReqArg (\ f opts -> Ok opts { optDynuFile = Just f }) "FILE")
+ "Import dynamic utilisation data from the given FILE"
-oOneline :: OptType
-oOneline = Option "o" ["oneline"]
- (NoArg (\ opts -> opts { optOneline = True }))
- "print the ganeti command list for reaching the solution"
+oEvacMode :: OptType
+oEvacMode = Option "E" ["evac-mode"]
+ (NoArg (\opts -> Ok opts { optEvacMode = True }))
+ "enable evacuation mode, where the algorithm only moves \
+ \ instances away from offline and drained nodes"
-oNoHeaders :: OptType
-oNoHeaders = Option "" ["no-headers"]
- (NoArg (\ opts -> opts { optNoHeaders = True }))
- "do not show a header line"
+oExTags :: OptType
+oExTags = Option "" ["exclusion-tags"]
+ (ReqArg (\ f opts -> Ok opts { optExTags = Just $ sepSplit ',' f })
+ "TAG,...") "Enable instance exclusion based on given tag prefix"
-oOutputDir :: OptType
-oOutputDir = Option "d" ["output-dir"]
- (ReqArg (\ d opts -> opts { optOutPath = d }) "PATH")
- "directory in which to write output files"
+oExecJobs :: OptType
+oExecJobs = Option "X" ["exec"]
+ (NoArg (\ opts -> Ok opts { optExecJobs = True}))
+ "execute the suggested moves via Luxi (only available when using\
+ \ it for data gathering)"
-oNodeFile :: OptType
-oNodeFile = Option "n" ["nodes"]
- (ReqArg (\ f o -> o { optNodeFile = f, optNodeSet = True }) "FILE")
- "the node list FILE"
+oIDisk :: OptType
+oIDisk = Option "" ["disk"]
+ (ReqArg (\ d opts ->
+ let ospec = optISpec opts
+ nspec = ospec { rspecDsk = read d }
+ in Ok opts { optISpec = nspec }) "DISK")
+ "disk size for instances"
-oInstFile :: OptType
-oInstFile = Option "i" ["instances"]
- (ReqArg (\ f o -> o { optInstFile = f, optInstSet = True }) "FILE")
- "the instance list FILE"
+oIMem :: OptType
+oIMem = Option "" ["memory"]
+ (ReqArg (\ m opts ->
+ let ospec = optISpec opts
+ nspec = ospec { rspecMem = read m }
+ in Ok opts { optISpec = nspec }) "MEMORY")
+ "memory size for instances"
-oNodeSim :: OptType
-oNodeSim = Option "" ["simulate"]
- (ReqArg (\ f o -> o { optNodeSim = Just f }) "SPEC")
- "simulate an empty cluster, given as 'num_nodes,disk,memory,cpus'"
+oINodes :: OptType
+oINodes = Option "" ["req-nodes"]
+ (ReqArg (\ n opts -> Ok opts { optINodes = read n }) "NODES")
+ "number of nodes for the new instances (1=plain, 2=mirrored)"
-oRapiMaster :: OptType
-oRapiMaster = Option "m" ["master"]
- (ReqArg (\ m opts -> opts { optMaster = m }) "ADDRESS")
- "collect data via RAPI at the given ADDRESS"
+oIVcpus :: OptType
+oIVcpus = Option "" ["vcpus"]
+ (ReqArg (\ p opts ->
+ let ospec = optISpec opts
+ nspec = ospec { rspecCpu = read p }
+ in Ok opts { optISpec = nspec }) "NUM")
+ "number of virtual cpus for instances"
oLuxiSocket :: OptType
oLuxiSocket = Option "L" ["luxi"]
- (OptArg ((\ f opts -> opts { optLuxi = Just f }) .
+ (OptArg ((\ f opts -> Ok opts { optLuxi = Just f }) .
fromMaybe defaultLuxiSocket) "SOCKET")
"collect data via Luxi, optionally using the given SOCKET path"
-oExecJobs :: OptType
-oExecJobs = Option "X" ["exec"]
- (NoArg (\ opts -> opts { optExecJobs = True}))
- "execute the suggested moves via Luxi (only available when using\
- \ it for data gathering"
-
-oVerbose :: OptType
-oVerbose = Option "v" ["verbose"]
- (NoArg (\ opts -> opts { optVerbose = optVerbose opts + 1 }))
- "increase the verbosity level"
-
-oQuiet :: OptType
-oQuiet = Option "q" ["quiet"]
- (NoArg (\ opts -> opts { optVerbose = optVerbose opts - 1 }))
- "decrease the verbosity level"
-
-oOfflineNode :: OptType
-oOfflineNode = Option "O" ["offline"]
- (ReqArg (\ n o -> o { optOffline = n:optOffline o }) "NODE")
- "set node as offline"
+oMaxCpu :: OptType
+oMaxCpu = Option "" ["max-cpu"]
+ (ReqArg (\ n opts -> Ok opts { optMcpu = read n }) "RATIO")
+ "maximum virtual-to-physical cpu ratio for nodes"
oMaxSolLength :: OptType
oMaxSolLength = Option "l" ["max-length"]
- (ReqArg (\ i opts -> opts { optMaxLength = read i::Int }) "N")
+ (ReqArg (\ i opts -> Ok opts { optMaxLength = read i }) "N")
"cap the solution at this many moves (useful for very\
\ unbalanced clusters)"
+oMinDisk :: OptType
+oMinDisk = Option "" ["min-disk"]
+ (ReqArg (\ n opts -> Ok opts { optMdsk = read n }) "RATIO")
+ "minimum free disk space for nodes (between 0 and 1)"
+
oMinScore :: OptType
oMinScore = Option "e" ["min-score"]
- (ReqArg (\ e opts -> opts { optMinScore = read e }) "EPSILON")
+ (ReqArg (\ e opts -> Ok opts { optMinScore = read e }) "EPSILON")
" mininum score to aim for"
-oIMem :: OptType
-oIMem = Option "" ["memory"]
- (ReqArg (\ m opts -> opts { optIMem = read m }) "MEMORY")
- "memory size for instances"
+oNoHeaders :: OptType
+oNoHeaders = Option "" ["no-headers"]
+ (NoArg (\ opts -> Ok opts { optNoHeaders = True }))
+ "do not show a header line"
-oIDisk :: OptType
-oIDisk = Option "" ["disk"]
- (ReqArg (\ d opts -> opts { optIDsk = read d }) "DISK")
- "disk size for instances"
+oNodeSim :: OptType
+oNodeSim = Option "" ["simulate"]
+ (ReqArg (\ f o -> Ok o { optNodeSim = Just f }) "SPEC")
+ "simulate an empty cluster, given as 'num_nodes,disk,ram,cpu'"
-oIVcpus :: OptType
-oIVcpus = Option "" ["vcpus"]
- (ReqArg (\ p opts -> opts { optIVCPUs = read p }) "NUM")
- "number of virtual cpus for instances"
+oOfflineNode :: OptType
+oOfflineNode = Option "O" ["offline"]
+ (ReqArg (\ n o -> Ok o { optOffline = n:optOffline o }) "NODE")
+ "set node as offline"
-oINodes :: OptType
-oINodes = Option "" ["req-nodes"]
- (ReqArg (\ n opts -> opts { optINodes = read n }) "NODES")
- "number of nodes for the new instances (1=plain, 2=mirrored)"
+oOneline :: OptType
+oOneline = Option "o" ["oneline"]
+ (NoArg (\ opts -> Ok opts { optOneline = True }))
+ "print the ganeti command list for reaching the solution"
-oMaxCpu :: OptType
-oMaxCpu = Option "" ["max-cpu"]
- (ReqArg (\ n opts -> opts { optMcpu = read n }) "RATIO")
- "maximum virtual-to-physical cpu ratio for nodes"
+oOutputDir :: OptType
+oOutputDir = Option "d" ["output-dir"]
+ (ReqArg (\ d opts -> Ok opts { optOutPath = d }) "PATH")
+ "directory in which to write output files"
-oMinDisk :: OptType
-oMinDisk = Option "" ["min-disk"]
- (ReqArg (\ n opts -> opts { optMdsk = read n }) "RATIO")
- "minimum free disk space for nodes (between 0 and 1)"
+oPrintCommands :: OptType
+oPrintCommands = Option "C" ["print-commands"]
+ (OptArg ((\ f opts -> Ok opts { optShowCmds = Just f }) .
+ fromMaybe "-")
+ "FILE")
+ "print the ganeti command list for reaching the solution,\
+ \ if an argument is passed then write the commands to a\
+ \ file named as such"
-oDiskMoves :: OptType
-oDiskMoves = Option "" ["no-disk-moves"]
- (NoArg (\ opts -> opts { optDiskMoves = False}))
- "disallow disk moves from the list of allowed instance changes,\
- \ thus allowing only the 'cheap' failover/migrate operations"
+oPrintInsts :: OptType
+oPrintInsts = Option "" ["print-instances"]
+ (NoArg (\ opts -> Ok opts { optShowInsts = True }))
+ "print the final instance map"
-oDynuFile :: OptType
-oDynuFile = Option "U" ["dynu-file"]
- (ReqArg (\ f opts -> opts { optDynuFile = Just f }) "FILE")
- "Import dynamic utilisation data from the given FILE"
+oPrintNodes :: OptType
+oPrintNodes = Option "p" ["print-nodes"]
+ (OptArg ((\ f opts ->
+ let splitted = sepSplit ',' f
+ in Ok opts { optShowNodes = Just splitted }) .
+ fromMaybe []) "FIELDS")
+ "print the final node list"
-oShowVer :: OptType
-oShowVer = Option "V" ["version"]
- (NoArg (\ opts -> opts { optShowVer = True}))
- "show the version of the program"
+oQuiet :: OptType
+oQuiet = Option "q" ["quiet"]
+ (NoArg (\ opts -> Ok opts { optVerbose = optVerbose opts - 1 }))
+ "decrease the verbosity level"
+
+oRapiMaster :: OptType
+oRapiMaster = Option "m" ["master"]
+ (ReqArg (\ m opts -> Ok opts { optMaster = m }) "ADDRESS")
+ "collect data via RAPI at the given ADDRESS"
oShowHelp :: OptType
oShowHelp = Option "h" ["help"]
- (NoArg (\ opts -> opts { optShowHelp = True}))
+ (NoArg (\ opts -> Ok opts { optShowHelp = True}))
"show help"
+oShowVer :: OptType
+oShowVer = Option "V" ["version"]
+ (NoArg (\ opts -> Ok opts { optShowVer = True}))
+ "show the version of the program"
+
+oTieredSpec :: OptType
+oTieredSpec = Option "" ["tiered-alloc"]
+ (ReqArg (\ inp opts -> do
+ let sp = sepSplit ',' inp
+ prs <- mapM (tryRead "tiered specs") sp
+ tspec <-
+ case prs of
+ [dsk, ram, cpu] -> return $ RSpec cpu ram dsk
+ _ -> Bad $ "Invalid specification: " ++ inp
+ return $ opts { optTieredSpec = Just tspec } )
+ "TSPEC")
+ "enable tiered specs allocation, given as 'disk,ram,cpu'"
+
+oVerbose :: OptType
+oVerbose = Option "v" ["verbose"]
+ (NoArg (\ opts -> Ok opts { optVerbose = optVerbose opts + 1 }))
+ "increase the verbosity level"
+
-- | Usage info
usageHelp :: String -> [OptType] -> String
usageHelp progname =
case getOpt Permute options argv of
(o, n, []) ->
do
- let resu@(po, _) = (foldl (flip id) defaultOptions o, n)
+ let (pr, args) = (foldM (flip id) defaultOptions o, n)
+ po <- (case pr of
+ Bad msg -> do
+ hPutStrLn stderr "Error while parsing command\
+ \line arguments:"
+ hPutStrLn stderr msg
+ exitWith $ ExitFailure 1
+ Ok val -> return val)
when (optShowHelp po) $ do
putStr $ usageHelp progname options
exitWith ExitSuccess
compilerName (Data.Version.showVersion compilerVersion)
os arch
exitWith ExitSuccess
- return resu
+ return (po, args)
(_, _, errs) -> do
hPutStrLn stderr $ "Command line error: " ++ concat errs
hPutStrLn stderr $ usageHelp progname options
projects / ganeti-local / blobdiff