root / src / Ganeti / OpCodes.hs @ de36f091
History | View | Annotate | Download (27.5 kB)
1 |
{-# LANGUAGE ExistentialQuantification, TemplateHaskell #-} |
---|---|
2 |
{-# OPTIONS_GHC -fno-warn-orphans #-} |
3 |
|
4 |
{-| Implementation of the opcodes. |
5 |
|
6 |
-} |
7 |
|
8 |
{- |
9 |
|
10 |
Copyright (C) 2009, 2010, 2011, 2012, 2013 Google Inc. |
11 |
|
12 |
This program is free software; you can redistribute it and/or modify |
13 |
it under the terms of the GNU General Public License as published by |
14 |
the Free Software Foundation; either version 2 of the License, or |
15 |
(at your option) any later version. |
16 |
|
17 |
This program is distributed in the hope that it will be useful, but |
18 |
WITHOUT ANY WARRANTY; without even the implied warranty of |
19 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
20 |
General Public License for more details. |
21 |
|
22 |
You should have received a copy of the GNU General Public License |
23 |
along with this program; if not, write to the Free Software |
24 |
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
25 |
02110-1301, USA. |
26 |
|
27 |
-} |
28 |
|
29 |
module Ganeti.OpCodes |
30 |
( pyClasses |
31 |
, OpCode(..) |
32 |
, ReplaceDisksMode(..) |
33 |
, DiskIndex |
34 |
, mkDiskIndex |
35 |
, unDiskIndex |
36 |
, opID |
37 |
, allOpIDs |
38 |
, allOpFields |
39 |
, opSummary |
40 |
, CommonOpParams(..) |
41 |
, defOpParams |
42 |
, MetaOpCode(..) |
43 |
, wrapOpCode |
44 |
, setOpComment |
45 |
, setOpPriority |
46 |
) where |
47 |
|
48 |
import Text.JSON (readJSON, JSObject, JSON, JSValue(..), makeObj, fromJSObject) |
49 |
import qualified Text.JSON |
50 |
|
51 |
import Ganeti.THH |
52 |
|
53 |
import qualified Ganeti.Hs2Py.OpDoc as OpDoc |
54 |
import Ganeti.OpParams |
55 |
import Ganeti.Types |
56 |
import Ganeti.Query.Language (queryTypeOpToRaw) |
57 |
|
58 |
import Data.List (intercalate) |
59 |
import Data.Map (Map) |
60 |
import qualified Data.Map as Map |
61 |
import Data.Set (Set) |
62 |
import qualified Data.Set as Set |
63 |
|
64 |
import qualified Ganeti.Constants as C |
65 |
|
66 |
instance PyValue Bool |
67 |
instance PyValue Int |
68 |
instance PyValue Double |
69 |
instance PyValue Char |
70 |
|
71 |
instance (PyValue a, PyValue b) => PyValue (a, b) where |
72 |
showValue (x, y) = show (showValue x, showValue y) |
73 |
|
74 |
instance PyValue a => PyValue [a] where |
75 |
showValue xs = show (map showValue xs) |
76 |
|
77 |
instance PyValue a => PyValue (Set a) where |
78 |
showValue s = showValue (Set.toList s) |
79 |
|
80 |
instance (PyValue k, PyValue a) => PyValue (Map k a) where |
81 |
showValue mp = |
82 |
"{" ++ intercalate ", " (map showPair (Map.assocs mp)) ++ "}" |
83 |
where showPair (k, x) = show k ++ ":" ++ show x |
84 |
|
85 |
instance PyValue DiskIndex where |
86 |
showValue = showValue . unDiskIndex |
87 |
|
88 |
instance PyValue IDiskParams where |
89 |
showValue _ = error "OpCodes.showValue(IDiskParams): unhandled case" |
90 |
|
91 |
instance PyValue RecreateDisksInfo where |
92 |
showValue RecreateDisksAll = "[]" |
93 |
showValue (RecreateDisksIndices is) = showValue is |
94 |
showValue (RecreateDisksParams is) = showValue is |
95 |
|
96 |
instance PyValue a => PyValue (SetParamsMods a) where |
97 |
showValue SetParamsEmpty = "[]" |
98 |
showValue _ = error "OpCodes.showValue(SetParamsMods): unhandled case" |
99 |
|
100 |
instance PyValue a => PyValue (NonNegative a) where |
101 |
showValue = showValue . fromNonNegative |
102 |
|
103 |
instance PyValue a => PyValue (NonEmpty a) where |
104 |
showValue = showValue . fromNonEmpty |
105 |
|
106 |
-- FIXME: should use the 'toRaw' function instead of being harcoded or |
107 |
-- perhaps use something similar to the NonNegative type instead of |
108 |
-- using the declareSADT |
109 |
instance PyValue ExportMode where |
110 |
showValue ExportModeLocal = show C.exportModeLocal |
111 |
showValue ExportModeRemove = show C.exportModeLocal |
112 |
|
113 |
instance PyValue CVErrorCode where |
114 |
showValue = cVErrorCodeToRaw |
115 |
|
116 |
instance PyValue VerifyOptionalChecks where |
117 |
showValue = verifyOptionalChecksToRaw |
118 |
|
119 |
instance PyValue INicParams where |
120 |
showValue = error "instance PyValue INicParams: not implemented" |
121 |
|
122 |
instance PyValue a => PyValue (JSObject a) where |
123 |
showValue obj = |
124 |
"{" ++ intercalate ", " (map showPair (fromJSObject obj)) ++ "}" |
125 |
where showPair (k, v) = show k ++ ":" ++ showValue v |
126 |
|
127 |
instance PyValue JSValue where |
128 |
showValue (JSObject obj) = showValue obj |
129 |
showValue x = show x |
130 |
|
131 |
type JobIdListOnly = [(Bool, Either String JobId)] |
132 |
|
133 |
type InstanceMultiAllocResponse = |
134 |
([(Bool, Either String JobId)], NonEmptyString) |
135 |
|
136 |
type QueryFieldDef = |
137 |
(NonEmptyString, NonEmptyString, TagKind, NonEmptyString) |
138 |
|
139 |
type QueryResponse = |
140 |
([QueryFieldDef], [[(QueryResultCode, JSValue)]]) |
141 |
|
142 |
type QueryFieldsResponse = [QueryFieldDef] |
143 |
|
144 |
-- | OpCode representation. |
145 |
-- |
146 |
-- We only implement a subset of Ganeti opcodes: those which are actually used |
147 |
-- in the htools codebase. |
148 |
$(genOpCode "OpCode" |
149 |
[ ("OpClusterPostInit", |
150 |
[t| Bool |], |
151 |
OpDoc.opClusterPostInit, |
152 |
[], |
153 |
[]) |
154 |
, ("OpClusterDestroy", |
155 |
[t| NonEmptyString |], |
156 |
OpDoc.opClusterDestroy, |
157 |
[], |
158 |
[]) |
159 |
, ("OpClusterQuery", |
160 |
[t| JSObject JSValue |], |
161 |
OpDoc.opClusterQuery, |
162 |
[], |
163 |
[]) |
164 |
, ("OpClusterVerify", |
165 |
[t| JobIdListOnly |], |
166 |
OpDoc.opClusterVerify, |
167 |
[ pDebugSimulateErrors |
168 |
, pErrorCodes |
169 |
, pSkipChecks |
170 |
, pIgnoreErrors |
171 |
, pVerbose |
172 |
, pOptGroupName |
173 |
], |
174 |
[]) |
175 |
, ("OpClusterVerifyConfig", |
176 |
[t| Bool |], |
177 |
OpDoc.opClusterVerifyConfig, |
178 |
[ pDebugSimulateErrors |
179 |
, pErrorCodes |
180 |
, pIgnoreErrors |
181 |
, pVerbose |
182 |
], |
183 |
[]) |
184 |
, ("OpClusterVerifyGroup", |
185 |
[t| Bool |], |
186 |
OpDoc.opClusterVerifyGroup, |
187 |
[ pGroupName |
188 |
, pDebugSimulateErrors |
189 |
, pErrorCodes |
190 |
, pSkipChecks |
191 |
, pIgnoreErrors |
192 |
, pVerbose |
193 |
], |
194 |
"group_name") |
195 |
, ("OpClusterVerifyDisks", |
196 |
[t| JobIdListOnly |], |
197 |
OpDoc.opClusterVerifyDisks, |
198 |
[], |
199 |
[]) |
200 |
, ("OpGroupVerifyDisks", |
201 |
[t| (Map String String, [String], Map String [[String]]) |], |
202 |
OpDoc.opGroupVerifyDisks, |
203 |
[ pGroupName |
204 |
], |
205 |
"group_name") |
206 |
, ("OpClusterRepairDiskSizes", |
207 |
[t| [(NonEmptyString, NonNegative Int, NonEmptyString, NonNegative Int)]|], |
208 |
OpDoc.opClusterRepairDiskSizes, |
209 |
[ pInstances |
210 |
], |
211 |
[]) |
212 |
, ("OpClusterConfigQuery", |
213 |
[t| [JSValue] |], |
214 |
OpDoc.opClusterConfigQuery, |
215 |
[ pOutputFields |
216 |
], |
217 |
[]) |
218 |
, ("OpClusterRename", |
219 |
[t| NonEmptyString |], |
220 |
OpDoc.opClusterRename, |
221 |
[ pName |
222 |
], |
223 |
"name") |
224 |
, ("OpClusterSetParams", |
225 |
[t| () |], |
226 |
OpDoc.opClusterSetParams, |
227 |
[ pForce |
228 |
, pHvState |
229 |
, pDiskState |
230 |
, pVgName |
231 |
, pEnabledHypervisors |
232 |
, pClusterHvParams |
233 |
, pClusterBeParams |
234 |
, pOsHvp |
235 |
, pClusterOsParams |
236 |
, pDiskParams |
237 |
, pCandidatePoolSize |
238 |
, pUidPool |
239 |
, pAddUids |
240 |
, pRemoveUids |
241 |
, pMaintainNodeHealth |
242 |
, pPreallocWipeDisks |
243 |
, pNicParams |
244 |
, withDoc "Cluster-wide node parameter defaults" pNdParams |
245 |
, withDoc "Cluster-wide ipolicy specs" pIpolicy |
246 |
, pDrbdHelper |
247 |
, pDefaultIAllocator |
248 |
, pMasterNetdev |
249 |
, pMasterNetmask |
250 |
, pReservedLvs |
251 |
, pHiddenOs |
252 |
, pBlacklistedOs |
253 |
, pUseExternalMipScript |
254 |
, pEnabledDiskTemplates |
255 |
, pModifyEtcHosts |
256 |
, pGlobalFileStorageDir |
257 |
], |
258 |
[]) |
259 |
, ("OpClusterRedistConf", |
260 |
[t| () |], |
261 |
OpDoc.opClusterRedistConf, |
262 |
[], |
263 |
[]) |
264 |
, ("OpClusterActivateMasterIp", |
265 |
[t| () |], |
266 |
OpDoc.opClusterActivateMasterIp, |
267 |
[], |
268 |
[]) |
269 |
, ("OpClusterDeactivateMasterIp", |
270 |
[t| () |], |
271 |
OpDoc.opClusterDeactivateMasterIp, |
272 |
[], |
273 |
[]) |
274 |
, ("OpQuery", |
275 |
[t| QueryResponse |], |
276 |
OpDoc.opQuery, |
277 |
[ pQueryWhat |
278 |
, pUseLocking |
279 |
, pQueryFields |
280 |
, pQueryFilter |
281 |
], |
282 |
"what") |
283 |
, ("OpQueryFields", |
284 |
[t| QueryFieldsResponse |], |
285 |
OpDoc.opQueryFields, |
286 |
[ pQueryWhat |
287 |
, pQueryFieldsFields |
288 |
], |
289 |
"what") |
290 |
, ("OpOobCommand", |
291 |
[t| [[(QueryResultCode, JSValue)]] |], |
292 |
OpDoc.opOobCommand, |
293 |
[ pNodeNames |
294 |
, withDoc "List of node UUIDs to run the OOB command against" pNodeUuids |
295 |
, pOobCommand |
296 |
, pOobTimeout |
297 |
, pIgnoreStatus |
298 |
, pPowerDelay |
299 |
], |
300 |
[]) |
301 |
, ("OpRestrictedCommand", |
302 |
[t| [(Bool, String)] |], |
303 |
OpDoc.opRestrictedCommand, |
304 |
[ pUseLocking |
305 |
, withDoc |
306 |
"Nodes on which the command should be run (at least one)" |
307 |
pRequiredNodes |
308 |
, withDoc |
309 |
"Node UUIDs on which the command should be run (at least one)" |
310 |
pRequiredNodeUuids |
311 |
, pRestrictedCommand |
312 |
], |
313 |
[]) |
314 |
, ("OpNodeRemove", |
315 |
[t| () |], |
316 |
OpDoc.opNodeRemove, |
317 |
[ pNodeName |
318 |
, pNodeUuid |
319 |
], |
320 |
"node_name") |
321 |
, ("OpNodeAdd", |
322 |
[t| () |], |
323 |
OpDoc.opNodeAdd, |
324 |
[ pNodeName |
325 |
, pHvState |
326 |
, pDiskState |
327 |
, pPrimaryIp |
328 |
, pSecondaryIp |
329 |
, pReadd |
330 |
, pNodeGroup |
331 |
, pMasterCapable |
332 |
, pVmCapable |
333 |
, pNdParams |
334 |
], |
335 |
"node_name") |
336 |
, ("OpNodeQuery", |
337 |
[t| [[JSValue]] |], |
338 |
OpDoc.opNodeQuery, |
339 |
[ pOutputFields |
340 |
, withDoc "Empty list to query all nodes, node names otherwise" pNames |
341 |
, pUseLocking |
342 |
], |
343 |
[]) |
344 |
, ("OpNodeQueryvols", |
345 |
[t| [JSValue] |], |
346 |
OpDoc.opNodeQueryvols, |
347 |
[ pOutputFields |
348 |
, withDoc "Empty list to query all nodes, node names otherwise" pNodes |
349 |
], |
350 |
[]) |
351 |
, ("OpNodeQueryStorage", |
352 |
[t| [[JSValue]] |], |
353 |
OpDoc.opNodeQueryStorage, |
354 |
[ pOutputFields |
355 |
, pStorageType |
356 |
, withDoc |
357 |
"Empty list to query all, list of names to query otherwise" |
358 |
pNodes |
359 |
, pStorageName |
360 |
], |
361 |
[]) |
362 |
, ("OpNodeModifyStorage", |
363 |
[t| () |], |
364 |
OpDoc.opNodeModifyStorage, |
365 |
[ pNodeName |
366 |
, pNodeUuid |
367 |
, pStorageType |
368 |
, pStorageName |
369 |
, pStorageChanges |
370 |
], |
371 |
"node_name") |
372 |
, ("OpRepairNodeStorage", |
373 |
[t| () |], |
374 |
OpDoc.opRepairNodeStorage, |
375 |
[ pNodeName |
376 |
, pNodeUuid |
377 |
, pStorageType |
378 |
, pStorageName |
379 |
, pIgnoreConsistency |
380 |
], |
381 |
"node_name") |
382 |
, ("OpNodeSetParams", |
383 |
[t| [(NonEmptyString, JSValue)] |], |
384 |
OpDoc.opNodeSetParams, |
385 |
[ pNodeName |
386 |
, pNodeUuid |
387 |
, pForce |
388 |
, pHvState |
389 |
, pDiskState |
390 |
, pMasterCandidate |
391 |
, withDoc "Whether to mark the node offline" pOffline |
392 |
, pDrained |
393 |
, pAutoPromote |
394 |
, pMasterCapable |
395 |
, pVmCapable |
396 |
, pSecondaryIp |
397 |
, pNdParams |
398 |
, pPowered |
399 |
], |
400 |
"node_name") |
401 |
, ("OpNodePowercycle", |
402 |
[t| Maybe NonEmptyString |], |
403 |
OpDoc.opNodePowercycle, |
404 |
[ pNodeName |
405 |
, pNodeUuid |
406 |
, pForce |
407 |
], |
408 |
"node_name") |
409 |
, ("OpNodeMigrate", |
410 |
[t| JobIdListOnly |], |
411 |
OpDoc.opNodeMigrate, |
412 |
[ pNodeName |
413 |
, pNodeUuid |
414 |
, pMigrationMode |
415 |
, pMigrationLive |
416 |
, pMigrationTargetNode |
417 |
, pMigrationTargetNodeUuid |
418 |
, pAllowRuntimeChgs |
419 |
, pIgnoreIpolicy |
420 |
, pIallocator |
421 |
], |
422 |
"node_name") |
423 |
, ("OpNodeEvacuate", |
424 |
[t| JobIdListOnly |], |
425 |
OpDoc.opNodeEvacuate, |
426 |
[ pEarlyRelease |
427 |
, pNodeName |
428 |
, pNodeUuid |
429 |
, pRemoteNode |
430 |
, pRemoteNodeUuid |
431 |
, pIallocator |
432 |
, pEvacMode |
433 |
], |
434 |
"node_name") |
435 |
, ("OpInstanceCreate", |
436 |
[t| [NonEmptyString] |], |
437 |
OpDoc.opInstanceCreate, |
438 |
[ pInstanceName |
439 |
, pForceVariant |
440 |
, pWaitForSync |
441 |
, pNameCheck |
442 |
, pIgnoreIpolicy |
443 |
, pOpportunisticLocking |
444 |
, pInstBeParams |
445 |
, pInstDisks |
446 |
, pDiskTemplate |
447 |
, pFileDriver |
448 |
, pFileStorageDir |
449 |
, pInstHvParams |
450 |
, pHypervisor |
451 |
, pIallocator |
452 |
, pResetDefaults |
453 |
, pIpCheck |
454 |
, pIpConflictsCheck |
455 |
, pInstCreateMode |
456 |
, pInstNics |
457 |
, pNoInstall |
458 |
, pInstOsParams |
459 |
, pInstOs |
460 |
, pPrimaryNode |
461 |
, pPrimaryNodeUuid |
462 |
, pSecondaryNode |
463 |
, pSecondaryNodeUuid |
464 |
, pSourceHandshake |
465 |
, pSourceInstance |
466 |
, pSourceShutdownTimeout |
467 |
, pSourceX509Ca |
468 |
, pSrcNode |
469 |
, pSrcNodeUuid |
470 |
, pSrcPath |
471 |
, pStartInstance |
472 |
, pInstTags |
473 |
], |
474 |
"instance_name") |
475 |
, ("OpInstanceMultiAlloc", |
476 |
[t| InstanceMultiAllocResponse |], |
477 |
OpDoc.opInstanceMultiAlloc, |
478 |
[ pOpportunisticLocking |
479 |
, pIallocator |
480 |
, pMultiAllocInstances |
481 |
], |
482 |
[]) |
483 |
, ("OpInstanceReinstall", |
484 |
[t| () |], |
485 |
OpDoc.opInstanceReinstall, |
486 |
[ pInstanceName |
487 |
, pInstanceUuid |
488 |
, pForceVariant |
489 |
, pInstOs |
490 |
, pTempOsParams |
491 |
], |
492 |
"instance_name") |
493 |
, ("OpInstanceRemove", |
494 |
[t| () |], |
495 |
OpDoc.opInstanceRemove, |
496 |
[ pInstanceName |
497 |
, pInstanceUuid |
498 |
, pShutdownTimeout |
499 |
, pIgnoreFailures |
500 |
], |
501 |
"instance_name") |
502 |
, ("OpInstanceRename", |
503 |
[t| NonEmptyString |], |
504 |
OpDoc.opInstanceRename, |
505 |
[ pInstanceName |
506 |
, pInstanceUuid |
507 |
, withDoc "New instance name" pNewName |
508 |
, pNameCheck |
509 |
, pIpCheck |
510 |
], |
511 |
[]) |
512 |
, ("OpInstanceStartup", |
513 |
[t| () |], |
514 |
OpDoc.opInstanceStartup, |
515 |
[ pInstanceName |
516 |
, pInstanceUuid |
517 |
, pForce |
518 |
, pIgnoreOfflineNodes |
519 |
, pTempHvParams |
520 |
, pTempBeParams |
521 |
, pNoRemember |
522 |
, pStartupPaused |
523 |
], |
524 |
"instance_name") |
525 |
, ("OpInstanceShutdown", |
526 |
[t| () |], |
527 |
OpDoc.opInstanceShutdown, |
528 |
[ pInstanceName |
529 |
, pInstanceUuid |
530 |
, pForce |
531 |
, pIgnoreOfflineNodes |
532 |
, pShutdownTimeout |
533 |
, pNoRemember |
534 |
], |
535 |
"instance_name") |
536 |
, ("OpInstanceReboot", |
537 |
[t| () |], |
538 |
OpDoc.opInstanceReboot, |
539 |
[ pInstanceName |
540 |
, pInstanceUuid |
541 |
, pShutdownTimeout |
542 |
, pIgnoreSecondaries |
543 |
, pRebootType |
544 |
], |
545 |
"instance_name") |
546 |
, ("OpInstanceReplaceDisks", |
547 |
[t| () |], |
548 |
OpDoc.opInstanceReplaceDisks, |
549 |
[ pInstanceName |
550 |
, pInstanceUuid |
551 |
, pEarlyRelease |
552 |
, pIgnoreIpolicy |
553 |
, pReplaceDisksMode |
554 |
, pReplaceDisksList |
555 |
, pRemoteNode |
556 |
, pRemoteNodeUuid |
557 |
, pIallocator |
558 |
], |
559 |
"instance_name") |
560 |
, ("OpInstanceFailover", |
561 |
[t| () |], |
562 |
OpDoc.opInstanceFailover, |
563 |
[ pInstanceName |
564 |
, pInstanceUuid |
565 |
, pShutdownTimeout |
566 |
, pIgnoreConsistency |
567 |
, pMigrationTargetNode |
568 |
, pMigrationTargetNodeUuid |
569 |
, pIgnoreIpolicy |
570 |
, pIallocator |
571 |
], |
572 |
"instance_name") |
573 |
, ("OpInstanceMigrate", |
574 |
[t| () |], |
575 |
OpDoc.opInstanceMigrate, |
576 |
[ pInstanceName |
577 |
, pInstanceUuid |
578 |
, pMigrationMode |
579 |
, pMigrationLive |
580 |
, pMigrationTargetNode |
581 |
, pMigrationTargetNodeUuid |
582 |
, pAllowRuntimeChgs |
583 |
, pIgnoreIpolicy |
584 |
, pMigrationCleanup |
585 |
, pIallocator |
586 |
, pAllowFailover |
587 |
], |
588 |
"instance_name") |
589 |
, ("OpInstanceMove", |
590 |
[t| () |], |
591 |
OpDoc.opInstanceMove, |
592 |
[ pInstanceName |
593 |
, pInstanceUuid |
594 |
, pShutdownTimeout |
595 |
, pIgnoreIpolicy |
596 |
, pMoveTargetNode |
597 |
, pMoveTargetNodeUuid |
598 |
, pIgnoreConsistency |
599 |
], |
600 |
"instance_name") |
601 |
, ("OpInstanceConsole", |
602 |
[t| JSObject JSValue |], |
603 |
OpDoc.opInstanceConsole, |
604 |
[ pInstanceName |
605 |
, pInstanceUuid |
606 |
], |
607 |
"instance_name") |
608 |
, ("OpInstanceActivateDisks", |
609 |
[t| [(NonEmptyString, NonEmptyString, NonEmptyString)] |], |
610 |
OpDoc.opInstanceActivateDisks, |
611 |
[ pInstanceName |
612 |
, pInstanceUuid |
613 |
, pIgnoreDiskSize |
614 |
, pWaitForSyncFalse |
615 |
], |
616 |
"instance_name") |
617 |
, ("OpInstanceDeactivateDisks", |
618 |
[t| () |], |
619 |
OpDoc.opInstanceDeactivateDisks, |
620 |
[ pInstanceName |
621 |
, pInstanceUuid |
622 |
, pForce |
623 |
], |
624 |
"instance_name") |
625 |
, ("OpInstanceRecreateDisks", |
626 |
[t| () |], |
627 |
OpDoc.opInstanceRecreateDisks, |
628 |
[ pInstanceName |
629 |
, pInstanceUuid |
630 |
, pRecreateDisksInfo |
631 |
, withDoc "New instance nodes, if relocation is desired" pNodes |
632 |
, withDoc "New instance node UUIDs, if relocation is desired" pNodeUuids |
633 |
, pIallocator |
634 |
], |
635 |
"instance_name") |
636 |
, ("OpInstanceQuery", |
637 |
[t| [[JSValue]] |], |
638 |
OpDoc.opInstanceQuery, |
639 |
[ pOutputFields |
640 |
, pUseLocking |
641 |
, withDoc |
642 |
"Empty list to query all instances, instance names otherwise" |
643 |
pNames |
644 |
], |
645 |
[]) |
646 |
, ("OpInstanceQueryData", |
647 |
[t| JSObject (JSObject JSValue) |], |
648 |
OpDoc.opInstanceQueryData, |
649 |
[ pUseLocking |
650 |
, pInstances |
651 |
, pStatic |
652 |
], |
653 |
[]) |
654 |
, ("OpInstanceSetParams", |
655 |
[t| [(NonEmptyString, JSValue)] |], |
656 |
OpDoc.opInstanceSetParams, |
657 |
[ pInstanceName |
658 |
, pInstanceUuid |
659 |
, pForce |
660 |
, pForceVariant |
661 |
, pIgnoreIpolicy |
662 |
, pInstParamsNicChanges |
663 |
, pInstParamsDiskChanges |
664 |
, pInstBeParams |
665 |
, pRuntimeMem |
666 |
, pInstHvParams |
667 |
, pOptDiskTemplate |
668 |
, pPrimaryNode |
669 |
, pPrimaryNodeUuid |
670 |
, withDoc "Secondary node (used when changing disk template)" pRemoteNode |
671 |
, withDoc |
672 |
"Secondary node UUID (used when changing disk template)" |
673 |
pRemoteNodeUuid |
674 |
, pOsNameChange |
675 |
, pInstOsParams |
676 |
, pWaitForSync |
677 |
, withDoc "Whether to mark the instance as offline" pOffline |
678 |
, pIpConflictsCheck |
679 |
], |
680 |
"instance_name") |
681 |
, ("OpInstanceGrowDisk", |
682 |
[t| () |], |
683 |
OpDoc.opInstanceGrowDisk, |
684 |
[ pInstanceName |
685 |
, pInstanceUuid |
686 |
, pWaitForSync |
687 |
, pDiskIndex |
688 |
, pDiskChgAmount |
689 |
, pDiskChgAbsolute |
690 |
], |
691 |
"instance_name") |
692 |
, ("OpInstanceChangeGroup", |
693 |
[t| JobIdListOnly |], |
694 |
OpDoc.opInstanceChangeGroup, |
695 |
[ pInstanceName |
696 |
, pInstanceUuid |
697 |
, pEarlyRelease |
698 |
, pIallocator |
699 |
, pTargetGroups |
700 |
], |
701 |
"instance_name") |
702 |
, ("OpGroupAdd", |
703 |
[t| () |], |
704 |
OpDoc.opGroupAdd, |
705 |
[ pGroupName |
706 |
, pNodeGroupAllocPolicy |
707 |
, pGroupNodeParams |
708 |
, pDiskParams |
709 |
, pHvState |
710 |
, pDiskState |
711 |
, withDoc "Group-wide ipolicy specs" pIpolicy |
712 |
], |
713 |
"group_name") |
714 |
, ("OpGroupAssignNodes", |
715 |
[t| () |], |
716 |
OpDoc.opGroupAssignNodes, |
717 |
[ pGroupName |
718 |
, pForce |
719 |
, withDoc "List of nodes to assign" pRequiredNodes |
720 |
, withDoc "List of node UUIDs to assign" pRequiredNodeUuids |
721 |
], |
722 |
"group_name") |
723 |
, ("OpGroupQuery", |
724 |
[t| [[JSValue]] |], |
725 |
OpDoc.opGroupQuery, |
726 |
[ pOutputFields |
727 |
, withDoc "Empty list to query all groups, group names otherwise" pNames |
728 |
], |
729 |
[]) |
730 |
, ("OpGroupSetParams", |
731 |
[t| [(NonEmptyString, JSValue)] |], |
732 |
OpDoc.opGroupSetParams, |
733 |
[ pGroupName |
734 |
, pNodeGroupAllocPolicy |
735 |
, pGroupNodeParams |
736 |
, pDiskParams |
737 |
, pHvState |
738 |
, pDiskState |
739 |
, withDoc "Group-wide ipolicy specs" pIpolicy |
740 |
], |
741 |
"group_name") |
742 |
, ("OpGroupRemove", |
743 |
[t| () |], |
744 |
OpDoc.opGroupRemove, |
745 |
[ pGroupName |
746 |
], |
747 |
"group_name") |
748 |
, ("OpGroupRename", |
749 |
[t| NonEmptyString |], |
750 |
OpDoc.opGroupRename, |
751 |
[ pGroupName |
752 |
, withDoc "New group name" pNewName |
753 |
], |
754 |
[]) |
755 |
, ("OpGroupEvacuate", |
756 |
[t| JobIdListOnly |], |
757 |
OpDoc.opGroupEvacuate, |
758 |
[ pGroupName |
759 |
, pEarlyRelease |
760 |
, pIallocator |
761 |
, pTargetGroups |
762 |
], |
763 |
"group_name") |
764 |
, ("OpOsDiagnose", |
765 |
[t| [[JSValue]] |], |
766 |
OpDoc.opOsDiagnose, |
767 |
[ pOutputFields |
768 |
, withDoc "Which operating systems to diagnose" pNames |
769 |
], |
770 |
[]) |
771 |
, ("OpExtStorageDiagnose", |
772 |
[t| [[JSValue]] |], |
773 |
OpDoc.opExtStorageDiagnose, |
774 |
[ pOutputFields |
775 |
, withDoc "Which ExtStorage Provider to diagnose" pNames |
776 |
], |
777 |
[]) |
778 |
, ("OpBackupQuery", |
779 |
[t| JSObject (Either Bool [NonEmptyString]) |], |
780 |
OpDoc.opBackupQuery, |
781 |
[ pUseLocking |
782 |
, withDoc "Empty list to query all nodes, node names otherwise" pNodes |
783 |
], |
784 |
[]) |
785 |
, ("OpBackupPrepare", |
786 |
[t| Maybe (JSObject JSValue) |], |
787 |
OpDoc.opBackupPrepare, |
788 |
[ pInstanceName |
789 |
, pInstanceUuid |
790 |
, pExportMode |
791 |
], |
792 |
"instance_name") |
793 |
, ("OpBackupExport", |
794 |
[t| (Bool, [Bool]) |], |
795 |
OpDoc.opBackupExport, |
796 |
[ pInstanceName |
797 |
, pInstanceUuid |
798 |
, pShutdownTimeout |
799 |
, pExportTargetNode |
800 |
, pExportTargetNodeUuid |
801 |
, pShutdownInstance |
802 |
, pRemoveInstance |
803 |
, pIgnoreRemoveFailures |
804 |
, defaultField [| ExportModeLocal |] pExportMode |
805 |
, pX509KeyName |
806 |
, pX509DestCA |
807 |
], |
808 |
"instance_name") |
809 |
, ("OpBackupRemove", |
810 |
[t| () |], |
811 |
OpDoc.opBackupRemove, |
812 |
[ pInstanceName |
813 |
, pInstanceUuid |
814 |
], |
815 |
"instance_name") |
816 |
, ("OpTagsGet", |
817 |
[t| [NonEmptyString] |], |
818 |
OpDoc.opTagsGet, |
819 |
[ pTagsObject |
820 |
, pUseLocking |
821 |
, withDoc "Name of object to retrieve tags from" pTagsName |
822 |
], |
823 |
"name") |
824 |
, ("OpTagsSearch", |
825 |
[t| [(NonEmptyString, NonEmptyString)] |], |
826 |
OpDoc.opTagsSearch, |
827 |
[ pTagSearchPattern |
828 |
], |
829 |
"pattern") |
830 |
, ("OpTagsSet", |
831 |
[t| () |], |
832 |
OpDoc.opTagsSet, |
833 |
[ pTagsObject |
834 |
, pTagsList |
835 |
, withDoc "Name of object where tag(s) should be added" pTagsName |
836 |
], |
837 |
[]) |
838 |
, ("OpTagsDel", |
839 |
[t| () |], |
840 |
OpDoc.opTagsDel, |
841 |
[ pTagsObject |
842 |
, pTagsList |
843 |
, withDoc "Name of object where tag(s) should be deleted" pTagsName |
844 |
], |
845 |
[]) |
846 |
, ("OpTestDelay", |
847 |
[t| () |], |
848 |
OpDoc.opTestDelay, |
849 |
[ pDelayDuration |
850 |
, pDelayOnMaster |
851 |
, pDelayOnNodes |
852 |
, pDelayOnNodeUuids |
853 |
, pDelayRepeat |
854 |
], |
855 |
"duration") |
856 |
, ("OpTestAllocator", |
857 |
[t| () |], |
858 |
OpDoc.opTestAllocator, |
859 |
[ pIAllocatorDirection |
860 |
, pIAllocatorMode |
861 |
, pIAllocatorReqName |
862 |
, pIAllocatorNics |
863 |
, pIAllocatorDisks |
864 |
, pHypervisor |
865 |
, pIallocator |
866 |
, pInstTags |
867 |
, pIAllocatorMemory |
868 |
, pIAllocatorVCpus |
869 |
, pIAllocatorOs |
870 |
, pDiskTemplate |
871 |
, pIAllocatorInstances |
872 |
, pIAllocatorEvacMode |
873 |
, pTargetGroups |
874 |
, pIAllocatorSpindleUse |
875 |
, pIAllocatorCount |
876 |
], |
877 |
"iallocator") |
878 |
, ("OpTestJqueue", |
879 |
[t| () |], |
880 |
OpDoc.opTestJqueue, |
881 |
[ pJQueueNotifyWaitLock |
882 |
, pJQueueNotifyExec |
883 |
, pJQueueLogMessages |
884 |
, pJQueueFail |
885 |
], |
886 |
[]) |
887 |
, ("OpTestDummy", |
888 |
[t| () |], |
889 |
OpDoc.opTestDummy, |
890 |
[ pTestDummyResult |
891 |
, pTestDummyMessages |
892 |
, pTestDummyFail |
893 |
, pTestDummySubmitJobs |
894 |
], |
895 |
[]) |
896 |
, ("OpNetworkAdd", |
897 |
[t| () |], |
898 |
OpDoc.opNetworkAdd, |
899 |
[ pNetworkName |
900 |
, pNetworkAddress4 |
901 |
, pNetworkGateway4 |
902 |
, pNetworkAddress6 |
903 |
, pNetworkGateway6 |
904 |
, pNetworkMacPrefix |
905 |
, pNetworkAddRsvdIps |
906 |
, pIpConflictsCheck |
907 |
, withDoc "Network tags" pInstTags |
908 |
], |
909 |
"network_name") |
910 |
, ("OpNetworkRemove", |
911 |
[t| () |], |
912 |
OpDoc.opNetworkRemove, |
913 |
[ pNetworkName |
914 |
, pForce |
915 |
], |
916 |
"network_name") |
917 |
, ("OpNetworkSetParams", |
918 |
[t| () |], |
919 |
OpDoc.opNetworkSetParams, |
920 |
[ pNetworkName |
921 |
, pNetworkGateway4 |
922 |
, pNetworkAddress6 |
923 |
, pNetworkGateway6 |
924 |
, pNetworkMacPrefix |
925 |
, withDoc "Which external IP addresses to reserve" pNetworkAddRsvdIps |
926 |
, pNetworkRemoveRsvdIps |
927 |
], |
928 |
"network_name") |
929 |
, ("OpNetworkConnect", |
930 |
[t| () |], |
931 |
OpDoc.opNetworkConnect, |
932 |
[ pGroupName |
933 |
, pNetworkName |
934 |
, pNetworkMode |
935 |
, pNetworkLink |
936 |
, pIpConflictsCheck |
937 |
], |
938 |
"network_name") |
939 |
, ("OpNetworkDisconnect", |
940 |
[t| () |], |
941 |
OpDoc.opNetworkDisconnect, |
942 |
[ pGroupName |
943 |
, pNetworkName |
944 |
], |
945 |
"network_name") |
946 |
, ("OpNetworkQuery", |
947 |
[t| [[JSValue]] |], |
948 |
OpDoc.opNetworkQuery, |
949 |
[ pOutputFields |
950 |
, pUseLocking |
951 |
, withDoc "Empty list to query all groups, group names otherwise" pNames |
952 |
], |
953 |
[]) |
954 |
]) |
955 |
|
956 |
-- | Returns the OP_ID for a given opcode value. |
957 |
$(genOpID ''OpCode "opID") |
958 |
|
959 |
-- | A list of all defined/supported opcode IDs. |
960 |
$(genAllOpIDs ''OpCode "allOpIDs") |
961 |
|
962 |
instance JSON OpCode where |
963 |
readJSON = loadOpCode |
964 |
showJSON = saveOpCode |
965 |
|
966 |
-- | Generates the summary value for an opcode. |
967 |
opSummaryVal :: OpCode -> Maybe String |
968 |
opSummaryVal OpClusterVerifyGroup { opGroupName = s } = Just (fromNonEmpty s) |
969 |
opSummaryVal OpGroupVerifyDisks { opGroupName = s } = Just (fromNonEmpty s) |
970 |
opSummaryVal OpClusterRename { opName = s } = Just (fromNonEmpty s) |
971 |
opSummaryVal OpQuery { opWhat = s } = Just (queryTypeOpToRaw s) |
972 |
opSummaryVal OpQueryFields { opWhat = s } = Just (queryTypeOpToRaw s) |
973 |
opSummaryVal OpNodeRemove { opNodeName = s } = Just (fromNonEmpty s) |
974 |
opSummaryVal OpNodeAdd { opNodeName = s } = Just (fromNonEmpty s) |
975 |
opSummaryVal OpNodeModifyStorage { opNodeName = s } = Just (fromNonEmpty s) |
976 |
opSummaryVal OpRepairNodeStorage { opNodeName = s } = Just (fromNonEmpty s) |
977 |
opSummaryVal OpNodeSetParams { opNodeName = s } = Just (fromNonEmpty s) |
978 |
opSummaryVal OpNodePowercycle { opNodeName = s } = Just (fromNonEmpty s) |
979 |
opSummaryVal OpNodeMigrate { opNodeName = s } = Just (fromNonEmpty s) |
980 |
opSummaryVal OpNodeEvacuate { opNodeName = s } = Just (fromNonEmpty s) |
981 |
opSummaryVal OpInstanceCreate { opInstanceName = s } = Just s |
982 |
opSummaryVal OpInstanceReinstall { opInstanceName = s } = Just s |
983 |
opSummaryVal OpInstanceRemove { opInstanceName = s } = Just s |
984 |
-- FIXME: instance rename should show both names; currently it shows none |
985 |
-- opSummaryVal OpInstanceRename { opInstanceName = s } = Just s |
986 |
opSummaryVal OpInstanceStartup { opInstanceName = s } = Just s |
987 |
opSummaryVal OpInstanceShutdown { opInstanceName = s } = Just s |
988 |
opSummaryVal OpInstanceReboot { opInstanceName = s } = Just s |
989 |
opSummaryVal OpInstanceReplaceDisks { opInstanceName = s } = Just s |
990 |
opSummaryVal OpInstanceFailover { opInstanceName = s } = Just s |
991 |
opSummaryVal OpInstanceMigrate { opInstanceName = s } = Just s |
992 |
opSummaryVal OpInstanceMove { opInstanceName = s } = Just s |
993 |
opSummaryVal OpInstanceConsole { opInstanceName = s } = Just s |
994 |
opSummaryVal OpInstanceActivateDisks { opInstanceName = s } = Just s |
995 |
opSummaryVal OpInstanceDeactivateDisks { opInstanceName = s } = Just s |
996 |
opSummaryVal OpInstanceRecreateDisks { opInstanceName = s } = Just s |
997 |
opSummaryVal OpInstanceSetParams { opInstanceName = s } = Just s |
998 |
opSummaryVal OpInstanceGrowDisk { opInstanceName = s } = Just s |
999 |
opSummaryVal OpInstanceChangeGroup { opInstanceName = s } = Just s |
1000 |
opSummaryVal OpGroupAdd { opGroupName = s } = Just (fromNonEmpty s) |
1001 |
opSummaryVal OpGroupAssignNodes { opGroupName = s } = Just (fromNonEmpty s) |
1002 |
opSummaryVal OpGroupSetParams { opGroupName = s } = Just (fromNonEmpty s) |
1003 |
opSummaryVal OpGroupRemove { opGroupName = s } = Just (fromNonEmpty s) |
1004 |
opSummaryVal OpGroupEvacuate { opGroupName = s } = Just (fromNonEmpty s) |
1005 |
opSummaryVal OpBackupPrepare { opInstanceName = s } = Just s |
1006 |
opSummaryVal OpBackupExport { opInstanceName = s } = Just s |
1007 |
opSummaryVal OpBackupRemove { opInstanceName = s } = Just s |
1008 |
opSummaryVal OpTagsGet { opKind = s } = Just (show s) |
1009 |
opSummaryVal OpTagsSearch { opTagSearchPattern = s } = Just (fromNonEmpty s) |
1010 |
opSummaryVal OpTestDelay { opDelayDuration = d } = Just (show d) |
1011 |
opSummaryVal OpTestAllocator { opIallocator = s } = |
1012 |
-- FIXME: Python doesn't handle None fields well, so we have behave the same |
1013 |
Just $ maybe "None" fromNonEmpty s |
1014 |
opSummaryVal OpNetworkAdd { opNetworkName = s} = Just (fromNonEmpty s) |
1015 |
opSummaryVal OpNetworkRemove { opNetworkName = s} = Just (fromNonEmpty s) |
1016 |
opSummaryVal OpNetworkSetParams { opNetworkName = s} = Just (fromNonEmpty s) |
1017 |
opSummaryVal OpNetworkConnect { opNetworkName = s} = Just (fromNonEmpty s) |
1018 |
opSummaryVal OpNetworkDisconnect { opNetworkName = s} = Just (fromNonEmpty s) |
1019 |
opSummaryVal _ = Nothing |
1020 |
|
1021 |
-- | Computes the summary of the opcode. |
1022 |
opSummary :: OpCode -> String |
1023 |
opSummary op = |
1024 |
case opSummaryVal op of |
1025 |
Nothing -> op_suffix |
1026 |
Just s -> op_suffix ++ "(" ++ s ++ ")" |
1027 |
where op_suffix = drop 3 $ opID op |
1028 |
|
1029 |
-- | Generic\/common opcode parameters. |
1030 |
$(buildObject "CommonOpParams" "op" |
1031 |
[ pDryRun |
1032 |
, pDebugLevel |
1033 |
, pOpPriority |
1034 |
, pDependencies |
1035 |
, pComment |
1036 |
, pReason |
1037 |
]) |
1038 |
|
1039 |
-- | Default common parameter values. |
1040 |
defOpParams :: CommonOpParams |
1041 |
defOpParams = |
1042 |
CommonOpParams { opDryRun = Nothing |
1043 |
, opDebugLevel = Nothing |
1044 |
, opPriority = OpPrioNormal |
1045 |
, opDepends = Nothing |
1046 |
, opComment = Nothing |
1047 |
, opReason = [] |
1048 |
} |
1049 |
|
1050 |
-- | The top-level opcode type. |
1051 |
data MetaOpCode = MetaOpCode { metaParams :: CommonOpParams |
1052 |
, metaOpCode :: OpCode |
1053 |
} deriving (Show, Eq) |
1054 |
|
1055 |
-- | JSON serialisation for 'MetaOpCode'. |
1056 |
showMeta :: MetaOpCode -> JSValue |
1057 |
showMeta (MetaOpCode params op) = |
1058 |
let objparams = toDictCommonOpParams params |
1059 |
objop = toDictOpCode op |
1060 |
in makeObj (objparams ++ objop) |
1061 |
|
1062 |
-- | JSON deserialisation for 'MetaOpCode' |
1063 |
readMeta :: JSValue -> Text.JSON.Result MetaOpCode |
1064 |
readMeta v = do |
1065 |
meta <- readJSON v |
1066 |
op <- readJSON v |
1067 |
return $ MetaOpCode meta op |
1068 |
|
1069 |
instance JSON MetaOpCode where |
1070 |
showJSON = showMeta |
1071 |
readJSON = readMeta |
1072 |
|
1073 |
-- | Wraps an 'OpCode' with the default parameters to build a |
1074 |
-- 'MetaOpCode'. |
1075 |
wrapOpCode :: OpCode -> MetaOpCode |
1076 |
wrapOpCode = MetaOpCode defOpParams |
1077 |
|
1078 |
-- | Sets the comment on a meta opcode. |
1079 |
setOpComment :: String -> MetaOpCode -> MetaOpCode |
1080 |
setOpComment comment (MetaOpCode common op) = |
1081 |
MetaOpCode (common { opComment = Just comment}) op |
1082 |
|
1083 |
-- | Sets the priority on a meta opcode. |
1084 |
setOpPriority :: OpSubmitPriority -> MetaOpCode -> MetaOpCode |
1085 |
setOpPriority prio (MetaOpCode common op) = |
1086 |
MetaOpCode (common { opPriority = prio }) op |