Add strict name validation for the LVM backend
[ganeti-local] / scripts / gnt-backup
index ba52b39..f5598cb 100755 (executable)
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 # 02110-1301, USA.
 
+"""Backup related commands"""
 
-# pylint: disable-msg=W0401,W0614
+# pylint: disable-msg=W0401,W0613,W0614,C0103
 # W0401: Wildcard import ganeti.cli
+# W0613: Unused argument, since all functions follow the same API
 # W0614: Unused import %s from wildcard import (since we need cli)
+# C0103: Invalid name gnt-backup
 
 import sys
 
 from ganeti.cli import *
 from ganeti import opcodes
 from ganeti import constants
-from ganeti import errors
-from ganeti import utils
 
 
 _VALUE_TRUE = "true"
@@ -72,13 +73,13 @@ def ExportInstance(opts, args):
   """
   op = opcodes.OpExportInstance(instance_name=args[0],
                                 target_node=opts.node,
-                                shutdown=opts.shutdown)
+                                shutdown=opts.shutdown,
+                                shutdown_timeout=opts.shutdown_timeout)
 
-  fin_resu, dlist = SubmitOpCode(op)
+  fin_resu, dlist = SubmitOpCode(op, opts=opts)
   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
@@ -99,95 +100,10 @@ def ExportInstance(opts, args):
 def ImportInstance(opts, args):
   """Add an instance to the cluster.
 
-  @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
+  This is just a wrapper over GenericInstanceCreate.
 
   """
-  instance = args[0]
-
-  (pnode, snode) = SplitNodeOption(opts.node)
-
-  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,
-                                ip_check=opts.ip_check,
-                                start=False,
-                                src_node=opts.src_node, src_path=opts.src_dir,
-                                wait_for_sync=opts.wait_for_sync,
-                                file_storage_dir=opts.file_storage_dir,
-                                file_driver=opts.file_driver,
-                                iallocator=opts.iallocator,
-                                hypervisor=hypervisor,
-                                hvparams=hvparams,
-                                beparams=opts.beparams)
-
-  SubmitOpCode(op)
-  return 0
+  return GenericInstanceCreate(constants.INSTANCE_IMPORT, opts, args)
 
 
 def RemoveExport(opts, args):
@@ -201,77 +117,50 @@ def RemoveExport(opts, args):
   @return: the desired exit code
 
   """
-  instance = args[0]
   op = opcodes.OpRemoveExport(instance_name=args[0])
 
-  SubmitOpCode(op)
+  SubmitOpCode(op, opts=opts)
   return 0
 
 
 # this is defined separately due to readability only
 import_opts = [
-  DEBUG_OPT,
-  cli_option("-n", "--node", dest="node",
-             help="Target node and optional secondary node",
-             metavar="<pnode>[:<snode>]",
-             completion_suggest=OPT_COMPL_INST_ADD_NODES),
+  NODE_PLACEMENT_OPT,
   BACKEND_OPT,
   DISK_TEMPLATE_OPT,
-  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"),
+  DISK_OPT,
+  OS_SIZE_OPT,
+  NET_OPT,
   NONICS_OPT,
   NWSYNC_OPT,
-  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"),
+  SRC_DIR_OPT,
+  SRC_NODE_OPT,
+  NOIPCHECK_OPT,
+  NONAMECHECK_OPT,
   IALLOCATOR_OPT,
   FILESTORE_DIR_OPT,
   FILESTORE_DRIVER_OPT,
   HYPERVISOR_OPT,
+  SUBMIT_OPT,
   ]
 
 commands = {
-  'list': (PrintExportList, ARGS_NONE,
-           [DEBUG_OPT,
-            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_INSTANCE,
-             [DEBUG_OPT, FORCE_OPT,
-              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_INSTANCE, import_opts,
-             ("[...] -t disk-type -n node[:secondary-node]"
-              " <name>"),
-             "Imports an instance from an exported image"),
-  'remove': (RemoveExport, [ArgUnknown(min=1, max=1)],
-             [DEBUG_OPT],
-             "<name>",
-             "Remove exports of named instance from the filesystem."),
+  'list': (
+    PrintExportList, ARGS_NONE,
+    [NODE_LIST_OPT],
+    "", "Lists instance exports available in the ganeti cluster"),
+  'export': (
+    ExportInstance, ARGS_ONE_INSTANCE,
+    [FORCE_OPT, SINGLE_NODE_OPT, NOSHUTDOWN_OPT, SHUTDOWN_TIMEOUT_OPT],
+    "-n <target_node> [opts...] <name>",
+    "Exports an instance to an image"),
+  'import': (
+    ImportInstance, ARGS_ONE_INSTANCE, import_opts,
+    "[...] -t disk-type -n node[:secondary-node] <name>",
+    "Imports an instance from an exported image"),
+  'remove': (
+    RemoveExport, [ArgUnknown(min=1, max=1)], [],
+    "<name>", "Remove exports of named instance from the filesystem."),
   }