4 # Copyright (C) 2006, 2007, 2008 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)
28 from ganeti.cli import *
29 from ganeti import cli
30 from ganeti import opcodes
31 from ganeti import utils
32 from ganeti import constants
33 from ganeti import errors
34 from ganeti import bootstrap
37 #: default list of field for L{ListNodes}
39 "name", "dtotal", "dfree",
40 "mtotal", "mnode", "mfree",
41 "pinst_cnt", "sinst_cnt",
44 #: headers (and full field list for L{ListNodes}
46 "name": "Node", "pinst_cnt": "Pinst", "sinst_cnt": "Sinst",
47 "pinst_list": "PriInstances", "sinst_list": "SecInstances",
48 "pip": "PrimaryIP", "sip": "SecondaryIP",
49 "dtotal": "DTotal", "dfree": "DFree",
50 "mtotal": "MTotal", "mnode": "MNode", "mfree": "MFree",
52 "ctotal": "CTotal", "cnodes": "CNodes", "csockets": "CSockets",
54 "serial_no": "SerialNo",
55 "master_candidate": "MasterC",
57 "offline": "Offline", "drained": "Drained",
59 "ctime": "CTime", "mtime": "MTime",
62 #: User-facing storage unit types
63 _USER_STORAGE_TYPE = {
64 constants.ST_FILE: "file",
65 constants.ST_LVM_PV: "lvm-pv",
66 constants.ST_LVM_VG: "lvm-vg",
70 cli_option("--storage-type",
71 dest="user_storage_type",
72 choices=_USER_STORAGE_TYPE.keys(),
74 metavar="STORAGE_TYPE",
75 help=("Storage type (%s)" %
76 utils.CommaJoin(_USER_STORAGE_TYPE.keys())))
78 _REPAIRABLE_STORAGE_TYPES = \
79 [st for st, so in constants.VALID_STORAGE_OPERATIONS.iteritems()
80 if constants.SO_FIX_CONSISTENCY in so]
82 _MODIFIABLE_STORAGE_TYPES = constants.MODIFIABLE_STORAGE_FIELDS.keys()
85 def ConvertStorageType(user_storage_type):
86 """Converts a user storage type to its internal name.
90 return _USER_STORAGE_TYPE[user_storage_type]
92 raise errors.OpPrereqError("Unknown storage type: %s" % user_storage_type)
96 def AddNode(opts, args):
97 """Add a node to the cluster.
99 @param opts: the command line options selected by the user
101 @param args: should contain only one element, the new node name
103 @return: the desired exit code
107 dns_data = utils.HostInfo(args[0])
112 output = cl.QueryNodes(names=[node], fields=['name', 'sip'],
114 node_exists, sip = output[0]
115 except (errors.OpPrereqError, errors.OpExecError):
121 ToStderr("Node %s not in the cluster"
122 " - please retry without '--readd'", node)
126 ToStderr("Node %s already in the cluster (as %s)"
127 " - please retry with '--readd'", node, node_exists)
129 sip = opts.secondary_ip
131 # read the cluster name from the master
132 output = cl.QueryConfigValues(['cluster_name'])
133 cluster_name = output[0]
136 ToStderr("-- WARNING -- \n"
137 "Performing this operation is going to replace the ssh daemon"
139 "on the target machine (%s) with the ones of the"
141 "and grant full intra-cluster ssh root access to/from it\n", node)
143 bootstrap.SetupNodeDaemon(cluster_name, node, opts.ssh_key_check)
145 op = opcodes.OpAddNode(node_name=args[0], secondary_ip=sip,
150 def ListNodes(opts, args):
151 """List nodes and their properties.
153 @param opts: the command line options selected by the user
155 @param args: should be an empty list
157 @return: the desired exit code
160 if opts.output is None:
161 selected_fields = _LIST_DEF_FIELDS
162 elif opts.output.startswith("+"):
163 selected_fields = _LIST_DEF_FIELDS + opts.output[1:].split(",")
165 selected_fields = opts.output.split(",")
167 output = GetClient().QueryNodes(args, selected_fields, opts.do_locking)
169 if not opts.no_headers:
170 headers = _LIST_HEADERS
174 unitfields = ["dtotal", "dfree", "mtotal", "mnode", "mfree"]
176 numfields = ["dtotal", "dfree",
177 "mtotal", "mnode", "mfree",
178 "pinst_cnt", "sinst_cnt",
179 "ctotal", "serial_no"]
181 list_type_fields = ("pinst_list", "sinst_list", "tags")
182 # change raw values to nicer strings
184 for idx, field in enumerate(selected_fields):
186 if field in list_type_fields:
188 elif field in ('master', 'master_candidate', 'offline', 'drained'):
193 elif field == "ctime" or field == "mtime":
194 val = utils.FormatTime(val)
199 data = GenerateTable(separator=opts.separator, headers=headers,
200 fields=selected_fields, unitfields=unitfields,
201 numfields=numfields, data=output, units=opts.units)
208 def EvacuateNode(opts, args):
209 """Relocate all secondary instance from a node.
211 @param opts: the command line options selected by the user
213 @param args: should be an empty list
215 @return: the desired exit code
221 dst_node = opts.dst_node
222 iallocator = opts.iallocator
224 cnt = [dst_node, iallocator].count(None)
226 raise errors.OpPrereqError("One and only one of the -n and -I"
227 " options must be passed")
229 selected_fields = ["name", "sinst_list"]
232 result = cl.QueryNodes(names=[src_node], fields=selected_fields,
234 src_node, sinst = result[0]
237 ToStderr("No secondary instances on node %s, exiting.", src_node)
238 return constants.EXIT_SUCCESS
240 if dst_node is not None:
241 result = cl.QueryNodes(names=[dst_node], fields=["name"],
243 dst_node = result[0][0]
245 if src_node == dst_node:
246 raise errors.OpPrereqError("Evacuate node needs different source and"
247 " target nodes (node %s given twice)" %
249 txt_msg = "to node %s" % dst_node
251 txt_msg = "using iallocator %s" % iallocator
253 sinst = utils.NiceSort(sinst)
255 if not force and not AskUser("Relocate instance(s) %s from node\n"
257 (",".join("'%s'" % name for name in sinst),
259 return constants.EXIT_CONFIRMATION
261 op = opcodes.OpEvacuateNode(node_name=args[0], remote_node=dst_node,
262 iallocator=iallocator)
263 SubmitOpCode(op, cl=cl)
266 def FailoverNode(opts, args):
267 """Failover all primary instance on a node.
269 @param opts: the command line options selected by the user
271 @param args: should be an empty list
273 @return: the desired exit code
278 selected_fields = ["name", "pinst_list"]
280 # these fields are static data anyway, so it doesn't matter, but
281 # locking=True should be safer
282 result = cl.QueryNodes(names=args, fields=selected_fields,
284 node, pinst = result[0]
287 ToStderr("No primary instances on node %s, exiting.", node)
290 pinst = utils.NiceSort(pinst)
294 if not force and not AskUser("Fail over instance(s) %s?" %
295 (",".join("'%s'" % name for name in pinst))):
298 jex = JobExecutor(cl=cl)
300 op = opcodes.OpFailoverInstance(instance_name=iname,
301 ignore_consistency=opts.ignore_consistency)
302 jex.QueueJob(iname, op)
303 results = jex.GetResults()
304 bad_cnt = len([row for row in results if not row[0]])
306 ToStdout("All %d instance(s) failed over successfully.", len(results))
308 ToStdout("There were errors during the failover:\n"
309 "%d error(s) out of %d instance(s).", bad_cnt, len(results))
313 def MigrateNode(opts, args):
314 """Migrate all primary instance on a node.
319 selected_fields = ["name", "pinst_list"]
321 result = cl.QueryNodes(names=args, fields=selected_fields, use_locking=False)
322 node, pinst = result[0]
325 ToStdout("No primary instances on node %s, exiting." % node)
328 pinst = utils.NiceSort(pinst)
332 if not force and not AskUser("Migrate instance(s) %s?" %
333 (",".join("'%s'" % name for name in pinst))):
336 op = opcodes.OpMigrateNode(node_name=args[0], live=opts.live)
337 SubmitOpCode(op, cl=cl)
340 def ShowNodeConfig(opts, args):
341 """Show node information.
343 @param opts: the command line options selected by the user
345 @param args: should either be an empty list, in which case
346 we show information about all nodes, or should contain
347 a list of nodes to be queried for information
349 @return: the desired exit code
353 result = cl.QueryNodes(fields=["name", "pip", "sip",
354 "pinst_list", "sinst_list",
355 "master_candidate", "drained", "offline"],
356 names=args, use_locking=False)
358 for (name, primary_ip, secondary_ip, pinst, sinst,
359 is_mc, drained, offline) in result:
360 ToStdout("Node name: %s", name)
361 ToStdout(" primary ip: %s", primary_ip)
362 ToStdout(" secondary ip: %s", secondary_ip)
363 ToStdout(" master candidate: %s", is_mc)
364 ToStdout(" drained: %s", drained)
365 ToStdout(" offline: %s", offline)
367 ToStdout(" primary for instances:")
368 for iname in utils.NiceSort(pinst):
369 ToStdout(" - %s", iname)
371 ToStdout(" primary for no instances")
373 ToStdout(" secondary for instances:")
374 for iname in utils.NiceSort(sinst):
375 ToStdout(" - %s", iname)
377 ToStdout(" secondary for no instances")
382 def RemoveNode(opts, args):
383 """Remove a node from the cluster.
385 @param opts: the command line options selected by the user
387 @param args: should contain only one element, the name of
388 the node to be removed
390 @return: the desired exit code
393 op = opcodes.OpRemoveNode(node_name=args[0])
398 def PowercycleNode(opts, args):
399 """Remove a node from the cluster.
401 @param opts: the command line options selected by the user
403 @param args: should contain only one element, the name of
404 the node to be removed
406 @return: the desired exit code
410 if (not opts.confirm and
411 not AskUser("Are you sure you want to hard powercycle node %s?" % node)):
414 op = opcodes.OpPowercycleNode(node_name=node, force=opts.force)
415 result = SubmitOpCode(op)
420 def ListVolumes(opts, args):
421 """List logical volumes on node(s).
423 @param opts: the command line options selected by the user
425 @param args: should either be an empty list, in which case
426 we list data for all nodes, or contain a list of nodes
427 to display data only for those
429 @return: the desired exit code
432 if opts.output is None:
433 selected_fields = ["node", "phys", "vg",
434 "name", "size", "instance"]
436 selected_fields = opts.output.split(",")
438 op = opcodes.OpQueryNodeVolumes(nodes=args, output_fields=selected_fields)
439 output = SubmitOpCode(op)
441 if not opts.no_headers:
442 headers = {"node": "Node", "phys": "PhysDev",
443 "vg": "VG", "name": "Name",
444 "size": "Size", "instance": "Instance"}
448 unitfields = ["size"]
452 data = GenerateTable(separator=opts.separator, headers=headers,
453 fields=selected_fields, unitfields=unitfields,
454 numfields=numfields, data=output, units=opts.units)
462 def ListPhysicalVolumes(opts, args):
463 """List physical volumes on node(s).
465 @param opts: the command line options selected by the user
467 @param args: should either be an empty list, in which case
468 we list data for all nodes, or contain a list of nodes
469 to display data only for those
471 @return: the desired exit code
474 # TODO: Default to ST_FILE if LVM is disabled on the cluster
475 if opts.user_storage_type is None:
476 opts.user_storage_type = constants.ST_LVM_PV
478 storage_type = ConvertStorageType(opts.user_storage_type)
486 constants.ST_LVM_PV: [
492 constants.ST_LVM_VG: [
498 if opts.output is None:
499 selected_fields = ["node"]
500 selected_fields.extend(default_fields[storage_type])
502 selected_fields = opts.output.split(",")
504 op = opcodes.OpQueryNodeStorage(nodes=args,
505 storage_type=storage_type,
506 output_fields=selected_fields)
507 output = SubmitOpCode(op)
509 if not opts.no_headers:
512 constants.SF_NAME: "Name",
513 constants.SF_SIZE: "Size",
514 constants.SF_USED: "Used",
515 constants.SF_FREE: "Free",
516 constants.SF_ALLOCATABLE: "Allocatable",
521 unitfields = [constants.SF_SIZE, constants.SF_USED, constants.SF_FREE]
522 numfields = [constants.SF_SIZE, constants.SF_USED, constants.SF_FREE]
524 data = GenerateTable(separator=opts.separator, headers=headers,
525 fields=selected_fields, unitfields=unitfields,
526 numfields=numfields, data=output, units=opts.units)
534 def ModifyVolume(opts, args):
535 """Modify storage volume on a node.
537 @param opts: the command line options selected by the user
539 @param args: should contain 3 items: node name, storage type and volume name
541 @return: the desired exit code
544 (node_name, user_storage_type, volume_name) = args
546 storage_type = ConvertStorageType(user_storage_type)
550 if opts.allocatable is not None:
551 changes[constants.SF_ALLOCATABLE] = (opts.allocatable == "yes")
554 op = opcodes.OpModifyNodeStorage(node_name=node_name,
555 storage_type=storage_type,
561 def RepairVolume(opts, args):
562 """Repairs a storage volume on a node.
564 @param opts: the command line options selected by the user
566 @param args: should contain 3 items: node name, storage type and volume name
568 @return: the desired exit code
571 (node_name, user_storage_type, volume_name) = args
573 storage_type = ConvertStorageType(user_storage_type)
575 op = opcodes.OpRepairNodeStorage(node_name=node_name,
576 storage_type=storage_type,
581 def SetNodeParams(opts, args):
584 @param opts: the command line options selected by the user
586 @param args: should contain only one element, the node name
588 @return: the desired exit code
591 if [opts.master_candidate, opts.drained, opts.offline].count(None) == 3:
592 ToStderr("Please give at least one of the parameters.")
595 if opts.master_candidate is not None:
596 candidate = opts.master_candidate == 'yes'
599 if opts.offline is not None:
600 offline = opts.offline == 'yes'
604 if opts.drained is not None:
605 drained = opts.drained == 'yes'
608 op = opcodes.OpSetNodeParams(node_name=args[0],
609 master_candidate=candidate,
614 # even if here we process the result, we allow submit only
615 result = SubmitOrSend(op, opts)
618 ToStdout("Modified node %s", args[0])
619 for param, data in result:
620 ToStdout(" - %-5s -> %s", param, data)
625 'add': (AddNode, [ArgHost(min=1, max=1)],
627 cli_option("-s", "--secondary-ip", dest="secondary_ip",
628 help="Specify the secondary ip for the node",
629 metavar="ADDRESS", default=None),
630 cli_option("--readd", dest="readd",
631 default=False, action="store_true",
632 help="Readd old node after replacing it"),
633 cli_option("--no-ssh-key-check", dest="ssh_key_check",
634 default=True, action="store_false",
635 help="Disable SSH key fingerprint checking"),
637 "[-s ip] [--readd] [--no-ssh-key-check] <node_name>",
638 "Add a node to the cluster"),
639 'evacuate': (EvacuateNode, ARGS_ONE_NODE,
640 [DEBUG_OPT, FORCE_OPT,
641 cli_option("-n", "--new-secondary", dest="dst_node",
642 help="New secondary node", metavar="NODE",
644 completion_suggest=OPT_COMPL_ONE_NODE),
645 cli_option("-I", "--iallocator", metavar="<NAME>",
646 help="Select new secondary for the instance"
647 " automatically using the"
648 " <NAME> iallocator plugin",
649 default=None, type="string",
650 completion_suggest=OPT_COMPL_ONE_IALLOCATOR),
652 "[-f] {-I <iallocator> | -n <dst>} <node>",
653 "Relocate the secondary instances from a node"
654 " to other nodes (only for instances with drbd disk template)"),
655 'failover': (FailoverNode, ARGS_ONE_NODE,
656 [DEBUG_OPT, FORCE_OPT,
657 cli_option("--ignore-consistency", dest="ignore_consistency",
658 action="store_true", default=False,
659 help="Ignore the consistency of the disks on"
663 "Stops the primary instances on a node and start them on their"
664 " secondary node (only for instances with drbd disk template)"),
665 'migrate': (MigrateNode, ARGS_ONE_NODE,
666 [DEBUG_OPT, FORCE_OPT,
667 cli_option("--non-live", dest="live",
668 default=True, action="store_false",
669 help="Do a non-live migration (this usually means"
670 " freeze the instance, save the state,"
671 " transfer and only then resume running on the"
675 "Migrate all the primary instance on a node away from it"
676 " (only for instances of type drbd)"),
677 'info': (ShowNodeConfig, ARGS_MANY_NODES, [DEBUG_OPT],
678 "[<node_name>...]", "Show information about the node(s)"),
679 'list': (ListNodes, ARGS_MANY_NODES,
680 [DEBUG_OPT, NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT, SYNC_OPT],
682 "Lists the nodes in the cluster. The available fields"
683 " are (see the man page for details): %s"
684 " The default field list is (in order): %s." %
685 (", ".join(_LIST_HEADERS), ", ".join(_LIST_DEF_FIELDS))),
686 'modify': (SetNodeParams, ARGS_ONE_NODE,
687 [DEBUG_OPT, FORCE_OPT,
689 cli_option("-C", "--master-candidate", dest="master_candidate",
690 choices=('yes', 'no'), default=None,
692 help="Set the master_candidate flag on the node"),
693 cli_option("-O", "--offline", dest="offline", metavar="yes|no",
694 choices=('yes', 'no'), default=None,
695 help="Set the offline flag on the node"),
696 cli_option("-D", "--drained", dest="drained", metavar="yes|no",
697 choices=('yes', 'no'), default=None,
698 help="Set the drained flag on the node"),
700 "<node>", "Alters the parameters of a node"),
701 'powercycle': (PowercycleNode, ARGS_ONE_NODE,
702 [DEBUG_OPT, FORCE_OPT, CONFIRM_OPT],
703 "<node_name>", "Tries to forcefully powercycle a node"),
704 'remove': (RemoveNode, ARGS_ONE_NODE, [DEBUG_OPT],
705 "<node_name>", "Removes a node from the cluster"),
706 'volumes': (ListVolumes, [ArgNode()],
707 [DEBUG_OPT, NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT],
708 "[<node_name>...]", "List logical volumes on node(s)"),
709 'physical-volumes': (ListPhysicalVolumes, ARGS_MANY_NODES,
710 [DEBUG_OPT, NOHDR_OPT, SEP_OPT, USEUNITS_OPT,
711 FIELDS_OPT, _STORAGE_TYPE_OPT],
713 "List physical volumes on node(s)"),
714 'modify-volume': (ModifyVolume,
715 [ArgNode(min=1, max=1),
716 ArgChoice(min=1, max=1,
717 choices=_MODIFIABLE_STORAGE_TYPES),
718 ArgFile(min=1, max=1)],
720 cli_option("--allocatable", dest="allocatable",
721 choices=["yes", "no"], default=None,
723 help="Set the allocatable flag on a volume"),
725 "<node_name> <storage_type> <name>",
726 "Modify storage volume on a node"),
727 'repair-volume': (RepairVolume,
728 [ArgNode(min=1, max=1),
729 ArgChoice(min=1, max=1,
730 choices=_REPAIRABLE_STORAGE_TYPES),
731 ArgFile(min=1, max=1)],
733 "<node_name> <storage_type> <name>",
734 "Repairs a storage volume on a node"),
735 'list-tags': (ListTags, ARGS_ONE_NODE, [DEBUG_OPT],
736 "<node_name>", "List the tags of the given node"),
737 'add-tags': (AddTags, [ArgNode(min=1, max=1), ArgUnknown()],
738 [DEBUG_OPT, TAG_SRC_OPT],
739 "<node_name> tag...", "Add tags to the given node"),
740 'remove-tags': (RemoveTags, [ArgNode(min=1, max=1), ArgUnknown()],
741 [DEBUG_OPT, TAG_SRC_OPT],
742 "<node_name> tag...", "Remove tags from the given node"),
746 if __name__ == '__main__':
747 sys.exit(GenericMain(commands, override={"tag_type": constants.TAG_NODE}))