gnt-cluster init, handle candidate_pool_size
[ganeti-local] / scripts / gnt-cluster
index 5578992..1c9134b 100755 (executable)
 # 02110-1301, USA.
 
 
+# pylint: disable-msg=W0401,W0614
+# W0401: Wildcard import ganeti.cli
+# W0614: Unused import %s from wildcard import (since we need cli)
+
 import sys
 from optparse import make_option
 import os.path
@@ -30,15 +34,18 @@ from ganeti import errors
 from ganeti import utils
 from ganeti import bootstrap
 from ganeti import ssh
-from ganeti import ssconf
 
 
+@UsesRPC
 def InitCluster(opts, args):
   """Initialize the cluster.
 
-  Args:
-    opts - class with options as members
-    args - list of arguments, expected to be [clustername]
+  @param opts: the command line options selected by the user
+  @type args: list
+  @param args: should contain only one element, the desired
+      cluster name
+  @rtype: int
+  @return: the desired exit code
 
   """
   if not opts.lvm_storage and opts.vg_name:
@@ -53,7 +60,14 @@ def InitCluster(opts, args):
   if hvlist is not None:
     hvlist = hvlist.split(",")
   else:
-    hvlist = constants.DEFAULT_ENABLED_HYPERVISOR
+    hvlist = [opts.default_hypervisor]
+
+  # avoid an impossible situation
+  if opts.default_hypervisor not in hvlist:
+    ToStderr("The default hypervisor requested (%s) is not"
+             " within the enabled hypervisor list (%s)" %
+             (opts.default_hypervisor, hvlist))
+    return 1
 
   hvparams = opts.hvparams
   if hvparams:
@@ -67,7 +81,7 @@ def InitCluster(opts, args):
   # check for invalid parameters
   for parameter in beparams:
     if parameter not in constants.BES_PARAMETERS:
-      print "Invalid backend parameter: %s" % parameter
+      ToStderr("Invalid backend parameter: %s", parameter)
       return 1
 
   # prepare beparams dict
@@ -79,10 +93,12 @@ def InitCluster(opts, args):
   try:
     beparams[constants.BE_VCPUS] = int(beparams[constants.BE_VCPUS])
   except ValueError:
-    print "%s must be an integer" % constants.BE_VCPUS
+    ToStderr("%s must be an integer", constants.BE_VCPUS)
     return 1
 
-  beparams[constants.BE_MEMORY] = utils.ParseUnit(beparams[constants.BE_MEMORY])
+  if not isinstance(beparams[constants.BE_MEMORY], int):
+    beparams[constants.BE_MEMORY] = utils.ParseUnit(
+        beparams[constants.BE_MEMORY])
 
   # prepare hvparams dict
   for hv in constants.HYPER_TYPES:
@@ -94,7 +110,7 @@ def InitCluster(opts, args):
 
   for hv in hvlist:
     if hv not in constants.HYPER_TYPES:
-      print "invalid hypervisor: %s" % hv
+      ToStderr("invalid hypervisor: %s", hv)
       return 1
 
   bootstrap.InitCluster(cluster_name=args[0],
@@ -105,16 +121,23 @@ def InitCluster(opts, args):
                         master_netdev=opts.master_netdev,
                         file_storage_dir=opts.file_storage_dir,
                         enabled_hypervisors=hvlist,
+                        default_hypervisor=opts.default_hypervisor,
                         hvparams=hvparams,
-                        beparams=beparams)
+                        beparams=beparams,
+                        candidate_pool_size=opts.candidate_pool_size,
+                        )
   return 0
 
 
+@UsesRPC
 def DestroyCluster(opts, args):
   """Destroy the cluster.
 
-  Args:
-    opts - class with options as members
+  @param opts: the command line options selected by the user
+  @type args: list
+  @param args: should be an empty list
+  @rtype: int
+  @return: the desired exit code
 
   """
   if not opts.yes_do_it:
@@ -133,9 +156,11 @@ def DestroyCluster(opts, args):
 def RenameCluster(opts, args):
   """Rename the cluster.
 
-  Args:
-    opts - class with options as members, we use force only
-    args - list of arguments, expected to be [new_name]
+  @param opts: the command line options selected by the user
+  @type args: list
+  @param args: should contain only one element, the new cluster name
+  @rtype: int
+  @return: the desired exit code
 
   """
   name = args[0]
@@ -155,8 +180,11 @@ def RenameCluster(opts, args):
 def ShowClusterVersion(opts, args):
   """Write version of ganeti software to the standard output.
 
-  Args:
-    opts - class with options as members
+  @param opts: the command line options selected by the user
+  @type args: list
+  @param args: should be an empty list
+  @rtype: int
+  @return: the desired exit code
 
   """
   op = opcodes.OpQueryClusterInfo()
@@ -172,8 +200,11 @@ def ShowClusterVersion(opts, args):
 def ShowClusterMaster(opts, args):
   """Write name of master node to the standard output.
 
-  Args:
-    opts - class with options as members
+  @param opts: the command line options selected by the user
+  @type args: list
+  @param args: should be an empty list
+  @rtype: int
+  @return: the desired exit code
 
   """
   ToStdout("%s", GetClient().QueryConfigValues(["master_node"])[0])
@@ -183,6 +214,12 @@ def ShowClusterMaster(opts, args):
 def ShowClusterConfig(opts, args):
   """Shows cluster information.
 
+  @param opts: the command line options selected by the user
+  @type args: list
+  @param args: should be an empty list
+  @rtype: int
+  @return: the desired exit code
+
   """
   op = opcodes.OpQueryClusterInfo()
   result = SubmitOpCode(op)
@@ -194,7 +231,7 @@ def ShowClusterConfig(opts, args):
   ToStdout("Architecture (this node): %s (%s)",
            result["architecture"][0], result["architecture"][1])
 
-  ToStdout("Default hypervisor: %s", result["hypervisor_type"])
+  ToStdout("Default hypervisor: %s", result["default_hypervisor"])
   ToStdout("Enabled hypervisors: %s", ", ".join(result["enabled_hypervisors"]))
 
   ToStdout("Hypervisor parameters:")
@@ -204,6 +241,9 @@ def ShowClusterConfig(opts, args):
       ToStdout("      %s: %s", item, val)
 
   ToStdout("Cluster parameters:")
+  ToStdout("  - candidate pool size: %s", result["candidate_pool_size"])
+
+  ToStdout("Default instance parameters:")
   for gr_name, gr_dict in result["beparams"].items():
     ToStdout("  - %s:", gr_name)
     for item, val in gr_dict.iteritems():
@@ -215,11 +255,12 @@ def ShowClusterConfig(opts, args):
 def ClusterCopyFile(opts, args):
   """Copy a file from master to some nodes.
 
-  Args:
-    opts - class with options as members
-    args - list containing a single element, the file name
-  Opts used:
-    nodes - list containing the name of target nodes; if empty, all nodes
+  @param opts: the command line options selected by the user
+  @type args: list
+  @param args: should contain only one element, the path of
+      the file to be copied
+  @rtype: int
+  @return: the desired exit code
 
   """
   filename = args[0]
@@ -246,11 +287,11 @@ def ClusterCopyFile(opts, args):
 def RunClusterCommand(opts, args):
   """Run a command on some nodes.
 
-  Args:
-    opts - class with options as members
-    args - the command list as a list
-  Opts used:
-    nodes: list containing the name of target nodes; if empty, all nodes
+  @param opts: the command line options selected by the user
+  @type args: list
+  @param args: should contain the command to be run and its arguments
+  @rtype: int
+  @return: the desired exit code
 
   """
   cl = GetClient()
@@ -282,8 +323,11 @@ def RunClusterCommand(opts, args):
 def VerifyCluster(opts, args):
   """Verify integrity of cluster, performing various test on nodes.
 
-  Args:
-    opts - class with options as members
+  @param opts: the command line options selected by the user
+  @type args: list
+  @param args: should be an empty list
+  @rtype: int
+  @return: the desired exit code
 
   """
   skip_checks = []
@@ -299,8 +343,11 @@ def VerifyCluster(opts, args):
 def VerifyDisks(opts, args):
   """Verify integrity of cluster disks.
 
-  Args:
-    opts - class with options as members
+  @param opts: the command line options selected by the user
+  @type args: list
+  @param args: should be an empty list
+  @rtype: int
+  @return: the desired exit code
 
   """
   op = opcodes.OpVerifyDisks()
@@ -357,6 +404,7 @@ def VerifyDisks(opts, args):
   return retcode
 
 
+@UsesRPC
 def MasterFailover(opts, args):
   """Failover the master node.
 
@@ -364,6 +412,12 @@ def MasterFailover(opts, args):
   master to cease being master, and the non-master to become new
   master.
 
+  @param opts: the command line options selected by the user
+  @type args: list
+  @param args: should be an empty list
+  @rtype: int
+  @return: the desired exit code
+
   """
   return bootstrap.MasterFailover()
 
@@ -371,6 +425,12 @@ def MasterFailover(opts, args):
 def SearchTags(opts, args):
   """Searches the tags on all the cluster.
 
+  @param opts: the command line options selected by the user
+  @type args: list
+  @param args: should contain only one element, the tag pattern
+  @rtype: int
+  @return: the desired exit code
+
   """
   op = opcodes.OpSearchTags(pattern=args[0])
   result = SubmitOpCode(op)
@@ -385,13 +445,16 @@ def SearchTags(opts, args):
 def SetClusterParams(opts, args):
   """Modify the cluster.
 
-  Args:
-    opts - class with options as members
+  @param opts: the command line options selected by the user
+  @type args: list
+  @param args: should be an empty list
+  @rtype: int
+  @return: the desired exit code
 
   """
   if not (not opts.lvm_storage or opts.vg_name or
           opts.enabled_hypervisors or opts.hvparams or
-          opts.beparams):
+          opts.beparams or opts.candidate_pool_size is not None):
     ToStderr("Please give at least one of the parameters.")
     return 1
 
@@ -414,7 +477,8 @@ def SetClusterParams(opts, args):
   op = opcodes.OpSetClusterParams(vg_name=opts.vg_name,
                                   enabled_hypervisors=hvlist,
                                   hvparams=hvparams,
-                                  beparams=beparams)
+                                  beparams=beparams,
+                                  candidate_pool_size=opts.candidate_pool_size)
   SubmitOpCode(op)
   return 0
 
@@ -422,6 +486,12 @@ def SetClusterParams(opts, args):
 def QueueOps(opts, args):
   """Queue operations.
 
+  @param opts: the command line options selected by the user
+  @type args: list
+  @param args: should contain only one element, the subcommand
+  @rtype: int
+  @return: the desired exit code
+
   """
   command = args[0]
   client = GetClient()
@@ -487,6 +557,11 @@ commands = {
             make_option("--enabled-hypervisors", dest="enabled_hypervisors",
                         help="Comma-separated list of hypervisors",
                         type="string", default=None),
+            make_option("-t", "--default-hypervisor",
+                        dest="default_hypervisor",
+                        help="Default hypervisor to use for instance creation",
+                        choices=list(constants.HYPER_TYPES),
+                        default=constants.DEFAULT_ENABLED_HYPERVISOR),
             ikv_option("-H", "--hypervisor-parameters", dest="hvparams",
                        help="Hypervisor and hypervisor options, in the"
                          " format"
@@ -497,6 +572,10 @@ commands = {
             keyval_option("-B", "--backend-parameters", dest="beparams",
                           type="keyval", default={},
                           help="Backend parameters"),
+            make_option("-C", "--candidate-pool-size",
+                        default=constants.MASTER_POOL_SIZE_DEFAULT,
+                        help="Set the candidate pool size",
+                        dest="candidate_pool_size", type="int"),
             ],
            "[opts...] <cluster_name>",
            "Initialises a new cluster configuration"),
@@ -568,6 +647,9 @@ commands = {
               keyval_option("-B", "--backend-parameters", dest="beparams",
                             type="keyval", default={},
                             help="Backend parameters"),
+              make_option("-C", "--candidate-pool-size", default=None,
+                          help="Set the candidate pool size",
+                          dest="candidate_pool_size", type="int"),
               ],
              "[opts...]",
              "Alters the parameters of the cluster"),