4 # Copyright (C) 2006, 2007 Google Inc.
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 # pylint: disable-msg=W0401,W0614
23 # W0401: Wildcard import ganeti.cli
24 # W0614: Unused import %s from wildcard import (since we need cli)
30 from optparse import make_option
31 from cStringIO import StringIO
33 from ganeti.cli import *
34 from ganeti import cli
35 from ganeti import opcodes
36 from ganeti import constants
37 from ganeti import utils
38 from ganeti import errors
41 _SHUTDOWN_CLUSTER = "cluster"
42 _SHUTDOWN_NODES_BOTH = "nodes"
43 _SHUTDOWN_NODES_PRI = "nodes-pri"
44 _SHUTDOWN_NODES_SEC = "nodes-sec"
45 _SHUTDOWN_INSTANCES = "instances"
50 #: default list of options for L{ListInstances}
52 "name", "hypervisor", "os", "pnode", "status", "oper_ram",
56 def _ExpandMultiNames(mode, names, client=None):
57 """Expand the given names using the passed mode.
59 For _SHUTDOWN_CLUSTER, all instances will be returned. For
60 _SHUTDOWN_NODES_PRI/SEC, all instances having those nodes as
61 primary/secondary will be returned. For _SHUTDOWN_NODES_BOTH, all
62 instances having those nodes as either primary or secondary will be
63 returned. For _SHUTDOWN_INSTANCES, the given instances will be
66 @param mode: one of L{_SHUTDOWN_CLUSTER}, L{_SHUTDOWN_NODES_BOTH},
67 L{_SHUTDOWN_NODES_PRI}, L{_SHUTDOWN_NODES_SEC} or
68 L{_SHUTDOWN_INSTANCES}
69 @param names: a list of names; for cluster, it must be empty,
70 and for node and instance it must be a list of valid item
71 names (short names are valid as usual, e.g. node1 instead of
74 @return: the list of names after the expansion
75 @raise errors.ProgrammerError: for unknown selection type
76 @raise errors.OpPrereqError: for invalid input parameters
81 if mode == _SHUTDOWN_CLUSTER:
83 raise errors.OpPrereqError("Cluster filter mode takes no arguments")
84 idata = client.QueryInstances([], ["name"], False)
85 inames = [row[0] for row in idata]
87 elif mode in (_SHUTDOWN_NODES_BOTH,
91 raise errors.OpPrereqError("No node names passed")
92 ndata = client.QueryNodes(names, ["name", "pinst_list", "sinst_list"],
94 ipri = [row[1] for row in ndata]
95 pri_names = list(itertools.chain(*ipri))
96 isec = [row[2] for row in ndata]
97 sec_names = list(itertools.chain(*isec))
98 if mode == _SHUTDOWN_NODES_BOTH:
99 inames = pri_names + sec_names
100 elif mode == _SHUTDOWN_NODES_PRI:
102 elif mode == _SHUTDOWN_NODES_SEC:
105 raise errors.ProgrammerError("Unhandled shutdown type")
107 elif mode == _SHUTDOWN_INSTANCES:
109 raise errors.OpPrereqError("No instance names passed")
110 idata = client.QueryInstances(names, ["name"], False)
111 inames = [row[0] for row in idata]
114 raise errors.OpPrereqError("Unknown mode '%s'" % mode)
119 def _ConfirmOperation(inames, text):
120 """Ask the user to confirm an operation on a list of instances.
122 This function is used to request confirmation for doing an operation
123 on a given list of instances.
126 @param inames: the list of names that we display when
127 we ask for confirmation
129 @param text: the operation that the user should confirm
130 (e.g. I{shutdown} or I{startup})
132 @return: True or False depending on user's confirmation.
136 msg = ("The %s will operate on %d instances.\n"
137 "Do you want to continue?" % (text, count))
138 affected = ("\nAffected instances:\n" +
139 "\n".join([" %s" % name for name in inames]))
141 choices = [('y', True, 'Yes, execute the %s' % text),
142 ('n', False, 'No, abort the %s' % text)]
145 choices.insert(1, ('v', 'v', 'View the list of affected instances'))
150 choice = AskUser(ask, choices)
153 choice = AskUser(msg + affected, choices)
157 def _EnsureInstancesExist(client, names):
158 """Check for and ensure the given instance names exist.
160 This function will raise an OpPrereqError in case they don't
161 exist. Otherwise it will exit cleanly.
163 @type client: L{luxi.Client}
164 @param client: the client to use for the query
166 @param names: the list of instance names to query
167 @raise errors.OpPrereqError: in case any instance is missing
170 # TODO: change LUQueryInstances to that it actually returns None
171 # instead of raising an exception, or devise a better mechanism
172 result = client.QueryInstances(names, ["name"], False)
173 for orig_name, row in zip(names, result):
175 raise errors.OpPrereqError("Instance '%s' does not exist" % orig_name)
178 def ListInstances(opts, args):
179 """List instances and their properties.
181 @param opts: the command line options selected by the user
183 @param args: should be an empty list
185 @return: the desired exit code
188 if opts.output is None:
189 selected_fields = _LIST_DEF_FIELDS
190 elif opts.output.startswith("+"):
191 selected_fields = _LIST_DEF_FIELDS + opts.output[1:].split(",")
193 selected_fields = opts.output.split(",")
195 output = GetClient().QueryInstances(args, selected_fields, opts.do_locking)
197 if not opts.no_headers:
199 "name": "Instance", "os": "OS", "pnode": "Primary_node",
200 "snodes": "Secondary_Nodes", "admin_state": "Autostart",
201 "oper_state": "Running",
202 "oper_ram": "Memory", "disk_template": "Disk_template",
203 "ip": "IP_address", "mac": "MAC_address",
205 "sda_size": "Disk/0", "sdb_size": "Disk/1",
206 "disk_usage": "DiskUsage",
207 "status": "Status", "tags": "Tags",
208 "network_port": "Network_port",
209 "hv/kernel_path": "Kernel_path",
210 "hv/initrd_path": "Initrd_path",
211 "hv/boot_order": "HVM_boot_order",
212 "hv/acpi": "HVM_ACPI",
214 "hv/cdrom_image_path": "HVM_CDROM_image_path",
215 "hv/nic_type": "HVM_NIC_type",
216 "hv/disk_type": "HVM_Disk_type",
217 "hv/vnc_bind_address": "VNC_bind_address",
218 "serial_no": "SerialNo", "hypervisor": "Hypervisor",
219 "hvparams": "Hypervisor_parameters",
220 "be/memory": "Configured_memory",
222 "be/auto_balance": "Auto_balance",
223 "disk.count": "Disks", "disk.sizes": "Disk_sizes",
224 "nic.count": "NICs", "nic.ips": "NIC_IPs",
225 "nic.bridges": "NIC_bridges", "nic.macs": "NIC_MACs",
230 unitfields = ["be/memory", "oper_ram", "sd(a|b)_size", "disk\.size/.*"]
231 numfields = ["be/memory", "oper_ram", "sd(a|b)_size", "be/vcpus",
232 "serial_no", "(disk|nic)\.count", "disk\.size/.*"]
234 list_type_fields = ("tags", "disk.sizes",
235 "nic.macs", "nic.ips", "nic.bridges")
236 # change raw values to nicer strings
238 for idx, field in enumerate(selected_fields):
240 if field == "snodes":
241 val = ",".join(val) or "-"
242 elif field == "admin_state":
247 elif field == "oper_state":
254 elif field == "oper_ram":
257 elif field == "sda_size" or field == "sdb_size":
260 elif field in list_type_fields:
261 val = ",".join(str(item) for item in val)
266 data = GenerateTable(separator=opts.separator, headers=headers,
267 fields=selected_fields, unitfields=unitfields,
268 numfields=numfields, data=output, units=opts.units)
276 def AddInstance(opts, args):
277 """Add an instance to the cluster.
279 @param opts: the command line options selected by the user
281 @param args: should contain only one element, the new instance name
283 @return: the desired exit code
288 (pnode, snode) = SplitNodeOption(opts.node)
293 hypervisor, hvparams = opts.hypervisor
297 nic_max = max(int(nidx[0])+1 for nidx in opts.nics)
298 except ValueError, err:
299 raise errors.OpPrereqError("Invalid NIC index passed: %s" % str(err))
300 nics = [{}] * nic_max
301 for nidx, ndict in opts.nics:
308 # default of one nic, all auto
311 if opts.disk_template == constants.DT_DISKLESS:
312 if opts.disks or opts.sd_size is not None:
313 raise errors.OpPrereqError("Diskless instance but disk"
314 " information passed")
317 if not opts.disks and not opts.sd_size:
318 raise errors.OpPrereqError("No disk information specified")
319 if opts.disks and opts.sd_size is not None:
320 raise errors.OpPrereqError("Please use either the '--disk' or"
322 if opts.sd_size is not None:
323 opts.disks = [(0, {"size": opts.sd_size})]
325 disk_max = max(int(didx[0])+1 for didx in opts.disks)
326 except ValueError, err:
327 raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err))
328 disks = [{}] * disk_max
329 for didx, ddict in opts.disks:
331 if "size" not in ddict:
332 raise errors.OpPrereqError("Missing size for disk %d" % didx)
334 ddict["size"] = utils.ParseUnit(ddict["size"])
335 except ValueError, err:
336 raise errors.OpPrereqError("Invalid disk size for disk %d: %s" %
340 utils.ForceDictType(opts.beparams, constants.BES_PARAMETER_TYPES)
341 utils.ForceDictType(hvparams, constants.HVS_PARAMETER_TYPES)
343 op = opcodes.OpCreateInstance(instance_name=instance,
345 disk_template=opts.disk_template,
347 mode=constants.INSTANCE_CREATE,
348 os_type=opts.os, pnode=pnode,
350 start=opts.start, ip_check=opts.ip_check,
351 wait_for_sync=opts.wait_for_sync,
352 hypervisor=hypervisor,
354 beparams=opts.beparams,
355 iallocator=opts.iallocator,
356 file_storage_dir=opts.file_storage_dir,
357 file_driver=opts.file_driver,
360 SubmitOrSend(op, opts)
364 def BatchCreate(opts, args):
365 """Create instances using a definition file.
367 This function reads a json file with instances defined
371 "disk_size": [20480],
377 "primary_node": "firstnode",
378 "secondary_node": "secondnode",
379 "iallocator": "dumb"}
382 Note that I{primary_node} and I{secondary_node} have precedence over
385 @param opts: the command line options selected by the user
387 @param args: should contain one element, the json filename
389 @return: the desired exit code
392 _DEFAULT_SPECS = {"disk_size": [20 * 1024],
395 "primary_node": None,
396 "secondary_node": None,
404 "file_storage_dir": None,
405 "file_driver": 'loop'}
407 def _PopulateWithDefaults(spec):
408 """Returns a new hash combined with default values."""
409 mydict = _DEFAULT_SPECS.copy()
414 """Validate the instance specs."""
415 # Validate fields required under any circumstances
416 for required_field in ('os', 'template'):
417 if required_field not in spec:
418 raise errors.OpPrereqError('Required field "%s" is missing.' %
420 # Validate special fields
421 if spec['primary_node'] is not None:
422 if (spec['template'] in constants.DTS_NET_MIRROR and
423 spec['secondary_node'] is None):
424 raise errors.OpPrereqError('Template requires secondary node, but'
425 ' there was no secondary provided.')
426 elif spec['iallocator'] is None:
427 raise errors.OpPrereqError('You have to provide at least a primary_node'
428 ' or an iallocator.')
430 if (spec['hvparams'] and
431 not isinstance(spec['hvparams'], dict)):
432 raise errors.OpPrereqError('Hypervisor parameters must be a dict.')
434 json_filename = args[0]
436 fd = open(json_filename, 'r')
437 instance_data = simplejson.load(fd)
439 except Exception, err:
440 ToStderr("Can't parse the instance definition file: %s" % str(err))
443 # Iterate over the instances and do:
444 # * Populate the specs with default value
445 # * Validate the instance specs
446 i_names = utils.NiceSort(instance_data.keys())
448 specs = instance_data[name]
449 specs = _PopulateWithDefaults(specs)
452 hypervisor = specs['hypervisor']
453 hvparams = specs['hvparams']
456 for elem in specs['disk_size']:
458 size = utils.ParseUnit(elem)
459 except ValueError, err:
460 raise errors.OpPrereqError("Invalid disk size '%s' for"
463 disks.append({"size": size})
465 nic0 = {'ip': specs['ip'], 'bridge': specs['bridge'], 'mac': specs['mac']}
467 utils.ForceDictType(specs['backend'], constants.BES_PARAMETER_TYPES)
468 utils.ForceDictType(hvparams, constants.HVS_PARAMETER_TYPES)
470 op = opcodes.OpCreateInstance(instance_name=name,
472 disk_template=specs['template'],
473 mode=constants.INSTANCE_CREATE,
475 pnode=specs['primary_node'],
476 snode=specs['secondary_node'],
478 start=specs['start'],
479 ip_check=specs['ip_check'],
481 iallocator=specs['iallocator'],
482 hypervisor=hypervisor,
484 beparams=specs['backend'],
485 file_storage_dir=specs['file_storage_dir'],
486 file_driver=specs['file_driver'])
488 ToStdout("%s: %s", name, cli.SendJob([op]))
493 def ReinstallInstance(opts, args):
494 """Reinstall an instance.
496 @param opts: the command line options selected by the user
498 @param args: should contain only one element, the name of the
499 instance to be reinstalled
501 @return: the desired exit code
504 instance_name = args[0]
506 if opts.select_os is True:
507 op = opcodes.OpDiagnoseOS(output_fields=["name", "valid"], names=[])
508 result = SubmitOpCode(op)
511 ToStdout("Can't get the OS list")
514 ToStdout("Available OS templates:")
518 ToStdout("%3s: %s", number, entry[0])
519 choices.append(("%s" % number, entry[0], entry[0]))
522 choices.append(('x', 'exit', 'Exit gnt-instance reinstall'))
523 selected = AskUser("Enter OS template number (or x to abort):",
526 if selected == 'exit':
527 ToStdout("User aborted reinstall, exiting")
535 usertext = ("This will reinstall the instance %s and remove"
536 " all data. Continue?") % instance_name
537 if not AskUser(usertext):
540 op = opcodes.OpReinstallInstance(instance_name=instance_name,
542 SubmitOrSend(op, opts)
547 def RemoveInstance(opts, args):
548 """Remove an instance.
550 @param opts: the command line options selected by the user
552 @param args: should contain only one element, the name of
553 the instance to be removed
555 @return: the desired exit code
558 instance_name = args[0]
563 _EnsureInstancesExist(cl, [instance_name])
565 usertext = ("This will remove the volumes of the instance %s"
566 " (including mirrors), thus removing all the data"
567 " of the instance. Continue?") % instance_name
568 if not AskUser(usertext):
571 op = opcodes.OpRemoveInstance(instance_name=instance_name,
572 ignore_failures=opts.ignore_failures)
573 SubmitOrSend(op, opts, cl=cl)
577 def RenameInstance(opts, args):
578 """Rename an instance.
580 @param opts: the command line options selected by the user
582 @param args: should contain two elements, the old and the
585 @return: the desired exit code
588 op = opcodes.OpRenameInstance(instance_name=args[0],
590 ignore_ip=opts.ignore_ip)
591 SubmitOrSend(op, opts)
595 def ActivateDisks(opts, args):
596 """Activate an instance's disks.
598 This serves two purposes:
599 - it allows (as long as the instance is not running)
600 mounting the disks and modifying them from the node
601 - it repairs inactive secondary drbds
603 @param opts: the command line options selected by the user
605 @param args: should contain only one element, the instance name
607 @return: the desired exit code
610 instance_name = args[0]
611 op = opcodes.OpActivateInstanceDisks(instance_name=instance_name)
612 disks_info = SubmitOrSend(op, opts)
613 for host, iname, nname in disks_info:
614 ToStdout("%s:%s:%s", host, iname, nname)
618 def DeactivateDisks(opts, args):
619 """Deactivate an instance's disks..
621 This function takes the instance name, looks for its primary node
622 and the tries to shutdown its block devices on that node.
624 @param opts: the command line options selected by the user
626 @param args: should contain only one element, the instance name
628 @return: the desired exit code
631 instance_name = args[0]
632 op = opcodes.OpDeactivateInstanceDisks(instance_name=instance_name)
633 SubmitOrSend(op, opts)
637 def GrowDisk(opts, args):
638 """Grow an instance's disks.
640 @param opts: the command line options selected by the user
642 @param args: should contain two elements, the instance name
643 whose disks we grow and the disk name, e.g. I{sda}
645 @return: the desired exit code
652 except ValueError, err:
653 raise errors.OpPrereqError("Invalid disk index: %s" % str(err))
654 amount = utils.ParseUnit(args[2])
655 op = opcodes.OpGrowDisk(instance_name=instance, disk=disk, amount=amount,
656 wait_for_sync=opts.wait_for_sync)
657 SubmitOrSend(op, opts)
661 def StartupInstance(opts, args):
662 """Startup instances.
664 Depending on the options given, this will start one or more
667 @param opts: the command line options selected by the user
669 @param args: the instance or node names based on which we
670 create the final selection (in conjunction with the
673 @return: the desired exit code
677 if opts.multi_mode is None:
678 opts.multi_mode = _SHUTDOWN_INSTANCES
679 inames = _ExpandMultiNames(opts.multi_mode, args, client=cl)
681 raise errors.OpPrereqError("Selection filter does not match any instances")
682 multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
683 if not (opts.force_multi or not multi_on
684 or _ConfirmOperation(inames, "startup")):
686 jex = cli.JobExecutor(verbose=multi_on, cl=cl)
688 op = opcodes.OpStartupInstance(instance_name=name,
690 # do not add these parameters to the opcode unless they're defined
692 op.hvparams = opts.hvparams
694 op.beparams = opts.beparams
695 jex.QueueJob(name, op)
696 jex.WaitOrShow(not opts.submit_only)
700 def RebootInstance(opts, args):
701 """Reboot instance(s).
703 Depending on the parameters given, this will reboot one or more
706 @param opts: the command line options selected by the user
708 @param args: the instance or node names based on which we
709 create the final selection (in conjunction with the
712 @return: the desired exit code
716 if opts.multi_mode is None:
717 opts.multi_mode = _SHUTDOWN_INSTANCES
718 inames = _ExpandMultiNames(opts.multi_mode, args, client=cl)
720 raise errors.OpPrereqError("Selection filter does not match any instances")
721 multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
722 if not (opts.force_multi or not multi_on
723 or _ConfirmOperation(inames, "reboot")):
725 jex = JobExecutor(verbose=multi_on, cl=cl)
727 op = opcodes.OpRebootInstance(instance_name=name,
728 reboot_type=opts.reboot_type,
729 ignore_secondaries=opts.ignore_secondaries)
730 jex.QueueJob(name, op)
731 jex.WaitOrShow(not opts.submit_only)
735 def ShutdownInstance(opts, args):
736 """Shutdown an instance.
738 @param opts: the command line options selected by the user
740 @param args: the instance or node names based on which we
741 create the final selection (in conjunction with the
744 @return: the desired exit code
748 if opts.multi_mode is None:
749 opts.multi_mode = _SHUTDOWN_INSTANCES
750 inames = _ExpandMultiNames(opts.multi_mode, args, client=cl)
752 raise errors.OpPrereqError("Selection filter does not match any instances")
753 multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
754 if not (opts.force_multi or not multi_on
755 or _ConfirmOperation(inames, "shutdown")):
758 jex = cli.JobExecutor(verbose=multi_on, cl=cl)
760 op = opcodes.OpShutdownInstance(instance_name=name)
761 jex.QueueJob(name, op)
762 jex.WaitOrShow(not opts.submit_only)
766 def ReplaceDisks(opts, args):
767 """Replace the disks of an instance
769 @param opts: the command line options selected by the user
771 @param args: should contain only one element, the instance name
773 @return: the desired exit code
776 instance_name = args[0]
777 new_2ndary = opts.new_secondary
778 iallocator = opts.iallocator
779 if opts.disks is None:
783 disks = [int(i) for i in opts.disks.split(",")]
784 except ValueError, err:
785 raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err))
786 cnt = [opts.on_primary, opts.on_secondary,
787 new_2ndary is not None, iallocator is not None].count(True)
789 raise errors.OpPrereqError("One and only one of the -p, -s, -n and -i"
790 " options must be passed")
791 elif opts.on_primary:
792 mode = constants.REPLACE_DISK_PRI
793 elif opts.on_secondary:
794 mode = constants.REPLACE_DISK_SEC
795 elif new_2ndary is not None or iallocator is not None:
797 mode = constants.REPLACE_DISK_CHG
799 op = opcodes.OpReplaceDisks(instance_name=args[0], disks=disks,
800 remote_node=new_2ndary, mode=mode,
801 iallocator=iallocator)
802 SubmitOrSend(op, opts)
806 def FailoverInstance(opts, args):
807 """Failover an instance.
809 The failover is done by shutting it down on its present node and
810 starting it on the secondary.
812 @param opts: the command line options selected by the user
814 @param args: should contain only one element, the instance name
816 @return: the desired exit code
820 instance_name = args[0]
824 _EnsureInstancesExist(cl, [instance_name])
826 usertext = ("Failover will happen to image %s."
827 " This requires a shutdown of the instance. Continue?" %
829 if not AskUser(usertext):
832 op = opcodes.OpFailoverInstance(instance_name=instance_name,
833 ignore_consistency=opts.ignore_consistency)
834 SubmitOrSend(op, opts, cl=cl)
838 def MigrateInstance(opts, args):
839 """Migrate an instance.
841 The migrate is done without shutdown.
843 @param opts: the command line options selected by the user
845 @param args: should contain only one element, the instance name
847 @return: the desired exit code
851 instance_name = args[0]
855 _EnsureInstancesExist(cl, [instance_name])
858 usertext = ("Instance %s will be recovered from a failed migration."
859 " Note that the migration procedure (including cleanup)" %
862 usertext = ("Instance %s will be migrated. Note that migration" %
864 usertext += (" is **experimental** in this version."
865 " This might impact the instance if anything goes wrong."
867 if not AskUser(usertext):
870 op = opcodes.OpMigrateInstance(instance_name=instance_name, live=opts.live,
871 cleanup=opts.cleanup)
872 SubmitOpCode(op, cl=cl)
876 def ConnectToInstanceConsole(opts, args):
877 """Connect to the console of an instance.
879 @param opts: the command line options selected by the user
881 @param args: should contain only one element, the instance name
883 @return: the desired exit code
886 instance_name = args[0]
888 op = opcodes.OpConnectConsole(instance_name=instance_name)
889 cmd = SubmitOpCode(op)
891 if opts.show_command:
892 ToStdout("%s", utils.ShellQuoteArgs(cmd))
895 os.execvp(cmd[0], cmd)
897 ToStderr("Can't run console command %s with arguments:\n'%s'",
898 cmd[0], " ".join(cmd))
902 def _FormatLogicalID(dev_type, logical_id):
903 """Formats the logical_id of a disk.
906 if dev_type == constants.LD_DRBD8:
907 node_a, node_b, port, minor_a, minor_b, key = logical_id
909 ("nodeA", "%s, minor=%s" % (node_a, minor_a)),
910 ("nodeB", "%s, minor=%s" % (node_b, minor_b)),
914 elif dev_type == constants.LD_LV:
915 vg_name, lv_name = logical_id
916 data = ["%s/%s" % (vg_name, lv_name)]
918 data = [str(logical_id)]
923 def _FormatBlockDevInfo(idx, top_level, dev, static):
924 """Show block device information.
926 This is only used by L{ShowInstanceConfig}, but it's too big to be
927 left for an inline definition.
930 @param idx: the index of the current disk
931 @type top_level: boolean
932 @param top_level: if this a top-level disk?
934 @param dev: dictionary with disk information
935 @type static: boolean
936 @param static: wheter the device information doesn't contain
937 runtime information but only static data
938 @return: a list of either strings, tuples or lists
939 (which should be formatted at a higher indent level)
942 def helper(dtype, status):
943 """Format one line for physical device status.
946 @param dtype: a constant from the L{constants.LDS_BLOCK} set
948 @param status: a tuple as returned from L{backend.FindBlockDevice}
949 @return: the string representing the status
955 (path, major, minor, syncp, estt, degr, ldisk) = status
959 major_string = str(major)
964 minor_string = str(minor)
966 txt += ("%s (%s:%s)" % (path, major_string, minor_string))
967 if dtype in (constants.LD_DRBD8, ):
968 if syncp is not None:
969 sync_text = "*RECOVERING* %5.2f%%," % syncp
971 sync_text += " ETA %ds" % estt
973 sync_text += " ETA unknown"
975 sync_text = "in sync"
977 degr_text = "*DEGRADED*"
981 ldisk_text = " *MISSING DISK*"
984 txt += (" %s, status %s%s" % (sync_text, degr_text, ldisk_text))
985 elif dtype == constants.LD_LV:
987 ldisk_text = " *FAILED* (failed drive?)"
995 if dev["iv_name"] is not None:
998 txt = "disk %d" % idx
1000 txt = "child %d" % idx
1001 if isinstance(dev["size"], int):
1002 nice_size = utils.FormatUnit(dev["size"], "h")
1004 nice_size = dev["size"]
1005 d1 = ["- %s: %s, size %s" % (txt, dev["dev_type"], nice_size)]
1008 data.append(("access mode", dev["mode"]))
1009 if dev["logical_id"] is not None:
1011 l_id = _FormatLogicalID(dev["dev_type"], dev["logical_id"])
1013 l_id = [str(dev["logical_id"])]
1015 data.append(("logical_id", l_id[0]))
1018 elif dev["physical_id"] is not None:
1019 data.append("physical_id:")
1020 data.append([dev["physical_id"]])
1022 data.append(("on primary", helper(dev["dev_type"], dev["pstatus"])))
1023 if dev["sstatus"] and not static:
1024 data.append(("on secondary", helper(dev["dev_type"], dev["sstatus"])))
1027 data.append("child devices:")
1028 for c_idx, child in enumerate(dev["children"]):
1029 data.append(_FormatBlockDevInfo(c_idx, False, child, static))
1034 def _FormatList(buf, data, indent_level):
1035 """Formats a list of data at a given indent level.
1037 If the element of the list is:
1038 - a string, it is simply formatted as is
1039 - a tuple, it will be split into key, value and the all the
1040 values in a list will be aligned all at the same start column
1041 - a list, will be recursively formatted
1044 @param buf: the buffer into which we write the output
1045 @param data: the list to format
1046 @type indent_level: int
1047 @param indent_level: the indent level to format at
1050 max_tlen = max([len(elem[0]) for elem in data
1051 if isinstance(elem, tuple)] or [0])
1053 if isinstance(elem, basestring):
1054 buf.write("%*s%s\n" % (2*indent_level, "", elem))
1055 elif isinstance(elem, tuple):
1057 spacer = "%*s" % (max_tlen - len(key), "")
1058 buf.write("%*s%s:%s %s\n" % (2*indent_level, "", key, spacer, value))
1059 elif isinstance(elem, list):
1060 _FormatList(buf, elem, indent_level+1)
1062 def ShowInstanceConfig(opts, args):
1063 """Compute instance run-time status.
1065 @param opts: the command line options selected by the user
1067 @param args: either an empty list, and then we query all
1068 instances, or should contain a list of instance names
1070 @return: the desired exit code
1073 if not args and not opts.show_all:
1074 ToStderr("No instance selected."
1075 " Please pass in --all if you want to query all instances.\n"
1076 "Note that this can take a long time on a big cluster.")
1078 elif args and opts.show_all:
1079 ToStderr("Cannot use --all if you specify instance names.")
1083 op = opcodes.OpQueryInstanceData(instances=args, static=opts.static)
1084 result = SubmitOpCode(op)
1086 ToStdout("No instances.")
1091 for instance_name in result:
1092 instance = result[instance_name]
1093 buf.write("Instance name: %s\n" % instance["name"])
1094 buf.write("State: configured to be %s" % instance["config_state"])
1096 buf.write(", actual state is %s" % instance["run_state"])
1098 ##buf.write("Considered for memory checks in cluster verify: %s\n" %
1099 ## instance["auto_balance"])
1100 buf.write(" Nodes:\n")
1101 buf.write(" - primary: %s\n" % instance["pnode"])
1102 buf.write(" - secondaries: %s\n" % ", ".join(instance["snodes"]))
1103 buf.write(" Operating system: %s\n" % instance["os"])
1104 if instance.has_key("network_port"):
1105 buf.write(" Allocated network port: %s\n" % instance["network_port"])
1106 buf.write(" Hypervisor: %s\n" % instance["hypervisor"])
1108 # custom VNC console information
1109 vnc_bind_address = instance["hv_actual"].get(constants.HV_VNC_BIND_ADDRESS,
1111 if vnc_bind_address:
1112 port = instance["network_port"]
1113 display = int(port) - constants.VNC_BASE_PORT
1114 if display > 0 and vnc_bind_address == constants.BIND_ADDRESS_GLOBAL:
1115 vnc_console_port = "%s:%s (display %s)" % (instance["pnode"],
1118 elif display > 0 and utils.IsValidIP(vnc_bind_address):
1119 vnc_console_port = ("%s:%s (node %s) (display %s)" %
1120 (vnc_bind_address, port,
1121 instance["pnode"], display))
1123 # vnc bind address is a file
1124 vnc_console_port = "%s:%s" % (instance["pnode"],
1126 buf.write(" - console connection: vnc to %s\n" % vnc_console_port)
1128 for key in instance["hv_actual"]:
1129 if key in instance["hv_instance"]:
1130 val = instance["hv_instance"][key]
1132 val = "default (%s)" % instance["hv_actual"][key]
1133 buf.write(" - %s: %s\n" % (key, val))
1134 buf.write(" Hardware:\n")
1135 buf.write(" - VCPUs: %d\n" %
1136 instance["be_actual"][constants.BE_VCPUS])
1137 buf.write(" - memory: %dMiB\n" %
1138 instance["be_actual"][constants.BE_MEMORY])
1139 buf.write(" - NICs:\n")
1140 for idx, (mac, ip, bridge) in enumerate(instance["nics"]):
1141 buf.write(" - nic/%d: MAC: %s, IP: %s, bridge: %s\n" %
1142 (idx, mac, ip, bridge))
1143 buf.write(" Disks:\n")
1145 for idx, device in enumerate(instance["disks"]):
1146 _FormatList(buf, _FormatBlockDevInfo(idx, True, device, opts.static), 2)
1148 ToStdout(buf.getvalue().rstrip('\n'))
1152 def SetInstanceParams(opts, args):
1153 """Modifies an instance.
1155 All parameters take effect only at the next restart of the instance.
1157 @param opts: the command line options selected by the user
1159 @param args: should contain only one element, the instance name
1161 @return: the desired exit code
1164 if not (opts.nics or opts.disks or
1165 opts.hypervisor or opts.beparams):
1166 ToStderr("Please give at least one of the parameters.")
1169 for param in opts.beparams:
1170 if isinstance(opts.beparams[param], basestring):
1171 if opts.beparams[param].lower() == "default":
1172 opts.beparams[param] = constants.VALUE_DEFAULT
1174 utils.ForceDictType(opts.beparams, constants.BES_PARAMETER_TYPES,
1175 allowed_values=[constants.VALUE_DEFAULT])
1177 for param in opts.hypervisor:
1178 if isinstance(opts.hypervisor[param], basestring):
1179 if opts.hypervisor[param].lower() == "default":
1180 opts.hypervisor[param] = constants.VALUE_DEFAULT
1182 utils.ForceDictType(opts.hypervisor, constants.HVS_PARAMETER_TYPES,
1183 allowed_values=[constants.VALUE_DEFAULT])
1185 for idx, (nic_op, nic_dict) in enumerate(opts.nics):
1187 nic_op = int(nic_op)
1188 opts.nics[idx] = (nic_op, nic_dict)
1192 for idx, (disk_op, disk_dict) in enumerate(opts.disks):
1194 disk_op = int(disk_op)
1195 opts.disks[idx] = (disk_op, disk_dict)
1198 if disk_op == constants.DDM_ADD:
1199 if 'size' not in disk_dict:
1200 raise errors.OpPrereqError("Missing required parameter 'size'")
1201 disk_dict['size'] = utils.ParseUnit(disk_dict['size'])
1203 op = opcodes.OpSetInstanceParams(instance_name=args[0],
1206 hvparams=opts.hypervisor,
1207 beparams=opts.beparams,
1210 # even if here we process the result, we allow submit only
1211 result = SubmitOrSend(op, opts)
1214 ToStdout("Modified instance %s", args[0])
1215 for param, data in result:
1216 ToStdout(" - %-5s -> %s", param, data)
1217 ToStdout("Please don't forget that these parameters take effect"
1218 " only at the next start of the instance.")
1222 # options used in more than one cmd
1223 node_opt = make_option("-n", "--node", dest="node", help="Target node",
1226 os_opt = cli_option("-o", "--os-type", dest="os", help="What OS to run",
1229 # multi-instance selection options
1230 m_force_multi = make_option("--force-multiple", dest="force_multi",
1231 help="Do not ask for confirmation when more than"
1232 " one instance is affected",
1233 action="store_true", default=False)
1235 m_pri_node_opt = make_option("--primary", dest="multi_mode",
1236 help="Filter by nodes (primary only)",
1237 const=_SHUTDOWN_NODES_PRI, action="store_const")
1239 m_sec_node_opt = make_option("--secondary", dest="multi_mode",
1240 help="Filter by nodes (secondary only)",
1241 const=_SHUTDOWN_NODES_SEC, action="store_const")
1243 m_node_opt = make_option("--node", dest="multi_mode",
1244 help="Filter by nodes (primary and secondary)",
1245 const=_SHUTDOWN_NODES_BOTH, action="store_const")
1247 m_clust_opt = make_option("--all", dest="multi_mode",
1248 help="Select all instances in the cluster",
1249 const=_SHUTDOWN_CLUSTER, action="store_const")
1251 m_inst_opt = make_option("--instance", dest="multi_mode",
1252 help="Filter by instance name [default]",
1253 const=_SHUTDOWN_INSTANCES, action="store_const")
1256 # this is defined separately due to readability only
1259 make_option("-n", "--node", dest="node",
1260 help="Target node and optional secondary node",
1261 metavar="<pnode>[:<snode>]"),
1263 keyval_option("-B", "--backend", dest="beparams",
1264 type="keyval", default={},
1265 help="Backend parameters"),
1266 make_option("-t", "--disk-template", dest="disk_template",
1267 help="Custom disk setup (diskless, file, plain or drbd)",
1268 default=None, metavar="TEMPL"),
1269 cli_option("-s", "--os-size", dest="sd_size", help="Disk size for a"
1270 " single-disk configuration, when not using the --disk option,"
1271 " in MiB unless a suffix is used",
1272 default=None, type="unit", metavar="<size>"),
1273 ikv_option("--disk", help="Disk information",
1274 default=[], dest="disks",
1276 type="identkeyval"),
1277 ikv_option("--net", help="NIC information",
1278 default=[], dest="nics",
1280 type="identkeyval"),
1281 make_option("--no-nics", default=False, action="store_true",
1282 help="Do not create any network cards for the instance"),
1283 make_option("--no-wait-for-sync", dest="wait_for_sync", default=True,
1284 action="store_false", help="Don't wait for sync (DANGEROUS!)"),
1285 make_option("--no-start", dest="start", default=True,
1286 action="store_false", help="Don't start the instance after"
1288 make_option("--no-ip-check", dest="ip_check", default=True,
1289 action="store_false", help="Don't check that the instance's IP"
1290 " is alive (only valid with --no-start)"),
1291 make_option("--file-storage-dir", dest="file_storage_dir",
1292 help="Relative path under default cluster-wide file storage dir"
1293 " to store file-based disks", default=None,
1295 make_option("--file-driver", dest="file_driver", help="Driver to use"
1296 " for image files", default="loop", metavar="<DRIVER>"),
1297 make_option("-I", "--iallocator", metavar="<NAME>",
1298 help="Select nodes for the instance automatically using the"
1299 " <NAME> iallocator plugin", default=None, type="string"),
1300 ikv_option("-H", "--hypervisor", dest="hypervisor",
1301 help="Hypervisor and hypervisor options, in the format"
1302 " hypervisor:option=value,option=value,...", default=None,
1303 type="identkeyval"),
1308 'add': (AddInstance, ARGS_ONE, add_opts,
1309 "[...] -t disk-type -n node[:secondary-node] -o os-type <name>",
1310 "Creates and adds a new instance to the cluster"),
1311 'batch-create': (BatchCreate, ARGS_ONE,
1313 "<instances_file.json>",
1314 "Create a bunch of instances based on specs in the file."),
1315 'console': (ConnectToInstanceConsole, ARGS_ONE,
1317 make_option("--show-cmd", dest="show_command",
1318 action="store_true", default=False,
1319 help=("Show command instead of executing it"))],
1320 "[--show-cmd] <instance>",
1321 "Opens a console on the specified instance"),
1322 'failover': (FailoverInstance, ARGS_ONE,
1323 [DEBUG_OPT, FORCE_OPT,
1324 make_option("--ignore-consistency", dest="ignore_consistency",
1325 action="store_true", default=False,
1326 help="Ignore the consistency of the disks on"
1331 "Stops the instance and starts it on the backup node, using"
1332 " the remote mirror (only for instances of type drbd)"),
1333 'migrate': (MigrateInstance, ARGS_ONE,
1334 [DEBUG_OPT, FORCE_OPT,
1335 make_option("--non-live", dest="live",
1336 default=True, action="store_false",
1337 help="Do a non-live migration (this usually means"
1338 " freeze the instance, save the state,"
1339 " transfer and only then resume running on the"
1340 " secondary node)"),
1341 make_option("--cleanup", dest="cleanup",
1342 default=False, action="store_true",
1343 help="Instead of performing the migration, try to"
1344 " recover from a failed cleanup. This is safe"
1345 " to run even if the instance is healthy, but it"
1346 " will create extra replication traffic and "
1347 " disrupt briefly the replication (like during the"
1351 "Migrate instance to its secondary node"
1352 " (only for instances of type drbd)"),
1353 'info': (ShowInstanceConfig, ARGS_ANY,
1355 make_option("-s", "--static", dest="static",
1356 action="store_true", default=False,
1357 help="Only show configuration data, not runtime data"),
1358 make_option("--all", dest="show_all",
1359 default=False, action="store_true",
1360 help="Show info on all instances on the cluster."
1361 " This can take a long time to run, use wisely."),
1362 ], "[-s] {--all | <instance>...}",
1363 "Show information on the specified instance(s)"),
1364 'list': (ListInstances, ARGS_ANY,
1365 [DEBUG_OPT, NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT, SYNC_OPT],
1367 "Lists the instances and their status. The available fields are"
1368 " (see the man page for details): status, oper_state, oper_ram,"
1369 " name, os, pnode, snodes, admin_state, admin_ram, disk_template,"
1370 " ip, mac, bridge, sda_size, sdb_size, vcpus, serial_no,"
1372 " The default field"
1373 " list is (in order): %s." % ", ".join(_LIST_DEF_FIELDS),
1375 'reinstall': (ReinstallInstance, ARGS_ONE,
1376 [DEBUG_OPT, FORCE_OPT, os_opt,
1377 make_option("--select-os", dest="select_os",
1378 action="store_true", default=False,
1379 help="Interactive OS reinstall, lists available"
1380 " OS templates for selection"),
1383 "[-f] <instance>", "Reinstall a stopped instance"),
1384 'remove': (RemoveInstance, ARGS_ONE,
1385 [DEBUG_OPT, FORCE_OPT,
1386 make_option("--ignore-failures", dest="ignore_failures",
1387 action="store_true", default=False,
1388 help=("Remove the instance from the cluster even"
1389 " if there are failures during the removal"
1390 " process (shutdown, disk removal, etc.)")),
1393 "[-f] <instance>", "Shuts down the instance and removes it"),
1394 'rename': (RenameInstance, ARGS_FIXED(2),
1396 make_option("--no-ip-check", dest="ignore_ip",
1397 help="Do not check that the IP of the new name"
1399 default=False, action="store_true"),
1402 "<instance> <new_name>", "Rename the instance"),
1403 'replace-disks': (ReplaceDisks, ARGS_ONE,
1405 make_option("-n", "--new-secondary", dest="new_secondary",
1406 help=("New secondary node (for secondary"
1407 " node change)"), metavar="NODE",
1409 make_option("-p", "--on-primary", dest="on_primary",
1410 default=False, action="store_true",
1411 help=("Replace the disk(s) on the primary"
1412 " node (only for the drbd template)")),
1413 make_option("-s", "--on-secondary", dest="on_secondary",
1414 default=False, action="store_true",
1415 help=("Replace the disk(s) on the secondary"
1416 " node (only for the drbd template)")),
1417 make_option("--disks", dest="disks", default=None,
1418 help="Comma-separated list of disks"
1419 " indices to replace (e.g. 0,2) (optional,"
1420 " defaults to all disks)"),
1421 make_option("-I", "--iallocator", metavar="<NAME>",
1422 help="Select new secondary for the instance"
1423 " automatically using the"
1424 " <NAME> iallocator plugin (enables"
1425 " secondary node replacement)",
1426 default=None, type="string"),
1429 "[-s|-p|-n NODE|-I NAME] <instance>",
1430 "Replaces all disks for the instance"),
1431 'modify': (SetInstanceParams, ARGS_ONE,
1432 [DEBUG_OPT, FORCE_OPT,
1433 keyval_option("-H", "--hypervisor", type="keyval",
1434 default={}, dest="hypervisor",
1435 help="Change hypervisor parameters"),
1436 keyval_option("-B", "--backend", type="keyval",
1437 default={}, dest="beparams",
1438 help="Change backend parameters"),
1439 ikv_option("--disk", help="Disk changes",
1440 default=[], dest="disks",
1442 type="identkeyval"),
1443 ikv_option("--net", help="NIC changes",
1444 default=[], dest="nics",
1446 type="identkeyval"),
1449 "<instance>", "Alters the parameters of an instance"),
1450 'shutdown': (ShutdownInstance, ARGS_ANY,
1451 [DEBUG_OPT, m_node_opt, m_pri_node_opt, m_sec_node_opt,
1452 m_clust_opt, m_inst_opt, m_force_multi,
1455 "<instance>", "Stops an instance"),
1456 'startup': (StartupInstance, ARGS_ANY,
1457 [DEBUG_OPT, FORCE_OPT, m_force_multi,
1458 m_node_opt, m_pri_node_opt, m_sec_node_opt,
1459 m_clust_opt, m_inst_opt,
1461 keyval_option("-H", "--hypervisor", type="keyval",
1462 default={}, dest="hvparams",
1463 help="Temporary hypervisor parameters"),
1464 keyval_option("-B", "--backend", type="keyval",
1465 default={}, dest="beparams",
1466 help="Temporary backend parameters"),
1468 "<instance>", "Starts an instance"),
1470 'reboot': (RebootInstance, ARGS_ANY,
1471 [DEBUG_OPT, m_force_multi,
1472 make_option("-t", "--type", dest="reboot_type",
1473 help="Type of reboot: soft/hard/full",
1474 default=constants.INSTANCE_REBOOT_HARD,
1475 type="string", metavar="<REBOOT>"),
1476 make_option("--ignore-secondaries", dest="ignore_secondaries",
1477 default=False, action="store_true",
1478 help="Ignore errors from secondaries"),
1479 m_node_opt, m_pri_node_opt, m_sec_node_opt,
1480 m_clust_opt, m_inst_opt,
1483 "<instance>", "Reboots an instance"),
1484 'activate-disks': (ActivateDisks, ARGS_ONE, [DEBUG_OPT, SUBMIT_OPT],
1486 "Activate an instance's disks"),
1487 'deactivate-disks': (DeactivateDisks, ARGS_ONE, [DEBUG_OPT, SUBMIT_OPT],
1489 "Deactivate an instance's disks"),
1490 'grow-disk': (GrowDisk, ARGS_FIXED(3),
1491 [DEBUG_OPT, SUBMIT_OPT,
1492 make_option("--no-wait-for-sync",
1493 dest="wait_for_sync", default=True,
1494 action="store_false",
1495 help="Don't wait for sync (DANGEROUS!)"),
1497 "<instance> <disk> <size>", "Grow an instance's disk"),
1498 'list-tags': (ListTags, ARGS_ONE, [DEBUG_OPT],
1499 "<instance_name>", "List the tags of the given instance"),
1500 'add-tags': (AddTags, ARGS_ATLEAST(1), [DEBUG_OPT, TAG_SRC_OPT],
1501 "<instance_name> tag...", "Add tags to the given instance"),
1502 'remove-tags': (RemoveTags, ARGS_ATLEAST(1), [DEBUG_OPT, TAG_SRC_OPT],
1503 "<instance_name> tag...", "Remove tags from given instance"),
1506 #: dictionary with aliases for commands
1508 'activate_block_devs': 'activate-disks',
1509 'replace_disks': 'replace-disks',
1514 if __name__ == '__main__':
1515 sys.exit(GenericMain(commands, aliases=aliases,
1516 override={"tag_type": constants.TAG_INSTANCE}))