#!/usr/bin/python
#
-# Copyright (C) 2006, 2007 Google Inc.
+# Copyright (C) 2006, 2007, 2010 Google Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# 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 optparse import make_option
from ganeti.cli import *
from ganeti import opcodes
from ganeti import constants
+from ganeti import errors
_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
"""
- exports = GetClient().QueryExports(opts.nodes)
+ exports = GetClient().QueryExports(opts.nodes, False)
retcode = 0
for node in exports:
ToStdout("Node: %s", node)
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
"""
+ ignore_remove_failures = opts.ignore_remove_failures
+
+ if not opts.node:
+ raise errors.OpPrereqError("Target node must be specified",
+ errors.ECODE_INVAL)
+
op = opcodes.OpExportInstance(instance_name=args[0],
target_node=opts.node,
- shutdown=opts.shutdown)
+ shutdown=opts.shutdown,
+ shutdown_timeout=opts.shutdown_timeout,
+ remove_instance=opts.remove_instance,
+ ignore_remove_failures=ignore_remove_failures)
- SubmitOpCode(op)
+ SubmitOpCode(op, opts=opts)
+ return 0
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
+ 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
-
- ValidateBeParams(opts.beparams)
-
- op = opcodes.OpCreateInstance(instance_name=instance,
- disk_size=opts.size, swap_size=opts.swap,
- disk_template=opts.disk_template,
- mode=constants.INSTANCE_IMPORT,
- pnode=pnode, snode=snode,
- ip_check=opts.ip_check,
- ip=opts.ip, bridge=opts.bridge, start=False,
- src_node=opts.src_node, src_path=opts.src_dir,
- wait_for_sync=opts.wait_for_sync, mac=opts.mac,
- 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):
"""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]
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,
- 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>"),
- keyval_option("-B", "--backend", dest="beparams",
- type="keyval", default={},
- help="Backend parameters"),
- 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("--mac", dest="mac",
- help="MAC address ('auto' [default], or specify address)",
- default='auto', type="string", metavar="<MACADDRESS>"),
- 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>"),
- ikv_option("-H", "--hypervisor", dest="hypervisor",
- help="Hypervisor and hypervisor options, in the format"
- " hypervisor:option=value,option=value,...", default=None,
- type="identkeyval"),
+ BACKEND_OPT,
+ DISK_OPT,
+ DISK_TEMPLATE_OPT,
+ FILESTORE_DIR_OPT,
+ FILESTORE_DRIVER_OPT,
+ HYPERVISOR_OPT,
+ IALLOCATOR_OPT,
+ IDENTIFY_DEFAULTS_OPT,
+ NET_OPT,
+ NODE_PLACEMENT_OPT,
+ NOIPCHECK_OPT,
+ NONAMECHECK_OPT,
+ NONICS_OPT,
+ NWSYNC_OPT,
+ OSPARAMS_OPT,
+ OS_SIZE_OPT,
+ SRC_DIR_OPT,
+ SRC_NODE_OPT,
+ SUBMIT_OPT,
+ DRY_RUN_OPT,
+ PRIORITY_OPT,
]
+
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)"),
- ],
- "", "Lists instance exports available in the ganeti cluster"),
- 'export': (ExportInstance, ARGS_ONE,
- [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)"), ],
- "-n <target_node> [opts...] <name>",
- "Exports an instance to an image"),
- 'import': (ImportInstance, ARGS_ONE, 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,
- [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,
+ REMOVE_INSTANCE_OPT, IGNORE_REMOVE_FAILURES_OPT, DRY_RUN_OPT,
+ PRIORITY_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)], [DRY_RUN_OPT, PRIORITY_OPT],
+ "<name>", "Remove exports of named instance from the filesystem."),
}
+
if __name__ == '__main__':
sys.exit(GenericMain(commands))
projects / ganeti-local / blobdiff