X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/dff8507840e35f6f59422dbb6fb0eab181dd817d..69b999879d380c6c8ea2e8871085ffe46a13779b:/lib/cli.py diff --git a/lib/cli.py b/lib/cli.py index 0f2fc9b..292cab0 100644 --- a/lib/cli.py +++ b/lib/cli.py @@ -25,7 +25,6 @@ import sys import textwrap import os.path -import copy import time import logging from cStringIO import StringIO @@ -42,21 +41,126 @@ from optparse import (OptionParser, TitledHelpFormatter, Option, OptionValueError) -__all__ = ["DEBUG_OPT", "NOHDR_OPT", "SEP_OPT", "GenericMain", - "SubmitOpCode", "GetClient", - "cli_option", - "GenerateTable", "AskUser", - "USEUNITS_OPT", "FIELDS_OPT", "FORCE_OPT", "SUBMIT_OPT", - "ListTags", "AddTags", "RemoveTags", "TAG_SRC_OPT", - "FormatError", "SplitNodeOption", "SubmitOrSend", - "JobSubmittedException", "FormatTimestamp", "ParseTimespec", - "ToStderr", "ToStdout", "UsesRPC", - "GetOnlineNodes", "JobExecutor", "SYNC_OPT", "CONFIRM_OPT", - "ArgJobId", "ArgSuggest", "ArgUnknown", "ArgFile", "ArgCommand", - "ArgInstance", "ArgNode", "ArgChoice", "ArgHost", - "ARGS_NONE", "ARGS_ONE_INSTANCE", "ARGS_ONE_NODE", - "ARGS_MANY_INSTANCES", "ARGS_MANY_NODES", - ] +__all__ = [ + # Command line options + "ALLOCATABLE_OPT", + "ALL_OPT", + "AUTO_REPLACE_OPT", + "BACKEND_OPT", + "CLEANUP_OPT", + "CONFIRM_OPT", + "CP_SIZE_OPT", + "DEBUG_OPT", + "DEBUG_SIMERR_OPT", + "DISKIDX_OPT", + "DISK_OPT", + "DISK_TEMPLATE_OPT", + "DRAINED_OPT", + "ENABLED_HV_OPT", + "ERROR_CODES_OPT", + "FIELDS_OPT", + "FILESTORE_DIR_OPT", + "FILESTORE_DRIVER_OPT", + "FORCE_OPT", + "FORCE_VARIANT_OPT", + "GLOBAL_FILEDIR_OPT", + "HVLIST_OPT", + "HVOPTS_OPT", + "HYPERVISOR_OPT", + "IALLOCATOR_OPT", + "IGNORE_CONSIST_OPT", + "IGNORE_FAILURES_OPT", + "IGNORE_SECONDARIES_OPT", + "IGNORE_SIZE_OPT", + "MAC_PREFIX_OPT", + "MASTER_NETDEV_OPT", + "MC_OPT", + "NET_OPT", + "NEW_SECONDARY_OPT", + "NIC_PARAMS_OPT", + "NODE_LIST_OPT", + "NODE_PLACEMENT_OPT", + "NOHDR_OPT", + "NOIPCHECK_OPT", + "NOLVM_STORAGE_OPT", + "NOMODIFY_ETCHOSTS_OPT", + "NONICS_OPT", + "NONLIVE_OPT", + "NONPLUS1_OPT", + "NOSHUTDOWN_OPT", + "NOSTART_OPT", + "NOSSH_KEYCHECK_OPT", + "NOVOTING_OPT", + "NWSYNC_OPT", + "ON_PRIMARY_OPT", + "ON_SECONDARY_OPT", + "OFFLINE_OPT", + "OS_OPT", + "OS_SIZE_OPT", + "READD_OPT", + "REBOOT_TYPE_OPT", + "SECONDARY_IP_OPT", + "SELECT_OS_OPT", + "SEP_OPT", + "SHOWCMD_OPT", + "SINGLE_NODE_OPT", + "SRC_DIR_OPT", + "SRC_NODE_OPT", + "SUBMIT_OPT", + "STATIC_OPT", + "SYNC_OPT", + "TAG_SRC_OPT", + "TIMEOUT_OPT", + "USEUNITS_OPT", + "VERBOSE_OPT", + "VG_NAME_OPT", + "YES_DOIT_OPT", + # Generic functions for CLI programs + "GenericMain", + "GenericInstanceCreate", + "GetClient", + "GetOnlineNodes", + "JobExecutor", + "JobSubmittedException", + "ParseTimespec", + "SubmitOpCode", + "SubmitOrSend", + "UsesRPC", + # Formatting functions + "ToStderr", "ToStdout", + "FormatError", + "GenerateTable", + "AskUser", + "FormatTimestamp", + # Tags functions + "ListTags", + "AddTags", + "RemoveTags", + # command line options support infrastructure + "ARGS_MANY_INSTANCES", + "ARGS_MANY_NODES", + "ARGS_NONE", + "ARGS_ONE_INSTANCE", + "ARGS_ONE_NODE", + "ArgChoice", + "ArgCommand", + "ArgFile", + "ArgHost", + "ArgInstance", + "ArgJobId", + "ArgNode", + "ArgSuggest", + "ArgUnknown", + "OPT_COMPL_INST_ADD_NODES", + "OPT_COMPL_MANY_NODES", + "OPT_COMPL_ONE_IALLOCATOR", + "OPT_COMPL_ONE_INSTANCE", + "OPT_COMPL_ONE_NODE", + "OPT_COMPL_ONE_OS", + "cli_option", + "SplitNodeOption", + "CalculateOSNames", + ] NO_PREFIX = "no_" UN_PREFIX = "-" @@ -144,6 +248,7 @@ ARGS_ONE_INSTANCE = [ArgInstance(min=1, max=1)] ARGS_ONE_NODE = [ArgNode(min=1, max=1)] + def _ExtractTagsObject(opts, args): """Extract the tag type object. @@ -330,6 +435,25 @@ def check_key_val(option, opt, value): return _SplitKeyVal(opt, value) +# completion_suggestion is normally a list. Using numeric values not evaluating +# to False for dynamic completion. +(OPT_COMPL_MANY_NODES, + OPT_COMPL_ONE_NODE, + OPT_COMPL_ONE_INSTANCE, + OPT_COMPL_ONE_OS, + OPT_COMPL_ONE_IALLOCATOR, + OPT_COMPL_INST_ADD_NODES) = range(100, 106) + +OPT_COMPL_ALL = frozenset([ + OPT_COMPL_MANY_NODES, + OPT_COMPL_ONE_NODE, + OPT_COMPL_ONE_INSTANCE, + OPT_COMPL_ONE_OS, + OPT_COMPL_ONE_IALLOCATOR, + OPT_COMPL_INST_ADD_NODES, + ]) + + class CliOption(Option): """Custom option class for optparse. @@ -352,6 +476,9 @@ class CliOption(Option): cli_option = CliOption +_YESNO = ("yes", "no") +_YORNO = "yes|no" + DEBUG_OPT = cli_option("-d", "--debug", default=False, action="store_true", help="Turn debugging on") @@ -398,6 +525,301 @@ _DRY_RUN_OPT = cli_option("--dry-run", default=False, " check steps and verify it it could be" " executed")) +VERBOSE_OPT = cli_option("-v", "--verbose", default=False, + action="store_true", + help="Increase the verbosity of the operation") + +DEBUG_SIMERR_OPT = cli_option("--debug-simulate-errors", default=False, + action="store_true", dest="simulate_errors", + help="Debugging option that makes the operation" + " treat most runtime checks as failed") + +NWSYNC_OPT = cli_option("--no-wait-for-sync", dest="wait_for_sync", + default=True, action="store_false", + help="Don't wait for sync (DANGEROUS!)") + +DISK_TEMPLATE_OPT = cli_option("-t", "--disk-template", dest="disk_template", + help="Custom disk setup (diskless, file," + " plain or drbd)", + default=None, metavar="TEMPL", + choices=list(constants.DISK_TEMPLATES)) + +NONICS_OPT = cli_option("--no-nics", default=False, action="store_true", + help="Do not create any network cards for" + " the instance") + +FILESTORE_DIR_OPT = cli_option("--file-storage-dir", dest="file_storage_dir", + help="Relative path under default cluster-wide" + " file storage dir to store file-based disks", + default=None, metavar="") + +FILESTORE_DRIVER_OPT = cli_option("--file-driver", dest="file_driver", + help="Driver to use for image files", + default="loop", metavar="", + choices=list(constants.FILE_DRIVER)) + +IALLOCATOR_OPT = cli_option("-I", "--iallocator", metavar="", + help="Select nodes for the instance automatically" + " using the iallocator plugin", + default=None, type="string", + completion_suggest=OPT_COMPL_ONE_IALLOCATOR) + +OS_OPT = cli_option("-o", "--os-type", dest="os", help="What OS to run", + metavar="", + completion_suggest=OPT_COMPL_ONE_OS) + +FORCE_VARIANT_OPT = cli_option("--force-variant", dest="force_variant", + action="store_true", default=False, + help="Force an unknown variant") + +BACKEND_OPT = cli_option("-B", "--backend-parameters", dest="beparams", + type="keyval", default={}, + help="Backend parameters") + +HVOPTS_OPT = cli_option("-H", "--hypervisor-parameters", type="keyval", + default={}, dest="hvparams", + help="Hypervisor parameters") + +HYPERVISOR_OPT = cli_option("-H", "--hypervisor-parameters", dest="hypervisor", + help="Hypervisor and hypervisor options, in the" + " format hypervisor:option=value,option=value,...", + default=None, type="identkeyval") + +HVLIST_OPT = cli_option("-H", "--hypervisor-parameters", dest="hvparams", + help="Hypervisor and hypervisor options, in the" + " format hypervisor:option=value,option=value,...", + default=[], action="append", type="identkeyval") + +NOIPCHECK_OPT = cli_option("--no-ip-check", dest="ip_check", default=True, + action="store_false", + help="Don't check that the instance's IP" + " is alive") + +NET_OPT = cli_option("--net", + help="NIC parameters", default=[], + dest="nics", action="append", type="identkeyval") + +DISK_OPT = cli_option("--disk", help="Disk parameters", default=[], + dest="disks", action="append", type="identkeyval") + +DISKIDX_OPT = cli_option("--disks", dest="disks", default=None, + help="Comma-separated list of disks" + " indices to act on (e.g. 0,2) (optional," + " defaults to all disks)") + +OS_SIZE_OPT = cli_option("-s", "--os-size", dest="sd_size", + help="Enforces a single-disk configuration using the" + " given disk size, in MiB unless a suffix is used", + default=None, type="unit", metavar="") + +IGNORE_CONSIST_OPT = cli_option("--ignore-consistency", + dest="ignore_consistency", + action="store_true", default=False, + help="Ignore the consistency of the disks on" + " the secondary") + +NONLIVE_OPT = cli_option("--non-live", dest="live", + default=True, action="store_false", + help="Do a non-live migration (this usually means" + " freeze the instance, save the state, transfer and" + " only then resume running on the secondary node)") + +NODE_PLACEMENT_OPT = cli_option("-n", "--node", dest="node", + help="Target node and optional secondary node", + metavar="[:]", + completion_suggest=OPT_COMPL_INST_ADD_NODES) + +NODE_LIST_OPT = cli_option("-n", "--node", dest="nodes", default=[], + action="append", metavar="", + help="Use only this node (can be used multiple" + " times, if not given defaults to all nodes)", + completion_suggest=OPT_COMPL_ONE_NODE) + +SINGLE_NODE_OPT = cli_option("-n", "--node", dest="node", help="Target node", + metavar="", + completion_suggest=OPT_COMPL_ONE_NODE) + +NOSTART_OPT = cli_option("--no-start", dest="start", default=True, + action="store_false", + help="Don't start the instance after creation") + +SHOWCMD_OPT = cli_option("--show-cmd", dest="show_command", + action="store_true", default=False, + help="Show command instead of executing it") + +CLEANUP_OPT = cli_option("--cleanup", dest="cleanup", + default=False, action="store_true", + help="Instead of performing the migration, try to" + " recover from a failed cleanup. This is safe" + " to run even if the instance is healthy, but it" + " will create extra replication traffic and " + " disrupt briefly the replication (like during the" + " migration") + +STATIC_OPT = cli_option("-s", "--static", dest="static", + action="store_true", default=False, + help="Only show configuration data, not runtime data") + +ALL_OPT = cli_option("--all", dest="show_all", + default=False, action="store_true", + help="Show info on all instances on the cluster." + " This can take a long time to run, use wisely") + +SELECT_OS_OPT = cli_option("--select-os", dest="select_os", + action="store_true", default=False, + help="Interactive OS reinstall, lists available" + " OS templates for selection") + +IGNORE_FAILURES_OPT = cli_option("--ignore-failures", dest="ignore_failures", + action="store_true", default=False, + help="Remove the instance from the cluster" + " configuration even if there are failures" + " during the removal process") + +NEW_SECONDARY_OPT = cli_option("-n", "--new-secondary", dest="dst_node", + help="Specifies the new secondary node", + metavar="NODE", default=None, + completion_suggest=OPT_COMPL_ONE_NODE) + +ON_PRIMARY_OPT = cli_option("-p", "--on-primary", dest="on_primary", + default=False, action="store_true", + help="Replace the disk(s) on the primary" + " node (only for the drbd template)") + +ON_SECONDARY_OPT = cli_option("-s", "--on-secondary", dest="on_secondary", + default=False, action="store_true", + help="Replace the disk(s) on the secondary" + " node (only for the drbd template)") + +AUTO_REPLACE_OPT = cli_option("-a", "--auto", dest="auto", + default=False, action="store_true", + help="Automatically replace faulty disks" + " (only for the drbd template)") + +IGNORE_SIZE_OPT = cli_option("--ignore-size", dest="ignore_size", + default=False, action="store_true", + help="Ignore current recorded size" + " (useful for forcing activation when" + " the recorded size is wrong)") + +SRC_NODE_OPT = cli_option("--src-node", dest="src_node", help="Source node", + metavar="", + completion_suggest=OPT_COMPL_ONE_NODE) + +SRC_DIR_OPT = cli_option("--src-dir", dest="src_dir", help="Source directory", + metavar="") + +SECONDARY_IP_OPT = cli_option("-s", "--secondary-ip", dest="secondary_ip", + help="Specify the secondary ip for the node", + metavar="ADDRESS", default=None) + +READD_OPT = cli_option("--readd", dest="readd", + default=False, action="store_true", + help="Readd old node after replacing it") + +NOSSH_KEYCHECK_OPT = cli_option("--no-ssh-key-check", dest="ssh_key_check", + default=True, action="store_false", + help="Disable SSH key fingerprint checking") + + +MC_OPT = cli_option("-C", "--master-candidate", dest="master_candidate", + choices=_YESNO, default=None, metavar=_YORNO, + help="Set the master_candidate flag on the node") + +OFFLINE_OPT = cli_option("-O", "--offline", dest="offline", metavar=_YORNO, + choices=_YESNO, default=None, + help="Set the offline flag on the node") + +DRAINED_OPT = cli_option("-D", "--drained", dest="drained", metavar=_YORNO, + choices=_YESNO, default=None, + help="Set the drained flag on the node") + +ALLOCATABLE_OPT = cli_option("--allocatable", dest="allocatable", + choices=_YESNO, default=None, metavar=_YORNO, + help="Set the allocatable flag on a volume") + +NOLVM_STORAGE_OPT = cli_option("--no-lvm-storage", dest="lvm_storage", + help="Disable support for lvm based instances" + " (cluster-wide)", + action="store_false", default=True) + +ENABLED_HV_OPT = cli_option("--enabled-hypervisors", + dest="enabled_hypervisors", + help="Comma-separated list of hypervisors", + type="string", default=None) + +NIC_PARAMS_OPT = cli_option("-N", "--nic-parameters", dest="nicparams", + type="keyval", default={}, + help="NIC parameters") + +CP_SIZE_OPT = cli_option("-C", "--candidate-pool-size", default=None, + dest="candidate_pool_size", type="int", + help="Set the candidate pool size") + +VG_NAME_OPT = cli_option("-g", "--vg-name", dest="vg_name", + help="Enables LVM and specifies the volume group" + " name (cluster-wide) for disk allocation [xenvg]", + metavar="VG", default=None) + +YES_DOIT_OPT = cli_option("--yes-do-it", dest="yes_do_it", + help="Destroy cluster", action="store_true") + +NOVOTING_OPT = cli_option("--no-voting", dest="no_voting", + help="Skip node agreement check (dangerous)", + action="store_true", default=False) + +MAC_PREFIX_OPT = cli_option("-m", "--mac-prefix", dest="mac_prefix", + help="Specify the mac prefix for the instance IP" + " addresses, in the format XX:XX:XX", + metavar="PREFIX", + default=None) + +MASTER_NETDEV_OPT = cli_option("--master-netdev", dest="master_netdev", + help="Specify the node interface (cluster-wide)" + " on which the master IP address will be added " + " [%s]" % constants.DEFAULT_BRIDGE, + metavar="NETDEV", + default=constants.DEFAULT_BRIDGE) + + +GLOBAL_FILEDIR_OPT = cli_option("--file-storage-dir", dest="file_storage_dir", + help="Specify the default directory (cluster-" + "wide) for storing the file-based disks [%s]" % + constants.DEFAULT_FILE_STORAGE_DIR, + metavar="DIR", + default=constants.DEFAULT_FILE_STORAGE_DIR) + +NOMODIFY_ETCHOSTS_OPT = cli_option("--no-etc-hosts", dest="modify_etc_hosts", + help="Don't modify /etc/hosts", + action="store_false", default=True) + +ERROR_CODES_OPT = cli_option("--error-codes", dest="error_codes", + help="Enable parseable error messages", + action="store_true", default=False) + +NONPLUS1_OPT = cli_option("--no-nplus1-mem", dest="skip_nplusone_mem", + help="Skip N+1 memory redundancy tests", + action="store_true", default=False) + +REBOOT_TYPE_OPT = cli_option("-t", "--type", dest="reboot_type", + help="Type of reboot: soft/hard/full", + default=constants.INSTANCE_REBOOT_HARD, + metavar="", + choices=list(constants.REBOOT_TYPES)) + +IGNORE_SECONDARIES_OPT = cli_option("--ignore-secondaries", + dest="ignore_secondaries", + default=False, action="store_true", + help="Ignore errors from secondaries") + +NOSHUTDOWN_OPT = cli_option("--noshutdown", dest="shutdown", + action="store_false", default=True, + help="Don't shutdown the instance (unsafe)") + +TIMEOUT_OPT = cli_option("--timeout", dest="timeout", type="int", + default=constants.DEFAULT_SHUTDOWN_TIMEOUT, + help="Maximum time to wait") + def _ParseArgs(argv, commands, aliases): """Parser for the command line arguments. @@ -464,7 +886,7 @@ def _ParseArgs(argv, commands, aliases): cmd = aliases[cmd] func, args_def, parser_opts, usage, description = commands[cmd] - parser = OptionParser(option_list=parser_opts + [_DRY_RUN_OPT], + parser = OptionParser(option_list=parser_opts + [_DRY_RUN_OPT, DEBUG_OPT], description=description, formatter=TitledHelpFormatter(), usage="%%prog %s %s" % (cmd, usage)) @@ -558,6 +980,23 @@ def SplitNodeOption(value): return (value, None) +def CalculateOSNames(os_name, os_variants): + """Calculates all the names an OS can be called, according to its variants. + + @type os_name: string + @param os_name: base name of the os + @type os_variants: list or None + @param os_variants: list of supported variants + @rtype: list + @return: list of valid names + + """ + if os_variants: + return ['%s+%s' % (os_name, v) for v in os_variants] + else: + return [os_name] + + def UsesRPC(fn): def wrapper(*args, **kwargs): rpc.Init() @@ -716,6 +1155,7 @@ def PollJob(job_id, cl=None, feedback_fn=None): if status == constants.OP_STATUS_SUCCESS: has_ok = True elif status == constants.OP_STATUS_ERROR: + errors.MaybeRaise(msg) if has_ok: raise errors.OpExecError("partial failure (opcode %d): %s" % (idx, msg)) @@ -910,6 +1350,116 @@ def GenericMain(commands, override=None, aliases=None): return result +def GenericInstanceCreate(mode, opts, args): + """Add an instance to the cluster via either creation or import. + + @param mode: constants.INSTANCE_CREATE or constants.INSTANCE_IMPORT + @param opts: the command line options selected by the user + @type args: list + @param args: should contain only one element, the new instance name + @rtype: int + @return: the desired exit code + + """ + instance = args[0] + + (pnode, snode) = SplitNodeOption(opts.node) + + hypervisor = None + hvparams = {} + if opts.hypervisor: + hypervisor, hvparams = opts.hypervisor + + if opts.nics: + try: + nic_max = max(int(nidx[0])+1 for nidx in opts.nics) + except ValueError, err: + raise errors.OpPrereqError("Invalid NIC index passed: %s" % str(err)) + nics = [{}] * nic_max + for nidx, ndict in opts.nics: + nidx = int(nidx) + if not isinstance(ndict, dict): + msg = "Invalid nic/%d value: expected dict, got %s" % (nidx, ndict) + raise errors.OpPrereqError(msg) + nics[nidx] = ndict + elif opts.no_nics: + # no nics + nics = [] + else: + # default of one nic, all auto + nics = [{}] + + if opts.disk_template == constants.DT_DISKLESS: + if opts.disks or opts.sd_size is not None: + raise errors.OpPrereqError("Diskless instance but disk" + " information passed") + disks = [] + else: + if not opts.disks and not opts.sd_size: + raise errors.OpPrereqError("No disk information specified") + if opts.disks and opts.sd_size is not None: + raise errors.OpPrereqError("Please use either the '--disk' or" + " '-s' option") + if opts.sd_size is not None: + opts.disks = [(0, {"size": opts.sd_size})] + try: + disk_max = max(int(didx[0])+1 for didx in opts.disks) + except ValueError, err: + raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err)) + disks = [{}] * disk_max + for didx, ddict in opts.disks: + didx = int(didx) + if not isinstance(ddict, dict): + msg = "Invalid disk/%d value: expected dict, got %s" % (didx, ddict) + raise errors.OpPrereqError(msg) + elif "size" not in ddict: + raise errors.OpPrereqError("Missing size for disk %d" % didx) + try: + ddict["size"] = utils.ParseUnit(ddict["size"]) + except ValueError, err: + raise errors.OpPrereqError("Invalid disk size for disk %d: %s" % + (didx, err)) + disks[didx] = ddict + + utils.ForceDictType(opts.beparams, constants.BES_PARAMETER_TYPES) + utils.ForceDictType(hvparams, constants.HVS_PARAMETER_TYPES) + + if mode == constants.INSTANCE_CREATE: + start = opts.start + os_type = opts.os + src_node = None + src_path = None + elif mode == constants.INSTANCE_IMPORT: + start = False + os_type = None + src_node = opts.src_node + src_path = opts.src_dir + else: + raise errors.ProgrammerError("Invalid creation mode %s" % mode) + + op = opcodes.OpCreateInstance(instance_name=instance, + disks=disks, + disk_template=opts.disk_template, + nics=nics, + pnode=pnode, snode=snode, + ip_check=opts.ip_check, + wait_for_sync=opts.wait_for_sync, + file_storage_dir=opts.file_storage_dir, + file_driver=opts.file_driver, + iallocator=opts.iallocator, + hypervisor=hypervisor, + hvparams=hvparams, + beparams=opts.beparams, + mode=mode, + start=start, + os_type=os_type, + src_node=src_node, + src_path=src_path) + + SubmitOrSend(op, opts) + return 0 + + def GenerateTable(headers, fields, separator, data, numfields=None, unitfields=None, units=None): @@ -1003,7 +1553,7 @@ def GenerateTable(headers, fields, separator, data, args = [] if line is None: line = ['-' for _ in fields] - for idx in xrange(len(fields)): + for idx in range(len(fields)): if separator is None: args.append(mlens[idx]) args.append(line[idx])