check-python-code: Report EOL whitespace
[ganeti-local] / scripts / gnt-backup
index 34aeffe..12a667d 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
 
 from ganeti.cli import *
-from ganeti import cmdlib
 from ganeti import opcodes
 from ganeti import constants
+from ganeti import errors
+from ganeti import utils
+
+
+_VALUE_TRUE = "true"
 
 
 def PrintExportList(opts, args):
   """Prints a list of all the exported system images.
 
-  Args:
-   opts - class with options as members (should be empty)
-   args - should be empty
-
-  Returns:
-    nothing
+  @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.OpQueryExports(nodes=opts.nodes)
-  exports = SubmitOpCode(op)
+  exports = GetClient().QueryExports(opts.nodes, False)
+  retcode = 0
   for node in exports:
-    print ("Node: %s" % node)
-    print ("Exports:")
+    ToStdout("Node: %s", node)
+    ToStdout("Exports:")
     if isinstance(exports[node], list):
       for instance_name in exports[node]:
-        print ("\t%s" % instance_name)
+        ToStdout("\t%s", instance_name)
     else:
-      print ("  Could not get exports list")
+      ToStdout("  Could not get exports list")
+      retcode = 1
+  return retcode
 
 
 def ExportInstance(opts, args):
   """Export an instance to an image in the cluster.
 
-  Args:
-   opts - class with options as members
-   args - list with a single element, the instance name
-
-  Returns:
-    1 in case of error, 0 otherwise
+  @param opts: the command line options selected by the user
+  @type args: list
+  @param args: should contain only one element, the name
+      of the instance to be exported
+  @rtype: int
+  @return: the desired exit code
 
   """
   op = opcodes.OpExportInstance(instance_name=args[0],
                                 target_node=opts.node,
                                 shutdown=opts.shutdown)
 
-  SubmitOpCode(op)
-
+  fin_resu, dlist = SubmitOpCode(op)
+  if not isinstance(dlist, list):
+    ToStderr("Cannot parse execution results")
+    return 1
+  tot_dsk = len(dlist)
+  # TODO: handle diskless instances
+  if dlist.count(False) == 0:
+    # all OK
+    rcode = 0
+  elif dlist.count(True) == 0:
+    ToStderr("Error: No disks were backed up successfully."
+             " The export doesn't have any valid data,"
+             " it is recommended to retry the operation.")
+    rcode = 1
+  else:
+    ToStderr("Partial export failure: %d disks backed up, %d disks failed.",
+             dlist.count(True), dlist.count(False))
+    rcode = 2
+  if not fin_resu:
+    rcode = 1
+  return rcode
 
 def ImportInstance(opts, args):
   """Add an instance to the cluster.
 
-  Args:
-   opts - class with options as members
-   args - list with a single element, the new instance name
-  Opts used:
-   memory - amount of memory to allocate to instance (MiB)
-   size - amount of disk space to allocate to instance (MiB)
-   os - which OS to run on instance
-   node - node to run new instance on
-   src_node - node containing the export
-   src_dir - directory on the old node with the export in it
-
-  Returns:
-    1 in case of error, 0 otherwise
+  @param opts: the command line options selected by the user
+  @type args: list
+  @param args: should contain only one element, the new instance name
+  @rtype: int
+  @return: the desired exit code
 
   """
   instance = args[0]
 
   (pnode, snode) = SplitNodeOption(opts.node)
 
-  op = opcodes.OpCreateInstance(instance_name=instance, mem_size=opts.mem,
-                                disk_size=opts.size, swap_size=opts.swap,
+  hypervisor = None
+  hvparams = {}
+  if opts.hypervisor:
+    hypervisor, hvparams = opts.hypervisor
+
+  if opts.nics:
+    try:
+      nic_max = max(int(nidx[0])+1 for nidx in opts.nics)
+    except ValueError, err:
+      raise errors.OpPrereqError("Invalid NIC index passed: %s" % str(err))
+    nics = [{}] * nic_max
+    for nidx, ndict in opts.nics:
+      nidx = int(nidx)
+      if not isinstance(ndict, dict):
+        msg = "Invalid nic/%d value: expected dict, got %s" % (nidx, ndict)
+        raise errors.OpPrereqError(msg)
+      nics[nidx] = ndict
+  elif opts.no_nics:
+    # no nics
+    nics = []
+  else:
+    # default of one nic, all auto
+    nics = [{}]
+
+  if opts.disk_template == constants.DT_DISKLESS:
+    if opts.disks or opts.sd_size is not None:
+      raise errors.OpPrereqError("Diskless instance but disk"
+                                 " information passed")
+    disks = []
+  else:
+    if not opts.disks and not opts.sd_size:
+      raise errors.OpPrereqError("No disk information specified")
+    if opts.disks and opts.sd_size is not None:
+      raise errors.OpPrereqError("Please use either the '--disk' or"
+                                 " '-s' option")
+    if opts.sd_size is not None:
+      opts.disks = [(0, {"size": opts.sd_size})]
+    try:
+      disk_max = max(int(didx[0])+1 for didx in opts.disks)
+    except ValueError, err:
+      raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err))
+    disks = [{}] * disk_max
+    for didx, ddict in opts.disks:
+      didx = int(didx)
+      if not isinstance(ddict, dict):
+        msg = "Invalid disk/%d value: expected dict, got %s" % (didx, ddict)
+        raise errors.OpPrereqError(msg)
+      elif "size" not in ddict:
+        raise errors.OpPrereqError("Missing size for disk %d" % didx)
+      try:
+        ddict["size"] = utils.ParseUnit(ddict["size"])
+      except ValueError, err:
+        raise errors.OpPrereqError("Invalid disk size for disk %d: %s" %
+                                   (didx, err))
+      disks[didx] = ddict
+
+  utils.ForceDictType(opts.beparams, constants.BES_PARAMETER_TYPES)
+  utils.ForceDictType(hvparams, constants.HVS_PARAMETER_TYPES)
+
+  op = opcodes.OpCreateInstance(instance_name=instance,
                                 disk_template=opts.disk_template,
+                                disks=disks,
+                                nics=nics,
                                 mode=constants.INSTANCE_IMPORT,
                                 pnode=pnode, snode=snode,
-                                vcpus=opts.vcpus, ip_check=opts.ip_check,
-                                ip=opts.ip, bridge=opts.bridge, start=False,
+                                ip_check=opts.ip_check,
+                                start=False,
                                 src_node=opts.src_node, src_path=opts.src_dir,
-                                wait_for_sync=opts.wait_for_sync, mac="auto",
+                                wait_for_sync=opts.wait_for_sync,
                                 file_storage_dir=opts.file_storage_dir,
                                 file_driver=opts.file_driver,
-                                iallocator=opts.iallocator)
+                                iallocator=opts.iallocator,
+                                hypervisor=hypervisor,
+                                hvparams=hvparams,
+                                beparams=opts.beparams)
+
   SubmitOpCode(op)
   return 0
 
@@ -110,13 +193,12 @@ def ImportInstance(opts, args):
 def RemoveExport(opts, args):
   """Remove an export from the cluster.
 
-  Args:
-   opts - class with options as members
-   args - list with a single element, the exported instance to remove
-  Opts used:
-
-  Returns:
-    1 in case of error, 0 otherwise
+  @param opts: the command line options selected by the user
+  @type args: list
+  @param args: should contain only one element, the name of the
+      instance whose backup should be removed
+  @rtype: int
+  @return: the desired exit code
 
   """
   instance = args[0]
@@ -129,74 +211,87 @@ def RemoveExport(opts, args):
 # this is defined separately due to readability only
 import_opts = [
   DEBUG_OPT,
-  make_option("-n", "--node", dest="node",
-              help="Target node and optional secondary node",
-              metavar="<pnode>[:<snode>]"),
-  cli_option("-s", "--os-size", dest="size", help="Disk size, in MiB unless"
-             " a suffix is used",
-             default=20 * 1024, type="unit", metavar="<size>"),
-  cli_option("--swap-size", dest="swap", help="Swap size",
-             default=4 * 1024, type="unit", metavar="<size>"),
-  cli_option("-m", "--memory", dest="mem", help="Memory size",
-             default=128, type="unit", metavar="<mem>"),
-  make_option("-p", "--cpu", dest="vcpus", help="Number of virtual CPUs",
-              default=1, type="int", metavar="<PROC>"),
-  make_option("-t", "--disk-template", dest="disk_template",
-              help="Custom disk setup (diskless, file, plain, drbd)",
-              default=None, metavar="TEMPL"),
-  make_option("-i", "--ip", dest="ip",
-              help="IP address ('none' [default], 'auto', or specify address)",
-              default='none', type="string", metavar="<ADDRESS>"),
-  make_option("--no-wait-for-sync", dest="wait_for_sync", default=True,
-              action="store_false", help="Don't wait for sync (DANGEROUS!)"),
-  make_option("-b", "--bridge", dest="bridge",
-              help="Bridge to connect this instance to",
-              default=None, metavar="<bridge>"),
-  make_option("--src-node", dest="src_node", help="Source node",
-              metavar="<node>"),
-  make_option("--src-dir", dest="src_dir", help="Source directory",
-              metavar="<dir>"),
-  make_option("--no-ip-check", dest="ip_check", default=True,
-              action="store_false", help="Don't check that the instance's IP"
-              " is alive"),
-  make_option("--iallocator", metavar="<NAME>",
-              help="Select nodes for the instance automatically using the"
-              " <NAME> iallocator plugin", default=None, type="string"),
-  make_option("--file-storage-dir", dest="file_storage_dir",
-              help="Relative path under default cluster-wide file storage dir"
-              " to store file-based disks", default=None,
-              metavar="<DIR>"),
-  make_option("--file-driver", dest="file_driver", help="Driver to use"
-              " for image files", default="loop", metavar="<DRIVER>"),
+  cli_option("-n", "--node", dest="node",
+             help="Target node and optional secondary node",
+             metavar="<pnode>[:<snode>]",
+             completion_suggest=OPT_COMPL_INST_ADD_NODES),
+  cli_option("-B", "--backend", dest="beparams",
+             type="keyval", default={},
+             help="Backend parameters"),
+  cli_option("-t", "--disk-template", dest="disk_template",
+             help="Custom disk setup (diskless, file, plain, drbd)",
+             default=None, metavar="TEMPL",
+             choices=list(constants.DISK_TEMPLATES)),
+  cli_option("--disk", help="Disk information",
+             default=[], dest="disks",
+             action="append",
+             type="identkeyval"),
+  cli_option("-s", "--os-size", dest="sd_size", help="Disk size for a"
+             " single-disk configuration, when not using the --disk option,"
+             " in MiB unless a suffix is used",
+             default=None, type="unit", metavar="<size>"),
+  cli_option("--net", help="NIC information",
+             default=[], dest="nics",
+             action="append",
+             type="identkeyval"),
+  cli_option("--no-nics", default=False, action="store_true",
+             help="Do not create any network cards for the instance"),
+  cli_option("--no-wait-for-sync", dest="wait_for_sync", default=True,
+             action="store_false", help="Don't wait for sync (DANGEROUS!)"),
+  cli_option("--src-node", dest="src_node", help="Source node",
+             metavar="<node>",
+             completion_suggest=OPT_COMPL_ONE_NODE),
+  cli_option("--src-dir", dest="src_dir", help="Source directory",
+             metavar="<dir>"),
+  cli_option("--no-ip-check", dest="ip_check", default=True,
+             action="store_false", help="Don't check that the instance's IP"
+             " is alive"),
+  cli_option("-I", "--iallocator", metavar="<NAME>",
+             help="Select nodes for the instance automatically using the"
+             " <NAME> iallocator plugin", default=None, type="string",
+             completion_suggest=OPT_COMPL_ONE_IALLOCATOR),
+  cli_option("--file-storage-dir", dest="file_storage_dir",
+             help="Relative path under default cluster-wide file storage dir"
+             " to store file-based disks", default=None,
+             metavar="<DIR>"),
+  cli_option("--file-driver", dest="file_driver", help="Driver to use"
+             " for image files", default="loop", metavar="<DRIVER>",
+             choices=list(constants.FILE_DRIVER)),
+  cli_option("-H", "--hypervisor", dest="hypervisor",
+             help="Hypervisor and hypervisor options, in the format"
+             " hypervisor:option=value,option=value,...", default=None,
+             type="identkeyval"),
   ]
 
 commands = {
   'list': (PrintExportList, ARGS_NONE,
            [DEBUG_OPT,
-            make_option("--node", dest="nodes", default=[], action="append",
-                        help="List only backups stored on this node"
-                             " (can be used multiple times)"),
+            cli_option("--node", dest="nodes", default=[], action="append",
+                       help="List only backups stored on this node"
+                            " (can be used multiple times)",
+                       completion_suggest=OPT_COMPL_ONE_NODE),
             ],
            "", "Lists instance exports available in the ganeti cluster"),
-  'export': (ExportInstance, ARGS_ONE,
+  'export': (ExportInstance, ARGS_ONE_INSTANCE,
              [DEBUG_OPT, FORCE_OPT,
-              make_option("-n", "--node", dest="node", help="Target node",
-                          metavar="<node>"),
-              make_option("","--noshutdown", dest="shutdown",
-                          action="store_false", default=True,
-                          help="Don't shutdown the instance (unsafe)"), ],
+              cli_option("-n", "--node", dest="node", help="Target node",
+                         metavar="<node>",
+                         completion_suggest=OPT_COMPL_ONE_NODE),
+              cli_option("","--noshutdown", dest="shutdown",
+                         action="store_false", default=True,
+                         help="Don't shutdown the instance (unsafe)"), ],
              "-n <target_node> [opts...] <name>",
              "Exports an instance to an image"),
-  'import': (ImportInstance, ARGS_ONE, import_opts,
+  'import': (ImportInstance, ARGS_ONE_INSTANCE, import_opts,
              ("[...] -t disk-type -n node[:secondary-node]"
-              " --src-node node --src-dir dir"
               " <name>"),
              "Imports an instance from an exported image"),
-  'remove': (RemoveExport, ARGS_ONE,
+  'remove': (RemoveExport, [ArgUnknown(min=1, max=1)],
              [DEBUG_OPT],
              "<name>",
              "Remove exports of named instance from the filesystem."),
   }
 
+
 if __name__ == '__main__':
   sys.exit(GenericMain(commands))