module Ganeti.HTools.CLI
( Options(..)
, OptType
, parseOpts
, shTemplate
, defaultLuxiSocket
, oDataFile
, oDiskMoves
, oDynuFile
, oEvacMode
, oExInst
, oExTags
, oExecJobs
, oIDisk
, oIMem
, oINodes
, oIVcpus
, oLuxiSocket
, oMaxCpu
, oMaxSolLength
, oMinDisk
, oMinScore
, oNoHeaders
, oNodeSim
, oOfflineNode
, oOneline
, oOutputDir
, oPrintCommands
, oPrintInsts
, oPrintNodes
, oQuiet
, oRapiMaster
, oShowHelp
, oShowVer
, oTieredSpec
, oVerbose
) where
import Data.Maybe (fromMaybe)
import qualified Data.Version
import Monad
import System.Console.GetOpt
import System.IO
import System.Info
import System
import Text.Printf (printf)
import qualified Ganeti.HTools.Version as Version(version)
import Ganeti.HTools.Types
import Ganeti.HTools.Utils
defaultLuxiSocket :: FilePath
defaultLuxiSocket = "/var/run/ganeti/socket/ganeti-master"
data Options = Options
{ optDataFile :: Maybe FilePath
, optDiskMoves :: Bool
, optDynuFile :: Maybe FilePath
, optEvacMode :: Bool
, optExInst :: [String]
, optExTags :: Maybe [String]
, optExecJobs :: Bool
, optINodes :: Int
, optISpec :: RSpec
, optLuxi :: Maybe FilePath
, optMaster :: String
, optMaxLength :: Int
, optMcpu :: Double
, optMdsk :: Double
, optMinScore :: Score
, optNoHeaders :: Bool
, optNodeSim :: Maybe String
, optOffline :: [String]
, optOneline :: Bool
, optOutPath :: FilePath
, optShowCmds :: Maybe FilePath
, optShowHelp :: Bool
, optShowInsts :: Bool
, optShowNodes :: Maybe [String]
, optShowVer :: Bool
, optTieredSpec :: Maybe RSpec
, optVerbose :: Int
} deriving Show
defaultOptions :: Options
defaultOptions = Options
{ optDataFile = Nothing
, optDiskMoves = True
, optDynuFile = Nothing
, optEvacMode = False
, optExInst = []
, 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
}
type OptType = OptDescr (Options -> Result Options)
oDataFile :: OptType
oDataFile = Option "t" ["text-data"]
(ReqArg (\ f o -> Ok o { optDataFile = Just f }) "FILE")
"the cluster data FILE"
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"
oDynuFile :: OptType
oDynuFile = Option "U" ["dynu-file"]
(ReqArg (\ f opts -> Ok opts { optDynuFile = Just f }) "FILE")
"Import dynamic utilisation data from the given FILE"
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"
oExInst :: OptType
oExInst = Option "" ["exclude-instances"]
(ReqArg (\ f opts -> Ok opts { optExInst = sepSplit ',' f }) "INSTS")
"exclude given instances from any moves"
oExTags :: OptType
oExTags = Option "" ["exclusion-tags"]
(ReqArg (\ f opts -> Ok opts { optExTags = Just $ sepSplit ',' f })
"TAG,...") "Enable instance exclusion based on given tag prefix"
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)"
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"
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"
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)"
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 -> Ok opts { optLuxi = Just f }) .
fromMaybe defaultLuxiSocket) "SOCKET")
"collect data via Luxi, optionally using the given SOCKET path"
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 -> 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 -> Ok opts { optMinScore = read e }) "EPSILON")
" mininum score to aim for"
oNoHeaders :: OptType
oNoHeaders = Option "" ["no-headers"]
(NoArg (\ opts -> Ok opts { optNoHeaders = True }))
"do not show a header line"
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'"
oOfflineNode :: OptType
oOfflineNode = Option "O" ["offline"]
(ReqArg (\ n o -> Ok o { optOffline = n:optOffline o }) "NODE")
"set node as offline"
oOneline :: OptType
oOneline = Option "o" ["oneline"]
(NoArg (\ opts -> Ok opts { optOneline = True }))
"print the ganeti command list for reaching the solution"
oOutputDir :: OptType
oOutputDir = Option "d" ["output-dir"]
(ReqArg (\ d opts -> Ok opts { optOutPath = d }) "PATH")
"directory in which to write output files"
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"
oPrintInsts :: OptType
oPrintInsts = Option "" ["print-instances"]
(NoArg (\ opts -> Ok opts { optShowInsts = True }))
"print the final instance map"
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"
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 -> 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"
usageHelp :: String -> [OptType] -> String
usageHelp progname =
usageInfo (printf "%s %s\nUsage: %s [OPTION...]"
progname Version.version progname)
parseOpts :: [String]
-> String
-> [OptType]
-> IO (Options, [String])
parseOpts argv progname options =
case getOpt Permute options argv of
(o, n, []) ->
do
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
when (optShowVer po) $ do
printf "%s %s\ncompiled with %s %s\nrunning on %s %s\n"
progname Version.version
compilerName (Data.Version.showVersion compilerVersion)
os arch :: IO ()
exitWith ExitSuccess
return (po, args)
(_, _, errs) -> do
hPutStrLn stderr $ "Command line error: " ++ concat errs
hPutStrLn stderr $ usageHelp progname options
exitWith $ ExitFailure 2
shTemplate :: String
shTemplate =
printf "#!/bin/sh\n\n\
\# Auto-generated script for executing cluster rebalancing\n\n\
\# To stop, touch the file /tmp/stop-htools\n\n\
\set -e\n\n\
\check() {\n\
\ if [ -f /tmp/stop-htools ]; then\n\
\ echo 'Stop requested, exiting'\n\
\ exit 0\n\
\ fi\n\
\}\n\n"