1 {-| Cluster space sizing
7 Copyright (C) 2009 Google Inc.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26 module Main (main) where
30 import Data.Maybe (isJust, fromJust, isNothing)
34 import System.Console.GetOpt
35 import qualified System
37 import Text.Printf (printf)
39 import qualified Ganeti.HTools.Container as Container
40 import qualified Ganeti.HTools.Cluster as Cluster
41 import qualified Ganeti.HTools.Node as Node
42 import qualified Ganeti.HTools.Instance as Instance
43 import qualified Ganeti.HTools.CLI as CLI
45 import Ganeti.HTools.Utils
47 -- | Command line options structure.
48 data Options = Options
49 { optShowNodes :: Bool -- ^ Whether to show node status
50 , optNodef :: FilePath -- ^ Path to the nodes file
51 , optNodeSet :: Bool -- ^ The nodes have been set by options
52 , optInstf :: FilePath -- ^ Path to the instances file
53 , optInstSet :: Bool -- ^ The insts have been set by options
54 , optMaster :: String -- ^ Collect data from RAPI
55 , optVerbose :: Int -- ^ Verbosity level
56 , optOffline :: [String] -- ^ Names of offline nodes
57 , optIMem :: Int -- ^ Instance memory
58 , optIDsk :: Int -- ^ Instance disk
59 , optIVCPUs :: Int -- ^ Instance VCPUs
60 , optINodes :: Int -- ^ Nodes required for an instance
61 , optMcpu :: Double -- ^ Max cpu ratio for nodes
62 , optMdsk :: Double -- ^ Max disk usage ratio for nodes
63 , optShowVer :: Bool -- ^ Just show the program version
64 , optShowHelp :: Bool -- ^ Just show the help
67 instance CLI.CLIOptions Options where
68 showVersion = optShowVer
69 showHelp = optShowHelp
71 instance CLI.EToolOptions Options where
76 masterName = optMaster
77 silent a = (optVerbose a) == 0
79 -- | Default values for the command line options.
80 defaultOptions :: Options
81 defaultOptions = Options
82 { optShowNodes = False
85 , optInstf = "instances"
100 -- | Options list and functions
101 options :: [OptDescr (Options -> Options)]
103 [ Option ['p'] ["print-nodes"]
104 (NoArg (\ opts -> opts { optShowNodes = True }))
105 "print the final node list"
106 , Option ['n'] ["nodes"]
107 (ReqArg (\ f opts -> opts { optNodef = f, optNodeSet = True }) "FILE")
109 , Option ['i'] ["instances"]
110 (ReqArg (\ f opts -> opts { optInstf = f, optInstSet = True }) "FILE")
111 "the instance list FILE"
112 , Option ['m'] ["master"]
113 (ReqArg (\ m opts -> opts { optMaster = m }) "ADDRESS")
114 "collect data via RAPI at the given ADDRESS"
115 , Option ['v'] ["verbose"]
116 (NoArg (\ opts -> opts { optVerbose = (optVerbose opts) + 1 }))
117 "increase the verbosity level"
118 , Option ['q'] ["quiet"]
119 (NoArg (\ opts -> opts { optVerbose = (optVerbose opts) - 1 }))
120 "decrease the verbosity level"
121 , Option ['O'] ["offline"]
122 (ReqArg (\ n opts -> opts { optOffline = n:optOffline opts }) "NODE")
123 "set node as offline"
124 , Option [] ["memory"]
125 (ReqArg (\ m opts -> opts { optIMem = read m }) "MEMORY")
126 "memory size for instances"
128 (ReqArg (\ d opts -> opts { optIDsk = read d }) "DISK")
129 "disk size for instances"
130 , Option [] ["vcpus"]
131 (ReqArg (\ p opts -> opts { optIVCPUs = read p }) "NUM")
132 "number of virtual cpus for instances"
133 , Option [] ["req-nodes"]
134 (ReqArg (\ n opts -> opts { optINodes = read n }) "NODES")
135 "number of nodes for the new instances (1=plain, 2=mirrored)"
136 , Option [] ["max-cpu"]
137 (ReqArg (\ n opts -> opts { optMcpu = read n }) "RATIO")
138 "maximum virtual-to-physical cpu ratio for nodes"
139 , Option [] ["min-disk"]
140 (ReqArg (\ n opts -> opts { optMdsk = read n }) "RATIO")
141 "minimum free disk space for nodes (between 0 and 1)"
142 , Option ['V'] ["version"]
143 (NoArg (\ opts -> opts { optShowVer = True}))
144 "show the version of the program"
145 , Option ['h'] ["help"]
146 (NoArg (\ opts -> opts { optShowHelp = True}))
150 filterFails :: Cluster.AllocSolution
151 -> Maybe [(Node.List, Instance.Instance, [Node.Node])]
153 if null sols then Nothing -- No nodes onto which to allocate at all
154 else let sols' = filter (isJust . fst3) sols
155 in if null sols' then
156 Nothing -- No valid allocation solutions
158 return $ map (\(x, y, z) -> (fromJust x, y, z)) sols'
160 processResults :: (Monad m) => [(Node.List, Instance.Instance, [Node.Node])]
161 -> m (Node.List, Instance.Instance, [Node.Node])
162 processResults sols =
163 let sols' = map (\e@(nl', _, _) -> (Cluster.compCV nl', e)) sols
164 sols'' = sortBy (compare `on` fst) sols'
165 in return $ snd $ head sols''
167 iterateDepth :: Node.List
171 -> [Instance.Instance]
172 -> (Node.List, [Instance.Instance])
173 iterateDepth nl il newinst nreq ixes =
174 let depth = length ixes
175 newname = (printf "new-%d" depth)::String
176 newidx = (length $ Container.elems il) + depth
177 newi2 = Instance.setIdx (Instance.setName newinst newname) newidx
178 sols = (Cluster.tryAlloc nl il newi2 nreq)::
179 Maybe Cluster.AllocSolution
182 if isNothing sols then orig
183 else let sols' = fromJust sols
184 sols'' = filterFails sols'
185 in if isNothing sols'' then orig
186 else let (xnl, xi, _) = fromJust $ processResults $
188 in iterateDepth xnl il newinst nreq (xi:ixes)
194 cmd_args <- System.getArgs
195 (opts, args) <- CLI.parseOpts cmd_args "hspace" options defaultOptions
197 unless (null args) $ do
198 hPutStrLn stderr "Error: this program doesn't take any arguments."
199 exitWith $ ExitFailure 1
201 let verbose = optVerbose opts
203 (fixed_nl, il, csf) <- CLI.loadExternalData opts
204 let num_instances = length $ Container.elems il
206 let offline_names = optOffline opts
207 all_nodes = Container.elems fixed_nl
208 all_names = map Node.name all_nodes
209 offline_wrong = filter (\n -> not $ elem n all_names) offline_names
210 offline_indices = map Node.idx $
211 filter (\n -> elem (Node.name n) offline_names)
213 req_nodes = optINodes opts
217 when (length offline_wrong > 0) $ do
218 printf "Error: Wrong node name(s) set as offline: %s\n"
219 (commaJoin offline_wrong)
220 exitWith $ ExitFailure 1
222 when (req_nodes /= 1 && req_nodes /= 2) $ do
223 printf "Error: Invalid required nodes (%d)\n" req_nodes
224 exitWith $ ExitFailure 1
226 let nm = Container.map (\n -> if elem (Node.idx n) offline_indices
227 then Node.setOffline n True
229 nl = Container.map (flip Node.setMdsk m_dsk . flip Node.setMcpu m_cpu)
232 when (length csf > 0 && verbose > 1) $ do
233 printf "Note: Stripping common suffix of '%s' from names\n" csf
235 let bad_nodes = fst $ Cluster.computeBadItems nl il
236 when (length bad_nodes > 0) $ do
237 putStrLn "Error: Cluster not N+1, no space to allocate."
238 exitWith $ ExitFailure 1
240 when (optShowNodes opts) $
242 putStrLn "Initial cluster status:"
243 putStrLn $ Cluster.printNodes nl
245 let ini_cv = Cluster.compCV nl
246 (orig_mem, orig_disk) = Cluster.totalResources nl
249 printf "Initial coefficients: overall %.8f, %s\n"
250 ini_cv (Cluster.printStats nl)
252 printf "Initial score: %.8f\n" ini_cv)
253 printf "Initial instances: %d\n" num_instances
254 printf "Initial free RAM: %d\n" orig_mem
255 printf "Initial free disk: %d\n" orig_disk
257 let nmlen = Container.maxNameLen nl
258 newinst = Instance.create "new" (optIMem opts) (optIDsk opts)
259 (optIVCPUs opts) "ADMIN_down" (-1) (-1)
261 let (fin_nl, ixes) = iterateDepth nl il newinst req_nodes []
263 fin_instances = num_instances + allocs
264 fin_ixes = reverse ixes
265 ix_namelen = maximum . map (length . Instance.name) $ fin_ixes
266 (final_mem, final_disk) = Cluster.totalResources fin_nl
268 printf "Final score: %.8f\n" (Cluster.compCV fin_nl)
269 printf "Final instances: %d\n" (num_instances + allocs)
270 printf "Final free RAM: %d\n" final_mem
271 printf "Final free disk: %d\n" final_disk
272 printf "Usage: %.5f\n" (((fromIntegral num_instances)::Double) /
273 (fromIntegral fin_instances))
274 printf "Allocations: %d\n" allocs
275 when (verbose > 1) $ do
276 putStr . unlines . map (\i -> printf "Inst: %*s %-*s %-*s"
277 ix_namelen (Instance.name i)
278 nmlen (Container.nameOf fin_nl $ Instance.pnode i)
279 nmlen (let sdx = Instance.snode i
280 in if sdx == Node.noSecondary then ""
281 else Container.nameOf fin_nl sdx))
284 when (optShowNodes opts) $
286 let (orig_mem, orig_disk) = Cluster.totalResources nl
287 (final_mem, final_disk) = Cluster.totalResources fin_nl
289 putStrLn "Final cluster status:"
290 putStrLn $ Cluster.printNodes fin_nl
293 printf "Original: mem=%d disk=%d\n" orig_mem orig_disk
294 printf "Final: mem=%d disk=%d\n" final_mem final_disk