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
37 from ganeti import objects
41 def InitCluster(opts, args):
42 """Initialize the cluster.
44 @param opts: the command line options selected by the user
46 @param args: should contain only one element, the desired
49 @return: the desired exit code
52 if not opts.lvm_storage and opts.vg_name:
53 ToStderr("Options --no-lvm-storage and --vg-name conflict.")
56 vg_name = opts.vg_name
57 if opts.lvm_storage and not opts.vg_name:
58 vg_name = constants.DEFAULT_VG
60 hvlist = opts.enabled_hypervisors
61 if hvlist is not None:
62 hvlist = hvlist.split(",")
64 hvlist = [opts.default_hypervisor]
66 # avoid an impossible situation
67 if opts.default_hypervisor not in hvlist:
68 ToStderr("The default hypervisor requested (%s) is not"
69 " within the enabled hypervisor list (%s)" %
70 (opts.default_hypervisor, hvlist))
73 hvparams = dict(opts.hvparams)
74 beparams = opts.beparams
75 nicparams = opts.nicparams
77 # prepare beparams dict
78 beparams = objects.FillDict(constants.BEC_DEFAULTS, beparams)
79 utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
81 # prepare nicparams dict
82 nicparams = objects.FillDict(constants.NICC_DEFAULTS, nicparams)
83 utils.ForceDictType(nicparams, constants.NICS_PARAMETER_TYPES)
85 # prepare hvparams dict
86 for hv in constants.HYPER_TYPES:
87 if hv not in hvparams:
89 hvparams[hv] = objects.FillDict(constants.HVC_DEFAULTS[hv], hvparams[hv])
90 utils.ForceDictType(hvparams[hv], constants.HVS_PARAMETER_TYPES)
93 if hv not in constants.HYPER_TYPES:
94 ToStderr("invalid hypervisor: %s", hv)
97 bootstrap.InitCluster(cluster_name=args[0],
98 secondary_ip=opts.secondary_ip,
100 mac_prefix=opts.mac_prefix,
101 def_bridge=opts.def_bridge,
102 master_netdev=opts.master_netdev,
103 file_storage_dir=opts.file_storage_dir,
104 enabled_hypervisors=hvlist,
105 default_hypervisor=opts.default_hypervisor,
109 candidate_pool_size=opts.candidate_pool_size,
110 modify_etc_hosts=opts.modify_etc_hosts,
116 def DestroyCluster(opts, args):
117 """Destroy the cluster.
119 @param opts: the command line options selected by the user
121 @param args: should be an empty list
123 @return: the desired exit code
126 if not opts.yes_do_it:
127 ToStderr("Destroying a cluster is irreversible. If you really want"
128 " destroy this cluster, supply the --yes-do-it option.")
131 op = opcodes.OpDestroyCluster()
132 master = SubmitOpCode(op)
133 # if we reached this, the opcode didn't fail; we can proceed to
134 # shutdown all the daemons
135 bootstrap.FinalizeClusterDestroy(master)
139 def RenameCluster(opts, args):
140 """Rename the cluster.
142 @param opts: the command line options selected by the user
144 @param args: should contain only one element, the new cluster name
146 @return: the desired exit code
151 usertext = ("This will rename the cluster to '%s'. If you are connected"
152 " over the network to the cluster name, the operation is very"
153 " dangerous as the IP address will be removed from the node"
154 " and the change may not go through. Continue?") % name
155 if not AskUser(usertext):
158 op = opcodes.OpRenameCluster(name=name)
163 def RedistributeConfig(opts, args):
164 """Forces push of the cluster configuration.
166 @param opts: the command line options selected by the user
168 @param args: empty list
170 @return: the desired exit code
173 op = opcodes.OpRedistributeConfig()
174 SubmitOrSend(op, opts)
178 def ShowClusterVersion(opts, args):
179 """Write version of ganeti software to the standard output.
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
189 result = cl.QueryClusterInfo()
190 ToStdout("Software version: %s", result["software_version"])
191 ToStdout("Internode protocol: %s", result["protocol_version"])
192 ToStdout("Configuration format: %s", result["config_version"])
193 ToStdout("OS api version: %s", result["os_api_version"])
194 ToStdout("Export interface: %s", result["export_version"])
198 def ShowClusterMaster(opts, args):
199 """Write name of master node to the standard output.
201 @param opts: the command line options selected by the user
203 @param args: should be an empty list
205 @return: the desired exit code
208 master = bootstrap.GetMaster()
212 def _PrintGroupedParams(paramsdict):
213 """Print Grouped parameters (be, nic, disk) by group.
215 @type paramsdict: dict of dicts
216 @param paramsdict: {group: {param: value, ...}, ...}
219 for gr_name, gr_dict in paramsdict.items():
220 ToStdout(" - %s:", gr_name)
221 for item, val in gr_dict.iteritems():
222 ToStdout(" %s: %s", item, val)
224 def ShowClusterConfig(opts, args):
225 """Shows cluster information.
227 @param opts: the command line options selected by the user
229 @param args: should be an empty list
231 @return: the desired exit code
235 result = cl.QueryClusterInfo()
237 ToStdout("Cluster name: %s", result["name"])
239 ToStdout("Master node: %s", result["master"])
241 ToStdout("Architecture (this node): %s (%s)",
242 result["architecture"][0], result["architecture"][1])
244 ToStdout("Default hypervisor: %s", result["default_hypervisor"])
245 ToStdout("Enabled hypervisors: %s", ", ".join(result["enabled_hypervisors"]))
247 ToStdout("Hypervisor parameters:")
248 _PrintGroupedParams(result["hvparams"])
250 ToStdout("Cluster parameters:")
251 ToStdout(" - candidate pool size: %s", result["candidate_pool_size"])
252 ToStdout(" - master netdev: %s", result["master_netdev"])
253 ToStdout(" - default bridge: %s", result["default_bridge"])
254 ToStdout(" - lvm volume group: %s", result["volume_group_name"])
255 ToStdout(" - file storage path: %s", result["file_storage_dir"])
257 ToStdout("Default instance parameters:")
258 _PrintGroupedParams(result["beparams"])
260 ToStdout("Default nic parameters:")
261 _PrintGroupedParams(result["nicparams"])
266 def ClusterCopyFile(opts, args):
267 """Copy a file from master to some nodes.
269 @param opts: the command line options selected by the user
271 @param args: should contain only one element, the path of
272 the file to be copied
274 @return: the desired exit code
278 if not os.path.exists(filename):
279 raise errors.OpPrereqError("No such filename '%s'" % filename)
283 myname = utils.HostInfo().name
285 cluster_name = cl.QueryConfigValues(["cluster_name"])[0]
287 results = GetOnlineNodes(nodes=opts.nodes, cl=cl)
288 results = [name for name in results if name != myname]
290 srun = ssh.SshRunner(cluster_name=cluster_name)
292 if not srun.CopyFileToNode(node, filename):
293 ToStderr("Copy of file %s to node %s failed", filename, node)
298 def RunClusterCommand(opts, args):
299 """Run a command on some nodes.
301 @param opts: the command line options selected by the user
303 @param args: should contain the command to be run and its arguments
305 @return: the desired exit code
310 command = " ".join(args)
312 nodes = GetOnlineNodes(nodes=opts.nodes, cl=cl)
314 cluster_name, master_node = cl.QueryConfigValues(["cluster_name",
317 srun = ssh.SshRunner(cluster_name=cluster_name)
319 # Make sure master node is at list end
320 if master_node in nodes:
321 nodes.remove(master_node)
322 nodes.append(master_node)
325 result = srun.Run(name, "root", command)
326 ToStdout("------------------------------------------------")
327 ToStdout("node: %s", name)
328 ToStdout("%s", result.output)
329 ToStdout("return code = %s", result.exit_code)
334 def VerifyCluster(opts, args):
335 """Verify integrity of cluster, performing various test on nodes.
337 @param opts: the command line options selected by the user
339 @param args: should be an empty list
341 @return: the desired exit code
345 if opts.skip_nplusone_mem:
346 skip_checks.append(constants.VERIFY_NPLUSONE_MEM)
347 op = opcodes.OpVerifyCluster(skip_checks=skip_checks)
354 def VerifyDisks(opts, args):
355 """Verify integrity of cluster disks.
357 @param opts: the command line options selected by the user
359 @param args: should be an empty list
361 @return: the desired exit code
364 op = opcodes.OpVerifyDisks()
365 result = SubmitOpCode(op)
366 if not isinstance(result, (list, tuple)) or len(result) != 4:
367 raise errors.ProgrammerError("Unknown result type for OpVerifyDisks")
369 nodes, nlvm, instances, missing = result
372 ToStdout("Nodes unreachable or with bad data:")
374 ToStdout("\t%s", name)
375 retcode = constants.EXIT_SUCCESS
378 for node, text in nlvm.iteritems():
379 ToStdout("Error on node %s: LVM error: %s",
380 node, utils.SafeEncode(text[-400:]))
382 ToStdout("You need to fix these nodes first before fixing instances")
385 for iname in instances:
388 op = opcodes.OpActivateInstanceDisks(instance_name=iname)
390 ToStdout("Activating disks for instance '%s'", iname)
392 except errors.GenericError, err:
393 nret, msg = FormatError(err)
395 ToStderr("Error activating disks for instance %s: %s", iname, msg)
398 for iname, ival in missing.iteritems():
399 all_missing = utils.all(ival, lambda x: x[0] in nlvm)
401 ToStdout("Instance %s cannot be verified as it lives on"
402 " broken nodes", iname)
404 ToStdout("Instance %s has missing logical volumes:", iname)
406 for node, vol in ival:
408 ToStdout("\tbroken node %s /dev/xenvg/%s", node, vol)
410 ToStdout("\t%s /dev/xenvg/%s", node, vol)
411 ToStdout("You need to run replace_disks for all the above"
412 " instances, if this message persist after fixing nodes.")
419 def MasterFailover(opts, args):
420 """Failover the master node.
422 This command, when run on a non-master node, will cause the current
423 master to cease being master, and the non-master to become new
426 @param opts: the command line options selected by the user
428 @param args: should be an empty list
430 @return: the desired exit code
433 return bootstrap.MasterFailover()
436 def SearchTags(opts, args):
437 """Searches the tags on all the cluster.
439 @param opts: the command line options selected by the user
441 @param args: should contain only one element, the tag pattern
443 @return: the desired exit code
446 op = opcodes.OpSearchTags(pattern=args[0])
447 result = SubmitOpCode(op)
450 result = list(result)
452 for path, tag in result:
453 ToStdout("%s %s", path, tag)
456 def SetClusterParams(opts, args):
457 """Modify the cluster.
459 @param opts: the command line options selected by the user
461 @param args: should be an empty list
463 @return: the desired exit code
466 if not (not opts.lvm_storage or opts.vg_name or
467 opts.enabled_hypervisors or opts.hvparams or
468 opts.beparams or opts.nicparams or
469 opts.candidate_pool_size is not None):
470 ToStderr("Please give at least one of the parameters.")
473 vg_name = opts.vg_name
474 if not opts.lvm_storage and opts.vg_name:
475 ToStdout("Options --no-lvm-storage and --vg-name conflict.")
477 elif not opts.lvm_storage:
480 hvlist = opts.enabled_hypervisors
481 if hvlist is not None:
482 hvlist = hvlist.split(",")
484 # a list of (name, dict) we can pass directly to dict() (or [])
485 hvparams = dict(opts.hvparams)
486 for hv, hv_params in hvparams.iteritems():
487 utils.ForceDictType(hv_params, constants.HVS_PARAMETER_TYPES)
489 beparams = opts.beparams
490 utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
492 nicparams = opts.nicparams
493 utils.ForceDictType(nicparams, constants.NICS_PARAMETER_TYPES)
495 op = opcodes.OpSetClusterParams(vg_name=vg_name,
496 enabled_hypervisors=hvlist,
500 candidate_pool_size=opts.candidate_pool_size)
505 def QueueOps(opts, args):
508 @param opts: the command line options selected by the user
510 @param args: should contain only one element, the subcommand
512 @return: the desired exit code
517 if command in ("drain", "undrain"):
518 drain_flag = command == "drain"
519 client.SetQueueDrainFlag(drain_flag)
520 elif command == "info":
521 result = client.QueryConfigValues(["drain_flag"])
526 ToStdout("The drain flag is %s" % val)
528 raise errors.OpPrereqError("Command '%s' is not valid." % command)
532 # this is an option common to more than one command, so we declare
533 # it here and reuse it
534 node_option = make_option("-n", "--node", action="append", dest="nodes",
535 help="Node to copy to (if not given, all nodes),"
536 " can be given multiple times",
537 metavar="<node>", default=[])
540 'init': (InitCluster, ARGS_ONE,
542 make_option("-s", "--secondary-ip", dest="secondary_ip",
543 help="Specify the secondary ip for this node;"
544 " if given, the entire cluster must have secondary"
546 metavar="ADDRESS", default=None),
547 make_option("-m", "--mac-prefix", dest="mac_prefix",
548 help="Specify the mac prefix for the instance IP"
549 " addresses, in the format XX:XX:XX",
551 default=constants.DEFAULT_MAC_PREFIX,),
552 make_option("-g", "--vg-name", dest="vg_name",
553 help="Specify the volume group name "
554 " (cluster-wide) for disk allocation [xenvg]",
557 make_option("-b", "--bridge", dest="def_bridge",
558 help="Specify the default bridge name (cluster-wide)"
559 " to connect the instances to [%s]" %
560 constants.DEFAULT_BRIDGE,
562 default=constants.DEFAULT_BRIDGE,),
563 make_option("--master-netdev", dest="master_netdev",
564 help="Specify the node interface (cluster-wide)"
565 " on which the master IP address will be added "
566 " [%s]" % constants.DEFAULT_BRIDGE,
568 default=constants.DEFAULT_BRIDGE,),
569 make_option("--file-storage-dir", dest="file_storage_dir",
570 help="Specify the default directory (cluster-wide)"
571 " for storing the file-based disks [%s]" %
572 constants.DEFAULT_FILE_STORAGE_DIR,
574 default=constants.DEFAULT_FILE_STORAGE_DIR,),
575 make_option("--no-lvm-storage", dest="lvm_storage",
576 help="No support for lvm based instances"
578 action="store_false", default=True,),
579 make_option("--no-etc-hosts", dest="modify_etc_hosts",
580 help="Don't modify /etc/hosts"
582 action="store_false", default=True,),
583 make_option("--enabled-hypervisors", dest="enabled_hypervisors",
584 help="Comma-separated list of hypervisors",
585 type="string", default=None),
586 make_option("-t", "--default-hypervisor",
587 dest="default_hypervisor",
588 help="Default hypervisor to use for instance creation",
589 choices=list(constants.HYPER_TYPES),
590 default=constants.DEFAULT_ENABLED_HYPERVISOR),
591 ikv_option("-H", "--hypervisor-parameters", dest="hvparams",
592 help="Hypervisor and hypervisor options, in the"
594 " hypervisor:option=value,option=value,...",
598 keyval_option("-B", "--backend-parameters", dest="beparams",
599 type="keyval", default={},
600 help="Backend parameters"),
601 keyval_option("-N", "--nic-parameters", dest="nicparams",
602 type="keyval", default={},
603 help="NIC parameters"),
604 make_option("-C", "--candidate-pool-size",
605 default=constants.MASTER_POOL_SIZE_DEFAULT,
606 help="Set the candidate pool size",
607 dest="candidate_pool_size", type="int"),
609 "[opts...] <cluster_name>",
610 "Initialises a new cluster configuration"),
611 'destroy': (DestroyCluster, ARGS_NONE,
613 make_option("--yes-do-it", dest="yes_do_it",
614 help="Destroy cluster",
615 action="store_true"),
617 "", "Destroy cluster"),
618 'rename': (RenameCluster, ARGS_ONE, [DEBUG_OPT, FORCE_OPT],
620 "Renames the cluster"),
621 'redist-conf': (RedistributeConfig, ARGS_NONE, [DEBUG_OPT, SUBMIT_OPT],
623 "Forces a push of the configuration file and ssconf files"
624 " to the nodes in the cluster"),
625 'verify': (VerifyCluster, ARGS_NONE, [DEBUG_OPT,
626 make_option("--no-nplus1-mem", dest="skip_nplusone_mem",
627 help="Skip N+1 memory redundancy tests",
631 "", "Does a check on the cluster configuration"),
632 'verify-disks': (VerifyDisks, ARGS_NONE, [DEBUG_OPT],
633 "", "Does a check on the cluster disk status"),
634 'masterfailover': (MasterFailover, ARGS_NONE, [DEBUG_OPT],
635 "", "Makes the current node the master"),
636 'version': (ShowClusterVersion, ARGS_NONE, [DEBUG_OPT],
637 "", "Shows the cluster version"),
638 'getmaster': (ShowClusterMaster, ARGS_NONE, [DEBUG_OPT],
639 "", "Shows the cluster master"),
640 'copyfile': (ClusterCopyFile, ARGS_ONE, [DEBUG_OPT, node_option],
641 "[-n node...] <filename>",
642 "Copies a file to all (or only some) nodes"),
643 'command': (RunClusterCommand, ARGS_ATLEAST(1), [DEBUG_OPT, node_option],
644 "[-n node...] <command>",
645 "Runs a command on all (or only some) nodes"),
646 'info': (ShowClusterConfig, ARGS_NONE, [DEBUG_OPT],
647 "", "Show cluster configuration"),
648 'list-tags': (ListTags, ARGS_NONE,
649 [DEBUG_OPT], "", "List the tags of the cluster"),
650 'add-tags': (AddTags, ARGS_ANY, [DEBUG_OPT, TAG_SRC_OPT],
651 "tag...", "Add tags to the cluster"),
652 'remove-tags': (RemoveTags, ARGS_ANY, [DEBUG_OPT, TAG_SRC_OPT],
653 "tag...", "Remove tags from the cluster"),
654 'search-tags': (SearchTags, ARGS_ONE,
655 [DEBUG_OPT], "", "Searches the tags on all objects on"
656 " the cluster for a given pattern (regex)"),
657 'queue': (QueueOps, ARGS_ONE, [DEBUG_OPT],
658 "drain|undrain|info", "Change queue properties"),
659 'modify': (SetClusterParams, ARGS_NONE,
661 make_option("-g", "--vg-name", dest="vg_name",
662 help="Specify the volume group name "
663 " (cluster-wide) for disk allocation "
664 "and enable lvm based storage",
666 make_option("--no-lvm-storage", dest="lvm_storage",
667 help="Disable support for lvm based instances"
669 action="store_false", default=True,),
670 make_option("--enabled-hypervisors", dest="enabled_hypervisors",
671 help="Comma-separated list of hypervisors",
672 type="string", default=None),
673 ikv_option("-H", "--hypervisor-parameters", dest="hvparams",
674 help="Hypervisor and hypervisor options, in the"
676 " hypervisor:option=value,option=value,...",
680 keyval_option("-B", "--backend-parameters", dest="beparams",
681 type="keyval", default={},
682 help="Backend parameters"),
683 keyval_option("-N", "--nic-parameters", dest="nicparams",
684 type="keyval", default={},
685 help="NIC parameters"),
686 make_option("-C", "--candidate-pool-size", default=None,
687 help="Set the candidate pool size",
688 dest="candidate_pool_size", type="int"),
691 "Alters the parameters of the cluster"),
694 if __name__ == '__main__':
695 sys.exit(GenericMain(commands, override={"tag_type": constants.TAG_CLUSTER}))