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)
96 bootstrap.InitCluster(cluster_name=args[0],
97 secondary_ip=opts.secondary_ip,
99 mac_prefix=opts.mac_prefix,
100 def_bridge=opts.def_bridge,
101 master_netdev=opts.master_netdev,
102 file_storage_dir=opts.file_storage_dir,
103 enabled_hypervisors=hvlist,
104 default_hypervisor=opts.default_hypervisor,
107 candidate_pool_size=opts.candidate_pool_size,
113 def DestroyCluster(opts, args):
114 """Destroy the cluster.
116 @param opts: the command line options selected by the user
118 @param args: should be an empty list
120 @return: the desired exit code
123 if not opts.yes_do_it:
124 ToStderr("Destroying a cluster is irreversible. If you really want"
125 " destroy this cluster, supply the --yes-do-it option.")
128 op = opcodes.OpDestroyCluster()
129 master = SubmitOpCode(op)
130 # if we reached this, the opcode didn't fail; we can proceed to
131 # shutdown all the daemons
132 bootstrap.FinalizeClusterDestroy(master)
136 def RenameCluster(opts, args):
137 """Rename the cluster.
139 @param opts: the command line options selected by the user
141 @param args: should contain only one element, the new cluster name
143 @return: the desired exit code
148 usertext = ("This will rename the cluster to '%s'. If you are connected"
149 " over the network to the cluster name, the operation is very"
150 " dangerous as the IP address will be removed from the node"
151 " and the change may not go through. Continue?") % name
152 if not AskUser(usertext):
155 op = opcodes.OpRenameCluster(name=name)
160 def RedistributeConfig(opts, args):
161 """Forces push of the cluster configuration.
163 @param opts: the command line options selected by the user
165 @param args: empty list
167 @return: the desired exit code
170 op = opcodes.OpRedistributeConfig()
171 SubmitOrSend(op, opts)
175 def ShowClusterVersion(opts, args):
176 """Write version of ganeti software to the standard output.
178 @param opts: the command line options selected by the user
180 @param args: should be an empty list
182 @return: the desired exit code
186 result = cl.QueryClusterInfo()
187 ToStdout("Software version: %s", result["software_version"])
188 ToStdout("Internode protocol: %s", result["protocol_version"])
189 ToStdout("Configuration format: %s", result["config_version"])
190 ToStdout("OS api version: %s", result["os_api_version"])
191 ToStdout("Export interface: %s", result["export_version"])
195 def ShowClusterMaster(opts, args):
196 """Write name of master node to the standard output.
198 @param opts: the command line options selected by the user
200 @param args: should be an empty list
202 @return: the desired exit code
205 master = bootstrap.GetMaster()
210 def ShowClusterConfig(opts, args):
211 """Shows cluster information.
213 @param opts: the command line options selected by the user
215 @param args: should be an empty list
217 @return: the desired exit code
221 result = cl.QueryClusterInfo()
223 ToStdout("Cluster name: %s", result["name"])
225 ToStdout("Master node: %s", result["master"])
227 ToStdout("Architecture (this node): %s (%s)",
228 result["architecture"][0], result["architecture"][1])
230 ToStdout("Default hypervisor: %s", result["default_hypervisor"])
231 ToStdout("Enabled hypervisors: %s", ", ".join(result["enabled_hypervisors"]))
233 ToStdout("Hypervisor parameters:")
234 for hv_name, hv_dict in result["hvparams"].items():
235 ToStdout(" - %s:", hv_name)
236 for item, val in hv_dict.iteritems():
237 ToStdout(" %s: %s", item, val)
239 ToStdout("Cluster parameters:")
240 ToStdout(" - candidate pool size: %s", result["candidate_pool_size"])
241 ToStdout(" - master netdev: %s", result["master_netdev"])
242 ToStdout(" - default bridge: %s", result["default_bridge"])
243 ToStdout(" - lvm volume group: %s", result["volume_group_name"])
244 ToStdout(" - file storage path: %s", result["file_storage_dir"])
246 ToStdout("Default instance parameters:")
247 for gr_name, gr_dict in result["beparams"].items():
248 ToStdout(" - %s:", gr_name)
249 for item, val in gr_dict.iteritems():
250 ToStdout(" %s: %s", item, val)
255 def ClusterCopyFile(opts, args):
256 """Copy a file from master to some nodes.
258 @param opts: the command line options selected by the user
260 @param args: should contain only one element, the path of
261 the file to be copied
263 @return: the desired exit code
267 if not os.path.exists(filename):
268 raise errors.OpPrereqError("No such filename '%s'" % filename)
272 myname = utils.HostInfo().name
274 cluster_name = cl.QueryConfigValues(["cluster_name"])[0]
276 results = GetOnlineNodes(nodes=opts.nodes, cl=cl)
277 results = [name for name in results if name != myname]
279 srun = ssh.SshRunner(cluster_name=cluster_name)
281 if not srun.CopyFileToNode(node, filename):
282 ToStderr("Copy of file %s to node %s failed", filename, node)
287 def RunClusterCommand(opts, args):
288 """Run a command on some nodes.
290 @param opts: the command line options selected by the user
292 @param args: should contain the command to be run and its arguments
294 @return: the desired exit code
299 command = " ".join(args)
301 nodes = GetOnlineNodes(nodes=opts.nodes, cl=cl)
303 cluster_name, master_node = cl.QueryConfigValues(["cluster_name",
306 srun = ssh.SshRunner(cluster_name=cluster_name)
308 # Make sure master node is at list end
309 if master_node in nodes:
310 nodes.remove(master_node)
311 nodes.append(master_node)
314 result = srun.Run(name, "root", command)
315 ToStdout("------------------------------------------------")
316 ToStdout("node: %s", name)
317 ToStdout("%s", result.output)
318 ToStdout("return code = %s", result.exit_code)
323 def VerifyCluster(opts, args):
324 """Verify integrity of cluster, performing various test on nodes.
326 @param opts: the command line options selected by the user
328 @param args: should be an empty list
330 @return: the desired exit code
334 if opts.skip_nplusone_mem:
335 skip_checks.append(constants.VERIFY_NPLUSONE_MEM)
336 op = opcodes.OpVerifyCluster(skip_checks=skip_checks)
343 def VerifyDisks(opts, args):
344 """Verify integrity of cluster disks.
346 @param opts: the command line options selected by the user
348 @param args: should be an empty list
350 @return: the desired exit code
353 op = opcodes.OpVerifyDisks()
354 result = SubmitOpCode(op)
355 if not isinstance(result, (list, tuple)) or len(result) != 4:
356 raise errors.ProgrammerError("Unknown result type for OpVerifyDisks")
358 nodes, nlvm, instances, missing = result
361 ToStdout("Nodes unreachable or with bad data:")
363 ToStdout("\t%s", name)
364 retcode = constants.EXIT_SUCCESS
367 for node, text in nlvm.iteritems():
368 ToStdout("Error on node %s: LVM error: %s",
369 node, utils.SafeEncode(text[-400:]))
371 ToStdout("You need to fix these nodes first before fixing instances")
374 for iname in instances:
377 op = opcodes.OpActivateInstanceDisks(instance_name=iname)
379 ToStdout("Activating disks for instance '%s'", iname)
381 except errors.GenericError, err:
382 nret, msg = FormatError(err)
384 ToStderr("Error activating disks for instance %s: %s", iname, msg)
387 for iname, ival in missing.iteritems():
388 all_missing = utils.all(ival, lambda x: x[0] in nlvm)
390 ToStdout("Instance %s cannot be verified as it lives on"
391 " broken nodes", iname)
393 ToStdout("Instance %s has missing logical volumes:", iname)
395 for node, vol in ival:
397 ToStdout("\tbroken node %s /dev/xenvg/%s", node, vol)
399 ToStdout("\t%s /dev/xenvg/%s", node, vol)
400 ToStdout("You need to run replace_disks for all the above"
401 " instances, if this message persist after fixing nodes.")
407 def RepairDiskSizes(opts, args):
408 """Verify sizes of cluster disks.
410 @param opts: the command line options selected by the user
412 @param args: optional list of instances to restrict check to
414 @return: the desired exit code
417 op = opcodes.OpRepairDiskSizes(instances=args)
422 def MasterFailover(opts, args):
423 """Failover the master node.
425 This command, when run on a non-master node, will cause the current
426 master to cease being master, and the non-master to become new
429 @param opts: the command line options selected by the user
431 @param args: should be an empty list
433 @return: the desired exit code
437 usertext = ("This will perform the failover even if most other nodes"
438 " are down, or if this node is outdated. This is dangerous"
439 " as it can lead to a non-consistent cluster. Check the"
440 " gnt-cluster(8) man page before proceeding. Continue?")
441 if not AskUser(usertext):
444 return bootstrap.MasterFailover(no_voting=opts.no_voting)
447 def SearchTags(opts, args):
448 """Searches the tags on all the cluster.
450 @param opts: the command line options selected by the user
452 @param args: should contain only one element, the tag pattern
454 @return: the desired exit code
457 op = opcodes.OpSearchTags(pattern=args[0])
458 result = SubmitOpCode(op)
461 result = list(result)
463 for path, tag in result:
464 ToStdout("%s %s", path, tag)
467 def SetClusterParams(opts, args):
468 """Modify the cluster.
470 @param opts: the command line options selected by the user
472 @param args: should be an empty list
474 @return: the desired exit code
477 if not (not opts.lvm_storage or opts.vg_name or
478 opts.enabled_hypervisors or opts.hvparams or
479 opts.beparams or opts.candidate_pool_size is not None):
480 ToStderr("Please give at least one of the parameters.")
483 vg_name = opts.vg_name
484 if not opts.lvm_storage and opts.vg_name:
485 ToStdout("Options --no-lvm-storage and --vg-name conflict.")
487 elif not opts.lvm_storage:
490 hvlist = opts.enabled_hypervisors
491 if hvlist is not None:
492 hvlist = hvlist.split(",")
494 # a list of (name, dict) we can pass directly to dict() (or [])
495 hvparams = dict(opts.hvparams)
496 for hv, hv_params in hvparams.iteritems():
497 utils.ForceDictType(hv_params, constants.HVS_PARAMETER_TYPES)
499 beparams = opts.beparams
500 utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
502 op = opcodes.OpSetClusterParams(vg_name=vg_name,
503 enabled_hypervisors=hvlist,
506 candidate_pool_size=opts.candidate_pool_size)
511 def QueueOps(opts, args):
514 @param opts: the command line options selected by the user
516 @param args: should contain only one element, the subcommand
518 @return: the desired exit code
523 if command in ("drain", "undrain"):
524 drain_flag = command == "drain"
525 client.SetQueueDrainFlag(drain_flag)
526 elif command == "info":
527 result = client.QueryConfigValues(["drain_flag"])
532 ToStdout("The drain flag is %s" % val)
534 raise errors.OpPrereqError("Command '%s' is not valid." % command)
538 # this is an option common to more than one command, so we declare
539 # it here and reuse it
540 node_option = make_option("-n", "--node", action="append", dest="nodes",
541 help="Node to copy to (if not given, all nodes),"
542 " can be given multiple times",
543 metavar="<node>", default=[])
546 'init': (InitCluster, ARGS_ONE,
548 make_option("-s", "--secondary-ip", dest="secondary_ip",
549 help="Specify the secondary ip for this node;"
550 " if given, the entire cluster must have secondary"
552 metavar="ADDRESS", default=None),
553 make_option("-m", "--mac-prefix", dest="mac_prefix",
554 help="Specify the mac prefix for the instance IP"
555 " addresses, in the format XX:XX:XX",
557 default=constants.DEFAULT_MAC_PREFIX,),
558 make_option("-g", "--vg-name", dest="vg_name",
559 help="Specify the volume group name "
560 " (cluster-wide) for disk allocation [xenvg]",
563 make_option("-b", "--bridge", dest="def_bridge",
564 help="Specify the default bridge name (cluster-wide)"
565 " to connect the instances to [%s]" %
566 constants.DEFAULT_BRIDGE,
568 default=constants.DEFAULT_BRIDGE,),
569 make_option("--master-netdev", dest="master_netdev",
570 help="Specify the node interface (cluster-wide)"
571 " on which the master IP address will be added "
572 " [%s]" % constants.DEFAULT_BRIDGE,
574 default=constants.DEFAULT_BRIDGE,),
575 make_option("--file-storage-dir", dest="file_storage_dir",
576 help="Specify the default directory (cluster-wide)"
577 " for storing the file-based disks [%s]" %
578 constants.DEFAULT_FILE_STORAGE_DIR,
580 default=constants.DEFAULT_FILE_STORAGE_DIR,),
581 make_option("--no-lvm-storage", dest="lvm_storage",
582 help="No support for lvm based instances"
584 action="store_false", default=True,),
585 make_option("--enabled-hypervisors", dest="enabled_hypervisors",
586 help="Comma-separated list of hypervisors",
587 type="string", default=None),
588 make_option("-t", "--default-hypervisor",
589 dest="default_hypervisor",
590 help="Default hypervisor to use for instance creation",
591 choices=list(constants.HYPER_TYPES),
592 default=constants.DEFAULT_ENABLED_HYPERVISOR),
593 ikv_option("-H", "--hypervisor-parameters", dest="hvparams",
594 help="Hypervisor and hypervisor options, in the"
596 " hypervisor:option=value,option=value,...",
600 keyval_option("-B", "--backend-parameters", dest="beparams",
601 type="keyval", default={},
602 help="Backend parameters"),
603 make_option("-C", "--candidate-pool-size",
604 default=constants.MASTER_POOL_SIZE_DEFAULT,
605 help="Set the candidate pool size",
606 dest="candidate_pool_size", type="int"),
608 "[opts...] <cluster_name>",
609 "Initialises a new cluster configuration"),
610 'destroy': (DestroyCluster, ARGS_NONE,
612 make_option("--yes-do-it", dest="yes_do_it",
613 help="Destroy cluster",
614 action="store_true"),
616 "", "Destroy cluster"),
617 'rename': (RenameCluster, ARGS_ONE, [DEBUG_OPT, FORCE_OPT],
619 "Renames the cluster"),
620 'redist-conf': (RedistributeConfig, ARGS_NONE, [DEBUG_OPT, SUBMIT_OPT],
622 "Forces a push of the configuration file and ssconf files"
623 " to the nodes in the cluster"),
624 'verify': (VerifyCluster, ARGS_NONE, [DEBUG_OPT,
625 make_option("--no-nplus1-mem", dest="skip_nplusone_mem",
626 help="Skip N+1 memory redundancy tests",
630 "", "Does a check on the cluster configuration"),
631 'verify-disks': (VerifyDisks, ARGS_NONE, [DEBUG_OPT],
632 "", "Does a check on the cluster disk status"),
633 'repair-disk-sizes': (RepairDiskSizes, ARGS_ANY, [DEBUG_OPT],
634 "", "Updates mismatches in recorded disk sizes"),
635 'masterfailover': (MasterFailover, ARGS_NONE, [DEBUG_OPT,
636 make_option("--no-voting", dest="no_voting",
637 help="Skip node agreement check (dangerous)",
641 "", "Makes the current node the master"),
642 'version': (ShowClusterVersion, ARGS_NONE, [DEBUG_OPT],
643 "", "Shows the cluster version"),
644 'getmaster': (ShowClusterMaster, ARGS_NONE, [DEBUG_OPT],
645 "", "Shows the cluster master"),
646 'copyfile': (ClusterCopyFile, ARGS_ONE, [DEBUG_OPT, node_option],
647 "[-n node...] <filename>",
648 "Copies a file to all (or only some) nodes"),
649 'command': (RunClusterCommand, ARGS_ATLEAST(1), [DEBUG_OPT, node_option],
650 "[-n node...] <command>",
651 "Runs a command on all (or only some) nodes"),
652 'info': (ShowClusterConfig, ARGS_NONE, [DEBUG_OPT],
653 "", "Show cluster configuration"),
654 'list-tags': (ListTags, ARGS_NONE,
655 [DEBUG_OPT], "", "List the tags of the cluster"),
656 'add-tags': (AddTags, ARGS_ANY, [DEBUG_OPT, TAG_SRC_OPT],
657 "tag...", "Add tags to the cluster"),
658 'remove-tags': (RemoveTags, ARGS_ANY, [DEBUG_OPT, TAG_SRC_OPT],
659 "tag...", "Remove tags from the cluster"),
660 'search-tags': (SearchTags, ARGS_ONE,
661 [DEBUG_OPT], "", "Searches the tags on all objects on"
662 " the cluster for a given pattern (regex)"),
663 'queue': (QueueOps, ARGS_ONE, [DEBUG_OPT],
664 "drain|undrain|info", "Change queue properties"),
665 'modify': (SetClusterParams, ARGS_NONE,
667 make_option("-g", "--vg-name", dest="vg_name",
668 help="Specify the volume group name "
669 " (cluster-wide) for disk allocation "
670 "and enable lvm based storage",
672 make_option("--no-lvm-storage", dest="lvm_storage",
673 help="Disable support for lvm based instances"
675 action="store_false", default=True,),
676 make_option("--enabled-hypervisors", dest="enabled_hypervisors",
677 help="Comma-separated list of hypervisors",
678 type="string", default=None),
679 ikv_option("-H", "--hypervisor-parameters", dest="hvparams",
680 help="Hypervisor and hypervisor options, in the"
682 " hypervisor:option=value,option=value,...",
686 keyval_option("-B", "--backend-parameters", dest="beparams",
687 type="keyval", default={},
688 help="Backend parameters"),
689 make_option("-C", "--candidate-pool-size", default=None,
690 help="Set the candidate pool size",
691 dest="candidate_pool_size", type="int"),
694 "Alters the parameters of the cluster"),
697 if __name__ == '__main__':
698 sys.exit(GenericMain(commands, override={"tag_type": constants.TAG_CLUSTER}))