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 ToStdout("%s", GetClient().QueryConfigValues(["master_node"])[0])
214 def ShowClusterConfig(opts, args):
215 """Shows cluster information.
217 @param opts: the command line options selected by the user
219 @param args: should be an empty list
221 @return: the desired exit code
225 result = cl.QueryClusterInfo()
227 ToStdout("Cluster name: %s", result["name"])
229 ToStdout("Master node: %s", result["master"])
231 ToStdout("Architecture (this node): %s (%s)",
232 result["architecture"][0], result["architecture"][1])
234 ToStdout("Default hypervisor: %s", result["default_hypervisor"])
235 ToStdout("Enabled hypervisors: %s", ", ".join(result["enabled_hypervisors"]))
237 ToStdout("Hypervisor parameters:")
238 for hv_name, hv_dict in result["hvparams"].items():
239 ToStdout(" - %s:", hv_name)
240 for item, val in hv_dict.iteritems():
241 ToStdout(" %s: %s", item, val)
243 ToStdout("Cluster parameters:")
244 ToStdout(" - candidate pool size: %s", result["candidate_pool_size"])
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.")
408 def MasterFailover(opts, args):
409 """Failover the master node.
411 This command, when run on a non-master node, will cause the current
412 master to cease being master, and the non-master to become new
415 @param opts: the command line options selected by the user
417 @param args: should be an empty list
419 @return: the desired exit code
422 return bootstrap.MasterFailover()
425 def SearchTags(opts, args):
426 """Searches the tags on all the cluster.
428 @param opts: the command line options selected by the user
430 @param args: should contain only one element, the tag pattern
432 @return: the desired exit code
435 op = opcodes.OpSearchTags(pattern=args[0])
436 result = SubmitOpCode(op)
439 result = list(result)
441 for path, tag in result:
442 ToStdout("%s %s", path, tag)
445 def SetClusterParams(opts, args):
446 """Modify the cluster.
448 @param opts: the command line options selected by the user
450 @param args: should be an empty list
452 @return: the desired exit code
455 if not (not opts.lvm_storage or opts.vg_name or
456 opts.enabled_hypervisors or opts.hvparams or
457 opts.beparams or opts.candidate_pool_size is not None):
458 ToStderr("Please give at least one of the parameters.")
461 vg_name = opts.vg_name
462 if not opts.lvm_storage and opts.vg_name:
463 ToStdout("Options --no-lvm-storage and --vg-name conflict.")
466 hvlist = opts.enabled_hypervisors
467 if hvlist is not None:
468 hvlist = hvlist.split(",")
470 # a list of (name, dict) we can pass directly to dict() (or [])
471 hvparams = dict(opts.hvparams)
472 for hv, hv_params in hvparams.iteritems():
473 utils.ForceDictType(hv_params, constants.HVS_PARAMETER_TYPES)
475 beparams = opts.beparams
476 utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
478 op = opcodes.OpSetClusterParams(vg_name=opts.vg_name,
479 enabled_hypervisors=hvlist,
482 candidate_pool_size=opts.candidate_pool_size)
487 def QueueOps(opts, args):
490 @param opts: the command line options selected by the user
492 @param args: should contain only one element, the subcommand
494 @return: the desired exit code
499 if command in ("drain", "undrain"):
500 drain_flag = command == "drain"
501 client.SetQueueDrainFlag(drain_flag)
502 elif command == "info":
503 result = client.QueryConfigValues(["drain_flag"])
508 ToStdout("The drain flag is %s" % val)
511 # this is an option common to more than one command, so we declare
512 # it here and reuse it
513 node_option = make_option("-n", "--node", action="append", dest="nodes",
514 help="Node to copy to (if not given, all nodes),"
515 " can be given multiple times",
516 metavar="<node>", default=[])
519 'init': (InitCluster, ARGS_ONE,
521 make_option("-s", "--secondary-ip", dest="secondary_ip",
522 help="Specify the secondary ip for this node;"
523 " if given, the entire cluster must have secondary"
525 metavar="ADDRESS", default=None),
526 make_option("-m", "--mac-prefix", dest="mac_prefix",
527 help="Specify the mac prefix for the instance IP"
528 " addresses, in the format XX:XX:XX",
530 default=constants.DEFAULT_MAC_PREFIX,),
531 make_option("-g", "--vg-name", dest="vg_name",
532 help="Specify the volume group name "
533 " (cluster-wide) for disk allocation [xenvg]",
536 make_option("-b", "--bridge", dest="def_bridge",
537 help="Specify the default bridge name (cluster-wide)"
538 " to connect the instances to [%s]" %
539 constants.DEFAULT_BRIDGE,
541 default=constants.DEFAULT_BRIDGE,),
542 make_option("--master-netdev", dest="master_netdev",
543 help="Specify the node interface (cluster-wide)"
544 " on which the master IP address will be added "
545 " [%s]" % constants.DEFAULT_BRIDGE,
547 default=constants.DEFAULT_BRIDGE,),
548 make_option("--file-storage-dir", dest="file_storage_dir",
549 help="Specify the default directory (cluster-wide)"
550 " for storing the file-based disks [%s]" %
551 constants.DEFAULT_FILE_STORAGE_DIR,
553 default=constants.DEFAULT_FILE_STORAGE_DIR,),
554 make_option("--no-lvm-storage", dest="lvm_storage",
555 help="No support for lvm based instances"
557 action="store_false", default=True,),
558 make_option("--enabled-hypervisors", dest="enabled_hypervisors",
559 help="Comma-separated list of hypervisors",
560 type="string", default=None),
561 make_option("-t", "--default-hypervisor",
562 dest="default_hypervisor",
563 help="Default hypervisor to use for instance creation",
564 choices=list(constants.HYPER_TYPES),
565 default=constants.DEFAULT_ENABLED_HYPERVISOR),
566 ikv_option("-H", "--hypervisor-parameters", dest="hvparams",
567 help="Hypervisor and hypervisor options, in the"
569 " hypervisor:option=value,option=value,...",
573 keyval_option("-B", "--backend-parameters", dest="beparams",
574 type="keyval", default={},
575 help="Backend parameters"),
576 make_option("-C", "--candidate-pool-size",
577 default=constants.MASTER_POOL_SIZE_DEFAULT,
578 help="Set the candidate pool size",
579 dest="candidate_pool_size", type="int"),
581 "[opts...] <cluster_name>",
582 "Initialises a new cluster configuration"),
583 'destroy': (DestroyCluster, ARGS_NONE,
585 make_option("--yes-do-it", dest="yes_do_it",
586 help="Destroy cluster",
587 action="store_true"),
589 "", "Destroy cluster"),
590 'rename': (RenameCluster, ARGS_ONE, [DEBUG_OPT, FORCE_OPT],
592 "Renames the cluster"),
593 'redist-conf': (RedistributeConfig, ARGS_NONE, [DEBUG_OPT, SUBMIT_OPT],
595 "Forces a push of the configuration file and ssconf files"
596 " to the nodes in the cluster"),
597 'verify': (VerifyCluster, ARGS_NONE, [DEBUG_OPT,
598 make_option("--no-nplus1-mem", dest="skip_nplusone_mem",
599 help="Skip N+1 memory redundancy tests",
603 "", "Does a check on the cluster configuration"),
604 'verify-disks': (VerifyDisks, ARGS_NONE, [DEBUG_OPT],
605 "", "Does a check on the cluster disk status"),
606 'masterfailover': (MasterFailover, ARGS_NONE, [DEBUG_OPT],
607 "", "Makes the current node the master"),
608 'version': (ShowClusterVersion, ARGS_NONE, [DEBUG_OPT],
609 "", "Shows the cluster version"),
610 'getmaster': (ShowClusterMaster, ARGS_NONE, [DEBUG_OPT],
611 "", "Shows the cluster master"),
612 'copyfile': (ClusterCopyFile, ARGS_ONE, [DEBUG_OPT, node_option],
613 "[-n node...] <filename>",
614 "Copies a file to all (or only some) nodes"),
615 'command': (RunClusterCommand, ARGS_ATLEAST(1), [DEBUG_OPT, node_option],
616 "[-n node...] <command>",
617 "Runs a command on all (or only some) nodes"),
618 'info': (ShowClusterConfig, ARGS_NONE, [DEBUG_OPT],
619 "", "Show cluster configuration"),
620 'list-tags': (ListTags, ARGS_NONE,
621 [DEBUG_OPT], "", "List the tags of the cluster"),
622 'add-tags': (AddTags, ARGS_ANY, [DEBUG_OPT, TAG_SRC_OPT],
623 "tag...", "Add tags to the cluster"),
624 'remove-tags': (RemoveTags, ARGS_ANY, [DEBUG_OPT, TAG_SRC_OPT],
625 "tag...", "Remove tags from the cluster"),
626 'search-tags': (SearchTags, ARGS_ONE,
627 [DEBUG_OPT], "", "Searches the tags on all objects on"
628 " the cluster for a given pattern (regex)"),
629 'queue': (QueueOps, ARGS_ONE, [DEBUG_OPT],
630 "drain|undrain|info", "Change queue properties"),
631 'modify': (SetClusterParams, ARGS_NONE,
633 make_option("-g", "--vg-name", dest="vg_name",
634 help="Specify the volume group name "
635 " (cluster-wide) for disk allocation "
636 "and enable lvm based storage",
638 make_option("--no-lvm-storage", dest="lvm_storage",
639 help="Disable support for lvm based instances"
641 action="store_false", default=True,),
642 make_option("--enabled-hypervisors", dest="enabled_hypervisors",
643 help="Comma-separated list of hypervisors",
644 type="string", default=None),
645 ikv_option("-H", "--hypervisor-parameters", dest="hvparams",
646 help="Hypervisor and hypervisor options, in the"
648 " hypervisor:option=value,option=value,...",
652 keyval_option("-B", "--backend-parameters", dest="beparams",
653 type="keyval", default={},
654 help="Backend parameters"),
655 make_option("-C", "--candidate-pool-size", default=None,
656 help="Set the candidate pool size",
657 dest="candidate_pool_size", type="int"),
660 "Alters the parameters of the cluster"),
663 if __name__ == '__main__':
664 sys.exit(GenericMain(commands, override={"tag_type": constants.TAG_CLUSTER}))