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)
27 from optparse import make_option
30 from ganeti.cli import *
31 from ganeti import opcodes
32 from ganeti import constants
33 from ganeti import errors
34 from ganeti import utils
35 from ganeti import bootstrap
36 from ganeti import ssh
40 def InitCluster(opts, args):
41 """Initialize the cluster.
43 @param opts: the command line options selected by the user
45 @param args: should contain only one element, the desired
48 @return: the desired exit code
51 if not opts.lvm_storage and opts.vg_name:
52 ToStderr("Options --no-lvm-storage and --vg-name conflict.")
55 vg_name = opts.vg_name
56 if opts.lvm_storage and not opts.vg_name:
57 vg_name = constants.DEFAULT_VG
59 hvlist = opts.enabled_hypervisors
60 if hvlist is not None:
61 hvlist = hvlist.split(",")
63 hvlist = [opts.default_hypervisor]
65 # avoid an impossible situation
66 if opts.default_hypervisor not in hvlist:
67 ToStderr("The default hypervisor requested (%s) is not"
68 " within the enabled hypervisor list (%s)" %
69 (opts.default_hypervisor, hvlist))
72 hvparams = dict(opts.hvparams)
74 beparams = opts.beparams
75 # check for invalid parameters
76 for parameter in beparams:
77 if parameter not in constants.BES_PARAMETERS:
78 ToStderr("Invalid backend parameter: %s", parameter)
81 # prepare beparams dict
82 for parameter in constants.BES_PARAMETERS:
83 if parameter not in beparams:
84 beparams[parameter] = constants.BEC_DEFAULTS[parameter]
85 utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
87 # prepare hvparams dict
88 for hv in constants.HYPER_TYPES:
89 if hv not in hvparams:
91 for parameter in constants.HVC_DEFAULTS[hv]:
92 if parameter not in hvparams[hv]:
93 hvparams[hv][parameter] = constants.HVC_DEFAULTS[hv][parameter]
94 utils.ForceDictType(hvparams[hv], constants.HVS_PARAMETER_TYPES)
97 if hv not in constants.HYPER_TYPES:
98 ToStderr("invalid hypervisor: %s", hv)
101 bootstrap.InitCluster(cluster_name=args[0],
102 secondary_ip=opts.secondary_ip,
104 mac_prefix=opts.mac_prefix,
105 def_bridge=opts.def_bridge,
106 master_netdev=opts.master_netdev,
107 file_storage_dir=opts.file_storage_dir,
108 enabled_hypervisors=hvlist,
109 default_hypervisor=opts.default_hypervisor,
112 candidate_pool_size=opts.candidate_pool_size,
118 def DestroyCluster(opts, args):
119 """Destroy the cluster.
121 @param opts: the command line options selected by the user
123 @param args: should be an empty list
125 @return: the desired exit code
128 if not opts.yes_do_it:
129 ToStderr("Destroying a cluster is irreversible. If you really want"
130 " destroy this cluster, supply the --yes-do-it option.")
133 op = opcodes.OpDestroyCluster()
134 master = SubmitOpCode(op)
135 # if we reached this, the opcode didn't fail; we can proceed to
136 # shutdown all the daemons
137 bootstrap.FinalizeClusterDestroy(master)
141 def RenameCluster(opts, args):
142 """Rename the cluster.
144 @param opts: the command line options selected by the user
146 @param args: should contain only one element, the new cluster name
148 @return: the desired exit code
153 usertext = ("This will rename the cluster to '%s'. If you are connected"
154 " over the network to the cluster name, the operation is very"
155 " dangerous as the IP address will be removed from the node"
156 " and the change may not go through. Continue?") % name
157 if not AskUser(usertext):
160 op = opcodes.OpRenameCluster(name=name)
165 def RedistributeConfig(opts, args):
166 """Forces push of the cluster configuration.
168 @param opts: the command line options selected by the user
170 @param args: empty list
172 @return: the desired exit code
175 op = opcodes.OpRedistributeConfig()
176 SubmitOrSend(op, opts)
180 def ShowClusterVersion(opts, args):
181 """Write version of ganeti software to the standard output.
183 @param opts: the command line options selected by the user
185 @param args: should be an empty list
187 @return: the desired exit code
191 result = cl.QueryClusterInfo()
192 ToStdout("Software version: %s", result["software_version"])
193 ToStdout("Internode protocol: %s", result["protocol_version"])
194 ToStdout("Configuration format: %s", result["config_version"])
195 ToStdout("OS api version: %s", result["os_api_version"])
196 ToStdout("Export interface: %s", result["export_version"])
200 def ShowClusterMaster(opts, args):
201 """Write name of master node to the standard output.
203 @param opts: the command line options selected by the user
205 @param args: should be an empty list
207 @return: the desired exit code
210 master = bootstrap.GetMaster()
215 def ShowClusterConfig(opts, args):
216 """Shows cluster information.
218 @param opts: the command line options selected by the user
220 @param args: should be an empty list
222 @return: the desired exit code
226 result = cl.QueryClusterInfo()
228 ToStdout("Cluster name: %s", result["name"])
230 ToStdout("Master node: %s", result["master"])
232 ToStdout("Architecture (this node): %s (%s)",
233 result["architecture"][0], result["architecture"][1])
235 ToStdout("Default hypervisor: %s", result["default_hypervisor"])
236 ToStdout("Enabled hypervisors: %s", ", ".join(result["enabled_hypervisors"]))
238 ToStdout("Hypervisor parameters:")
239 for hv_name, hv_dict in result["hvparams"].items():
240 ToStdout(" - %s:", hv_name)
241 for item, val in hv_dict.iteritems():
242 ToStdout(" %s: %s", item, val)
244 ToStdout("Cluster parameters:")
245 ToStdout(" - candidate pool size: %s", result["candidate_pool_size"])
246 ToStdout(" - master netdev: %s", result["master_netdev"])
247 ToStdout(" - default bridge: %s", result["default_bridge"])
248 ToStdout(" - lvm volume group: %s", result["volume_group_name"])
249 ToStdout(" - file storage path: %s", result["file_storage_dir"])
251 ToStdout("Default instance parameters:")
252 for gr_name, gr_dict in result["beparams"].items():
253 ToStdout(" - %s:", gr_name)
254 for item, val in gr_dict.iteritems():
255 ToStdout(" %s: %s", item, val)
260 def ClusterCopyFile(opts, args):
261 """Copy a file from master to some nodes.
263 @param opts: the command line options selected by the user
265 @param args: should contain only one element, the path of
266 the file to be copied
268 @return: the desired exit code
272 if not os.path.exists(filename):
273 raise errors.OpPrereqError("No such filename '%s'" % filename)
277 myname = utils.HostInfo().name
279 cluster_name = cl.QueryConfigValues(["cluster_name"])[0]
281 results = GetOnlineNodes(nodes=opts.nodes, cl=cl)
282 results = [name for name in results if name != myname]
284 srun = ssh.SshRunner(cluster_name=cluster_name)
286 if not srun.CopyFileToNode(node, filename):
287 ToStderr("Copy of file %s to node %s failed", filename, node)
292 def RunClusterCommand(opts, args):
293 """Run a command on some nodes.
295 @param opts: the command line options selected by the user
297 @param args: should contain the command to be run and its arguments
299 @return: the desired exit code
304 command = " ".join(args)
306 nodes = GetOnlineNodes(nodes=opts.nodes, cl=cl)
308 cluster_name, master_node = cl.QueryConfigValues(["cluster_name",
311 srun = ssh.SshRunner(cluster_name=cluster_name)
313 # Make sure master node is at list end
314 if master_node in nodes:
315 nodes.remove(master_node)
316 nodes.append(master_node)
319 result = srun.Run(name, "root", command)
320 ToStdout("------------------------------------------------")
321 ToStdout("node: %s", name)
322 ToStdout("%s", result.output)
323 ToStdout("return code = %s", result.exit_code)
328 def VerifyCluster(opts, args):
329 """Verify integrity of cluster, performing various test on nodes.
331 @param opts: the command line options selected by the user
333 @param args: should be an empty list
335 @return: the desired exit code
339 if opts.skip_nplusone_mem:
340 skip_checks.append(constants.VERIFY_NPLUSONE_MEM)
341 op = opcodes.OpVerifyCluster(skip_checks=skip_checks)
348 def VerifyDisks(opts, args):
349 """Verify integrity of cluster disks.
351 @param opts: the command line options selected by the user
353 @param args: should be an empty list
355 @return: the desired exit code
358 op = opcodes.OpVerifyDisks()
359 result = SubmitOpCode(op)
360 if not isinstance(result, (list, tuple)) or len(result) != 4:
361 raise errors.ProgrammerError("Unknown result type for OpVerifyDisks")
363 nodes, nlvm, instances, missing = result
366 ToStdout("Nodes unreachable or with bad data:")
368 ToStdout("\t%s", name)
369 retcode = constants.EXIT_SUCCESS
372 for node, text in nlvm.iteritems():
373 ToStdout("Error on node %s: LVM error: %s",
374 node, utils.SafeEncode(text[-400:]))
376 ToStdout("You need to fix these nodes first before fixing instances")
379 for iname in instances:
382 op = opcodes.OpActivateInstanceDisks(instance_name=iname)
384 ToStdout("Activating disks for instance '%s'", iname)
386 except errors.GenericError, err:
387 nret, msg = FormatError(err)
389 ToStderr("Error activating disks for instance %s: %s", iname, msg)
392 for iname, ival in missing.iteritems():
393 all_missing = utils.all(ival, lambda x: x[0] in nlvm)
395 ToStdout("Instance %s cannot be verified as it lives on"
396 " broken nodes", iname)
398 ToStdout("Instance %s has missing logical volumes:", iname)
400 for node, vol in ival:
402 ToStdout("\tbroken node %s /dev/xenvg/%s", node, vol)
404 ToStdout("\t%s /dev/xenvg/%s", node, vol)
405 ToStdout("You need to run replace_disks for all the above"
406 " instances, if this message persist after fixing nodes.")
413 def MasterFailover(opts, args):
414 """Failover the master node.
416 This command, when run on a non-master node, will cause the current
417 master to cease being master, and the non-master to become new
420 @param opts: the command line options selected by the user
422 @param args: should be an empty list
424 @return: the desired exit code
428 usertext = ("This will perform the failover even if most other nodes"
429 " are down, or if this node is outdated. This is dangerous"
430 " as it can lead to a non-consistent cluster. Check the"
431 " gnt-cluster(8) man page before proceeding. Continue?")
432 if not AskUser(usertext):
435 return bootstrap.MasterFailover(no_voting=opts.no_voting)
438 def SearchTags(opts, args):
439 """Searches the tags on all the cluster.
441 @param opts: the command line options selected by the user
443 @param args: should contain only one element, the tag pattern
445 @return: the desired exit code
448 op = opcodes.OpSearchTags(pattern=args[0])
449 result = SubmitOpCode(op)
452 result = list(result)
454 for path, tag in result:
455 ToStdout("%s %s", path, tag)
458 def SetClusterParams(opts, args):
459 """Modify the cluster.
461 @param opts: the command line options selected by the user
463 @param args: should be an empty list
465 @return: the desired exit code
468 if not (not opts.lvm_storage or opts.vg_name or
469 opts.enabled_hypervisors or opts.hvparams or
470 opts.beparams or opts.candidate_pool_size is not None):
471 ToStderr("Please give at least one of the parameters.")
474 vg_name = opts.vg_name
475 if not opts.lvm_storage and opts.vg_name:
476 ToStdout("Options --no-lvm-storage and --vg-name conflict.")
478 elif not opts.lvm_storage:
481 hvlist = opts.enabled_hypervisors
482 if hvlist is not None:
483 hvlist = hvlist.split(",")
485 # a list of (name, dict) we can pass directly to dict() (or [])
486 hvparams = dict(opts.hvparams)
487 for hv, hv_params in hvparams.iteritems():
488 utils.ForceDictType(hv_params, constants.HVS_PARAMETER_TYPES)
490 beparams = opts.beparams
491 utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
493 op = opcodes.OpSetClusterParams(vg_name=vg_name,
494 enabled_hypervisors=hvlist,
497 candidate_pool_size=opts.candidate_pool_size)
502 def QueueOps(opts, args):
505 @param opts: the command line options selected by the user
507 @param args: should contain only one element, the subcommand
509 @return: the desired exit code
514 if command in ("drain", "undrain"):
515 drain_flag = command == "drain"
516 client.SetQueueDrainFlag(drain_flag)
517 elif command == "info":
518 result = client.QueryConfigValues(["drain_flag"])
523 ToStdout("The drain flag is %s" % val)
525 raise errors.OpPrereqError("Command '%s' is not valid." % command)
529 # this is an option common to more than one command, so we declare
530 # it here and reuse it
531 node_option = make_option("-n", "--node", action="append", dest="nodes",
532 help="Node to copy to (if not given, all nodes),"
533 " can be given multiple times",
534 metavar="<node>", default=[])
537 'init': (InitCluster, ARGS_ONE,
539 make_option("-s", "--secondary-ip", dest="secondary_ip",
540 help="Specify the secondary ip for this node;"
541 " if given, the entire cluster must have secondary"
543 metavar="ADDRESS", default=None),
544 make_option("-m", "--mac-prefix", dest="mac_prefix",
545 help="Specify the mac prefix for the instance IP"
546 " addresses, in the format XX:XX:XX",
548 default=constants.DEFAULT_MAC_PREFIX,),
549 make_option("-g", "--vg-name", dest="vg_name",
550 help="Specify the volume group name "
551 " (cluster-wide) for disk allocation [xenvg]",
554 make_option("-b", "--bridge", dest="def_bridge",
555 help="Specify the default bridge name (cluster-wide)"
556 " to connect the instances to [%s]" %
557 constants.DEFAULT_BRIDGE,
559 default=constants.DEFAULT_BRIDGE,),
560 make_option("--master-netdev", dest="master_netdev",
561 help="Specify the node interface (cluster-wide)"
562 " on which the master IP address will be added "
563 " [%s]" % constants.DEFAULT_BRIDGE,
565 default=constants.DEFAULT_BRIDGE,),
566 make_option("--file-storage-dir", dest="file_storage_dir",
567 help="Specify the default directory (cluster-wide)"
568 " for storing the file-based disks [%s]" %
569 constants.DEFAULT_FILE_STORAGE_DIR,
571 default=constants.DEFAULT_FILE_STORAGE_DIR,),
572 make_option("--no-lvm-storage", dest="lvm_storage",
573 help="No support for lvm based instances"
575 action="store_false", default=True,),
576 make_option("--enabled-hypervisors", dest="enabled_hypervisors",
577 help="Comma-separated list of hypervisors",
578 type="string", default=None),
579 make_option("-t", "--default-hypervisor",
580 dest="default_hypervisor",
581 help="Default hypervisor to use for instance creation",
582 choices=list(constants.HYPER_TYPES),
583 default=constants.DEFAULT_ENABLED_HYPERVISOR),
584 ikv_option("-H", "--hypervisor-parameters", dest="hvparams",
585 help="Hypervisor and hypervisor options, in the"
587 " hypervisor:option=value,option=value,...",
591 keyval_option("-B", "--backend-parameters", dest="beparams",
592 type="keyval", default={},
593 help="Backend parameters"),
594 make_option("-C", "--candidate-pool-size",
595 default=constants.MASTER_POOL_SIZE_DEFAULT,
596 help="Set the candidate pool size",
597 dest="candidate_pool_size", type="int"),
599 "[opts...] <cluster_name>",
600 "Initialises a new cluster configuration"),
601 'destroy': (DestroyCluster, ARGS_NONE,
603 make_option("--yes-do-it", dest="yes_do_it",
604 help="Destroy cluster",
605 action="store_true"),
607 "", "Destroy cluster"),
608 'rename': (RenameCluster, ARGS_ONE, [DEBUG_OPT, FORCE_OPT],
610 "Renames the cluster"),
611 'redist-conf': (RedistributeConfig, ARGS_NONE, [DEBUG_OPT, SUBMIT_OPT],
613 "Forces a push of the configuration file and ssconf files"
614 " to the nodes in the cluster"),
615 'verify': (VerifyCluster, ARGS_NONE, [DEBUG_OPT,
616 make_option("--no-nplus1-mem", dest="skip_nplusone_mem",
617 help="Skip N+1 memory redundancy tests",
621 "", "Does a check on the cluster configuration"),
622 'verify-disks': (VerifyDisks, ARGS_NONE, [DEBUG_OPT],
623 "", "Does a check on the cluster disk status"),
624 'masterfailover': (MasterFailover, ARGS_NONE, [DEBUG_OPT,
625 make_option("--no-voting", dest="no_voting",
626 help="Skip node agreement check (dangerous)",
630 "", "Makes the current node the master"),
631 'version': (ShowClusterVersion, ARGS_NONE, [DEBUG_OPT],
632 "", "Shows the cluster version"),
633 'getmaster': (ShowClusterMaster, ARGS_NONE, [DEBUG_OPT],
634 "", "Shows the cluster master"),
635 'copyfile': (ClusterCopyFile, ARGS_ONE, [DEBUG_OPT, node_option],
636 "[-n node...] <filename>",
637 "Copies a file to all (or only some) nodes"),
638 'command': (RunClusterCommand, ARGS_ATLEAST(1), [DEBUG_OPT, node_option],
639 "[-n node...] <command>",
640 "Runs a command on all (or only some) nodes"),
641 'info': (ShowClusterConfig, ARGS_NONE, [DEBUG_OPT],
642 "", "Show cluster configuration"),
643 'list-tags': (ListTags, ARGS_NONE,
644 [DEBUG_OPT], "", "List the tags of the cluster"),
645 'add-tags': (AddTags, ARGS_ANY, [DEBUG_OPT, TAG_SRC_OPT],
646 "tag...", "Add tags to the cluster"),
647 'remove-tags': (RemoveTags, ARGS_ANY, [DEBUG_OPT, TAG_SRC_OPT],
648 "tag...", "Remove tags from the cluster"),
649 'search-tags': (SearchTags, ARGS_ONE,
650 [DEBUG_OPT], "", "Searches the tags on all objects on"
651 " the cluster for a given pattern (regex)"),
652 'queue': (QueueOps, ARGS_ONE, [DEBUG_OPT],
653 "drain|undrain|info", "Change queue properties"),
654 'modify': (SetClusterParams, ARGS_NONE,
656 make_option("-g", "--vg-name", dest="vg_name",
657 help="Specify the volume group name "
658 " (cluster-wide) for disk allocation "
659 "and enable lvm based storage",
661 make_option("--no-lvm-storage", dest="lvm_storage",
662 help="Disable support for lvm based instances"
664 action="store_false", default=True,),
665 make_option("--enabled-hypervisors", dest="enabled_hypervisors",
666 help="Comma-separated list of hypervisors",
667 type="string", default=None),
668 ikv_option("-H", "--hypervisor-parameters", dest="hvparams",
669 help="Hypervisor and hypervisor options, in the"
671 " hypervisor:option=value,option=value,...",
675 keyval_option("-B", "--backend-parameters", dest="beparams",
676 type="keyval", default={},
677 help="Backend parameters"),
678 make_option("-C", "--candidate-pool-size", default=None,
679 help="Set the candidate pool size",
680 dest="candidate_pool_size", type="int"),
683 "Alters the parameters of the cluster"),
686 if __name__ == '__main__':
687 sys.exit(GenericMain(commands, override={"tag_type": constants.TAG_CLUSTER}))