code.grnet.gr Git - ganeti-local/blob - scripts/gnt-backup

   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
  28 from ganeti.cli import *
  29 from ganeti import opcodes
  30 from ganeti import constants
  31 from ganeti import errors
  32 from ganeti import utils
  33
  34
  35 _VALUE_TRUE = "true"
  36
  37
  38 def PrintExportList(opts, args):
  39   """Prints a list of all the exported system images.
  40
  41   @param opts: the command line options selected by the user
  42   @type args: list
  43   @param args: should be an empty list
  44   @rtype: int
  45   @return: the desired exit code
  46
  47   """
  48   exports = GetClient().QueryExports(opts.nodes, False)
  49   retcode = 0
  50   for node in exports:
  51     ToStdout("Node: %s", node)
  52     ToStdout("Exports:")
  53     if isinstance(exports[node], list):
  54       for instance_name in exports[node]:
  55         ToStdout("\t%s", instance_name)
  56     else:
  57       ToStdout("  Could not get exports list")
  58       retcode = 1
  59   return retcode
  60
  61
  62 def ExportInstance(opts, args):
  63   """Export an instance to an image in the cluster.
  64
  65   @param opts: the command line options selected by the user
  66   @type args: list
  67   @param args: should contain only one element, the name
  68       of the instance to be exported
  69   @rtype: int
  70   @return: the desired exit code
  71
  72   """
  73   op = opcodes.OpExportInstance(instance_name=args[0],
  74                                 target_node=opts.node,
  75                                 shutdown=opts.shutdown)
  76
  77   fin_resu, dlist = SubmitOpCode(op)
  78   if not isinstance(dlist, list):
  79     ToStderr("Cannot parse execution results")
  80     return 1
  81   tot_dsk = len(dlist)
  82   # TODO: handle diskless instances
  83   if dlist.count(False) == 0:
  84     # all OK
  85     rcode = 0
  86   elif dlist.count(True) == 0:
  87     ToStderr("Error: No disks were backed up successfully."
  88              " The export doesn't have any valid data,"
  89              " it is recommended to retry the operation.")
  90     rcode = 1
  91   else:
  92     ToStderr("Partial export failure: %d disks backed up, %d disks failed.",
  93              dlist.count(True), dlist.count(False))
  94     rcode = 2
  95   if not fin_resu:
  96     rcode = 1
  97   return rcode
  98
  99 def ImportInstance(opts, args):
 100   """Add an instance to the cluster.
 101
 102   @param opts: the command line options selected by the user
 103   @type args: list
 104   @param args: should contain only one element, the new instance name
 105   @rtype: int
 106   @return: the desired exit code
 107
 108   """
 109   instance = args[0]
 110
 111   (pnode, snode) = SplitNodeOption(opts.node)
 112
 113   hypervisor = None
 114   hvparams = {}
 115   if opts.hypervisor:
 116     hypervisor, hvparams = opts.hypervisor
 117
 118   if opts.nics:
 119     try:
 120       nic_max = max(int(nidx[0])+1 for nidx in opts.nics)
 121     except ValueError, err:
 122       raise errors.OpPrereqError("Invalid NIC index passed: %s" % str(err))
 123     nics = [{}] * nic_max
 124     for nidx, ndict in opts.nics:
 125       nidx = int(nidx)
 126       if not isinstance(ndict, dict):
 127         msg = "Invalid nic/%d value: expected dict, got %s" % (nidx, ndict)
 128         raise errors.OpPrereqError(msg)
 129       nics[nidx] = ndict
 130   elif opts.no_nics:
 131     # no nics
 132     nics = []
 133   else:
 134     # default of one nic, all auto
 135     nics = [{}]
 136
 137   if opts.disk_template == constants.DT_DISKLESS:
 138     if opts.disks or opts.sd_size is not None:
 139       raise errors.OpPrereqError("Diskless instance but disk"
 140                                  " information passed")
 141     disks = []
 142   else:
 143     if not opts.disks and not opts.sd_size:
 144       raise errors.OpPrereqError("No disk information specified")
 145     if opts.disks and opts.sd_size is not None:
 146       raise errors.OpPrereqError("Please use either the '--disk' or"
 147                                  " '-s' option")
 148     if opts.sd_size is not None:
 149       opts.disks = [(0, {"size": opts.sd_size})]
 150     try:
 151       disk_max = max(int(didx[0])+1 for didx in opts.disks)
 152     except ValueError, err:
 153       raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err))
 154     disks = [{}] * disk_max
 155     for didx, ddict in opts.disks:
 156       didx = int(didx)
 157       if not isinstance(ddict, dict):
 158         msg = "Invalid disk/%d value: expected dict, got %s" % (didx, ddict)
 159         raise errors.OpPrereqError(msg)
 160       elif "size" not in ddict:
 161         raise errors.OpPrereqError("Missing size for disk %d" % didx)
 162       try:
 163         ddict["size"] = utils.ParseUnit(ddict["size"])
 164       except ValueError, err:
 165         raise errors.OpPrereqError("Invalid disk size for disk %d: %s" %
 166                                    (didx, err))
 167       disks[didx] = ddict
 168
 169   utils.ForceDictType(opts.beparams, constants.BES_PARAMETER_TYPES)
 170   utils.ForceDictType(hvparams, constants.HVS_PARAMETER_TYPES)
 171
 172   op = opcodes.OpCreateInstance(instance_name=instance,
 173                                 disk_template=opts.disk_template,
 174                                 disks=disks,
 175                                 nics=nics,
 176                                 mode=constants.INSTANCE_IMPORT,
 177                                 pnode=pnode, snode=snode,
 178                                 ip_check=opts.ip_check,
 179                                 start=False,
 180                                 src_node=opts.src_node, src_path=opts.src_dir,
 181                                 wait_for_sync=opts.wait_for_sync,
 182                                 file_storage_dir=opts.file_storage_dir,
 183                                 file_driver=opts.file_driver,
 184                                 iallocator=opts.iallocator,
 185                                 hypervisor=hypervisor,
 186                                 hvparams=hvparams,
 187                                 beparams=opts.beparams)
 188
 189   SubmitOpCode(op)
 190   return 0
 191
 192
 193 def RemoveExport(opts, args):
 194   """Remove an export from the cluster.
 195
 196   @param opts: the command line options selected by the user
 197   @type args: list
 198   @param args: should contain only one element, the name of the
 199       instance whose backup should be removed
 200   @rtype: int
 201   @return: the desired exit code
 202
 203   """
 204   instance = args[0]
 205   op = opcodes.OpRemoveExport(instance_name=args[0])
 206
 207   SubmitOpCode(op)
 208   return 0
 209
 210
 211 # this is defined separately due to readability only
 212 import_opts = [
 213   DEBUG_OPT,
 214   cli_option("-n", "--node", dest="node",
 215              help="Target node and optional secondary node",
 216              metavar="<pnode>[:<snode>]",
 217              completion_suggest=OPT_COMPL_INST_ADD_NODES),
 218   BACKEND_OPT,
 219   DISK_TEMPLATE_OPT,
 220   cli_option("--disk", help="Disk information",
 221              default=[], dest="disks",
 222              action="append",
 223              type="identkeyval"),
 224   cli_option("-s", "--os-size", dest="sd_size", help="Disk size for a"
 225              " single-disk configuration, when not using the --disk option,"
 226              " in MiB unless a suffix is used",
 227              default=None, type="unit", metavar="<size>"),
 228   cli_option("--net", help="NIC information",
 229              default=[], dest="nics",
 230              action="append",
 231              type="identkeyval"),
 232   NONICS_OPT,
 233   NWSYNC_OPT,
 234   cli_option("--src-node", dest="src_node", help="Source node",
 235              metavar="<node>",
 236              completion_suggest=OPT_COMPL_ONE_NODE),
 237   cli_option("--src-dir", dest="src_dir", help="Source directory",
 238              metavar="<dir>"),
 239   cli_option("--no-ip-check", dest="ip_check", default=True,
 240              action="store_false", help="Don't check that the instance's IP"
 241              " is alive"),
 242   IALLOCATOR_OPT,
 243   FILESTORE_DIR_OPT,
 244   FILESTORE_DRIVER_OPT,
 245   HYPERVISOR_OPT,
 246   ]
 247
 248 commands = {
 249   'list': (PrintExportList, ARGS_NONE,
 250            [DEBUG_OPT,
 251             cli_option("--node", dest="nodes", default=[], action="append",
 252                        help="List only backups stored on this node"
 253                             " (can be used multiple times)",
 254                        completion_suggest=OPT_COMPL_ONE_NODE),
 255             ],
 256            "", "Lists instance exports available in the ganeti cluster"),
 257   'export': (ExportInstance, ARGS_ONE_INSTANCE,
 258              [DEBUG_OPT, FORCE_OPT,
 259               cli_option("-n", "--node", dest="node", help="Target node",
 260                          metavar="<node>",
 261                          completion_suggest=OPT_COMPL_ONE_NODE),
 262               cli_option("","--noshutdown", dest="shutdown",
 263                          action="store_false", default=True,
 264                          help="Don't shutdown the instance (unsafe)"), ],
 265              "-n <target_node> [opts...] <name>",
 266              "Exports an instance to an image"),
 267   'import': (ImportInstance, ARGS_ONE_INSTANCE, import_opts,
 268              ("[...] -t disk-type -n node[:secondary-node]"
 269               " <name>"),
 270              "Imports an instance from an exported image"),
 271   'remove': (RemoveExport, [ArgUnknown(min=1, max=1)],
 272              [DEBUG_OPT],
 273              "<name>",
 274              "Remove exports of named instance from the filesystem."),
 275   }
 276
 277
 278 if __name__ == '__main__':
 279   sys.exit(GenericMain(commands))