gnt-cluster info: show more cluster parameters
[ganeti-local] / scripts / gnt-cluster
1 #!/usr/bin/python
2 #
3
4 # Copyright (C) 2006, 2007 Google Inc.
5 #
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.
10 #
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.
15 #
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
19 # 02110-1301, USA.
20
21
22 # pylint: disable-msg=W0401,W0614
23 # W0401: Wildcard import ganeti.cli
24 # W0614: Unused import %s from wildcard import (since we need cli)
25
26 import sys
27 from optparse import make_option
28 import os.path
29
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
38
39 @UsesRPC
40 def InitCluster(opts, args):
41   """Initialize the cluster.
42
43   @param opts: the command line options selected by the user
44   @type args: list
45   @param args: should contain only one element, the desired
46       cluster name
47   @rtype: int
48   @return: the desired exit code
49
50   """
51   if not opts.lvm_storage and opts.vg_name:
52     ToStderr("Options --no-lvm-storage and --vg-name conflict.")
53     return 1
54
55   vg_name = opts.vg_name
56   if opts.lvm_storage and not opts.vg_name:
57     vg_name = constants.DEFAULT_VG
58
59   hvlist = opts.enabled_hypervisors
60   if hvlist is not None:
61     hvlist = hvlist.split(",")
62   else:
63     hvlist = [opts.default_hypervisor]
64
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))
70     return 1
71
72   hvparams = dict(opts.hvparams)
73
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)
79       return 1
80
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)
86
87   # prepare hvparams dict
88   for hv in constants.HYPER_TYPES:
89     if hv not in hvparams:
90       hvparams[hv] = {}
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)
95
96   for hv in hvlist:
97     if hv not in constants.HYPER_TYPES:
98       ToStderr("invalid hypervisor: %s", hv)
99       return 1
100
101   bootstrap.InitCluster(cluster_name=args[0],
102                         secondary_ip=opts.secondary_ip,
103                         vg_name=vg_name,
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,
110                         hvparams=hvparams,
111                         beparams=beparams,
112                         candidate_pool_size=opts.candidate_pool_size,
113                         )
114   return 0
115
116
117 @UsesRPC
118 def DestroyCluster(opts, args):
119   """Destroy the cluster.
120
121   @param opts: the command line options selected by the user
122   @type args: list
123   @param args: should be an empty list
124   @rtype: int
125   @return: the desired exit code
126
127   """
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.")
131     return 1
132
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)
138   return 0
139
140
141 def RenameCluster(opts, args):
142   """Rename the cluster.
143
144   @param opts: the command line options selected by the user
145   @type args: list
146   @param args: should contain only one element, the new cluster name
147   @rtype: int
148   @return: the desired exit code
149
150   """
151   name = args[0]
152   if not opts.force:
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):
158       return 1
159
160   op = opcodes.OpRenameCluster(name=name)
161   SubmitOpCode(op)
162   return 0
163
164
165 def RedistributeConfig(opts, args):
166   """Forces push of the cluster configuration.
167
168   @param opts: the command line options selected by the user
169   @type args: list
170   @param args: empty list
171   @rtype: int
172   @return: the desired exit code
173
174   """
175   op = opcodes.OpRedistributeConfig()
176   SubmitOrSend(op, opts)
177   return 0
178
179
180 def ShowClusterVersion(opts, args):
181   """Write version of ganeti software to the standard output.
182
183   @param opts: the command line options selected by the user
184   @type args: list
185   @param args: should be an empty list
186   @rtype: int
187   @return: the desired exit code
188
189   """
190   cl = GetClient()
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"])
197   return 0
198
199
200 def ShowClusterMaster(opts, args):
201   """Write name of master node to the standard output.
202
203   @param opts: the command line options selected by the user
204   @type args: list
205   @param args: should be an empty list
206   @rtype: int
207   @return: the desired exit code
208
209   """
210   master = bootstrap.GetMaster()
211   ToStdout(master)
212   return 0
213
214
215 def ShowClusterConfig(opts, args):
216   """Shows cluster information.
217
218   @param opts: the command line options selected by the user
219   @type args: list
220   @param args: should be an empty list
221   @rtype: int
222   @return: the desired exit code
223
224   """
225   cl = GetClient()
226   result = cl.QueryClusterInfo()
227
228   ToStdout("Cluster name: %s", result["name"])
229
230   ToStdout("Master node: %s", result["master"])
231
232   ToStdout("Architecture (this node): %s (%s)",
233            result["architecture"][0], result["architecture"][1])
234
235   ToStdout("Default hypervisor: %s", result["default_hypervisor"])
236   ToStdout("Enabled hypervisors: %s", ", ".join(result["enabled_hypervisors"]))
237
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)
243
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"])
250
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)
256
257   return 0
258
259
260 def ClusterCopyFile(opts, args):
261   """Copy a file from master to some nodes.
262
263   @param opts: the command line options selected by the user
264   @type args: list
265   @param args: should contain only one element, the path of
266       the file to be copied
267   @rtype: int
268   @return: the desired exit code
269
270   """
271   filename = args[0]
272   if not os.path.exists(filename):
273     raise errors.OpPrereqError("No such filename '%s'" % filename)
274
275   cl = GetClient()
276
277   myname = utils.HostInfo().name
278
279   cluster_name = cl.QueryConfigValues(["cluster_name"])[0]
280
281   results = GetOnlineNodes(nodes=opts.nodes, cl=cl)
282   results = [name for name in results if name != myname]
283
284   srun = ssh.SshRunner(cluster_name=cluster_name)
285   for node in results:
286     if not srun.CopyFileToNode(node, filename):
287       ToStderr("Copy of file %s to node %s failed", filename, node)
288
289   return 0
290
291
292 def RunClusterCommand(opts, args):
293   """Run a command on some nodes.
294
295   @param opts: the command line options selected by the user
296   @type args: list
297   @param args: should contain the command to be run and its arguments
298   @rtype: int
299   @return: the desired exit code
300
301   """
302   cl = GetClient()
303
304   command = " ".join(args)
305
306   nodes = GetOnlineNodes(nodes=opts.nodes, cl=cl)
307
308   cluster_name, master_node = cl.QueryConfigValues(["cluster_name",
309                                                     "master_node"])
310
311   srun = ssh.SshRunner(cluster_name=cluster_name)
312
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)
317
318   for name in nodes:
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)
324
325   return 0
326
327
328 def VerifyCluster(opts, args):
329   """Verify integrity of cluster, performing various test on nodes.
330
331   @param opts: the command line options selected by the user
332   @type args: list
333   @param args: should be an empty list
334   @rtype: int
335   @return: the desired exit code
336
337   """
338   skip_checks = []
339   if opts.skip_nplusone_mem:
340     skip_checks.append(constants.VERIFY_NPLUSONE_MEM)
341   op = opcodes.OpVerifyCluster(skip_checks=skip_checks)
342   if SubmitOpCode(op):
343     return 0
344   else:
345     return 1
346
347
348 def VerifyDisks(opts, args):
349   """Verify integrity of cluster disks.
350
351   @param opts: the command line options selected by the user
352   @type args: list
353   @param args: should be an empty list
354   @rtype: int
355   @return: the desired exit code
356
357   """
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")
362
363   nodes, nlvm, instances, missing = result
364
365   if nodes:
366     ToStdout("Nodes unreachable or with bad data:")
367     for name in nodes:
368       ToStdout("\t%s", name)
369   retcode = constants.EXIT_SUCCESS
370
371   if nlvm:
372     for node, text in nlvm.iteritems():
373       ToStdout("Error on node %s: LVM error: %s",
374                node, utils.SafeEncode(text[-400:]))
375       retcode |= 1
376       ToStdout("You need to fix these nodes first before fixing instances")
377
378   if instances:
379     for iname in instances:
380       if iname in missing:
381         continue
382       op = opcodes.OpActivateInstanceDisks(instance_name=iname)
383       try:
384         ToStdout("Activating disks for instance '%s'", iname)
385         SubmitOpCode(op)
386       except errors.GenericError, err:
387         nret, msg = FormatError(err)
388         retcode |= nret
389         ToStderr("Error activating disks for instance %s: %s", iname, msg)
390
391   if missing:
392     for iname, ival in missing.iteritems():
393       all_missing = utils.all(ival, lambda x: x[0] in nlvm)
394       if all_missing:
395         ToStdout("Instance %s cannot be verified as it lives on"
396                  " broken nodes", iname)
397       else:
398         ToStdout("Instance %s has missing logical volumes:", iname)
399         ival.sort()
400         for node, vol in ival:
401           if node in nlvm:
402             ToStdout("\tbroken node %s /dev/xenvg/%s", node, vol)
403           else:
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.")
407     retcode |= 1
408
409   return retcode
410
411
412 @UsesRPC
413 def MasterFailover(opts, args):
414   """Failover the master node.
415
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
418   master.
419
420   @param opts: the command line options selected by the user
421   @type args: list
422   @param args: should be an empty list
423   @rtype: int
424   @return: the desired exit code
425
426   """
427   return bootstrap.MasterFailover()
428
429
430 def SearchTags(opts, args):
431   """Searches the tags on all the cluster.
432
433   @param opts: the command line options selected by the user
434   @type args: list
435   @param args: should contain only one element, the tag pattern
436   @rtype: int
437   @return: the desired exit code
438
439   """
440   op = opcodes.OpSearchTags(pattern=args[0])
441   result = SubmitOpCode(op)
442   if not result:
443     return 1
444   result = list(result)
445   result.sort()
446   for path, tag in result:
447     ToStdout("%s %s", path, tag)
448
449
450 def SetClusterParams(opts, args):
451   """Modify the cluster.
452
453   @param opts: the command line options selected by the user
454   @type args: list
455   @param args: should be an empty list
456   @rtype: int
457   @return: the desired exit code
458
459   """
460   if not (not opts.lvm_storage or opts.vg_name or
461           opts.enabled_hypervisors or opts.hvparams or
462           opts.beparams or opts.candidate_pool_size is not None):
463     ToStderr("Please give at least one of the parameters.")
464     return 1
465
466   vg_name = opts.vg_name
467   if not opts.lvm_storage and opts.vg_name:
468     ToStdout("Options --no-lvm-storage and --vg-name conflict.")
469     return 1
470
471   hvlist = opts.enabled_hypervisors
472   if hvlist is not None:
473     hvlist = hvlist.split(",")
474
475   # a list of (name, dict) we can pass directly to dict() (or [])
476   hvparams = dict(opts.hvparams)
477   for hv, hv_params in hvparams.iteritems():
478     utils.ForceDictType(hv_params, constants.HVS_PARAMETER_TYPES)
479
480   beparams = opts.beparams
481   utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
482
483   op = opcodes.OpSetClusterParams(vg_name=opts.vg_name,
484                                   enabled_hypervisors=hvlist,
485                                   hvparams=hvparams,
486                                   beparams=beparams,
487                                   candidate_pool_size=opts.candidate_pool_size)
488   SubmitOpCode(op)
489   return 0
490
491
492 def QueueOps(opts, args):
493   """Queue operations.
494
495   @param opts: the command line options selected by the user
496   @type args: list
497   @param args: should contain only one element, the subcommand
498   @rtype: int
499   @return: the desired exit code
500
501   """
502   command = args[0]
503   client = GetClient()
504   if command in ("drain", "undrain"):
505     drain_flag = command == "drain"
506     client.SetQueueDrainFlag(drain_flag)
507   elif command == "info":
508     result = client.QueryConfigValues(["drain_flag"])
509     if result[0]:
510       val = "set"
511     else:
512       val = "unset"
513     ToStdout("The drain flag is %s" % val)
514   else:
515     raise errors.OpPrereqError("Command '%s' is not valid." % command)
516
517   return 0
518
519 # this is an option common to more than one command, so we declare
520 # it here and reuse it
521 node_option = make_option("-n", "--node", action="append", dest="nodes",
522                           help="Node to copy to (if not given, all nodes),"
523                                " can be given multiple times",
524                           metavar="<node>", default=[])
525
526 commands = {
527   'init': (InitCluster, ARGS_ONE,
528            [DEBUG_OPT,
529             make_option("-s", "--secondary-ip", dest="secondary_ip",
530                         help="Specify the secondary ip for this node;"
531                         " if given, the entire cluster must have secondary"
532                         " addresses",
533                         metavar="ADDRESS", default=None),
534             make_option("-m", "--mac-prefix", dest="mac_prefix",
535                         help="Specify the mac prefix for the instance IP"
536                         " addresses, in the format XX:XX:XX",
537                         metavar="PREFIX",
538                         default=constants.DEFAULT_MAC_PREFIX,),
539             make_option("-g", "--vg-name", dest="vg_name",
540                         help="Specify the volume group name "
541                         " (cluster-wide) for disk allocation [xenvg]",
542                         metavar="VG",
543                         default=None,),
544             make_option("-b", "--bridge", dest="def_bridge",
545                         help="Specify the default bridge name (cluster-wide)"
546                           " to connect the instances to [%s]" %
547                           constants.DEFAULT_BRIDGE,
548                         metavar="BRIDGE",
549                         default=constants.DEFAULT_BRIDGE,),
550             make_option("--master-netdev", dest="master_netdev",
551                         help="Specify the node interface (cluster-wide)"
552                           " on which the master IP address will be added "
553                           " [%s]" % constants.DEFAULT_BRIDGE,
554                         metavar="NETDEV",
555                         default=constants.DEFAULT_BRIDGE,),
556             make_option("--file-storage-dir", dest="file_storage_dir",
557                         help="Specify the default directory (cluster-wide)"
558                              " for storing the file-based disks [%s]" %
559                              constants.DEFAULT_FILE_STORAGE_DIR,
560                         metavar="DIR",
561                         default=constants.DEFAULT_FILE_STORAGE_DIR,),
562             make_option("--no-lvm-storage", dest="lvm_storage",
563                         help="No support for lvm based instances"
564                              " (cluster-wide)",
565                         action="store_false", default=True,),
566             make_option("--enabled-hypervisors", dest="enabled_hypervisors",
567                         help="Comma-separated list of hypervisors",
568                         type="string", default=None),
569             make_option("-t", "--default-hypervisor",
570                         dest="default_hypervisor",
571                         help="Default hypervisor to use for instance creation",
572                         choices=list(constants.HYPER_TYPES),
573                         default=constants.DEFAULT_ENABLED_HYPERVISOR),
574             ikv_option("-H", "--hypervisor-parameters", dest="hvparams",
575                        help="Hypervisor and hypervisor options, in the"
576                          " format"
577                        " hypervisor:option=value,option=value,...",
578                        default=[],
579                        action="append",
580                        type="identkeyval"),
581             keyval_option("-B", "--backend-parameters", dest="beparams",
582                           type="keyval", default={},
583                           help="Backend parameters"),
584             make_option("-C", "--candidate-pool-size",
585                         default=constants.MASTER_POOL_SIZE_DEFAULT,
586                         help="Set the candidate pool size",
587                         dest="candidate_pool_size", type="int"),
588             ],
589            "[opts...] <cluster_name>",
590            "Initialises a new cluster configuration"),
591   'destroy': (DestroyCluster, ARGS_NONE,
592               [DEBUG_OPT,
593                make_option("--yes-do-it", dest="yes_do_it",
594                            help="Destroy cluster",
595                            action="store_true"),
596               ],
597               "", "Destroy cluster"),
598   'rename': (RenameCluster, ARGS_ONE, [DEBUG_OPT, FORCE_OPT],
599                "<new_name>",
600                "Renames the cluster"),
601   'redist-conf': (RedistributeConfig, ARGS_NONE, [DEBUG_OPT, SUBMIT_OPT],
602                   "",
603                   "Forces a push of the configuration file and ssconf files"
604                   " to the nodes in the cluster"),
605   'verify': (VerifyCluster, ARGS_NONE, [DEBUG_OPT,
606              make_option("--no-nplus1-mem", dest="skip_nplusone_mem",
607                          help="Skip N+1 memory redundancy tests",
608                          action="store_true",
609                          default=False,),
610              ],
611              "", "Does a check on the cluster configuration"),
612   'verify-disks': (VerifyDisks, ARGS_NONE, [DEBUG_OPT],
613                    "", "Does a check on the cluster disk status"),
614   'masterfailover': (MasterFailover, ARGS_NONE, [DEBUG_OPT],
615                      "", "Makes the current node the master"),
616   'version': (ShowClusterVersion, ARGS_NONE, [DEBUG_OPT],
617               "", "Shows the cluster version"),
618   'getmaster': (ShowClusterMaster, ARGS_NONE, [DEBUG_OPT],
619                 "", "Shows the cluster master"),
620   'copyfile': (ClusterCopyFile, ARGS_ONE, [DEBUG_OPT, node_option],
621                "[-n node...] <filename>",
622                "Copies a file to all (or only some) nodes"),
623   'command': (RunClusterCommand, ARGS_ATLEAST(1), [DEBUG_OPT, node_option],
624               "[-n node...] <command>",
625               "Runs a command on all (or only some) nodes"),
626   'info': (ShowClusterConfig, ARGS_NONE, [DEBUG_OPT],
627                  "", "Show cluster configuration"),
628   'list-tags': (ListTags, ARGS_NONE,
629                 [DEBUG_OPT], "", "List the tags of the cluster"),
630   'add-tags': (AddTags, ARGS_ANY, [DEBUG_OPT, TAG_SRC_OPT],
631                "tag...", "Add tags to the cluster"),
632   'remove-tags': (RemoveTags, ARGS_ANY, [DEBUG_OPT, TAG_SRC_OPT],
633                   "tag...", "Remove tags from the cluster"),
634   'search-tags': (SearchTags, ARGS_ONE,
635                   [DEBUG_OPT], "", "Searches the tags on all objects on"
636                   " the cluster for a given pattern (regex)"),
637   'queue': (QueueOps, ARGS_ONE, [DEBUG_OPT],
638             "drain|undrain|info", "Change queue properties"),
639   'modify': (SetClusterParams, ARGS_NONE,
640              [DEBUG_OPT,
641               make_option("-g", "--vg-name", dest="vg_name",
642                           help="Specify the volume group name "
643                           " (cluster-wide) for disk allocation "
644                           "and enable lvm based storage",
645                           metavar="VG",),
646               make_option("--no-lvm-storage", dest="lvm_storage",
647                           help="Disable support for lvm based instances"
648                                " (cluster-wide)",
649                           action="store_false", default=True,),
650               make_option("--enabled-hypervisors", dest="enabled_hypervisors",
651                           help="Comma-separated list of hypervisors",
652                           type="string", default=None),
653               ikv_option("-H", "--hypervisor-parameters", dest="hvparams",
654                          help="Hypervisor and hypervisor options, in the"
655                          " format"
656                          " hypervisor:option=value,option=value,...",
657                          default=[],
658                          action="append",
659                          type="identkeyval"),
660               keyval_option("-B", "--backend-parameters", dest="beparams",
661                             type="keyval", default={},
662                             help="Backend parameters"),
663               make_option("-C", "--candidate-pool-size", default=None,
664                           help="Set the candidate pool size",
665                           dest="candidate_pool_size", type="int"),
666               ],
667              "[opts...]",
668              "Alters the parameters of the cluster"),
669   }
670
671 if __name__ == '__main__':
672   sys.exit(GenericMain(commands, override={"tag_type": constants.TAG_CLUSTER}))