1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 """Module dealing with command line parsing"""
23
24
25 import sys
26 import textwrap
27 import os.path
28 import time
29 import logging
30 from cStringIO import StringIO
31
32 from ganeti import utils
33 from ganeti import errors
34 from ganeti import constants
35 from ganeti import opcodes
36 from ganeti import luxi
37 from ganeti import ssconf
38 from ganeti import rpc
39 from ganeti import ssh
40 from ganeti import compat
41 from ganeti import netutils
42
43 from optparse import (OptionParser, TitledHelpFormatter,
44 Option, OptionValueError)
45
46
47 __all__ = [
48
49 "ADD_UIDS_OPT",
50 "ALLOCATABLE_OPT",
51 "ALL_OPT",
52 "AUTO_PROMOTE_OPT",
53 "AUTO_REPLACE_OPT",
54 "BACKEND_OPT",
55 "BLK_OS_OPT",
56 "CLEANUP_OPT",
57 "CLUSTER_DOMAIN_SECRET_OPT",
58 "CONFIRM_OPT",
59 "CP_SIZE_OPT",
60 "DEBUG_OPT",
61 "DEBUG_SIMERR_OPT",
62 "DISKIDX_OPT",
63 "DISK_OPT",
64 "DISK_TEMPLATE_OPT",
65 "DRAINED_OPT",
66 "DRY_RUN_OPT",
67 "DRBD_HELPER_OPT",
68 "EARLY_RELEASE_OPT",
69 "ENABLED_HV_OPT",
70 "ERROR_CODES_OPT",
71 "FIELDS_OPT",
72 "FILESTORE_DIR_OPT",
73 "FILESTORE_DRIVER_OPT",
74 "FORCE_OPT",
75 "FORCE_VARIANT_OPT",
76 "GLOBAL_FILEDIR_OPT",
77 "HID_OS_OPT",
78 "HVLIST_OPT",
79 "HVOPTS_OPT",
80 "HYPERVISOR_OPT",
81 "IALLOCATOR_OPT",
82 "DEFAULT_IALLOCATOR_OPT",
83 "IDENTIFY_DEFAULTS_OPT",
84 "IGNORE_CONSIST_OPT",
85 "IGNORE_FAILURES_OPT",
86 "IGNORE_REMOVE_FAILURES_OPT",
87 "IGNORE_SECONDARIES_OPT",
88 "IGNORE_SIZE_OPT",
89 "INTERVAL_OPT",
90 "MAC_PREFIX_OPT",
91 "MAINTAIN_NODE_HEALTH_OPT",
92 "MASTER_NETDEV_OPT",
93 "MC_OPT",
94 "MIGRATION_MODE_OPT",
95 "NET_OPT",
96 "NEW_CLUSTER_CERT_OPT",
97 "NEW_CLUSTER_DOMAIN_SECRET_OPT",
98 "NEW_CONFD_HMAC_KEY_OPT",
99 "NEW_RAPI_CERT_OPT",
100 "NEW_SECONDARY_OPT",
101 "NIC_PARAMS_OPT",
102 "NODE_LIST_OPT",
103 "NODE_PLACEMENT_OPT",
104 "NODRBD_STORAGE_OPT",
105 "NOHDR_OPT",
106 "NOIPCHECK_OPT",
107 "NO_INSTALL_OPT",
108 "NONAMECHECK_OPT",
109 "NOLVM_STORAGE_OPT",
110 "NOMODIFY_ETCHOSTS_OPT",
111 "NOMODIFY_SSH_SETUP_OPT",
112 "NONICS_OPT",
113 "NONLIVE_OPT",
114 "NONPLUS1_OPT",
115 "NOSHUTDOWN_OPT",
116 "NOSTART_OPT",
117 "NOSSH_KEYCHECK_OPT",
118 "NOVOTING_OPT",
119 "NWSYNC_OPT",
120 "ON_PRIMARY_OPT",
121 "ON_SECONDARY_OPT",
122 "OFFLINE_OPT",
123 "OSPARAMS_OPT",
124 "OS_OPT",
125 "OS_SIZE_OPT",
126 "RAPI_CERT_OPT",
127 "READD_OPT",
128 "REBOOT_TYPE_OPT",
129 "REMOVE_INSTANCE_OPT",
130 "REMOVE_UIDS_OPT",
131 "RESERVED_LVS_OPT",
132 "ROMAN_OPT",
133 "SECONDARY_IP_OPT",
134 "SELECT_OS_OPT",
135 "SEP_OPT",
136 "SHOWCMD_OPT",
137 "SHUTDOWN_TIMEOUT_OPT",
138 "SINGLE_NODE_OPT",
139 "SRC_DIR_OPT",
140 "SRC_NODE_OPT",
141 "SUBMIT_OPT",
142 "STATIC_OPT",
143 "SYNC_OPT",
144 "TAG_SRC_OPT",
145 "TIMEOUT_OPT",
146 "UIDPOOL_OPT",
147 "USEUNITS_OPT",
148 "USE_REPL_NET_OPT",
149 "VERBOSE_OPT",
150 "VG_NAME_OPT",
151 "YES_DOIT_OPT",
152
153 "GenericMain",
154 "GenericInstanceCreate",
155 "GetClient",
156 "GetOnlineNodes",
157 "JobExecutor",
158 "JobSubmittedException",
159 "ParseTimespec",
160 "RunWhileClusterStopped",
161 "SubmitOpCode",
162 "SubmitOrSend",
163 "UsesRPC",
164
165 "ToStderr", "ToStdout",
166 "FormatError",
167 "GenerateTable",
168 "AskUser",
169 "FormatTimestamp",
170 "FormatLogMessage",
171
172 "ListTags",
173 "AddTags",
174 "RemoveTags",
175
176 "ARGS_MANY_INSTANCES",
177 "ARGS_MANY_NODES",
178 "ARGS_NONE",
179 "ARGS_ONE_INSTANCE",
180 "ARGS_ONE_NODE",
181 "ARGS_ONE_OS",
182 "ArgChoice",
183 "ArgCommand",
184 "ArgFile",
185 "ArgHost",
186 "ArgInstance",
187 "ArgJobId",
188 "ArgNode",
189 "ArgOs",
190 "ArgSuggest",
191 "ArgUnknown",
192 "OPT_COMPL_INST_ADD_NODES",
193 "OPT_COMPL_MANY_NODES",
194 "OPT_COMPL_ONE_IALLOCATOR",
195 "OPT_COMPL_ONE_INSTANCE",
196 "OPT_COMPL_ONE_NODE",
197 "OPT_COMPL_ONE_OS",
198 "cli_option",
199 "SplitNodeOption",
200 "CalculateOSNames",
201 "ParseFields",
202 ]
203
204 NO_PREFIX = "no_"
205 UN_PREFIX = "-"
206
207
210 self.min = min
211 self.max = max
212
214 return ("<%s min=%s max=%s>" %
215 (self.__class__.__name__, self.min, self.max))
216
217
219 """Suggesting argument.
220
221 Value can be any of the ones passed to the constructor.
222
223 """
224
225 - def __init__(self, min=0, max=None, choices=None):
228
230 return ("<%s min=%s max=%s choices=%r>" %
231 (self.__class__.__name__, self.min, self.max, self.choices))
232
233
235 """Choice argument.
236
237 Value can be any of the ones passed to the constructor. Like L{ArgSuggest},
238 but value must be one of the choices.
239
240 """
241
242
244 """Unknown argument to program (e.g. determined at runtime).
245
246 """
247
248
250 """Instances argument.
251
252 """
253
254
256 """Node argument.
257
258 """
259
261 """Job ID argument.
262
263 """
264
265
267 """File path argument.
268
269 """
270
271
273 """Command argument.
274
275 """
276
277
279 """Host argument.
280
281 """
282
283
285 """OS argument.
286
287 """
288
289
290 ARGS_NONE = []
291 ARGS_MANY_INSTANCES = [ArgInstance()]
292 ARGS_MANY_NODES = [ArgNode()]
293 ARGS_ONE_INSTANCE = [ArgInstance(min=1, max=1)]
294 ARGS_ONE_NODE = [ArgNode(min=1, max=1)]
295 ARGS_ONE_OS = [ArgOs(min=1, max=1)]
296
297
317
318
346
347
364
365
381
382
398
399
401 """OptParsers custom converter for units.
402
403 """
404 try:
405 return utils.ParseUnit(value)
406 except errors.UnitParseError, err:
407 raise OptionValueError("option %s: %s" % (opt, err))
408
409
411 """Convert a KeyVal string into a dict.
412
413 This function will convert a key=val[,...] string into a dict. Empty
414 values will be converted specially: keys which have the prefix 'no_'
415 will have the value=False and the prefix stripped, the others will
416 have value=True.
417
418 @type opt: string
419 @param opt: a string holding the option name for which we process the
420 data, used in building error messages
421 @type data: string
422 @param data: a string of the format key=val,key=val,...
423 @rtype: dict
424 @return: {key=val, key=val}
425 @raises errors.ParameterError: if there are duplicate keys
426
427 """
428 kv_dict = {}
429 if data:
430 for elem in utils.UnescapeAndSplit(data, sep=","):
431 if "=" in elem:
432 key, val = elem.split("=", 1)
433 else:
434 if elem.startswith(NO_PREFIX):
435 key, val = elem[len(NO_PREFIX):], False
436 elif elem.startswith(UN_PREFIX):
437 key, val = elem[len(UN_PREFIX):], None
438 else:
439 key, val = elem, True
440 if key in kv_dict:
441 raise errors.ParameterError("Duplicate key '%s' in option %s" %
442 (key, opt))
443 kv_dict[key] = val
444 return kv_dict
445
446
448 """Custom parser for ident:key=val,key=val options.
449
450 This will store the parsed values as a tuple (ident, {key: val}). As such,
451 multiple uses of this option via action=append is possible.
452
453 """
454 if ":" not in value:
455 ident, rest = value, ''
456 else:
457 ident, rest = value.split(":", 1)
458
459 if ident.startswith(NO_PREFIX):
460 if rest:
461 msg = "Cannot pass options when removing parameter groups: %s" % value
462 raise errors.ParameterError(msg)
463 retval = (ident[len(NO_PREFIX):], False)
464 elif ident.startswith(UN_PREFIX):
465 if rest:
466 msg = "Cannot pass options when removing parameter groups: %s" % value
467 raise errors.ParameterError(msg)
468 retval = (ident[len(UN_PREFIX):], None)
469 else:
470 kv_dict = _SplitKeyVal(opt, rest)
471 retval = (ident, kv_dict)
472 return retval
473
474
476 """Custom parser class for key=val,key=val options.
477
478 This will store the parsed values as a dict {key: val}.
479
480 """
481 return _SplitKeyVal(opt, value)
482
483
485 """Custom parser for yes/no options.
486
487 This will store the parsed value as either True or False.
488
489 """
490 value = value.lower()
491 if value == constants.VALUE_FALSE or value == "no":
492 return False
493 elif value == constants.VALUE_TRUE or value == "yes":
494 return True
495 else:
496 raise errors.ParameterError("Invalid boolean value '%s'" % value)
497
498
499
500
501 (OPT_COMPL_MANY_NODES,
502 OPT_COMPL_ONE_NODE,
503 OPT_COMPL_ONE_INSTANCE,
504 OPT_COMPL_ONE_OS,
505 OPT_COMPL_ONE_IALLOCATOR,
506 OPT_COMPL_INST_ADD_NODES) = range(100, 106)
507
508 OPT_COMPL_ALL = frozenset([
509 OPT_COMPL_MANY_NODES,
510 OPT_COMPL_ONE_NODE,
511 OPT_COMPL_ONE_INSTANCE,
512 OPT_COMPL_ONE_OS,
513 OPT_COMPL_ONE_IALLOCATOR,
514 OPT_COMPL_INST_ADD_NODES,
515 ])
516
517
536
537
538
539 cli_option = CliOption
540
541
542 _YORNO = "yes|no"
543
544 DEBUG_OPT = cli_option("-d", "--debug", default=0, action="count",
545 help="Increase debugging level")
546
547 NOHDR_OPT = cli_option("--no-headers", default=False,
548 action="store_true", dest="no_headers",
549 help="Don't display column headers")
550
551 SEP_OPT = cli_option("--separator", default=None,
552 action="store", dest="separator",
553 help=("Separator between output fields"
554 " (defaults to one space)"))
555
556 USEUNITS_OPT = cli_option("--units", default=None,
557 dest="units", choices=('h', 'm', 'g', 't'),
558 help="Specify units for output (one of hmgt)")
559
560 FIELDS_OPT = cli_option("-o", "--output", dest="output", action="store",
561 type="string", metavar="FIELDS",
562 help="Comma separated list of output fields")
563
564 FORCE_OPT = cli_option("-f", "--force", dest="force", action="store_true",
565 default=False, help="Force the operation")
566
567 CONFIRM_OPT = cli_option("--yes", dest="confirm", action="store_true",
568 default=False, help="Do not require confirmation")
569
570 TAG_SRC_OPT = cli_option("--from", dest="tags_source",
571 default=None, help="File with tag names")
572
573 SUBMIT_OPT = cli_option("--submit", dest="submit_only",
574 default=False, action="store_true",
575 help=("Submit the job and return the job ID, but"
576 " don't wait for the job to finish"))
577
578 SYNC_OPT = cli_option("--sync", dest="do_locking",
579 default=False, action="store_true",
580 help=("Grab locks while doing the queries"
581 " in order to ensure more consistent results"))
582
583 DRY_RUN_OPT = cli_option("--dry-run", default=False,
584 action="store_true",
585 help=("Do not execute the operation, just run the"
586 " check steps and verify it it could be"
587 " executed"))
588
589 VERBOSE_OPT = cli_option("-v", "--verbose", default=False,
590 action="store_true",
591 help="Increase the verbosity of the operation")
592
593 DEBUG_SIMERR_OPT = cli_option("--debug-simulate-errors", default=False,
594 action="store_true", dest="simulate_errors",
595 help="Debugging option that makes the operation"
596 " treat most runtime checks as failed")
597
598 NWSYNC_OPT = cli_option("--no-wait-for-sync", dest="wait_for_sync",
599 default=True, action="store_false",
600 help="Don't wait for sync (DANGEROUS!)")
601
602 DISK_TEMPLATE_OPT = cli_option("-t", "--disk-template", dest="disk_template",
603 help="Custom disk setup (diskless, file,"
604 " plain or drbd)",
605 default=None, metavar="TEMPL",
606 choices=list(constants.DISK_TEMPLATES))
607
608 NONICS_OPT = cli_option("--no-nics", default=False, action="store_true",
609 help="Do not create any network cards for"
610 " the instance")
611
612 FILESTORE_DIR_OPT = cli_option("--file-storage-dir", dest="file_storage_dir",
613 help="Relative path under default cluster-wide"
614 " file storage dir to store file-based disks",
615 default=None, metavar="<DIR>")
616
617 FILESTORE_DRIVER_OPT = cli_option("--file-driver", dest="file_driver",
618 help="Driver to use for image files",
619 default="loop", metavar="<DRIVER>",
620 choices=list(constants.FILE_DRIVER))
621
622 IALLOCATOR_OPT = cli_option("-I", "--iallocator", metavar="<NAME>",
623 help="Select nodes for the instance automatically"
624 " using the <NAME> iallocator plugin",
625 default=None, type="string",
626 completion_suggest=OPT_COMPL_ONE_IALLOCATOR)
627
628 DEFAULT_IALLOCATOR_OPT = cli_option("-I", "--default-iallocator",
629 metavar="<NAME>",
630 help="Set the default instance allocator plugin",
631 default=None, type="string",
632 completion_suggest=OPT_COMPL_ONE_IALLOCATOR)
633
634 OS_OPT = cli_option("-o", "--os-type", dest="os", help="What OS to run",
635 metavar="<os>",
636 completion_suggest=OPT_COMPL_ONE_OS)
637
638 OSPARAMS_OPT = cli_option("-O", "--os-parameters", dest="osparams",
639 type="keyval", default={},
640 help="OS parameters")
641
642 FORCE_VARIANT_OPT = cli_option("--force-variant", dest="force_variant",
643 action="store_true", default=False,
644 help="Force an unknown variant")
645
646 NO_INSTALL_OPT = cli_option("--no-install", dest="no_install",
647 action="store_true", default=False,
648 help="Do not install the OS (will"
649 " enable no-start)")
650
651 BACKEND_OPT = cli_option("-B", "--backend-parameters", dest="beparams",
652 type="keyval", default={},
653 help="Backend parameters")
654
655 HVOPTS_OPT = cli_option("-H", "--hypervisor-parameters", type="keyval",
656 default={}, dest="hvparams",
657 help="Hypervisor parameters")
658
659 HYPERVISOR_OPT = cli_option("-H", "--hypervisor-parameters", dest="hypervisor",
660 help="Hypervisor and hypervisor options, in the"
661 " format hypervisor:option=value,option=value,...",
662 default=None, type="identkeyval")
663
664 HVLIST_OPT = cli_option("-H", "--hypervisor-parameters", dest="hvparams",
665 help="Hypervisor and hypervisor options, in the"
666 " format hypervisor:option=value,option=value,...",
667 default=[], action="append", type="identkeyval")
668
669 NOIPCHECK_OPT = cli_option("--no-ip-check", dest="ip_check", default=True,
670 action="store_false",
671 help="Don't check that the instance's IP"
672 " is alive")
673
674 NONAMECHECK_OPT = cli_option("--no-name-check", dest="name_check",
675 default=True, action="store_false",
676 help="Don't check that the instance's name"
677 " is resolvable")
678
679 NET_OPT = cli_option("--net",
680 help="NIC parameters", default=[],
681 dest="nics", action="append", type="identkeyval")
682
683 DISK_OPT = cli_option("--disk", help="Disk parameters", default=[],
684 dest="disks", action="append", type="identkeyval")
685
686 DISKIDX_OPT = cli_option("--disks", dest="disks", default=None,
687 help="Comma-separated list of disks"
688 " indices to act on (e.g. 0,2) (optional,"
689 " defaults to all disks)")
690
691 OS_SIZE_OPT = cli_option("-s", "--os-size", dest="sd_size",
692 help="Enforces a single-disk configuration using the"
693 " given disk size, in MiB unless a suffix is used",
694 default=None, type="unit", metavar="<size>")
695
696 IGNORE_CONSIST_OPT = cli_option("--ignore-consistency",
697 dest="ignore_consistency",
698 action="store_true", default=False,
699 help="Ignore the consistency of the disks on"
700 " the secondary")
701
702 NONLIVE_OPT = cli_option("--non-live", dest="live",
703 default=True, action="store_false",
704 help="Do a non-live migration (this usually means"
705 " freeze the instance, save the state, transfer and"
706 " only then resume running on the secondary node)")
707
708 MIGRATION_MODE_OPT = cli_option("--migration-mode", dest="migration_mode",
709 default=None,
710 choices=list(constants.HT_MIGRATION_MODES),
711 help="Override default migration mode (choose"
712 " either live or non-live")
713
714 NODE_PLACEMENT_OPT = cli_option("-n", "--node", dest="node",
715 help="Target node and optional secondary node",
716 metavar="<pnode>[:<snode>]",
717 completion_suggest=OPT_COMPL_INST_ADD_NODES)
718
719 NODE_LIST_OPT = cli_option("-n", "--node", dest="nodes", default=[],
720 action="append", metavar="<node>",
721 help="Use only this node (can be used multiple"
722 " times, if not given defaults to all nodes)",
723 completion_suggest=OPT_COMPL_ONE_NODE)
724
725 SINGLE_NODE_OPT = cli_option("-n", "--node", dest="node", help="Target node",
726 metavar="<node>",
727 completion_suggest=OPT_COMPL_ONE_NODE)
728
729 NOSTART_OPT = cli_option("--no-start", dest="start", default=True,
730 action="store_false",
731 help="Don't start the instance after creation")
732
733 SHOWCMD_OPT = cli_option("--show-cmd", dest="show_command",
734 action="store_true", default=False,
735 help="Show command instead of executing it")
736
737 CLEANUP_OPT = cli_option("--cleanup", dest="cleanup",
738 default=False, action="store_true",
739 help="Instead of performing the migration, try to"
740 " recover from a failed cleanup. This is safe"
741 " to run even if the instance is healthy, but it"
742 " will create extra replication traffic and "
743 " disrupt briefly the replication (like during the"
744 " migration")
745
746 STATIC_OPT = cli_option("-s", "--static", dest="static",
747 action="store_true", default=False,
748 help="Only show configuration data, not runtime data")
749
750 ALL_OPT = cli_option("--all", dest="show_all",
751 default=False, action="store_true",
752 help="Show info on all instances on the cluster."
753 " This can take a long time to run, use wisely")
754
755 SELECT_OS_OPT = cli_option("--select-os", dest="select_os",
756 action="store_true", default=False,
757 help="Interactive OS reinstall, lists available"
758 " OS templates for selection")
759
760 IGNORE_FAILURES_OPT = cli_option("--ignore-failures", dest="ignore_failures",
761 action="store_true", default=False,
762 help="Remove the instance from the cluster"
763 " configuration even if there are failures"
764 " during the removal process")
765
766 IGNORE_REMOVE_FAILURES_OPT = cli_option("--ignore-remove-failures",
767 dest="ignore_remove_failures",
768 action="store_true", default=False,
769 help="Remove the instance from the"
770 " cluster configuration even if there"
771 " are failures during the removal"
772 " process")
773
774 REMOVE_INSTANCE_OPT = cli_option("--remove-instance", dest="remove_instance",
775 action="store_true", default=False,
776 help="Remove the instance from the cluster")
777
778 NEW_SECONDARY_OPT = cli_option("-n", "--new-secondary", dest="dst_node",
779 help="Specifies the new secondary node",
780 metavar="NODE", default=None,
781 completion_suggest=OPT_COMPL_ONE_NODE)
782
783 ON_PRIMARY_OPT = cli_option("-p", "--on-primary", dest="on_primary",
784 default=False, action="store_true",
785 help="Replace the disk(s) on the primary"
786 " node (only for the drbd template)")
787
788 ON_SECONDARY_OPT = cli_option("-s", "--on-secondary", dest="on_secondary",
789 default=False, action="store_true",
790 help="Replace the disk(s) on the secondary"
791 " node (only for the drbd template)")
792
793 AUTO_PROMOTE_OPT = cli_option("--auto-promote", dest="auto_promote",
794 default=False, action="store_true",
795 help="Lock all nodes and auto-promote as needed"
796 " to MC status")
797
798 AUTO_REPLACE_OPT = cli_option("-a", "--auto", dest="auto",
799 default=False, action="store_true",
800 help="Automatically replace faulty disks"
801 " (only for the drbd template)")
802
803 IGNORE_SIZE_OPT = cli_option("--ignore-size", dest="ignore_size",
804 default=False, action="store_true",
805 help="Ignore current recorded size"
806 " (useful for forcing activation when"
807 " the recorded size is wrong)")
808
809 SRC_NODE_OPT = cli_option("--src-node", dest="src_node", help="Source node",
810 metavar="<node>",
811 completion_suggest=OPT_COMPL_ONE_NODE)
812
813 SRC_DIR_OPT = cli_option("--src-dir", dest="src_dir", help="Source directory",
814 metavar="<dir>")
815
816 SECONDARY_IP_OPT = cli_option("-s", "--secondary-ip", dest="secondary_ip",
817 help="Specify the secondary ip for the node",
818 metavar="ADDRESS", default=None)
819
820 READD_OPT = cli_option("--readd", dest="readd",
821 default=False, action="store_true",
822 help="Readd old node after replacing it")
823
824 NOSSH_KEYCHECK_OPT = cli_option("--no-ssh-key-check", dest="ssh_key_check",
825 default=True, action="store_false",
826 help="Disable SSH key fingerprint checking")
827
828
829 MC_OPT = cli_option("-C", "--master-candidate", dest="master_candidate",
830 type="bool", default=None, metavar=_YORNO,
831 help="Set the master_candidate flag on the node")
832
833 OFFLINE_OPT = cli_option("-O", "--offline", dest="offline", metavar=_YORNO,
834 type="bool", default=None,
835 help="Set the offline flag on the node")
836
837 DRAINED_OPT = cli_option("-D", "--drained", dest="drained", metavar=_YORNO,
838 type="bool", default=None,
839 help="Set the drained flag on the node")
840
841 ALLOCATABLE_OPT = cli_option("--allocatable", dest="allocatable",
842 type="bool", default=None, metavar=_YORNO,
843 help="Set the allocatable flag on a volume")
844
845 NOLVM_STORAGE_OPT = cli_option("--no-lvm-storage", dest="lvm_storage",
846 help="Disable support for lvm based instances"
847 " (cluster-wide)",
848 action="store_false", default=True)
849
850 ENABLED_HV_OPT = cli_option("--enabled-hypervisors",
851 dest="enabled_hypervisors",
852 help="Comma-separated list of hypervisors",
853 type="string", default=None)
854
855 NIC_PARAMS_OPT = cli_option("-N", "--nic-parameters", dest="nicparams",
856 type="keyval", default={},
857 help="NIC parameters")
858
859 CP_SIZE_OPT = cli_option("-C", "--candidate-pool-size", default=None,
860 dest="candidate_pool_size", type="int",
861 help="Set the candidate pool size")
862
863 VG_NAME_OPT = cli_option("-g", "--vg-name", dest="vg_name",
864 help="Enables LVM and specifies the volume group"
865 " name (cluster-wide) for disk allocation [xenvg]",
866 metavar="VG", default=None)
867
868 YES_DOIT_OPT = cli_option("--yes-do-it", dest="yes_do_it",
869 help="Destroy cluster", action="store_true")
870
871 NOVOTING_OPT = cli_option("--no-voting", dest="no_voting",
872 help="Skip node agreement check (dangerous)",
873 action="store_true", default=False)
874
875 MAC_PREFIX_OPT = cli_option("-m", "--mac-prefix", dest="mac_prefix",
876 help="Specify the mac prefix for the instance IP"
877 " addresses, in the format XX:XX:XX",
878 metavar="PREFIX",
879 default=None)
880
881 MASTER_NETDEV_OPT = cli_option("--master-netdev", dest="master_netdev",
882 help="Specify the node interface (cluster-wide)"
883 " on which the master IP address will be added "
884 " [%s]" % constants.DEFAULT_BRIDGE,
885 metavar="NETDEV",
886 default=constants.DEFAULT_BRIDGE)
887
888 GLOBAL_FILEDIR_OPT = cli_option("--file-storage-dir", dest="file_storage_dir",
889 help="Specify the default directory (cluster-"
890 "wide) for storing the file-based disks [%s]" %
891 constants.DEFAULT_FILE_STORAGE_DIR,
892 metavar="DIR",
893 default=constants.DEFAULT_FILE_STORAGE_DIR)
894
895 NOMODIFY_ETCHOSTS_OPT = cli_option("--no-etc-hosts", dest="modify_etc_hosts",
896 help="Don't modify /etc/hosts",
897 action="store_false", default=True)
898
899 NOMODIFY_SSH_SETUP_OPT = cli_option("--no-ssh-init", dest="modify_ssh_setup",
900 help="Don't initialize SSH keys",
901 action="store_false", default=True)
902
903 ERROR_CODES_OPT = cli_option("--error-codes", dest="error_codes",
904 help="Enable parseable error messages",
905 action="store_true", default=False)
906
907 NONPLUS1_OPT = cli_option("--no-nplus1-mem", dest="skip_nplusone_mem",
908 help="Skip N+1 memory redundancy tests",
909 action="store_true", default=False)
910
911 REBOOT_TYPE_OPT = cli_option("-t", "--type", dest="reboot_type",
912 help="Type of reboot: soft/hard/full",
913 default=constants.INSTANCE_REBOOT_HARD,
914 metavar="<REBOOT>",
915 choices=list(constants.REBOOT_TYPES))
916
917 IGNORE_SECONDARIES_OPT = cli_option("--ignore-secondaries",
918 dest="ignore_secondaries",
919 default=False, action="store_true",
920 help="Ignore errors from secondaries")
921
922 NOSHUTDOWN_OPT = cli_option("--noshutdown", dest="shutdown",
923 action="store_false", default=True,
924 help="Don't shutdown the instance (unsafe)")
925
926 TIMEOUT_OPT = cli_option("--timeout", dest="timeout", type="int",
927 default=constants.DEFAULT_SHUTDOWN_TIMEOUT,
928 help="Maximum time to wait")
929
930 SHUTDOWN_TIMEOUT_OPT = cli_option("--shutdown-timeout",
931 dest="shutdown_timeout", type="int",
932 default=constants.DEFAULT_SHUTDOWN_TIMEOUT,
933 help="Maximum time to wait for instance shutdown")
934
935 INTERVAL_OPT = cli_option("--interval", dest="interval", type="int",
936 default=None,
937 help=("Number of seconds between repetions of the"
938 " command"))
939
940 EARLY_RELEASE_OPT = cli_option("--early-release",
941 dest="early_release", default=False,
942 action="store_true",
943 help="Release the locks on the secondary"
944 " node(s) early")
945
946 NEW_CLUSTER_CERT_OPT = cli_option("--new-cluster-certificate",
947 dest="new_cluster_cert",
948 default=False, action="store_true",
949 help="Generate a new cluster certificate")
950
951 RAPI_CERT_OPT = cli_option("--rapi-certificate", dest="rapi_cert",
952 default=None,
953 help="File containing new RAPI certificate")
954
955 NEW_RAPI_CERT_OPT = cli_option("--new-rapi-certificate", dest="new_rapi_cert",
956 default=None, action="store_true",
957 help=("Generate a new self-signed RAPI"
958 " certificate"))
959
960 NEW_CONFD_HMAC_KEY_OPT = cli_option("--new-confd-hmac-key",
961 dest="new_confd_hmac_key",
962 default=False, action="store_true",
963 help=("Create a new HMAC key for %s" %
964 constants.CONFD))
965
966 CLUSTER_DOMAIN_SECRET_OPT = cli_option("--cluster-domain-secret",
967 dest="cluster_domain_secret",
968 default=None,
969 help=("Load new new cluster domain"
970 " secret from file"))
971
972 NEW_CLUSTER_DOMAIN_SECRET_OPT = cli_option("--new-cluster-domain-secret",
973 dest="new_cluster_domain_secret",
974 default=False, action="store_true",
975 help=("Create a new cluster domain"
976 " secret"))
977
978 USE_REPL_NET_OPT = cli_option("--use-replication-network",
979 dest="use_replication_network",
980 help="Whether to use the replication network"
981 " for talking to the nodes",
982 action="store_true", default=False)
983
984 MAINTAIN_NODE_HEALTH_OPT = \
985 cli_option("--maintain-node-health", dest="maintain_node_health",
986 metavar=_YORNO, default=None, type="bool",
987 help="Configure the cluster to automatically maintain node"
988 " health, by shutting down unknown instances, shutting down"
989 " unknown DRBD devices, etc.")
990
991 IDENTIFY_DEFAULTS_OPT = \
992 cli_option("--identify-defaults", dest="identify_defaults",
993 default=False, action="store_true",
994 help="Identify which saved instance parameters are equal to"
995 " the current cluster defaults and set them as such, instead"
996 " of marking them as overridden")
997
998 UIDPOOL_OPT = cli_option("--uid-pool", default=None,
999 action="store", dest="uid_pool",
1000 help=("A list of user-ids or user-id"
1001 " ranges separated by commas"))
1002
1003 ADD_UIDS_OPT = cli_option("--add-uids", default=None,
1004 action="store", dest="add_uids",
1005 help=("A list of user-ids or user-id"
1006 " ranges separated by commas, to be"
1007 " added to the user-id pool"))
1008
1009 REMOVE_UIDS_OPT = cli_option("--remove-uids", default=None,
1010 action="store", dest="remove_uids",
1011 help=("A list of user-ids or user-id"
1012 " ranges separated by commas, to be"
1013 " removed from the user-id pool"))
1014
1015 RESERVED_LVS_OPT = cli_option("--reserved-lvs", default=None,
1016 action="store", dest="reserved_lvs",
1017 help=("A comma-separated list of reserved"
1018 " logical volumes names, that will be"
1019 " ignored by cluster verify"))
1020
1021 ROMAN_OPT = cli_option("--roman",
1022 dest="roman_integers", default=False,
1023 action="store_true",
1024 help="Use roman numbers for positive integers")
1025
1026 DRBD_HELPER_OPT = cli_option("--drbd-usermode-helper", dest="drbd_helper",
1027 action="store", default=None,
1028 help="Specifies usermode helper for DRBD")
1029
1030 NODRBD_STORAGE_OPT = cli_option("--no-drbd-storage", dest="drbd_storage",
1031 action="store_false", default=True,
1032 help="Disable support for DRBD")
1033
1034 HID_OS_OPT = cli_option("--hidden", dest="hidden",
1035 type="bool", default=None, metavar=_YORNO,
1036 help="Sets the hidden flag on the OS")
1037
1038 BLK_OS_OPT = cli_option("--blacklisted", dest="blacklisted",
1039 type="bool", default=None, metavar=_YORNO,
1040 help="Sets the blacklisted flag on the OS")
1041
1042
1043
1044 COMMON_OPTS = [DEBUG_OPT]
1045
1046
1048 """Parser for the command line arguments.
1049
1050 This function parses the arguments and returns the function which
1051 must be executed together with its (modified) arguments.
1052
1053 @param argv: the command line
1054 @param commands: dictionary with special contents, see the design
1055 doc for cmdline handling
1056 @param aliases: dictionary with command aliases {'alias': 'target, ...}
1057
1058 """
1059 if len(argv) == 0:
1060 binary = "<command>"
1061 else:
1062 binary = argv[0].split("/")[-1]
1063
1064 if len(argv) > 1 and argv[1] == "--version":
1065 ToStdout("%s (ganeti %s) %s", binary, constants.VCS_VERSION,
1066 constants.RELEASE_VERSION)
1067
1068
1069 sys.exit(0)
1070
1071 if len(argv) < 2 or not (argv[1] in commands or
1072 argv[1] in aliases):
1073
1074 sortedcmds = commands.keys()
1075 sortedcmds.sort()
1076
1077 ToStdout("Usage: %s {command} [options...] [argument...]", binary)
1078 ToStdout("%s <command> --help to see details, or man %s", binary, binary)
1079 ToStdout("")
1080
1081
1082 mlen = max([len(" %s" % cmd) for cmd in commands])
1083 mlen = min(60, mlen)
1084
1085
1086 ToStdout("Commands:")
1087 for cmd in sortedcmds:
1088 cmdstr = " %s" % (cmd,)
1089 help_text = commands[cmd][4]
1090 help_lines = textwrap.wrap(help_text, 79 - 3 - mlen)
1091 ToStdout("%-*s - %s", mlen, cmdstr, help_lines.pop(0))
1092 for line in help_lines:
1093 ToStdout("%-*s %s", mlen, "", line)
1094
1095 ToStdout("")
1096
1097 return None, None, None
1098
1099
1100 cmd = argv.pop(1)
1101 if cmd in aliases:
1102 if cmd in commands:
1103 raise errors.ProgrammerError("Alias '%s' overrides an existing"
1104 " command" % cmd)
1105
1106 if aliases[cmd] not in commands:
1107 raise errors.ProgrammerError("Alias '%s' maps to non-existing"
1108 " command '%s'" % (cmd, aliases[cmd]))
1109
1110 cmd = aliases[cmd]
1111
1112 func, args_def, parser_opts, usage, description = commands[cmd]
1113 parser = OptionParser(option_list=parser_opts + COMMON_OPTS,
1114 description=description,
1115 formatter=TitledHelpFormatter(),
1116 usage="%%prog %s %s" % (cmd, usage))
1117 parser.disable_interspersed_args()
1118 options, args = parser.parse_args()
1119
1120 if not _CheckArguments(cmd, args_def, args):
1121 return None, None, None
1122
1123 return func, options, args
1124
1125
1127 """Verifies the arguments using the argument definition.
1128
1129 Algorithm:
1130
1131 1. Abort with error if values specified by user but none expected.
1132
1133 1. For each argument in definition
1134
1135 1. Keep running count of minimum number of values (min_count)
1136 1. Keep running count of maximum number of values (max_count)
1137 1. If it has an unlimited number of values
1138
1139 1. Abort with error if it's not the last argument in the definition
1140
1141 1. If last argument has limited number of values
1142
1143 1. Abort with error if number of values doesn't match or is too large
1144
1145 1. Abort with error if user didn't pass enough values (min_count)
1146
1147 """
1148 if args and not args_def:
1149 ToStderr("Error: Command %s expects no arguments", cmd)
1150 return False
1151
1152 min_count = None
1153 max_count = None
1154 check_max = None
1155
1156 last_idx = len(args_def) - 1
1157
1158 for idx, arg in enumerate(args_def):
1159 if min_count is None:
1160 min_count = arg.min
1161 elif arg.min is not None:
1162 min_count += arg.min
1163
1164 if max_count is None:
1165 max_count = arg.max
1166 elif arg.max is not None:
1167 max_count += arg.max
1168
1169 if idx == last_idx:
1170 check_max = (arg.max is not None)
1171
1172 elif arg.max is None:
1173 raise errors.ProgrammerError("Only the last argument can have max=None")
1174
1175 if check_max:
1176
1177 if (min_count is not None and max_count is not None and
1178 min_count == max_count and len(args) != min_count):
1179 ToStderr("Error: Command %s expects %d argument(s)", cmd, min_count)
1180 return False
1181
1182
1183 if max_count is not None and len(args) > max_count:
1184 ToStderr("Error: Command %s expects only %d argument(s)",
1185 cmd, max_count)
1186 return False
1187
1188
1189 if min_count is not None and len(args) < min_count:
1190 ToStderr("Error: Command %s expects at least %d argument(s)",
1191 cmd, min_count)
1192 return False
1193
1194 return True
1195
1196
1198 """Splits the value of a --node option.
1199
1200 """
1201 if value and ':' in value:
1202 return value.split(':', 1)
1203 else:
1204 return (value, None)
1205
1206
1208 """Calculates all the names an OS can be called, according to its variants.
1209
1210 @type os_name: string
1211 @param os_name: base name of the os
1212 @type os_variants: list or None
1213 @param os_variants: list of supported variants
1214 @rtype: list
1215 @return: list of valid names
1216
1217 """
1218 if os_variants:
1219 return ['%s+%s' % (os_name, v) for v in os_variants]
1220 else:
1221 return [os_name]
1222
1223
1225 """Parses the values of "--field"-like options.
1226
1227 @type selected: string or None
1228 @param selected: User-selected options
1229 @type default: list
1230 @param default: Default fields
1231
1232 """
1233 if selected is None:
1234 return default
1235
1236 if selected.startswith("+"):
1237 return default + selected[1:].split(",")
1238
1239 return selected.split(",")
1240
1241
1242 UsesRPC = rpc.RunWithRPC
1243
1244
1246 """Ask the user a question.
1247
1248 @param text: the question to ask
1249
1250 @param choices: list with elements tuples (input_char, return_value,
1251 description); if not given, it will default to: [('y', True,
1252 'Perform the operation'), ('n', False, 'Do no do the operation')];
1253 note that the '?' char is reserved for help
1254
1255 @return: one of the return values from the choices list; if input is
1256 not possible (i.e. not running with a tty, we return the last
1257 entry from the list
1258
1259 """
1260 if choices is None:
1261 choices = [('y', True, 'Perform the operation'),
1262 ('n', False, 'Do not perform the operation')]
1263 if not choices or not isinstance(choices, list):
1264 raise errors.ProgrammerError("Invalid choices argument to AskUser")
1265 for entry in choices:
1266 if not isinstance(entry, tuple) or len(entry) < 3 or entry[0] == '?':
1267 raise errors.ProgrammerError("Invalid choices element to AskUser")
1268
1269 answer = choices[-1][1]
1270 new_text = []
1271 for line in text.splitlines():
1272 new_text.append(textwrap.fill(line, 70, replace_whitespace=False))
1273 text = "\n".join(new_text)
1274 try:
1275 f = file("/dev/tty", "a+")
1276 except IOError:
1277 return answer
1278 try:
1279 chars = [entry[0] for entry in choices]
1280 chars[-1] = "[%s]" % chars[-1]
1281 chars.append('?')
1282 maps = dict([(entry[0], entry[1]) for entry in choices])
1283 while True:
1284 f.write(text)
1285 f.write('\n')
1286 f.write("/".join(chars))
1287 f.write(": ")
1288 line = f.readline(2).strip().lower()
1289 if line in maps:
1290 answer = maps[line]
1291 break
1292 elif line == '?':
1293 for entry in choices:
1294 f.write(" %s - %s\n" % (entry[0], entry[2]))
1295 f.write("\n")
1296 continue
1297 finally:
1298 f.close()
1299 return answer
1300
1301
1303 """Job was submitted, client should exit.
1304
1305 This exception has one argument, the ID of the job that was
1306 submitted. The handler should print this ID.
1307
1308 This is not an error, just a structured way to exit from clients.
1309
1310 """
1311
1312
1314 """Function to submit an opcode without waiting for the results.
1315
1316 @type ops: list
1317 @param ops: list of opcodes
1318 @type cl: luxi.Client
1319 @param cl: the luxi client to use for communicating with the master;
1320 if None, a new client will be created
1321
1322 """
1323 if cl is None:
1324 cl = GetClient()
1325
1326 job_id = cl.SubmitJob(ops)
1327
1328 return job_id
1329
1330
1332 """Generic job-polling function.
1333
1334 @type job_id: number
1335 @param job_id: Job ID
1336 @type cbs: Instance of L{JobPollCbBase}
1337 @param cbs: Data callbacks
1338 @type report_cbs: Instance of L{JobPollReportCbBase}
1339 @param report_cbs: Reporting callbacks
1340
1341 """
1342 prev_job_info = None
1343 prev_logmsg_serial = None
1344
1345 status = None
1346
1347 while True:
1348 result = cbs.WaitForJobChangeOnce(job_id, ["status"], prev_job_info,
1349 prev_logmsg_serial)
1350 if not result:
1351
1352 raise errors.JobLost("Job with id %s lost" % job_id)
1353
1354 if result == constants.JOB_NOTCHANGED:
1355 report_cbs.ReportNotChanged(job_id, status)
1356
1357
1358 continue
1359
1360
1361 (job_info, log_entries) = result
1362 (status, ) = job_info
1363
1364 if log_entries:
1365 for log_entry in log_entries:
1366 (serial, timestamp, log_type, message) = log_entry
1367 report_cbs.ReportLogMessage(job_id, serial, timestamp,
1368 log_type, message)
1369 prev_logmsg_serial = max(prev_logmsg_serial, serial)
1370
1371
1372 elif status in (constants.JOB_STATUS_SUCCESS,
1373 constants.JOB_STATUS_ERROR,
1374 constants.JOB_STATUS_CANCELING,
1375 constants.JOB_STATUS_CANCELED):
1376 break
1377
1378 prev_job_info = job_info
1379
1380 jobs = cbs.QueryJobs([job_id], ["status", "opstatus", "opresult"])
1381 if not jobs:
1382 raise errors.JobLost("Job with id %s lost" % job_id)
1383
1384 status, opstatus, result = jobs[0]
1385
1386 if status == constants.JOB_STATUS_SUCCESS:
1387 return result
1388
1389 if status in (constants.JOB_STATUS_CANCELING, constants.JOB_STATUS_CANCELED):
1390 raise errors.OpExecError("Job was canceled")
1391
1392 has_ok = False
1393 for idx, (status, msg) in enumerate(zip(opstatus, result)):
1394 if status == constants.OP_STATUS_SUCCESS:
1395 has_ok = True
1396 elif status == constants.OP_STATUS_ERROR:
1397 errors.MaybeRaise(msg)
1398
1399 if has_ok:
1400 raise errors.OpExecError("partial failure (opcode %d): %s" %
1401 (idx, msg))
1402
1403 raise errors.OpExecError(str(msg))
1404
1405
1406 raise errors.OpExecError(result)
1407
1408
1410 """Base class for L{GenericPollJob} callbacks.
1411
1412 """
1414 """Initializes this class.
1415
1416 """
1417
1420 """Waits for changes on a job.
1421
1422 """
1423 raise NotImplementedError()
1424
1426 """Returns the selected fields for the selected job IDs.
1427
1428 @type job_ids: list of numbers
1429 @param job_ids: Job IDs
1430 @type fields: list of strings
1431 @param fields: Fields
1432
1433 """
1434 raise NotImplementedError()
1435
1436
1438 """Base class for L{GenericPollJob} reporting callbacks.
1439
1440 """
1442 """Initializes this class.
1443
1444 """
1445
1447 """Handles a log message.
1448
1449 """
1450 raise NotImplementedError()
1451
1453 """Called for if a job hasn't changed in a while.
1454
1455 @type job_id: number
1456 @param job_id: Job ID
1457 @type status: string or None
1458 @param status: Job status if available
1459
1460 """
1461 raise NotImplementedError()
1462
1463
1471
1474 """Waits for changes on a job.
1475
1476 """
1477 return self.cl.WaitForJobChangeOnce(job_id, fields,
1478 prev_job_info, prev_log_serial)
1479
1481 """Returns the selected fields for the selected job IDs.
1482
1483 """
1484 return self.cl.QueryJobs(job_ids, fields)
1485
1486
1489 """Initializes this class.
1490
1491 """
1492 JobPollReportCbBase.__init__(self)
1493
1494 self.feedback_fn = feedback_fn
1495
1496 assert callable(feedback_fn)
1497
1499 """Handles a log message.
1500
1501 """
1502 self.feedback_fn((timestamp, log_type, log_msg))
1503
1505 """Called if a job hasn't changed in a while.
1506
1507 """
1513 """Initializes this class.
1514
1515 """
1516 JobPollReportCbBase.__init__(self)
1517
1518 self.notified_queued = False
1519 self.notified_waitlock = False
1520
1527
1529 """Called if a job hasn't changed in a while.
1530
1531 """
1532 if status is None:
1533 return
1534
1535 if status == constants.JOB_STATUS_QUEUED and not self.notified_queued:
1536 ToStderr("Job %s is waiting in queue", job_id)
1537 self.notified_queued = True
1538
1539 elif status == constants.JOB_STATUS_WAITLOCK and not self.notified_waitlock:
1540 ToStderr("Job %s is trying to acquire all necessary locks", job_id)
1541 self.notified_waitlock = True
1554 -def PollJob(job_id, cl=None, feedback_fn=None, reporter=None):
1555 """Function to poll for the result of a job.
1556
1557 @type job_id: job identified
1558 @param job_id: the job to poll for results
1559 @type cl: luxi.Client
1560 @param cl: the luxi client to use for communicating with the master;
1561 if None, a new client will be created
1562
1563 """
1564 if cl is None:
1565 cl = GetClient()
1566
1567 if reporter is None:
1568 if feedback_fn:
1569 reporter = FeedbackFnJobPollReportCb(feedback_fn)
1570 else:
1571 reporter = StdioJobPollReportCb()
1572 elif feedback_fn:
1573 raise errors.ProgrammerError("Can't specify reporter and feedback function")
1574
1575 return GenericPollJob(job_id, _LuxiJobPollCb(cl), reporter)
1576
1577
1578 -def SubmitOpCode(op, cl=None, feedback_fn=None, opts=None, reporter=None):
1579 """Legacy function to submit an opcode.
1580
1581 This is just a simple wrapper over the construction of the processor
1582 instance. It should be extended to better handle feedback and
1583 interaction functions.
1584
1585 """
1586 if cl is None:
1587 cl = GetClient()
1588
1589 SetGenericOpcodeOpts([op], opts)
1590
1591 job_id = SendJob([op], cl=cl)
1592
1593 op_results = PollJob(job_id, cl=cl, feedback_fn=feedback_fn,
1594 reporter=reporter)
1595
1596 return op_results[0]
1597
1598
1600 """Wrapper around SubmitOpCode or SendJob.
1601
1602 This function will decide, based on the 'opts' parameter, whether to
1603 submit and wait for the result of the opcode (and return it), or
1604 whether to just send the job and print its identifier. It is used in
1605 order to simplify the implementation of the '--submit' option.
1606
1607 It will also process the opcodes if we're sending the via SendJob
1608 (otherwise SubmitOpCode does it).
1609
1610 """
1611 if opts and opts.submit_only:
1612 job = [op]
1613 SetGenericOpcodeOpts(job, opts)
1614 job_id = SendJob(job, cl=cl)
1615 raise JobSubmittedException(job_id)
1616 else:
1617 return SubmitOpCode(op, cl=cl, feedback_fn=feedback_fn, opts=opts)
1618
1619
1621 """Processor for generic options.
1622
1623 This function updates the given opcodes based on generic command
1624 line options (like debug, dry-run, etc.).
1625
1626 @param opcode_list: list of opcodes
1627 @param options: command line options or None
1628 @return: None (in-place modification)
1629
1630 """
1631 if not options:
1632 return
1633 for op in opcode_list:
1634 if hasattr(options, "dry_run"):
1635 op.dry_run = options.dry_run
1636 op.debug_level = options.debug
1637
1638
1660
1661
1742
1743
1744 -def GenericMain(commands, override=None, aliases=None):
1745 """Generic main function for all the gnt-* commands.
1746
1747 Arguments:
1748 - commands: a dictionary with a special structure, see the design doc
1749 for command line handling.
1750 - override: if not None, we expect a dictionary with keys that will
1751 override command line options; this can be used to pass
1752 options from the scripts to generic functions
1753 - aliases: dictionary with command aliases {'alias': 'target, ...}
1754
1755 """
1756
1757 if sys.argv:
1758 binary = os.path.basename(sys.argv[0]) or sys.argv[0]
1759 if len(sys.argv) >= 2:
1760 binary += " " + sys.argv[1]
1761 old_cmdline = " ".join(sys.argv[2:])
1762 else:
1763 old_cmdline = ""
1764 else:
1765 binary = "<unknown program>"
1766 old_cmdline = ""
1767
1768 if aliases is None:
1769 aliases = {}
1770
1771 try:
1772 func, options, args = _ParseArgs(sys.argv, commands, aliases)
1773 except errors.ParameterError, err:
1774 result, err_msg = FormatError(err)
1775 ToStderr(err_msg)
1776 return 1
1777
1778 if func is None:
1779 return 1
1780
1781 if override is not None:
1782 for key, val in override.iteritems():
1783 setattr(options, key, val)
1784
1785 utils.SetupLogging(constants.LOG_COMMANDS, debug=options.debug,
1786 stderr_logging=True, program=binary)
1787
1788 if old_cmdline:
1789 logging.info("run with arguments '%s'", old_cmdline)
1790 else:
1791 logging.info("run with no arguments")
1792
1793 try:
1794 result = func(options, args)
1795 except (errors.GenericError, luxi.ProtocolError,
1796 JobSubmittedException), err:
1797 result, err_msg = FormatError(err)
1798 logging.exception("Error during command processing")
1799 ToStderr(err_msg)
1800
1801 return result
1802
1803
1805 """Parses the value of the --net option(s).
1806
1807 """
1808 try:
1809 nic_max = max(int(nidx[0]) + 1 for nidx in optvalue)
1810 except (TypeError, ValueError), err:
1811 raise errors.OpPrereqError("Invalid NIC index passed: %s" % str(err))
1812
1813 nics = [{}] * nic_max
1814 for nidx, ndict in optvalue:
1815 nidx = int(nidx)
1816
1817 if not isinstance(ndict, dict):
1818 raise errors.OpPrereqError("Invalid nic/%d value: expected dict,"
1819 " got %s" % (nidx, ndict))
1820
1821 utils.ForceDictType(ndict, constants.INIC_PARAMS_TYPES)
1822
1823 nics[nidx] = ndict
1824
1825 return nics
1826
1827
1829 """Add an instance to the cluster via either creation or import.
1830
1831 @param mode: constants.INSTANCE_CREATE or constants.INSTANCE_IMPORT
1832 @param opts: the command line options selected by the user
1833 @type args: list
1834 @param args: should contain only one element, the new instance name
1835 @rtype: int
1836 @return: the desired exit code
1837
1838 """
1839 instance = args[0]
1840
1841 (pnode, snode) = SplitNodeOption(opts.node)
1842
1843 hypervisor = None
1844 hvparams = {}
1845 if opts.hypervisor:
1846 hypervisor, hvparams = opts.hypervisor
1847
1848 if opts.nics:
1849 nics = ParseNicOption(opts.nics)
1850 elif opts.no_nics:
1851
1852 nics = []
1853 elif mode == constants.INSTANCE_CREATE:
1854
1855 nics = [{}]
1856 else:
1857
1858 nics = []
1859
1860 if opts.disk_template == constants.DT_DISKLESS:
1861 if opts.disks or opts.sd_size is not None:
1862 raise errors.OpPrereqError("Diskless instance but disk"
1863 " information passed")
1864 disks = []
1865 else:
1866 if (not opts.disks and not opts.sd_size
1867 and mode == constants.INSTANCE_CREATE):
1868 raise errors.OpPrereqError("No disk information specified")
1869 if opts.disks and opts.sd_size is not None:
1870 raise errors.OpPrereqError("Please use either the '--disk' or"
1871 " '-s' option")
1872 if opts.sd_size is not None:
1873 opts.disks = [(0, {"size": opts.sd_size})]
1874
1875 if opts.disks:
1876 try:
1877 disk_max = max(int(didx[0]) + 1 for didx in opts.disks)
1878 except ValueError, err:
1879 raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err))
1880 disks = [{}] * disk_max
1881 else:
1882 disks = []
1883 for didx, ddict in opts.disks:
1884 didx = int(didx)
1885 if not isinstance(ddict, dict):
1886 msg = "Invalid disk/%d value: expected dict, got %s" % (didx, ddict)
1887 raise errors.OpPrereqError(msg)
1888 elif "size" in ddict:
1889 if "adopt" in ddict:
1890 raise errors.OpPrereqError("Only one of 'size' and 'adopt' allowed"
1891 " (disk %d)" % didx)
1892 try:
1893 ddict["size"] = utils.ParseUnit(ddict["size"])
1894 except ValueError, err:
1895 raise errors.OpPrereqError("Invalid disk size for disk %d: %s" %
1896 (didx, err))
1897 elif "adopt" in ddict:
1898 if mode == constants.INSTANCE_IMPORT:
1899 raise errors.OpPrereqError("Disk adoption not allowed for instance"
1900 " import")
1901 ddict["size"] = 0
1902 else:
1903 raise errors.OpPrereqError("Missing size or adoption source for"
1904 " disk %d" % didx)
1905 disks[didx] = ddict
1906
1907 utils.ForceDictType(opts.beparams, constants.BES_PARAMETER_TYPES)
1908 utils.ForceDictType(hvparams, constants.HVS_PARAMETER_TYPES)
1909
1910 if mode == constants.INSTANCE_CREATE:
1911 start = opts.start
1912 os_type = opts.os
1913 force_variant = opts.force_variant
1914 src_node = None
1915 src_path = None
1916 no_install = opts.no_install
1917 identify_defaults = False
1918 elif mode == constants.INSTANCE_IMPORT:
1919 start = False
1920 os_type = None
1921 force_variant = False
1922 src_node = opts.src_node
1923 src_path = opts.src_dir
1924 no_install = None
1925 identify_defaults = opts.identify_defaults
1926 else:
1927 raise errors.ProgrammerError("Invalid creation mode %s" % mode)
1928
1929 op = opcodes.OpCreateInstance(instance_name=instance,
1930 disks=disks,
1931 disk_template=opts.disk_template,
1932 nics=nics,
1933 pnode=pnode, snode=snode,
1934 ip_check=opts.ip_check,
1935 name_check=opts.name_check,
1936 wait_for_sync=opts.wait_for_sync,
1937 file_storage_dir=opts.file_storage_dir,
1938 file_driver=opts.file_driver,
1939 iallocator=opts.iallocator,
1940 hypervisor=hypervisor,
1941 hvparams=hvparams,
1942 beparams=opts.beparams,
1943 osparams=opts.osparams,
1944 mode=mode,
1945 start=start,
1946 os_type=os_type,
1947 force_variant=force_variant,
1948 src_node=src_node,
1949 src_path=src_path,
1950 no_install=no_install,
1951 identify_defaults=identify_defaults)
1952
1953 SubmitOrSend(op, opts)
1954 return 0
1955
1956
1958 """Helper class for L{RunWhileClusterStopped} to simplify state management
1959
1960 """
1961 - def __init__(self, feedback_fn, cluster_name, master_node, online_nodes):
1962 """Initializes this class.
1963
1964 @type feedback_fn: callable
1965 @param feedback_fn: Feedback function
1966 @type cluster_name: string
1967 @param cluster_name: Cluster name
1968 @type master_node: string
1969 @param master_node Master node name
1970 @type online_nodes: list
1971 @param online_nodes: List of names of online nodes
1972
1973 """
1974 self.feedback_fn = feedback_fn
1975 self.cluster_name = cluster_name
1976 self.master_node = master_node
1977 self.online_nodes = online_nodes
1978
1979 self.ssh = ssh.SshRunner(self.cluster_name)
1980
1981 self.nonmaster_nodes = [name for name in online_nodes
1982 if name != master_node]
1983
1984 assert self.master_node not in self.nonmaster_nodes
1985
1986 - def _RunCmd(self, node_name, cmd):
1987 """Runs a command on the local or a remote machine.
1988
1989 @type node_name: string
1990 @param node_name: Machine name
1991 @type cmd: list
1992 @param cmd: Command
1993
1994 """
1995 if node_name is None or node_name == self.master_node:
1996
1997 result = utils.RunCmd(cmd)
1998 else:
1999 result = self.ssh.Run(node_name, "root", utils.ShellQuoteArgs(cmd))
2000
2001 if result.failed:
2002 errmsg = ["Failed to run command %s" % result.cmd]
2003 if node_name:
2004 errmsg.append("on node %s" % node_name)
2005 errmsg.append(": exitcode %s and error %s" %
2006 (result.exit_code, result.output))
2007 raise errors.OpExecError(" ".join(errmsg))
2008
2009 - def Call(self, fn, *args):
2010 """Call function while all daemons are stopped.
2011
2012 @type fn: callable
2013 @param fn: Function to be called
2014
2015 """
2016
2017 self.feedback_fn("Blocking watcher")
2018 watcher_block = utils.FileLock.Open(constants.WATCHER_STATEFILE)
2019 try:
2020
2021
2022 watcher_block.Exclusive(blocking=True)
2023
2024
2025
2026 self.feedback_fn("Stopping master daemons")
2027 self._RunCmd(None, [constants.DAEMON_UTIL, "stop-master"])
2028 try:
2029
2030 for node_name in self.online_nodes:
2031 self.feedback_fn("Stopping daemons on %s" % node_name)
2032 self._RunCmd(node_name, [constants.DAEMON_UTIL, "stop-all"])
2033
2034
2035 try:
2036 return fn(self, *args)
2037 except Exception, err:
2038 _, errmsg = FormatError(err)
2039 logging.exception("Caught exception")
2040 self.feedback_fn(errmsg)
2041 raise
2042 finally:
2043
2044 for node_name in self.nonmaster_nodes + [self.master_node]:
2045 self.feedback_fn("Starting daemons on %s" % node_name)
2046 self._RunCmd(node_name, [constants.DAEMON_UTIL, "start-all"])
2047 finally:
2048
2049 watcher_block.Close()
2050
2051
2053 """Calls a function while all cluster daemons are stopped.
2054
2055 @type feedback_fn: callable
2056 @param feedback_fn: Feedback function
2057 @type fn: callable
2058 @param fn: Function to be called when daemons are stopped
2059
2060 """
2061 feedback_fn("Gathering cluster information")
2062
2063
2064 cl = GetClient()
2065
2066 (cluster_name, master_node) = \
2067 cl.QueryConfigValues(["cluster_name", "master_node"])
2068
2069 online_nodes = GetOnlineNodes([], cl=cl)
2070
2071
2072 del cl
2073
2074 assert master_node in online_nodes
2075
2076 return _RunWhileClusterStoppedHelper(feedback_fn, cluster_name, master_node,
2077 online_nodes).Call(fn, *args)
2078
2079
2080 -def GenerateTable(headers, fields, separator, data,
2081 numfields=None, unitfields=None,
2082 units=None):
2083 """Prints a table with headers and different fields.
2084
2085 @type headers: dict
2086 @param headers: dictionary mapping field names to headers for
2087 the table
2088 @type fields: list
2089 @param fields: the field names corresponding to each row in
2090 the data field
2091 @param separator: the separator to be used; if this is None,
2092 the default 'smart' algorithm is used which computes optimal
2093 field width, otherwise just the separator is used between
2094 each field
2095 @type data: list
2096 @param data: a list of lists, each sublist being one row to be output
2097 @type numfields: list
2098 @param numfields: a list with the fields that hold numeric
2099 values and thus should be right-aligned
2100 @type unitfields: list
2101 @param unitfields: a list with the fields that hold numeric
2102 values that should be formatted with the units field
2103 @type units: string or None
2104 @param units: the units we should use for formatting, or None for
2105 automatic choice (human-readable for non-separator usage, otherwise
2106 megabytes); this is a one-letter string
2107
2108 """
2109 if units is None:
2110 if separator:
2111 units = "m"
2112 else:
2113 units = "h"
2114
2115 if numfields is None:
2116 numfields = []
2117 if unitfields is None:
2118 unitfields = []
2119
2120 numfields = utils.FieldSet(*numfields)
2121 unitfields = utils.FieldSet(*unitfields)
2122
2123 format_fields = []
2124 for field in fields:
2125 if headers and field not in headers:
2126
2127
2128
2129 headers[field] = field
2130 if separator is not None:
2131 format_fields.append("%s")
2132 elif numfields.Matches(field):
2133 format_fields.append("%*s")
2134 else:
2135 format_fields.append("%-*s")
2136
2137 if separator is None:
2138 mlens = [0 for name in fields]
2139 format_str = ' '.join(format_fields)
2140 else:
2141 format_str = separator.replace("%", "%%").join(format_fields)
2142
2143 for row in data:
2144 if row is None:
2145 continue
2146 for idx, val in enumerate(row):
2147 if unitfields.Matches(fields[idx]):
2148 try:
2149 val = int(val)
2150 except (TypeError, ValueError):
2151 pass
2152 else:
2153 val = row[idx] = utils.FormatUnit(val, units)
2154 val = row[idx] = str(val)
2155 if separator is None:
2156 mlens[idx] = max(mlens[idx], len(val))
2157
2158 result = []
2159 if headers:
2160 args = []
2161 for idx, name in enumerate(fields):
2162 hdr = headers[name]
2163 if separator is None:
2164 mlens[idx] = max(mlens[idx], len(hdr))
2165 args.append(mlens[idx])
2166 args.append(hdr)
2167 result.append(format_str % tuple(args))
2168
2169 if separator is None:
2170 assert len(mlens) == len(fields)
2171
2172 if fields and not numfields.Matches(fields[-1]):
2173 mlens[-1] = 0
2174
2175 for line in data:
2176 args = []
2177 if line is None:
2178 line = ['-' for _ in fields]
2179 for idx in range(len(fields)):
2180 if separator is None:
2181 args.append(mlens[idx])
2182 args.append(line[idx])
2183 result.append(format_str % tuple(args))
2184
2185 return result
2186
2187
2202
2203
2205 """Parse a time specification.
2206
2207 The following suffixed will be recognized:
2208
2209 - s: seconds
2210 - m: minutes
2211 - h: hours
2212 - d: day
2213 - w: weeks
2214
2215 Without any suffix, the value will be taken to be in seconds.
2216
2217 """
2218 value = str(value)
2219 if not value:
2220 raise errors.OpPrereqError("Empty time specification passed")
2221 suffix_map = {
2222 's': 1,
2223 'm': 60,
2224 'h': 3600,
2225 'd': 86400,
2226 'w': 604800,
2227 }
2228 if value[-1] not in suffix_map:
2229 try:
2230 value = int(value)
2231 except (TypeError, ValueError):
2232 raise errors.OpPrereqError("Invalid time specification '%s'" % value)
2233 else:
2234 multiplier = suffix_map[value[-1]]
2235 value = value[:-1]
2236 if not value:
2237 raise errors.OpPrereqError("Invalid time specification (only"
2238 " suffix passed)")
2239 try:
2240 value = int(value) * multiplier
2241 except (TypeError, ValueError):
2242 raise errors.OpPrereqError("Invalid time specification '%s'" % value)
2243 return value
2244
2245
2246 -def GetOnlineNodes(nodes, cl=None, nowarn=False, secondary_ips=False,
2247 filter_master=False):
2248 """Returns the names of online nodes.
2249
2250 This function will also log a warning on stderr with the names of
2251 the online nodes.
2252
2253 @param nodes: if not empty, use only this subset of nodes (minus the
2254 offline ones)
2255 @param cl: if not None, luxi client to use
2256 @type nowarn: boolean
2257 @param nowarn: by default, this function will output a note with the
2258 offline nodes that are skipped; if this parameter is True the
2259 note is not displayed
2260 @type secondary_ips: boolean
2261 @param secondary_ips: if True, return the secondary IPs instead of the
2262 names, useful for doing network traffic over the replication interface
2263 (if any)
2264 @type filter_master: boolean
2265 @param filter_master: if True, do not return the master node in the list
2266 (useful in coordination with secondary_ips where we cannot check our
2267 node name against the list)
2268
2269 """
2270 if cl is None:
2271 cl = GetClient()
2272
2273 if secondary_ips:
2274 name_idx = 2
2275 else:
2276 name_idx = 0
2277
2278 if filter_master:
2279 master_node = cl.QueryConfigValues(["master_node"])[0]
2280 filter_fn = lambda x: x != master_node
2281 else:
2282 filter_fn = lambda _: True
2283
2284 result = cl.QueryNodes(names=nodes, fields=["name", "offline", "sip"],
2285 use_locking=False)
2286 offline = [row[0] for row in result if row[1]]
2287 if offline and not nowarn:
2288 ToStderr("Note: skipping offline node(s): %s" % utils.CommaJoin(offline))
2289 return [row[name_idx] for row in result if not row[1] and filter_fn(row[0])]
2290
2291
2293 """Write a message to a stream, bypassing the logging system
2294
2295 @type stream: file object
2296 @param stream: the file to which we should write
2297 @type txt: str
2298 @param txt: the message
2299
2300 """
2301 if args:
2302 args = tuple(args)
2303 stream.write(txt % args)
2304 else:
2305 stream.write(txt)
2306 stream.write('\n')
2307 stream.flush()
2308
2309
2311 """Write a message to stdout only, bypassing the logging system
2312
2313 This is just a wrapper over _ToStream.
2314
2315 @type txt: str
2316 @param txt: the message
2317
2318 """
2319 _ToStream(sys.stdout, txt, *args)
2320
2321
2323 """Write a message to stderr only, bypassing the logging system
2324
2325 This is just a wrapper over _ToStream.
2326
2327 @type txt: str
2328 @param txt: the message
2329
2330 """
2331 _ToStream(sys.stderr, txt, *args)
2332
2333
2335 """Class which manages the submission and execution of multiple jobs.
2336
2337 Note that instances of this class should not be reused between
2338 GetResults() calls.
2339
2340 """
2341 - def __init__(self, cl=None, verbose=True, opts=None, feedback_fn=None):
2342 self.queue = []
2343 if cl is None:
2344 cl = GetClient()
2345 self.cl = cl
2346 self.verbose = verbose
2347 self.jobs = []
2348 self.opts = opts
2349 self.feedback_fn = feedback_fn
2350
2352 """Record a job for later submit.
2353
2354 @type name: string
2355 @param name: a description of the job, will be used in WaitJobSet
2356 """
2357 SetGenericOpcodeOpts(ops, self.opts)
2358 self.queue.append((name, ops))
2359
2361 """Submit all pending jobs.
2362
2363 """
2364 if each:
2365 results = []
2366 for row in self.queue:
2367
2368
2369 results.append([True, self.cl.SubmitJob(row[1])])
2370 else:
2371 results = self.cl.SubmitManyJobs([row[1] for row in self.queue])
2372 for (idx, ((status, data), (name, _))) in enumerate(zip(results,
2373 self.queue)):
2374 self.jobs.append((idx, status, data, name))
2375
2377 """Choose a non-waiting/queued job to poll next.
2378
2379 """
2380 assert self.jobs, "_ChooseJob called with empty job list"
2381
2382 result = self.cl.QueryJobs([i[2] for i in self.jobs], ["status"])
2383 assert result
2384
2385 for job_data, status in zip(self.jobs, result):
2386 if (isinstance(status, list) and status and
2387 status[0] in (constants.JOB_STATUS_QUEUED,
2388 constants.JOB_STATUS_WAITLOCK,
2389 constants.JOB_STATUS_CANCELING)):
2390
2391 continue
2392
2393 self.jobs.remove(job_data)
2394 return job_data
2395
2396
2397 return self.jobs.pop(0)
2398
2400 """Wait for and return the results of all jobs.
2401
2402 @rtype: list
2403 @return: list of tuples (success, job results), in the same order
2404 as the submitted jobs; if a job has failed, instead of the result
2405 there will be the error message
2406
2407 """
2408 if not self.jobs:
2409 self.SubmitPending()
2410 results = []
2411 if self.verbose:
2412 ok_jobs = [row[2] for row in self.jobs if row[1]]
2413 if ok_jobs:
2414 ToStdout("Submitted jobs %s", utils.CommaJoin(ok_jobs))
2415
2416
2417 self.jobs, failures = compat.partition(self.jobs, lambda x: x[1])
2418 for idx, _, jid, name in failures:
2419 ToStderr("Failed to submit job for %s: %s", name, jid)
2420 results.append((idx, False, jid))
2421
2422 while self.jobs:
2423 (idx, _, jid, name) = self._ChooseJob()
2424 ToStdout("Waiting for job %s for %s...", jid, name)
2425 try:
2426 job_result = PollJob(jid, cl=self.cl, feedback_fn=self.feedback_fn)
2427 success = True
2428 except errors.JobLost, err:
2429 _, job_result = FormatError(err)
2430 ToStderr("Job %s for %s has been archived, cannot check its result",
2431 jid, name)
2432 success = False
2433 except (errors.GenericError, luxi.ProtocolError), err:
2434 _, job_result = FormatError(err)
2435 success = False
2436
2437 ToStderr("Job %s for %s has failed: %s", jid, name, job_result)
2438
2439 results.append((idx, success, job_result))
2440
2441
2442 results.sort()
2443 results = [i[1:] for i in results]
2444
2445 return results
2446
2448 """Wait for job results or only print the job IDs.
2449
2450 @type wait: boolean
2451 @param wait: whether to wait or not
2452
2453 """
2454 if wait:
2455 return self.GetResults()
2456 else:
2457 if not self.jobs:
2458 self.SubmitPending()
2459 for _, status, result, name in self.jobs:
2460 if status:
2461 ToStdout("%s: %s", result, name)
2462 else:
2463 ToStderr("Failure for %s: %s", name, result)
2464 return [row[1:3] for row in self.jobs]
2465