root / htools / Ganeti / HTools / Program / Hspace.hs @ 981bb5cf
History | View | Annotate | Download (17 kB)
1 |
{-| Cluster space sizing |
---|---|
2 |
|
3 |
-} |
4 |
|
5 |
{- |
6 |
|
7 |
Copyright (C) 2009, 2010, 2011, 2012 Google Inc. |
8 |
|
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. |
13 |
|
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. |
18 |
|
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 |
22 |
02110-1301, USA. |
23 |
|
24 |
-} |
25 |
|
26 |
module Ganeti.HTools.Program.Hspace (main, options) where |
27 |
|
28 |
import Control.Monad |
29 |
import Data.Char (toUpper, isAlphaNum, toLower) |
30 |
import Data.Function (on) |
31 |
import Data.List |
32 |
import Data.Maybe (fromMaybe) |
33 |
import Data.Ord (comparing) |
34 |
import System.Exit |
35 |
import System.IO |
36 |
|
37 |
import Text.Printf (printf, hPrintf) |
38 |
|
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 |
|
44 |
import Ganeti.HTools.Utils |
45 |
import Ganeti.HTools.Types |
46 |
import Ganeti.HTools.CLI |
47 |
import Ganeti.HTools.ExtLoader |
48 |
import Ganeti.HTools.Loader |
49 |
|
50 |
-- | Options list and functions. |
51 |
options :: [OptType] |
52 |
options = |
53 |
[ oPrintNodes |
54 |
, oDataFile |
55 |
, oDiskTemplate |
56 |
, oNodeSim |
57 |
, oRapiMaster |
58 |
, oLuxiSocket |
59 |
, oIAllocSrc |
60 |
, oVerbose |
61 |
, oQuiet |
62 |
, oOfflineNode |
63 |
, oMachineReadable |
64 |
, oMaxCpu |
65 |
, oMaxSolLength |
66 |
, oMinDisk |
67 |
, oStdSpec |
68 |
, oTieredSpec |
69 |
, oSaveCluster |
70 |
, oShowVer |
71 |
, oShowHelp |
72 |
] |
73 |
|
74 |
-- | The allocation phase we're in (initial, after tiered allocs, or |
75 |
-- after regular allocation). |
76 |
data Phase = PInitial |
77 |
| PFinal |
78 |
| PTiered |
79 |
|
80 |
-- | The kind of instance spec we print. |
81 |
data SpecType = SpecNormal |
82 |
| SpecTiered |
83 |
|
84 |
-- | What we prefix a spec with. |
85 |
specPrefix :: SpecType -> String |
86 |
specPrefix SpecNormal = "SPEC" |
87 |
specPrefix SpecTiered = "TSPEC_INI" |
88 |
|
89 |
-- | The description of a spec. |
90 |
specDescription :: SpecType -> String |
91 |
specDescription SpecNormal = "Standard (fixed-size)" |
92 |
specDescription SpecTiered = "Tiered (initial size)" |
93 |
|
94 |
-- | Efficiency generic function. |
95 |
effFn :: (Cluster.CStats -> Integer) |
96 |
-> (Cluster.CStats -> Double) |
97 |
-> Cluster.CStats -> Double |
98 |
effFn fi ft cs = fromIntegral (fi cs) / ft cs |
99 |
|
100 |
-- | Memory efficiency. |
101 |
memEff :: Cluster.CStats -> Double |
102 |
memEff = effFn Cluster.csImem Cluster.csTmem |
103 |
|
104 |
-- | Disk efficiency. |
105 |
dskEff :: Cluster.CStats -> Double |
106 |
dskEff = effFn Cluster.csIdsk Cluster.csTdsk |
107 |
|
108 |
-- | Cpu efficiency. |
109 |
cpuEff :: Cluster.CStats -> Double |
110 |
cpuEff = effFn Cluster.csIcpu (fromIntegral . Cluster.csVcpu) |
111 |
|
112 |
-- | Holds data for converting a 'Cluster.CStats' structure into |
113 |
-- detailed statictics. |
114 |
statsData :: [(String, Cluster.CStats -> String)] |
115 |
statsData = [ ("SCORE", printf "%.8f" . Cluster.csScore) |
116 |
, ("INST_CNT", printf "%d" . Cluster.csNinst) |
117 |
, ("MEM_FREE", printf "%d" . Cluster.csFmem) |
118 |
, ("MEM_AVAIL", printf "%d" . Cluster.csAmem) |
119 |
, ("MEM_RESVD", |
120 |
\cs -> printf "%d" (Cluster.csFmem cs - Cluster.csAmem cs)) |
121 |
, ("MEM_INST", printf "%d" . Cluster.csImem) |
122 |
, ("MEM_OVERHEAD", |
123 |
\cs -> printf "%d" (Cluster.csXmem cs + Cluster.csNmem cs)) |
124 |
, ("MEM_EFF", printf "%.8f" . memEff) |
125 |
, ("DSK_FREE", printf "%d" . Cluster.csFdsk) |
126 |
, ("DSK_AVAIL", printf "%d". Cluster.csAdsk) |
127 |
, ("DSK_RESVD", |
128 |
\cs -> printf "%d" (Cluster.csFdsk cs - Cluster.csAdsk cs)) |
129 |
, ("DSK_INST", printf "%d" . Cluster.csIdsk) |
130 |
, ("DSK_EFF", printf "%.8f" . dskEff) |
131 |
, ("CPU_INST", printf "%d" . Cluster.csIcpu) |
132 |
, ("CPU_EFF", printf "%.8f" . cpuEff) |
133 |
, ("MNODE_MEM_AVAIL", printf "%d" . Cluster.csMmem) |
134 |
, ("MNODE_DSK_AVAIL", printf "%d" . Cluster.csMdsk) |
135 |
] |
136 |
|
137 |
-- | List holding 'RSpec' formatting information. |
138 |
specData :: [(String, RSpec -> String)] |
139 |
specData = [ ("MEM", printf "%d" . rspecMem) |
140 |
, ("DSK", printf "%d" . rspecDsk) |
141 |
, ("CPU", printf "%d" . rspecCpu) |
142 |
] |
143 |
|
144 |
-- | List holding 'Cluster.CStats' formatting information. |
145 |
clusterData :: [(String, Cluster.CStats -> String)] |
146 |
clusterData = [ ("MEM", printf "%.0f" . Cluster.csTmem) |
147 |
, ("DSK", printf "%.0f" . Cluster.csTdsk) |
148 |
, ("CPU", printf "%.0f" . Cluster.csTcpu) |
149 |
, ("VCPU", printf "%d" . Cluster.csVcpu) |
150 |
] |
151 |
|
152 |
-- | Function to print stats for a given phase. |
153 |
printStats :: Phase -> Cluster.CStats -> [(String, String)] |
154 |
printStats ph cs = |
155 |
map (\(s, fn) -> (printf "%s_%s" kind s, fn cs)) statsData |
156 |
where kind = case ph of |
157 |
PInitial -> "INI" |
158 |
PFinal -> "FIN" |
159 |
PTiered -> "TRL" |
160 |
|
161 |
-- | Print failure reason and scores |
162 |
printFRScores :: Node.List -> Node.List -> [(FailMode, Int)] -> IO () |
163 |
printFRScores ini_nl fin_nl sreason = do |
164 |
printf " - most likely failure reason: %s\n" $ failureReason sreason::IO () |
165 |
printClusterScores ini_nl fin_nl |
166 |
printClusterEff (Cluster.totalResources fin_nl) |
167 |
|
168 |
-- | Print final stats and related metrics. |
169 |
printResults :: Bool -> Node.List -> Node.List -> Int -> Int |
170 |
-> [(FailMode, Int)] -> IO () |
171 |
printResults True _ fin_nl num_instances allocs sreason = do |
172 |
let fin_stats = Cluster.totalResources fin_nl |
173 |
fin_instances = num_instances + allocs |
174 |
|
175 |
when (num_instances + allocs /= Cluster.csNinst fin_stats) $ |
176 |
do |
177 |
hPrintf stderr "ERROR: internal inconsistency, allocated (%d)\ |
178 |
\ != counted (%d)\n" (num_instances + allocs) |
179 |
(Cluster.csNinst fin_stats) :: IO () |
180 |
exitWith $ ExitFailure 1 |
181 |
|
182 |
printKeys $ printStats PFinal fin_stats |
183 |
printKeys [ ("ALLOC_USAGE", printf "%.8f" |
184 |
((fromIntegral num_instances::Double) / |
185 |
fromIntegral fin_instances)) |
186 |
, ("ALLOC_INSTANCES", printf "%d" allocs) |
187 |
, ("ALLOC_FAIL_REASON", map toUpper . show . fst $ head sreason) |
188 |
] |
189 |
printKeys $ map (\(x, y) -> (printf "ALLOC_%s_CNT" (show x), |
190 |
printf "%d" y)) sreason |
191 |
|
192 |
printResults False ini_nl fin_nl _ allocs sreason = do |
193 |
putStrLn "Normal (fixed-size) allocation results:" |
194 |
printf " - %3d instances allocated\n" allocs :: IO () |
195 |
printFRScores ini_nl fin_nl sreason |
196 |
|
197 |
-- | Prints the final @OK@ marker in machine readable output. |
198 |
printFinal :: Bool -> IO () |
199 |
printFinal True = |
200 |
-- this should be the final entry |
201 |
printKeys [("OK", "1")] |
202 |
|
203 |
printFinal False = return () |
204 |
|
205 |
-- | Compute the tiered spec counts from a list of allocated |
206 |
-- instances. |
207 |
tieredSpecMap :: [Instance.Instance] |
208 |
-> [(RSpec, Int)] |
209 |
tieredSpecMap trl_ixes = |
210 |
let fin_trl_ixes = reverse trl_ixes |
211 |
ix_byspec = groupBy ((==) `on` Instance.specOf) fin_trl_ixes |
212 |
spec_map = map (\ixs -> (Instance.specOf $ head ixs, length ixs)) |
213 |
ix_byspec |
214 |
in spec_map |
215 |
|
216 |
-- | Formats a spec map to strings. |
217 |
formatSpecMap :: [(RSpec, Int)] -> [String] |
218 |
formatSpecMap = |
219 |
map (\(spec, cnt) -> printf "%d,%d,%d=%d" (rspecMem spec) |
220 |
(rspecDsk spec) (rspecCpu spec) cnt) |
221 |
|
222 |
-- | Formats \"key-metrics\" values. |
223 |
formatRSpec :: String -> AllocInfo -> [(String, String)] |
224 |
formatRSpec s r = |
225 |
[ ("KM_" ++ s ++ "_CPU", show $ allocInfoVCpus r) |
226 |
, ("KM_" ++ s ++ "_NPU", show $ allocInfoNCpus r) |
227 |
, ("KM_" ++ s ++ "_MEM", show $ allocInfoMem r) |
228 |
, ("KM_" ++ s ++ "_DSK", show $ allocInfoDisk r) |
229 |
] |
230 |
|
231 |
-- | Shows allocations stats. |
232 |
printAllocationStats :: Node.List -> Node.List -> IO () |
233 |
printAllocationStats ini_nl fin_nl = do |
234 |
let ini_stats = Cluster.totalResources ini_nl |
235 |
fin_stats = Cluster.totalResources fin_nl |
236 |
(rini, ralo, runa) = Cluster.computeAllocationDelta ini_stats fin_stats |
237 |
printKeys $ formatRSpec "USED" rini |
238 |
printKeys $ formatRSpec "POOL" ralo |
239 |
printKeys $ formatRSpec "UNAV" runa |
240 |
|
241 |
-- | Ensure a value is quoted if needed. |
242 |
ensureQuoted :: String -> String |
243 |
ensureQuoted v = if not (all (\c -> isAlphaNum c || c == '.') v) |
244 |
then '\'':v ++ "'" |
245 |
else v |
246 |
|
247 |
-- | Format a list of key\/values as a shell fragment. |
248 |
printKeys :: [(String, String)] -> IO () |
249 |
printKeys = mapM_ (\(k, v) -> |
250 |
printf "HTS_%s=%s\n" (map toUpper k) (ensureQuoted v)) |
251 |
|
252 |
-- | Converts instance data to a list of strings. |
253 |
printInstance :: Node.List -> Instance.Instance -> [String] |
254 |
printInstance nl i = [ Instance.name i |
255 |
, Container.nameOf nl $ Instance.pNode i |
256 |
, let sdx = Instance.sNode i |
257 |
in if sdx == Node.noSecondary then "" |
258 |
else Container.nameOf nl sdx |
259 |
, show (Instance.mem i) |
260 |
, show (Instance.dsk i) |
261 |
, show (Instance.vcpus i) |
262 |
] |
263 |
|
264 |
-- | Optionally print the allocation map. |
265 |
printAllocationMap :: Int -> String |
266 |
-> Node.List -> [Instance.Instance] -> IO () |
267 |
printAllocationMap verbose msg nl ixes = |
268 |
when (verbose > 1) $ do |
269 |
hPutStrLn stderr (msg ++ " map") |
270 |
hPutStr stderr . unlines . map ((:) ' ' . unwords) $ |
271 |
formatTable (map (printInstance nl) (reverse ixes)) |
272 |
-- This is the numberic-or-not field |
273 |
-- specification; the first three fields are |
274 |
-- strings, whereas the rest are numeric |
275 |
[False, False, False, True, True, True] |
276 |
|
277 |
-- | Formats nicely a list of resources. |
278 |
formatResources :: a -> [(String, a->String)] -> String |
279 |
formatResources res = |
280 |
intercalate ", " . map (\(a, fn) -> a ++ " " ++ fn res) |
281 |
|
282 |
-- | Print the cluster resources. |
283 |
printCluster :: Bool -> Cluster.CStats -> Int -> IO () |
284 |
printCluster True ini_stats node_count = do |
285 |
printKeys $ map (\(a, fn) -> ("CLUSTER_" ++ a, fn ini_stats)) clusterData |
286 |
printKeys [("CLUSTER_NODES", printf "%d" node_count)] |
287 |
printKeys $ printStats PInitial ini_stats |
288 |
|
289 |
printCluster False ini_stats node_count = do |
290 |
printf "The cluster has %d nodes and the following resources:\n %s.\n" |
291 |
node_count (formatResources ini_stats clusterData)::IO () |
292 |
printf "There are %s initial instances on the cluster.\n" |
293 |
(if inst_count > 0 then show inst_count else "no" ) |
294 |
where inst_count = Cluster.csNinst ini_stats |
295 |
|
296 |
-- | Prints the normal instance spec. |
297 |
printISpec :: Bool -> RSpec -> SpecType -> DiskTemplate -> IO () |
298 |
printISpec True ispec spec disk_template = do |
299 |
printKeys $ map (\(a, fn) -> (prefix ++ "_" ++ a, fn ispec)) specData |
300 |
printKeys [ (prefix ++ "_RQN", printf "%d" req_nodes) ] |
301 |
printKeys [ (prefix ++ "_DISK_TEMPLATE", |
302 |
diskTemplateToRaw disk_template) ] |
303 |
where req_nodes = Instance.requiredNodes disk_template |
304 |
prefix = specPrefix spec |
305 |
|
306 |
printISpec False ispec spec disk_template = |
307 |
printf "%s instance spec is:\n %s, using disk\ |
308 |
\ template '%s'.\n" |
309 |
(specDescription spec) |
310 |
(formatResources ispec specData) (diskTemplateToRaw disk_template) |
311 |
|
312 |
-- | Prints the tiered results. |
313 |
printTiered :: Bool -> [(RSpec, Int)] |
314 |
-> Node.List -> Node.List -> [(FailMode, Int)] -> IO () |
315 |
printTiered True spec_map nl trl_nl _ = do |
316 |
printKeys $ printStats PTiered (Cluster.totalResources trl_nl) |
317 |
printKeys [("TSPEC", unwords (formatSpecMap spec_map))] |
318 |
printAllocationStats nl trl_nl |
319 |
|
320 |
printTiered False spec_map ini_nl fin_nl sreason = do |
321 |
_ <- printf "Tiered allocation results:\n" |
322 |
if null spec_map |
323 |
then putStrLn " - no instances allocated" |
324 |
else mapM_ (\(ispec, cnt) -> |
325 |
printf " - %3d instances of spec %s\n" cnt |
326 |
(formatResources ispec specData)) spec_map |
327 |
printFRScores ini_nl fin_nl sreason |
328 |
|
329 |
-- | Displays the initial/final cluster scores. |
330 |
printClusterScores :: Node.List -> Node.List -> IO () |
331 |
printClusterScores ini_nl fin_nl = do |
332 |
printf " - initial cluster score: %.8f\n" $ Cluster.compCV ini_nl::IO () |
333 |
printf " - final cluster score: %.8f\n" $ Cluster.compCV fin_nl |
334 |
|
335 |
-- | Displays the cluster efficiency. |
336 |
printClusterEff :: Cluster.CStats -> IO () |
337 |
printClusterEff cs = |
338 |
mapM_ (\(s, fn) -> |
339 |
printf " - %s usage efficiency: %5.2f%%\n" s (fn cs * 100)) |
340 |
[("memory", memEff), |
341 |
(" disk", dskEff), |
342 |
(" vcpu", cpuEff)] |
343 |
|
344 |
-- | Computes the most likely failure reason. |
345 |
failureReason :: [(FailMode, Int)] -> String |
346 |
failureReason = show . fst . head |
347 |
|
348 |
-- | Sorts the failure reasons. |
349 |
sortReasons :: [(FailMode, Int)] -> [(FailMode, Int)] |
350 |
sortReasons = reverse . sortBy (comparing snd) |
351 |
|
352 |
-- | Aborts the program if we get a bad value. |
353 |
exitIfBad :: Result a -> IO a |
354 |
exitIfBad (Bad s) = |
355 |
hPrintf stderr "Failure: %s\n" s >> exitWith (ExitFailure 1) |
356 |
exitIfBad (Ok v) = return v |
357 |
|
358 |
-- | Runs an allocation algorithm and saves cluster state. |
359 |
runAllocation :: ClusterData -- ^ Cluster data |
360 |
-> Maybe Cluster.AllocResult -- ^ Optional stop-allocation |
361 |
-> Result Cluster.AllocResult -- ^ Allocation result |
362 |
-> RSpec -- ^ Requested instance spec |
363 |
-> DiskTemplate -- ^ Requested disk template |
364 |
-> SpecType -- ^ Allocation type |
365 |
-> Options -- ^ CLI options |
366 |
-> IO (FailStats, Node.List, Int, [(RSpec, Int)]) |
367 |
runAllocation cdata stop_allocation actual_result spec dt mode opts = do |
368 |
(reasons, new_nl, new_il, new_ixes, _) <- |
369 |
case stop_allocation of |
370 |
Just result_noalloc -> return result_noalloc |
371 |
Nothing -> exitIfBad actual_result |
372 |
|
373 |
let name = head . words . specDescription $ mode |
374 |
descr = name ++ " allocation" |
375 |
ldescr = "after " ++ map toLower descr |
376 |
|
377 |
printISpec (optMachineReadable opts) spec mode dt |
378 |
|
379 |
printAllocationMap (optVerbose opts) descr new_nl new_ixes |
380 |
|
381 |
maybePrintNodes (optShowNodes opts) descr (Cluster.printNodes new_nl) |
382 |
|
383 |
maybeSaveData (optSaveCluster opts) (map toLower name) ldescr |
384 |
(cdata { cdNodes = new_nl, cdInstances = new_il}) |
385 |
|
386 |
return (sortReasons reasons, new_nl, length new_ixes, tieredSpecMap new_ixes) |
387 |
|
388 |
-- | Create an instance from a given spec. |
389 |
instFromSpec :: RSpec -> DiskTemplate -> Instance.Instance |
390 |
instFromSpec spx disk_template = |
391 |
Instance.create "new" (rspecMem spx) (rspecDsk spx) |
392 |
(rspecCpu spx) Running [] True (-1) (-1) disk_template 1 |
393 |
|
394 |
-- | Main function. |
395 |
main :: Options -> [String] -> IO () |
396 |
main opts args = do |
397 |
unless (null args) $ do |
398 |
hPutStrLn stderr "Error: this program doesn't take any arguments." |
399 |
exitWith $ ExitFailure 1 |
400 |
|
401 |
let verbose = optVerbose opts |
402 |
machine_r = optMachineReadable opts |
403 |
|
404 |
orig_cdata@(ClusterData gl fixed_nl il _ ipol) <- loadExternalData opts |
405 |
nl <- setNodeStatus opts fixed_nl |
406 |
|
407 |
cluster_disk_template <- |
408 |
case iPolicyDiskTemplates ipol of |
409 |
first_templ:_ -> return first_templ |
410 |
_ -> do |
411 |
_ <- hPutStrLn stderr $ "Error: null list of disk templates\ |
412 |
\ received from cluster!" |
413 |
exitWith $ ExitFailure 1 |
414 |
|
415 |
let num_instances = Container.size il |
416 |
all_nodes = Container.elems fixed_nl |
417 |
cdata = orig_cdata { cdNodes = fixed_nl } |
418 |
disk_template = fromMaybe cluster_disk_template (optDiskTemplate opts) |
419 |
req_nodes = Instance.requiredNodes disk_template |
420 |
csf = commonSuffix fixed_nl il |
421 |
|
422 |
when (not (null csf) && verbose > 1) $ |
423 |
hPrintf stderr "Note: Stripping common suffix of '%s' from names\n" csf |
424 |
|
425 |
maybePrintNodes (optShowNodes opts) "Initial cluster" (Cluster.printNodes nl) |
426 |
|
427 |
when (verbose > 2) $ |
428 |
hPrintf stderr "Initial coefficients: overall %.8f\n%s" |
429 |
(Cluster.compCV nl) (Cluster.printStats " " nl) |
430 |
|
431 |
printCluster machine_r (Cluster.totalResources nl) (length all_nodes) |
432 |
|
433 |
let stop_allocation = case Cluster.computeBadItems nl il of |
434 |
([], _) -> Nothing |
435 |
_ -> Just ([(FailN1, 1)]::FailStats, nl, il, [], []) |
436 |
alloclimit = if optMaxLength opts == -1 |
437 |
then Nothing |
438 |
else Just (optMaxLength opts) |
439 |
|
440 |
allocnodes <- exitIfBad $ Cluster.genAllocNodes gl nl req_nodes True |
441 |
|
442 |
-- Run the tiered allocation |
443 |
|
444 |
let tspec = fromMaybe (rspecFromISpec (iPolicyMaxSpec ipol)) |
445 |
(optTieredSpec opts) |
446 |
|
447 |
(treason, trl_nl, _, spec_map) <- |
448 |
runAllocation cdata stop_allocation |
449 |
(Cluster.tieredAlloc nl il alloclimit |
450 |
(instFromSpec tspec disk_template) allocnodes [] []) |
451 |
tspec disk_template SpecTiered opts |
452 |
|
453 |
printTiered machine_r spec_map nl trl_nl treason |
454 |
|
455 |
-- Run the standard (avg-mode) allocation |
456 |
|
457 |
let ispec = fromMaybe (rspecFromISpec (iPolicyStdSpec ipol)) |
458 |
(optStdSpec opts) |
459 |
|
460 |
(sreason, fin_nl, allocs, _) <- |
461 |
runAllocation cdata stop_allocation |
462 |
(Cluster.iterateAlloc nl il alloclimit |
463 |
(instFromSpec ispec disk_template) allocnodes [] []) |
464 |
ispec disk_template SpecNormal opts |
465 |
|
466 |
printResults machine_r nl fin_nl num_instances allocs sreason |
467 |
|
468 |
-- Print final result |
469 |
|
470 |
printFinal machine_r |