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, extra=""):
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%s"
137 "Do you want to continue?" % (text, count, extra))
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))
445 # Iterate over the instances and do:
446 # * Populate the specs with default value
447 # * Validate the instance specs
448 i_names = utils.NiceSort(instance_data.keys())
450 specs = instance_data[name]
451 specs = _PopulateWithDefaults(specs)
454 hypervisor = specs['hypervisor']
455 hvparams = specs['hvparams']
458 for elem in specs['disk_size']:
460 size = utils.ParseUnit(elem)
461 except ValueError, err:
462 raise errors.OpPrereqError("Invalid disk size '%s' for"
465 disks.append({"size": size})
467 nic0 = {'ip': specs['ip'], 'bridge': specs['bridge'], 'mac': specs['mac']}
469 utils.ForceDictType(specs['backend'], constants.BES_PARAMETER_TYPES)
470 utils.ForceDictType(hvparams, constants.HVS_PARAMETER_TYPES)
472 op = opcodes.OpCreateInstance(instance_name=name,
474 disk_template=specs['template'],
475 mode=constants.INSTANCE_CREATE,
477 pnode=specs['primary_node'],
478 snode=specs['secondary_node'],
480 start=specs['start'],
481 ip_check=specs['ip_check'],
483 iallocator=specs['iallocator'],
484 hypervisor=hypervisor,
486 beparams=specs['backend'],
487 file_storage_dir=specs['file_storage_dir'],
488 file_driver=specs['file_driver'])
490 jex.QueueJob(name, op)
491 # we never want to wait, just show the submitted job IDs
492 jex.WaitOrShow(False)
497 def ReinstallInstance(opts, args):
498 """Reinstall an instance.
500 @param opts: the command line options selected by the user
502 @param args: should contain only one element, the name of the
503 instance to be reinstalled
505 @return: the desired exit code
508 # first, compute the desired name list
509 if opts.multi_mode is None:
510 opts.multi_mode = _SHUTDOWN_INSTANCES
512 inames = _ExpandMultiNames(opts.multi_mode, args)
514 raise errors.OpPrereqError("Selection filter does not match any instances")
516 # second, if requested, ask for an OS
517 if opts.select_os is True:
518 op = opcodes.OpDiagnoseOS(output_fields=["name", "valid"], names=[])
519 result = SubmitOpCode(op)
522 ToStdout("Can't get the OS list")
525 ToStdout("Available OS templates:")
529 ToStdout("%3s: %s", number, entry[0])
530 choices.append(("%s" % number, entry[0], entry[0]))
533 choices.append(('x', 'exit', 'Exit gnt-instance reinstall'))
534 selected = AskUser("Enter OS template number (or x to abort):",
537 if selected == 'exit':
538 ToStderr("User aborted reinstall, exiting")
545 # third, get confirmation: multi-reinstall requires --force-multi
546 # *and* --force, single-reinstall just --force
547 multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
549 warn_msg = "Note: this will remove *all* data for the below instances!\n"
550 if not ((opts.force_multi and opts.force) or
551 _ConfirmOperation(inames, "reinstall", extra=warn_msg)):
555 usertext = ("This will reinstall the instance %s and remove"
556 " all data. Continue?") % instance_name
557 if not AskUser(usertext):
560 jex = JobExecutor(verbose=multi_on)
561 for instance_name in inames:
562 op = opcodes.OpReinstallInstance(instance_name=instance_name,
564 jex.QueueJob(instance_name, op)
566 jex.WaitOrShow(not opts.submit_only)
570 def RemoveInstance(opts, args):
571 """Remove an instance.
573 @param opts: the command line options selected by the user
575 @param args: should contain only one element, the name of
576 the instance to be removed
578 @return: the desired exit code
581 instance_name = args[0]
586 _EnsureInstancesExist(cl, [instance_name])
588 usertext = ("This will remove the volumes of the instance %s"
589 " (including mirrors), thus removing all the data"
590 " of the instance. Continue?") % instance_name
591 if not AskUser(usertext):
594 op = opcodes.OpRemoveInstance(instance_name=instance_name,
595 ignore_failures=opts.ignore_failures)
596 SubmitOrSend(op, opts, cl=cl)
600 def RenameInstance(opts, args):
601 """Rename an instance.
603 @param opts: the command line options selected by the user
605 @param args: should contain two elements, the old and the
608 @return: the desired exit code
611 op = opcodes.OpRenameInstance(instance_name=args[0],
613 ignore_ip=opts.ignore_ip)
614 SubmitOrSend(op, opts)
618 def ActivateDisks(opts, args):
619 """Activate an instance's disks.
621 This serves two purposes:
622 - it allows (as long as the instance is not running)
623 mounting the disks and modifying them from the node
624 - it repairs inactive secondary drbds
626 @param opts: the command line options selected by the user
628 @param args: should contain only one element, the instance name
630 @return: the desired exit code
633 instance_name = args[0]
634 op = opcodes.OpActivateInstanceDisks(instance_name=instance_name)
635 disks_info = SubmitOrSend(op, opts)
636 for host, iname, nname in disks_info:
637 ToStdout("%s:%s:%s", host, iname, nname)
641 def DeactivateDisks(opts, args):
642 """Deactivate an instance's disks..
644 This function takes the instance name, looks for its primary node
645 and the tries to shutdown its block devices on that node.
647 @param opts: the command line options selected by the user
649 @param args: should contain only one element, the instance name
651 @return: the desired exit code
654 instance_name = args[0]
655 op = opcodes.OpDeactivateInstanceDisks(instance_name=instance_name)
656 SubmitOrSend(op, opts)
660 def GrowDisk(opts, args):
661 """Grow an instance's disks.
663 @param opts: the command line options selected by the user
665 @param args: should contain two elements, the instance name
666 whose disks we grow and the disk name, e.g. I{sda}
668 @return: the desired exit code
675 except ValueError, err:
676 raise errors.OpPrereqError("Invalid disk index: %s" % str(err))
677 amount = utils.ParseUnit(args[2])
678 op = opcodes.OpGrowDisk(instance_name=instance, disk=disk, amount=amount,
679 wait_for_sync=opts.wait_for_sync)
680 SubmitOrSend(op, opts)
684 def StartupInstance(opts, args):
685 """Startup instances.
687 Depending on the options given, this will start one or more
690 @param opts: the command line options selected by the user
692 @param args: the instance or node names based on which we
693 create the final selection (in conjunction with the
696 @return: the desired exit code
700 if opts.multi_mode is None:
701 opts.multi_mode = _SHUTDOWN_INSTANCES
702 inames = _ExpandMultiNames(opts.multi_mode, args, client=cl)
704 raise errors.OpPrereqError("Selection filter does not match any instances")
705 multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
706 if not (opts.force_multi or not multi_on
707 or _ConfirmOperation(inames, "startup")):
709 jex = cli.JobExecutor(verbose=multi_on, cl=cl)
711 op = opcodes.OpStartupInstance(instance_name=name,
713 # do not add these parameters to the opcode unless they're defined
715 op.hvparams = opts.hvparams
717 op.beparams = opts.beparams
718 jex.QueueJob(name, op)
719 jex.WaitOrShow(not opts.submit_only)
723 def RebootInstance(opts, args):
724 """Reboot instance(s).
726 Depending on the parameters given, this will reboot one or more
729 @param opts: the command line options selected by the user
731 @param args: the instance or node names based on which we
732 create the final selection (in conjunction with the
735 @return: the desired exit code
739 if opts.multi_mode is None:
740 opts.multi_mode = _SHUTDOWN_INSTANCES
741 inames = _ExpandMultiNames(opts.multi_mode, args, client=cl)
743 raise errors.OpPrereqError("Selection filter does not match any instances")
744 multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
745 if not (opts.force_multi or not multi_on
746 or _ConfirmOperation(inames, "reboot")):
748 jex = JobExecutor(verbose=multi_on, cl=cl)
750 op = opcodes.OpRebootInstance(instance_name=name,
751 reboot_type=opts.reboot_type,
752 ignore_secondaries=opts.ignore_secondaries)
753 jex.QueueJob(name, op)
754 jex.WaitOrShow(not opts.submit_only)
758 def ShutdownInstance(opts, args):
759 """Shutdown an instance.
761 @param opts: the command line options selected by the user
763 @param args: the instance or node names based on which we
764 create the final selection (in conjunction with the
767 @return: the desired exit code
771 if opts.multi_mode is None:
772 opts.multi_mode = _SHUTDOWN_INSTANCES
773 inames = _ExpandMultiNames(opts.multi_mode, args, client=cl)
775 raise errors.OpPrereqError("Selection filter does not match any instances")
776 multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
777 if not (opts.force_multi or not multi_on
778 or _ConfirmOperation(inames, "shutdown")):
781 jex = cli.JobExecutor(verbose=multi_on, cl=cl)
783 op = opcodes.OpShutdownInstance(instance_name=name)
784 jex.QueueJob(name, op)
785 jex.WaitOrShow(not opts.submit_only)
789 def ReplaceDisks(opts, args):
790 """Replace the disks of an instance
792 @param opts: the command line options selected by the user
794 @param args: should contain only one element, the instance name
796 @return: the desired exit code
799 instance_name = args[0]
800 new_2ndary = opts.new_secondary
801 iallocator = opts.iallocator
802 if opts.disks is None:
806 disks = [int(i) for i in opts.disks.split(",")]
807 except ValueError, err:
808 raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err))
809 cnt = [opts.on_primary, opts.on_secondary,
810 new_2ndary is not None, iallocator is not None].count(True)
812 raise errors.OpPrereqError("One and only one of the -p, -s, -n and -i"
813 " options must be passed")
814 elif opts.on_primary:
815 mode = constants.REPLACE_DISK_PRI
816 elif opts.on_secondary:
817 mode = constants.REPLACE_DISK_SEC
818 elif new_2ndary is not None or iallocator is not None:
820 mode = constants.REPLACE_DISK_CHG
822 op = opcodes.OpReplaceDisks(instance_name=args[0], disks=disks,
823 remote_node=new_2ndary, mode=mode,
824 iallocator=iallocator)
825 SubmitOrSend(op, opts)
829 def FailoverInstance(opts, args):
830 """Failover an instance.
832 The failover is done by shutting it down on its present node and
833 starting it on the secondary.
835 @param opts: the command line options selected by the user
837 @param args: should contain only one element, the instance name
839 @return: the desired exit code
843 instance_name = args[0]
847 _EnsureInstancesExist(cl, [instance_name])
849 usertext = ("Failover will happen to image %s."
850 " This requires a shutdown of the instance. Continue?" %
852 if not AskUser(usertext):
855 op = opcodes.OpFailoverInstance(instance_name=instance_name,
856 ignore_consistency=opts.ignore_consistency)
857 SubmitOrSend(op, opts, cl=cl)
861 def MigrateInstance(opts, args):
862 """Migrate an instance.
864 The migrate is done without shutdown.
866 @param opts: the command line options selected by the user
868 @param args: should contain only one element, the instance name
870 @return: the desired exit code
874 instance_name = args[0]
878 _EnsureInstancesExist(cl, [instance_name])
881 usertext = ("Instance %s will be recovered from a failed migration."
882 " Note that the migration procedure (including cleanup)" %
885 usertext = ("Instance %s will be migrated. Note that migration" %
887 usertext += (" is **experimental** in this version."
888 " This might impact the instance if anything goes wrong."
890 if not AskUser(usertext):
893 op = opcodes.OpMigrateInstance(instance_name=instance_name, live=opts.live,
894 cleanup=opts.cleanup)
895 SubmitOpCode(op, cl=cl)
899 def ConnectToInstanceConsole(opts, args):
900 """Connect to the console of an instance.
902 @param opts: the command line options selected by the user
904 @param args: should contain only one element, the instance name
906 @return: the desired exit code
909 instance_name = args[0]
911 op = opcodes.OpConnectConsole(instance_name=instance_name)
912 cmd = SubmitOpCode(op)
914 if opts.show_command:
915 ToStdout("%s", utils.ShellQuoteArgs(cmd))
918 os.execvp(cmd[0], cmd)
920 ToStderr("Can't run console command %s with arguments:\n'%s'",
921 cmd[0], " ".join(cmd))
925 def _FormatLogicalID(dev_type, logical_id):
926 """Formats the logical_id of a disk.
929 if dev_type == constants.LD_DRBD8:
930 node_a, node_b, port, minor_a, minor_b, key = logical_id
932 ("nodeA", "%s, minor=%s" % (node_a, minor_a)),
933 ("nodeB", "%s, minor=%s" % (node_b, minor_b)),
937 elif dev_type == constants.LD_LV:
938 vg_name, lv_name = logical_id
939 data = ["%s/%s" % (vg_name, lv_name)]
941 data = [str(logical_id)]
946 def _FormatBlockDevInfo(idx, top_level, dev, static):
947 """Show block device information.
949 This is only used by L{ShowInstanceConfig}, but it's too big to be
950 left for an inline definition.
953 @param idx: the index of the current disk
954 @type top_level: boolean
955 @param top_level: if this a top-level disk?
957 @param dev: dictionary with disk information
958 @type static: boolean
959 @param static: wheter the device information doesn't contain
960 runtime information but only static data
961 @return: a list of either strings, tuples or lists
962 (which should be formatted at a higher indent level)
965 def helper(dtype, status):
966 """Format one line for physical device status.
969 @param dtype: a constant from the L{constants.LDS_BLOCK} set
971 @param status: a tuple as returned from L{backend.FindBlockDevice}
972 @return: the string representing the status
978 (path, major, minor, syncp, estt, degr, ldisk) = status
982 major_string = str(major)
987 minor_string = str(minor)
989 txt += ("%s (%s:%s)" % (path, major_string, minor_string))
990 if dtype in (constants.LD_DRBD8, ):
991 if syncp is not None:
992 sync_text = "*RECOVERING* %5.2f%%," % syncp
994 sync_text += " ETA %ds" % estt
996 sync_text += " ETA unknown"
998 sync_text = "in sync"
1000 degr_text = "*DEGRADED*"
1004 ldisk_text = " *MISSING DISK*"
1007 txt += (" %s, status %s%s" % (sync_text, degr_text, ldisk_text))
1008 elif dtype == constants.LD_LV:
1010 ldisk_text = " *FAILED* (failed drive?)"
1018 if dev["iv_name"] is not None:
1019 txt = dev["iv_name"]
1021 txt = "disk %d" % idx
1023 txt = "child %d" % idx
1024 d1 = ["- %s: %s" % (txt, dev["dev_type"])]
1027 data.append(("access mode", dev["mode"]))
1028 if dev["logical_id"] is not None:
1030 l_id = _FormatLogicalID(dev["dev_type"], dev["logical_id"])
1032 l_id = [str(dev["logical_id"])]
1034 data.append(("logical_id", l_id[0]))
1037 elif dev["physical_id"] is not None:
1038 data.append("physical_id:")
1039 data.append([dev["physical_id"]])
1041 data.append(("on primary", helper(dev["dev_type"], dev["pstatus"])))
1042 if dev["sstatus"] and not static:
1043 data.append(("on secondary", helper(dev["dev_type"], dev["sstatus"])))
1046 data.append("child devices:")
1047 for c_idx, child in enumerate(dev["children"]):
1048 data.append(_FormatBlockDevInfo(c_idx, False, child, static))
1053 def _FormatList(buf, data, indent_level):
1054 """Formats a list of data at a given indent level.
1056 If the element of the list is:
1057 - a string, it is simply formatted as is
1058 - a tuple, it will be split into key, value and the all the
1059 values in a list will be aligned all at the same start column
1060 - a list, will be recursively formatted
1063 @param buf: the buffer into which we write the output
1064 @param data: the list to format
1065 @type indent_level: int
1066 @param indent_level: the indent level to format at
1069 max_tlen = max([len(elem[0]) for elem in data
1070 if isinstance(elem, tuple)] or [0])
1072 if isinstance(elem, basestring):
1073 buf.write("%*s%s\n" % (2*indent_level, "", elem))
1074 elif isinstance(elem, tuple):
1076 spacer = "%*s" % (max_tlen - len(key), "")
1077 buf.write("%*s%s:%s %s\n" % (2*indent_level, "", key, spacer, value))
1078 elif isinstance(elem, list):
1079 _FormatList(buf, elem, indent_level+1)
1081 def ShowInstanceConfig(opts, args):
1082 """Compute instance run-time status.
1084 @param opts: the command line options selected by the user
1086 @param args: either an empty list, and then we query all
1087 instances, or should contain a list of instance names
1089 @return: the desired exit code
1092 if not args and not opts.show_all:
1093 ToStderr("No instance selected."
1094 " Please pass in --all if you want to query all instances.\n"
1095 "Note that this can take a long time on a big cluster.")
1097 elif args and opts.show_all:
1098 ToStderr("Cannot use --all if you specify instance names.")
1102 op = opcodes.OpQueryInstanceData(instances=args, static=opts.static)
1103 result = SubmitOpCode(op)
1105 ToStdout("No instances.")
1110 for instance_name in result:
1111 instance = result[instance_name]
1112 buf.write("Instance name: %s\n" % instance["name"])
1113 buf.write("State: configured to be %s" % instance["config_state"])
1115 buf.write(", actual state is %s" % instance["run_state"])
1117 ##buf.write("Considered for memory checks in cluster verify: %s\n" %
1118 ## instance["auto_balance"])
1119 buf.write(" Nodes:\n")
1120 buf.write(" - primary: %s\n" % instance["pnode"])
1121 buf.write(" - secondaries: %s\n" % ", ".join(instance["snodes"]))
1122 buf.write(" Operating system: %s\n" % instance["os"])
1123 if instance.has_key("network_port"):
1124 buf.write(" Allocated network port: %s\n" % instance["network_port"])
1125 buf.write(" Hypervisor: %s\n" % instance["hypervisor"])
1127 # custom VNC console information
1128 vnc_bind_address = instance["hv_actual"].get(constants.HV_VNC_BIND_ADDRESS,
1130 if vnc_bind_address:
1131 port = instance["network_port"]
1132 display = int(port) - constants.VNC_BASE_PORT
1133 if display > 0 and vnc_bind_address == constants.BIND_ADDRESS_GLOBAL:
1134 vnc_console_port = "%s:%s (display %s)" % (instance["pnode"],
1137 elif display > 0 and utils.IsValidIP(vnc_bind_address):
1138 vnc_console_port = ("%s:%s (node %s) (display %s)" %
1139 (vnc_bind_address, port,
1140 instance["pnode"], display))
1142 # vnc bind address is a file
1143 vnc_console_port = "%s:%s" % (instance["pnode"],
1145 buf.write(" - console connection: vnc to %s\n" % vnc_console_port)
1147 for key in instance["hv_actual"]:
1148 if key in instance["hv_instance"]:
1149 val = instance["hv_instance"][key]
1151 val = "default (%s)" % instance["hv_actual"][key]
1152 buf.write(" - %s: %s\n" % (key, val))
1153 buf.write(" Hardware:\n")
1154 buf.write(" - VCPUs: %d\n" %
1155 instance["be_actual"][constants.BE_VCPUS])
1156 buf.write(" - memory: %dMiB\n" %
1157 instance["be_actual"][constants.BE_MEMORY])
1158 buf.write(" - NICs:\n")
1159 for idx, (mac, ip, bridge) in enumerate(instance["nics"]):
1160 buf.write(" - nic/%d: MAC: %s, IP: %s, bridge: %s\n" %
1161 (idx, mac, ip, bridge))
1162 buf.write(" Disks:\n")
1164 for idx, device in enumerate(instance["disks"]):
1165 _FormatList(buf, _FormatBlockDevInfo(idx, True, device, opts.static), 2)
1167 ToStdout(buf.getvalue().rstrip('\n'))
1171 def SetInstanceParams(opts, args):
1172 """Modifies an instance.
1174 All parameters take effect only at the next restart of the instance.
1176 @param opts: the command line options selected by the user
1178 @param args: should contain only one element, the instance name
1180 @return: the desired exit code
1183 if not (opts.nics or opts.disks or
1184 opts.hypervisor or opts.beparams):
1185 ToStderr("Please give at least one of the parameters.")
1188 for param in opts.beparams:
1189 if isinstance(opts.beparams[param], basestring):
1190 if opts.beparams[param].lower() == "default":
1191 opts.beparams[param] = constants.VALUE_DEFAULT
1193 utils.ForceDictType(opts.beparams, constants.BES_PARAMETER_TYPES,
1194 allowed_values=[constants.VALUE_DEFAULT])
1196 for param in opts.hypervisor:
1197 if isinstance(opts.hypervisor[param], basestring):
1198 if opts.hypervisor[param].lower() == "default":
1199 opts.hypervisor[param] = constants.VALUE_DEFAULT
1201 utils.ForceDictType(opts.hypervisor, constants.HVS_PARAMETER_TYPES,
1202 allowed_values=[constants.VALUE_DEFAULT])
1204 for idx, (nic_op, nic_dict) in enumerate(opts.nics):
1206 nic_op = int(nic_op)
1207 opts.nics[idx] = (nic_op, nic_dict)
1211 for idx, (disk_op, disk_dict) in enumerate(opts.disks):
1213 disk_op = int(disk_op)
1214 opts.disks[idx] = (disk_op, disk_dict)
1217 if disk_op == constants.DDM_ADD:
1218 if 'size' not in disk_dict:
1219 raise errors.OpPrereqError("Missing required parameter 'size'")
1220 disk_dict['size'] = utils.ParseUnit(disk_dict['size'])
1222 op = opcodes.OpSetInstanceParams(instance_name=args[0],
1225 hvparams=opts.hypervisor,
1226 beparams=opts.beparams,
1229 # even if here we process the result, we allow submit only
1230 result = SubmitOrSend(op, opts)
1233 ToStdout("Modified instance %s", args[0])
1234 for param, data in result:
1235 ToStdout(" - %-5s -> %s", param, data)
1236 ToStdout("Please don't forget that these parameters take effect"
1237 " only at the next start of the instance.")
1241 # options used in more than one cmd
1242 node_opt = make_option("-n", "--node", dest="node", help="Target node",
1245 os_opt = cli_option("-o", "--os-type", dest="os", help="What OS to run",
1248 # multi-instance selection options
1249 m_force_multi = make_option("--force-multiple", dest="force_multi",
1250 help="Do not ask for confirmation when more than"
1251 " one instance is affected",
1252 action="store_true", default=False)
1254 m_pri_node_opt = make_option("--primary", dest="multi_mode",
1255 help="Filter by nodes (primary only)",
1256 const=_SHUTDOWN_NODES_PRI, action="store_const")
1258 m_sec_node_opt = make_option("--secondary", dest="multi_mode",
1259 help="Filter by nodes (secondary only)",
1260 const=_SHUTDOWN_NODES_SEC, action="store_const")
1262 m_node_opt = make_option("--node", dest="multi_mode",
1263 help="Filter by nodes (primary and secondary)",
1264 const=_SHUTDOWN_NODES_BOTH, action="store_const")
1266 m_clust_opt = make_option("--all", dest="multi_mode",
1267 help="Select all instances in the cluster",
1268 const=_SHUTDOWN_CLUSTER, action="store_const")
1270 m_inst_opt = make_option("--instance", dest="multi_mode",
1271 help="Filter by instance name [default]",
1272 const=_SHUTDOWN_INSTANCES, action="store_const")
1275 # this is defined separately due to readability only
1278 make_option("-n", "--node", dest="node",
1279 help="Target node and optional secondary node",
1280 metavar="<pnode>[:<snode>]"),
1282 keyval_option("-B", "--backend", dest="beparams",
1283 type="keyval", default={},
1284 help="Backend parameters"),
1285 make_option("-t", "--disk-template", dest="disk_template",
1286 help="Custom disk setup (diskless, file, plain or drbd)",
1287 default=None, metavar="TEMPL"),
1288 cli_option("-s", "--os-size", dest="sd_size", help="Disk size for a"
1289 " single-disk configuration, when not using the --disk option,"
1290 " in MiB unless a suffix is used",
1291 default=None, type="unit", metavar="<size>"),
1292 ikv_option("--disk", help="Disk information",
1293 default=[], dest="disks",
1295 type="identkeyval"),
1296 ikv_option("--net", help="NIC information",
1297 default=[], dest="nics",
1299 type="identkeyval"),
1300 make_option("--no-nics", default=False, action="store_true",
1301 help="Do not create any network cards for the instance"),
1302 make_option("--no-wait-for-sync", dest="wait_for_sync", default=True,
1303 action="store_false", help="Don't wait for sync (DANGEROUS!)"),
1304 make_option("--no-start", dest="start", default=True,
1305 action="store_false", help="Don't start the instance after"
1307 make_option("--no-ip-check", dest="ip_check", default=True,
1308 action="store_false", help="Don't check that the instance's IP"
1309 " is alive (only valid with --no-start)"),
1310 make_option("--file-storage-dir", dest="file_storage_dir",
1311 help="Relative path under default cluster-wide file storage dir"
1312 " to store file-based disks", default=None,
1314 make_option("--file-driver", dest="file_driver", help="Driver to use"
1315 " for image files", default="loop", metavar="<DRIVER>"),
1316 make_option("-I", "--iallocator", metavar="<NAME>",
1317 help="Select nodes for the instance automatically using the"
1318 " <NAME> iallocator plugin", default=None, type="string"),
1319 ikv_option("-H", "--hypervisor", dest="hypervisor",
1320 help="Hypervisor and hypervisor options, in the format"
1321 " hypervisor:option=value,option=value,...", default=None,
1322 type="identkeyval"),
1327 'add': (AddInstance, ARGS_ONE, add_opts,
1328 "[...] -t disk-type -n node[:secondary-node] -o os-type <name>",
1329 "Creates and adds a new instance to the cluster"),
1330 'batch-create': (BatchCreate, ARGS_ONE,
1332 "<instances_file.json>",
1333 "Create a bunch of instances based on specs in the file."),
1334 'console': (ConnectToInstanceConsole, ARGS_ONE,
1336 make_option("--show-cmd", dest="show_command",
1337 action="store_true", default=False,
1338 help=("Show command instead of executing it"))],
1339 "[--show-cmd] <instance>",
1340 "Opens a console on the specified instance"),
1341 'failover': (FailoverInstance, ARGS_ONE,
1342 [DEBUG_OPT, FORCE_OPT,
1343 make_option("--ignore-consistency", dest="ignore_consistency",
1344 action="store_true", default=False,
1345 help="Ignore the consistency of the disks on"
1350 "Stops the instance and starts it on the backup node, using"
1351 " the remote mirror (only for instances of type drbd)"),
1352 'migrate': (MigrateInstance, ARGS_ONE,
1353 [DEBUG_OPT, FORCE_OPT,
1354 make_option("--non-live", dest="live",
1355 default=True, action="store_false",
1356 help="Do a non-live migration (this usually means"
1357 " freeze the instance, save the state,"
1358 " transfer and only then resume running on the"
1359 " secondary node)"),
1360 make_option("--cleanup", dest="cleanup",
1361 default=False, action="store_true",
1362 help="Instead of performing the migration, try to"
1363 " recover from a failed cleanup. This is safe"
1364 " to run even if the instance is healthy, but it"
1365 " will create extra replication traffic and "
1366 " disrupt briefly the replication (like during the"
1370 "Migrate instance to its secondary node"
1371 " (only for instances of type drbd)"),
1372 'info': (ShowInstanceConfig, ARGS_ANY,
1374 make_option("-s", "--static", dest="static",
1375 action="store_true", default=False,
1376 help="Only show configuration data, not runtime data"),
1377 make_option("--all", dest="show_all",
1378 default=False, action="store_true",
1379 help="Show info on all instances on the cluster."
1380 " This can take a long time to run, use wisely."),
1381 ], "[-s] {--all | <instance>...}",
1382 "Show information on the specified instance(s)"),
1383 'list': (ListInstances, ARGS_ANY,
1384 [DEBUG_OPT, NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT, SYNC_OPT],
1386 "Lists the instances and their status. The available fields are"
1387 " (see the man page for details): status, oper_state, oper_ram,"
1388 " name, os, pnode, snodes, admin_state, admin_ram, disk_template,"
1389 " ip, mac, bridge, sda_size, sdb_size, vcpus, serial_no,"
1391 " The default field"
1392 " list is (in order): %s." % ", ".join(_LIST_DEF_FIELDS),
1394 'reinstall': (ReinstallInstance, ARGS_ANY,
1395 [DEBUG_OPT, FORCE_OPT, os_opt,
1397 m_node_opt, m_pri_node_opt, m_sec_node_opt,
1398 m_clust_opt, m_inst_opt,
1399 make_option("--select-os", dest="select_os",
1400 action="store_true", default=False,
1401 help="Interactive OS reinstall, lists available"
1402 " OS templates for selection"),
1405 "[-f] <instance>", "Reinstall a stopped instance"),
1406 'remove': (RemoveInstance, ARGS_ONE,
1407 [DEBUG_OPT, FORCE_OPT,
1408 make_option("--ignore-failures", dest="ignore_failures",
1409 action="store_true", default=False,
1410 help=("Remove the instance from the cluster even"
1411 " if there are failures during the removal"
1412 " process (shutdown, disk removal, etc.)")),
1415 "[-f] <instance>", "Shuts down the instance and removes it"),
1416 'rename': (RenameInstance, ARGS_FIXED(2),
1418 make_option("--no-ip-check", dest="ignore_ip",
1419 help="Do not check that the IP of the new name"
1421 default=False, action="store_true"),
1424 "<instance> <new_name>", "Rename the instance"),
1425 'replace-disks': (ReplaceDisks, ARGS_ONE,
1427 make_option("-n", "--new-secondary", dest="new_secondary",
1428 help=("New secondary node (for secondary"
1429 " node change)"), metavar="NODE",
1431 make_option("-p", "--on-primary", dest="on_primary",
1432 default=False, action="store_true",
1433 help=("Replace the disk(s) on the primary"
1434 " node (only for the drbd template)")),
1435 make_option("-s", "--on-secondary", dest="on_secondary",
1436 default=False, action="store_true",
1437 help=("Replace the disk(s) on the secondary"
1438 " node (only for the drbd template)")),
1439 make_option("--disks", dest="disks", default=None,
1440 help="Comma-separated list of disks"
1441 " indices to replace (e.g. 0,2) (optional,"
1442 " defaults to all disks)"),
1443 make_option("-I", "--iallocator", metavar="<NAME>",
1444 help="Select new secondary for the instance"
1445 " automatically using the"
1446 " <NAME> iallocator plugin (enables"
1447 " secondary node replacement)",
1448 default=None, type="string"),
1451 "[-s|-p|-n NODE|-I NAME] <instance>",
1452 "Replaces all disks for the instance"),
1453 'modify': (SetInstanceParams, ARGS_ONE,
1454 [DEBUG_OPT, FORCE_OPT,
1455 keyval_option("-H", "--hypervisor", type="keyval",
1456 default={}, dest="hypervisor",
1457 help="Change hypervisor parameters"),
1458 keyval_option("-B", "--backend", type="keyval",
1459 default={}, dest="beparams",
1460 help="Change backend parameters"),
1461 ikv_option("--disk", help="Disk changes",
1462 default=[], dest="disks",
1464 type="identkeyval"),
1465 ikv_option("--net", help="NIC changes",
1466 default=[], dest="nics",
1468 type="identkeyval"),
1471 "<instance>", "Alters the parameters of an instance"),
1472 'shutdown': (ShutdownInstance, ARGS_ANY,
1473 [DEBUG_OPT, m_node_opt, m_pri_node_opt, m_sec_node_opt,
1474 m_clust_opt, m_inst_opt, m_force_multi,
1477 "<instance>", "Stops an instance"),
1478 'startup': (StartupInstance, ARGS_ANY,
1479 [DEBUG_OPT, FORCE_OPT, m_force_multi,
1480 m_node_opt, m_pri_node_opt, m_sec_node_opt,
1481 m_clust_opt, m_inst_opt,
1483 keyval_option("-H", "--hypervisor", type="keyval",
1484 default={}, dest="hvparams",
1485 help="Temporary hypervisor parameters"),
1486 keyval_option("-B", "--backend", type="keyval",
1487 default={}, dest="beparams",
1488 help="Temporary backend parameters"),
1490 "<instance>", "Starts an instance"),
1492 'reboot': (RebootInstance, ARGS_ANY,
1493 [DEBUG_OPT, m_force_multi,
1494 make_option("-t", "--type", dest="reboot_type",
1495 help="Type of reboot: soft/hard/full",
1496 default=constants.INSTANCE_REBOOT_HARD,
1497 type="string", metavar="<REBOOT>"),
1498 make_option("--ignore-secondaries", dest="ignore_secondaries",
1499 default=False, action="store_true",
1500 help="Ignore errors from secondaries"),
1501 m_node_opt, m_pri_node_opt, m_sec_node_opt,
1502 m_clust_opt, m_inst_opt,
1505 "<instance>", "Reboots an instance"),
1506 'activate-disks': (ActivateDisks, ARGS_ONE, [DEBUG_OPT, SUBMIT_OPT],
1508 "Activate an instance's disks"),
1509 'deactivate-disks': (DeactivateDisks, ARGS_ONE, [DEBUG_OPT, SUBMIT_OPT],
1511 "Deactivate an instance's disks"),
1512 'grow-disk': (GrowDisk, ARGS_FIXED(3),
1513 [DEBUG_OPT, SUBMIT_OPT,
1514 make_option("--no-wait-for-sync",
1515 dest="wait_for_sync", default=True,
1516 action="store_false",
1517 help="Don't wait for sync (DANGEROUS!)"),
1519 "<instance> <disk> <size>", "Grow an instance's disk"),
1520 'list-tags': (ListTags, ARGS_ONE, [DEBUG_OPT],
1521 "<instance_name>", "List the tags of the given instance"),
1522 'add-tags': (AddTags, ARGS_ATLEAST(1), [DEBUG_OPT, TAG_SRC_OPT],
1523 "<instance_name> tag...", "Add tags to the given instance"),
1524 'remove-tags': (RemoveTags, ARGS_ATLEAST(1), [DEBUG_OPT, TAG_SRC_OPT],
1525 "<instance_name> tag...", "Remove tags from given instance"),
1528 #: dictionary with aliases for commands
1530 'activate_block_devs': 'activate-disks',
1531 'replace_disks': 'replace-disks',
1536 if __name__ == '__main__':
1537 sys.exit(GenericMain(commands, aliases=aliases,
1538 override={"tag_type": constants.TAG_INSTANCE}))