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
21 """Node related commands"""
23 # pylint: disable-msg=W0401,W0613,W0614,C0103
24 # W0401: Wildcard import ganeti.cli
25 # W0613: Unused argument, since all functions follow the same API
26 # W0614: Unused import %s from wildcard import (since we need cli)
27 # C0103: Invalid name gnt-node
31 from ganeti.cli import *
32 from ganeti import opcodes
33 from ganeti import utils
34 from ganeti import constants
35 from ganeti import errors
36 from ganeti import bootstrap
39 #: default list of field for L{ListNodes}
41 "name", "dtotal", "dfree",
42 "mtotal", "mnode", "mfree",
43 "pinst_cnt", "sinst_cnt",
47 #: default list of field for L{ListStorage}
48 _LIST_STOR_DEF_FIELDS = [
55 constants.SF_ALLOCATABLE,
59 #: headers (and full field list for L{ListNodes}
61 "name": "Node", "pinst_cnt": "Pinst", "sinst_cnt": "Sinst",
62 "pinst_list": "PriInstances", "sinst_list": "SecInstances",
63 "pip": "PrimaryIP", "sip": "SecondaryIP",
64 "dtotal": "DTotal", "dfree": "DFree",
65 "mtotal": "MTotal", "mnode": "MNode", "mfree": "MFree",
67 "ctotal": "CTotal", "cnodes": "CNodes", "csockets": "CSockets",
69 "serial_no": "SerialNo",
70 "master_candidate": "MasterC",
72 "offline": "Offline", "drained": "Drained",
74 "ctime": "CTime", "mtime": "MTime", "uuid": "UUID"
78 #: headers (and full field list for L{ListStorage}
79 _LIST_STOR_HEADERS = {
80 constants.SF_NODE: "Node",
81 constants.SF_TYPE: "Type",
82 constants.SF_NAME: "Name",
83 constants.SF_SIZE: "Size",
84 constants.SF_USED: "Used",
85 constants.SF_FREE: "Free",
86 constants.SF_ALLOCATABLE: "Allocatable",
90 #: User-facing storage unit types
91 _USER_STORAGE_TYPE = {
92 constants.ST_FILE: "file",
93 constants.ST_LVM_PV: "lvm-pv",
94 constants.ST_LVM_VG: "lvm-vg",
98 cli_option("-t", "--storage-type",
99 dest="user_storage_type",
100 choices=_USER_STORAGE_TYPE.keys(),
102 metavar="STORAGE_TYPE",
103 help=("Storage type (%s)" %
104 utils.CommaJoin(_USER_STORAGE_TYPE.keys())))
106 _REPAIRABLE_STORAGE_TYPES = \
107 [st for st, so in constants.VALID_STORAGE_OPERATIONS.iteritems()
108 if constants.SO_FIX_CONSISTENCY in so]
110 _MODIFIABLE_STORAGE_TYPES = constants.MODIFIABLE_STORAGE_FIELDS.keys()
113 def ConvertStorageType(user_storage_type):
114 """Converts a user storage type to its internal name.
118 return _USER_STORAGE_TYPE[user_storage_type]
120 raise errors.OpPrereqError("Unknown storage type: %s" % user_storage_type,
125 def AddNode(opts, args):
126 """Add a node to the cluster.
128 @param opts: the command line options selected by the user
130 @param args: should contain only one element, the new node name
132 @return: the desired exit code
136 dns_data = utils.GetHostInfo(utils.HostInfo.NormalizeName(args[0]))
141 output = cl.QueryNodes(names=[node], fields=['name', 'sip'],
143 node_exists, sip = output[0]
144 except (errors.OpPrereqError, errors.OpExecError):
150 ToStderr("Node %s not in the cluster"
151 " - please retry without '--readd'", node)
155 ToStderr("Node %s already in the cluster (as %s)"
156 " - please retry with '--readd'", node, node_exists)
158 sip = opts.secondary_ip
160 # read the cluster name from the master
161 output = cl.QueryConfigValues(['cluster_name'])
162 cluster_name = output[0]
165 ToStderr("-- WARNING -- \n"
166 "Performing this operation is going to replace the ssh daemon"
168 "on the target machine (%s) with the ones of the"
170 "and grant full intra-cluster ssh root access to/from it\n", node)
172 bootstrap.SetupNodeDaemon(cluster_name, node, opts.ssh_key_check)
174 op = opcodes.OpAddNode(node_name=args[0], secondary_ip=sip,
176 SubmitOpCode(op, opts=opts)
179 def ListNodes(opts, args):
180 """List nodes and their properties.
182 @param opts: the command line options selected by the user
184 @param args: should be an empty list
186 @return: the desired exit code
189 if opts.output is None:
190 selected_fields = _LIST_DEF_FIELDS
191 elif opts.output.startswith("+"):
192 selected_fields = _LIST_DEF_FIELDS + opts.output[1:].split(",")
194 selected_fields = opts.output.split(",")
196 output = GetClient().QueryNodes(args, selected_fields, opts.do_locking)
198 if not opts.no_headers:
199 headers = _LIST_HEADERS
203 unitfields = ["dtotal", "dfree", "mtotal", "mnode", "mfree"]
205 numfields = ["dtotal", "dfree",
206 "mtotal", "mnode", "mfree",
207 "pinst_cnt", "sinst_cnt",
208 "ctotal", "serial_no"]
210 list_type_fields = ("pinst_list", "sinst_list", "tags")
211 # change raw values to nicer strings
213 for idx, field in enumerate(selected_fields):
215 if field in list_type_fields:
217 elif field in ('master', 'master_candidate', 'offline', 'drained'):
222 elif field == "ctime" or field == "mtime":
223 val = utils.FormatTime(val)
228 data = GenerateTable(separator=opts.separator, headers=headers,
229 fields=selected_fields, unitfields=unitfields,
230 numfields=numfields, data=output, units=opts.units)
237 def EvacuateNode(opts, args):
238 """Relocate all secondary instance from a node.
240 @param opts: the command line options selected by the user
242 @param args: should be an empty list
244 @return: the desired exit code
250 dst_node = opts.dst_node
251 iallocator = opts.iallocator
253 cnt = [dst_node, iallocator].count(None)
255 raise errors.OpPrereqError("One and only one of the -n and -I"
256 " options must be passed", errors.ECODE_INVAL)
258 op = opcodes.OpNodeEvacuationStrategy(nodes=args,
259 iallocator=iallocator,
260 remote_node=dst_node)
262 result = SubmitOpCode(op, cl=cl, opts=opts)
264 # no instances to migrate
265 ToStderr("No secondary instances on node(s) %s, exiting.",
266 utils.CommaJoin(args))
267 return constants.EXIT_SUCCESS
269 if not force and not AskUser("Relocate instance(s) %s from node(s) %s?" %
270 (",".join("'%s'" % name[0] for name in result),
271 utils.CommaJoin(args))):
272 return constants.EXIT_CONFIRMATION
274 jex = JobExecutor(cl=cl, opts=opts)
278 ToStdout("Will relocate instance %s to node %s", iname, node)
279 op = opcodes.OpReplaceDisks(instance_name=iname,
280 remote_node=node, disks=[],
281 mode=constants.REPLACE_DISK_CHG,
282 early_release=opts.early_release)
283 jex.QueueJob(iname, op)
284 results = jex.GetResults()
285 bad_cnt = len([row for row in results if not row[0]])
287 ToStdout("All %d instance(s) failed over successfully.", len(results))
288 rcode = constants.EXIT_SUCCESS
290 ToStdout("There were errors during the failover:\n"
291 "%d error(s) out of %d instance(s).", bad_cnt, len(results))
292 rcode = constants.EXIT_FAILURE
296 def FailoverNode(opts, args):
297 """Failover all primary instance on a node.
299 @param opts: the command line options selected by the user
301 @param args: should be an empty list
303 @return: the desired exit code
308 selected_fields = ["name", "pinst_list"]
310 # these fields are static data anyway, so it doesn't matter, but
311 # locking=True should be safer
312 result = cl.QueryNodes(names=args, fields=selected_fields,
314 node, pinst = result[0]
317 ToStderr("No primary instances on node %s, exiting.", node)
320 pinst = utils.NiceSort(pinst)
324 if not force and not AskUser("Fail over instance(s) %s?" %
325 (",".join("'%s'" % name for name in pinst))):
328 jex = JobExecutor(cl=cl, opts=opts)
330 op = opcodes.OpFailoverInstance(instance_name=iname,
331 ignore_consistency=opts.ignore_consistency)
332 jex.QueueJob(iname, op)
333 results = jex.GetResults()
334 bad_cnt = len([row for row in results if not row[0]])
336 ToStdout("All %d instance(s) failed over successfully.", len(results))
338 ToStdout("There were errors during the failover:\n"
339 "%d error(s) out of %d instance(s).", bad_cnt, len(results))
343 def MigrateNode(opts, args):
344 """Migrate all primary instance on a node.
349 selected_fields = ["name", "pinst_list"]
351 result = cl.QueryNodes(names=args, fields=selected_fields, use_locking=False)
352 node, pinst = result[0]
355 ToStdout("No primary instances on node %s, exiting." % node)
358 pinst = utils.NiceSort(pinst)
360 if not force and not AskUser("Migrate instance(s) %s?" %
361 (",".join("'%s'" % name for name in pinst))):
364 op = opcodes.OpMigrateNode(node_name=args[0], live=opts.live)
365 SubmitOpCode(op, cl=cl, opts=opts)
368 def ShowNodeConfig(opts, args):
369 """Show node information.
371 @param opts: the command line options selected by the user
373 @param args: should either be an empty list, in which case
374 we show information about all nodes, or should contain
375 a list of nodes to be queried for information
377 @return: the desired exit code
381 result = cl.QueryNodes(fields=["name", "pip", "sip",
382 "pinst_list", "sinst_list",
383 "master_candidate", "drained", "offline"],
384 names=args, use_locking=False)
386 for (name, primary_ip, secondary_ip, pinst, sinst,
387 is_mc, drained, offline) in result:
388 ToStdout("Node name: %s", name)
389 ToStdout(" primary ip: %s", primary_ip)
390 ToStdout(" secondary ip: %s", secondary_ip)
391 ToStdout(" master candidate: %s", is_mc)
392 ToStdout(" drained: %s", drained)
393 ToStdout(" offline: %s", offline)
395 ToStdout(" primary for instances:")
396 for iname in utils.NiceSort(pinst):
397 ToStdout(" - %s", iname)
399 ToStdout(" primary for no instances")
401 ToStdout(" secondary for instances:")
402 for iname in utils.NiceSort(sinst):
403 ToStdout(" - %s", iname)
405 ToStdout(" secondary for no instances")
410 def RemoveNode(opts, args):
411 """Remove a node from the cluster.
413 @param opts: the command line options selected by the user
415 @param args: should contain only one element, the name of
416 the node to be removed
418 @return: the desired exit code
421 op = opcodes.OpRemoveNode(node_name=args[0])
422 SubmitOpCode(op, opts=opts)
426 def PowercycleNode(opts, args):
427 """Remove a node from the cluster.
429 @param opts: the command line options selected by the user
431 @param args: should contain only one element, the name of
432 the node to be removed
434 @return: the desired exit code
438 if (not opts.confirm and
439 not AskUser("Are you sure you want to hard powercycle node %s?" % node)):
442 op = opcodes.OpPowercycleNode(node_name=node, force=opts.force)
443 result = SubmitOpCode(op, opts=opts)
448 def ListVolumes(opts, args):
449 """List logical volumes on node(s).
451 @param opts: the command line options selected by the user
453 @param args: should either be an empty list, in which case
454 we list data for all nodes, or contain a list of nodes
455 to display data only for those
457 @return: the desired exit code
460 if opts.output is None:
461 selected_fields = ["node", "phys", "vg",
462 "name", "size", "instance"]
464 selected_fields = opts.output.split(",")
466 op = opcodes.OpQueryNodeVolumes(nodes=args, output_fields=selected_fields)
467 output = SubmitOpCode(op, opts=opts)
469 if not opts.no_headers:
470 headers = {"node": "Node", "phys": "PhysDev",
471 "vg": "VG", "name": "Name",
472 "size": "Size", "instance": "Instance"}
476 unitfields = ["size"]
480 data = GenerateTable(separator=opts.separator, headers=headers,
481 fields=selected_fields, unitfields=unitfields,
482 numfields=numfields, data=output, units=opts.units)
490 def ListStorage(opts, args):
491 """List physical volumes on node(s).
493 @param opts: the command line options selected by the user
495 @param args: should either be an empty list, in which case
496 we list data for all nodes, or contain a list of nodes
497 to display data only for those
499 @return: the desired exit code
502 # TODO: Default to ST_FILE if LVM is disabled on the cluster
503 if opts.user_storage_type is None:
504 opts.user_storage_type = constants.ST_LVM_PV
506 storage_type = ConvertStorageType(opts.user_storage_type)
508 if opts.output is None:
509 selected_fields = _LIST_STOR_DEF_FIELDS
510 elif opts.output.startswith("+"):
511 selected_fields = _LIST_STOR_DEF_FIELDS + opts.output[1:].split(",")
513 selected_fields = opts.output.split(",")
515 op = opcodes.OpQueryNodeStorage(nodes=args,
516 storage_type=storage_type,
517 output_fields=selected_fields)
518 output = SubmitOpCode(op, opts=opts)
520 if not opts.no_headers:
522 constants.SF_NODE: "Node",
523 constants.SF_TYPE: "Type",
524 constants.SF_NAME: "Name",
525 constants.SF_SIZE: "Size",
526 constants.SF_USED: "Used",
527 constants.SF_FREE: "Free",
528 constants.SF_ALLOCATABLE: "Allocatable",
533 unitfields = [constants.SF_SIZE, constants.SF_USED, constants.SF_FREE]
534 numfields = [constants.SF_SIZE, constants.SF_USED, constants.SF_FREE]
536 # change raw values to nicer strings
538 for idx, field in enumerate(selected_fields):
540 if field == constants.SF_ALLOCATABLE:
547 data = GenerateTable(separator=opts.separator, headers=headers,
548 fields=selected_fields, unitfields=unitfields,
549 numfields=numfields, data=output, units=opts.units)
557 def ModifyStorage(opts, args):
558 """Modify storage volume on a node.
560 @param opts: the command line options selected by the user
562 @param args: should contain 3 items: node name, storage type and volume name
564 @return: the desired exit code
567 (node_name, user_storage_type, volume_name) = args
569 storage_type = ConvertStorageType(user_storage_type)
573 if opts.allocatable is not None:
574 changes[constants.SF_ALLOCATABLE] = opts.allocatable
577 op = opcodes.OpModifyNodeStorage(node_name=node_name,
578 storage_type=storage_type,
581 SubmitOpCode(op, opts=opts)
583 ToStderr("No changes to perform, exiting.")
586 def RepairStorage(opts, args):
587 """Repairs a storage volume on a node.
589 @param opts: the command line options selected by the user
591 @param args: should contain 3 items: node name, storage type and volume name
593 @return: the desired exit code
596 (node_name, user_storage_type, volume_name) = args
598 storage_type = ConvertStorageType(user_storage_type)
600 op = opcodes.OpRepairNodeStorage(node_name=node_name,
601 storage_type=storage_type,
603 ignore_consistency=opts.ignore_consistency)
604 SubmitOpCode(op, opts=opts)
607 def SetNodeParams(opts, args):
610 @param opts: the command line options selected by the user
612 @param args: should contain only one element, the node name
614 @return: the desired exit code
617 if [opts.master_candidate, opts.drained, opts.offline].count(None) == 3:
618 ToStderr("Please give at least one of the parameters.")
621 op = opcodes.OpSetNodeParams(node_name=args[0],
622 master_candidate=opts.master_candidate,
623 offline=opts.offline,
624 drained=opts.drained,
626 auto_promote=opts.auto_promote)
628 # even if here we process the result, we allow submit only
629 result = SubmitOrSend(op, opts)
632 ToStdout("Modified node %s", args[0])
633 for param, data in result:
634 ToStdout(" - %-5s -> %s", param, data)
640 AddNode, [ArgHost(min=1, max=1)],
641 [SECONDARY_IP_OPT, READD_OPT, NOSSH_KEYCHECK_OPT],
642 "[-s ip] [--readd] [--no-ssh-key-check] <node_name>",
643 "Add a node to the cluster"),
645 EvacuateNode, [ArgNode(min=1)],
646 [FORCE_OPT, IALLOCATOR_OPT, NEW_SECONDARY_OPT, EARLY_RELEASE_OPT],
647 "[-f] {-I <iallocator> | -n <dst>} <node>",
648 "Relocate the secondary instances from a node"
649 " to other nodes (only for instances with drbd disk template)"),
651 FailoverNode, ARGS_ONE_NODE, [FORCE_OPT, IGNORE_CONSIST_OPT],
653 "Stops the primary instances on a node and start them on their"
654 " secondary node (only for instances with drbd disk template)"),
656 MigrateNode, ARGS_ONE_NODE, [FORCE_OPT, NONLIVE_OPT],
658 "Migrate all the primary instance on a node away from it"
659 " (only for instances of type drbd)"),
661 ShowNodeConfig, ARGS_MANY_NODES, [],
662 "[<node_name>...]", "Show information about the node(s)"),
664 ListNodes, ARGS_MANY_NODES,
665 [NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT, SYNC_OPT],
667 "Lists the nodes in the cluster. The available fields are (see the man"
668 " page for details): %s. The default field list is (in order): %s." %
669 (utils.CommaJoin(_LIST_HEADERS), utils.CommaJoin(_LIST_DEF_FIELDS))),
671 SetNodeParams, ARGS_ONE_NODE,
672 [FORCE_OPT, SUBMIT_OPT, MC_OPT, DRAINED_OPT, OFFLINE_OPT,
674 "<node_name>", "Alters the parameters of a node"),
676 PowercycleNode, ARGS_ONE_NODE,
677 [FORCE_OPT, CONFIRM_OPT],
678 "<node_name>", "Tries to forcefully powercycle a node"),
680 RemoveNode, ARGS_ONE_NODE, [],
681 "<node_name>", "Removes a node from the cluster"),
683 ListVolumes, [ArgNode()],
684 [NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT],
685 "[<node_name>...]", "List logical volumes on node(s)"),
687 ListStorage, ARGS_MANY_NODES,
688 [NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT, _STORAGE_TYPE_OPT],
689 "[<node_name>...]", "List physical volumes on node(s). The available"
690 " fields are (see the man page for details): %s." %
691 (utils.CommaJoin(_LIST_STOR_HEADERS))),
694 [ArgNode(min=1, max=1),
695 ArgChoice(min=1, max=1, choices=_MODIFIABLE_STORAGE_TYPES),
696 ArgFile(min=1, max=1)],
698 "<node_name> <storage_type> <name>", "Modify storage volume on a node"),
701 [ArgNode(min=1, max=1),
702 ArgChoice(min=1, max=1, choices=_REPAIRABLE_STORAGE_TYPES),
703 ArgFile(min=1, max=1)],
704 [IGNORE_CONSIST_OPT],
705 "<node_name> <storage_type> <name>",
706 "Repairs a storage volume on a node"),
708 ListTags, ARGS_ONE_NODE, [],
709 "<node_name>", "List the tags of the given node"),
711 AddTags, [ArgNode(min=1, max=1), ArgUnknown()], [TAG_SRC_OPT],
712 "<node_name> tag...", "Add tags to the given node"),
714 RemoveTags, [ArgNode(min=1, max=1), ArgUnknown()], [TAG_SRC_OPT],
715 "<node_name> tag...", "Remove tags from the given node"),
719 if __name__ == '__main__':
720 sys.exit(GenericMain(commands, override={"tag_type": constants.TAG_NODE}))