Change the gnt-backup export help text
[ganeti-local] / 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 import sys
23 from optparse import make_option
24
25 from ganeti.cli import *
26 from ganeti import cmdlib
27 from ganeti import opcodes
28 from ganeti import constants
29
30
31 def PrintExportList(opts, args):
32   """Prints a list of all the exported system images.
33
34   Args:
35    opts - class with options as members (should be empty)
36    args - should be empty
37
38   Returns:
39     nothing
40
41   """
42   op = opcodes.OpQueryExports(nodes=opts.nodes)
43   exports = SubmitOpCode(op)
44   for node in exports:
45     print ("Node: %s" % node)
46     print ("Exports:")
47     if isinstance(exports[node], list):
48       for instance_name in exports[node]:
49         print ("\t%s" % instance_name)
50     else:
51       print ("  Could not get exports list")
52
53
54 def ExportInstance(opts, args):
55   """Export an instance to an image in the cluster.
56
57   Args:
58    opts - class with options as members
59    args - list with a single element, the instance name
60
61   Returns:
62     1 in case of error, 0 otherwise
63
64   """
65   op = opcodes.OpExportInstance(instance_name=args[0],
66                                 target_node=opts.node,
67                                 shutdown=opts.shutdown)
68
69   SubmitOpCode(op)
70
71
72 def ImportInstance(opts, args):
73   """Add an instance to the cluster.
74
75   Args:
76    opts - class with options as members
77    args - list with a single element, the new instance name
78   Opts used:
79    memory - amount of memory to allocate to instance (MiB)
80    size - amount of disk space to allocate to instance (MiB)
81    os - which OS to run on instance
82    node - node to run new instance on
83    src_node - node containing the export
84    src_dir - directory on the old node with the export in it
85
86   Returns:
87     1 in case of error, 0 otherwise
88
89   """
90   instance = args[0]
91
92   (pnode, snode) = SplitNodeOption(opts.node)
93
94   op = opcodes.OpCreateInstance(instance_name=instance, mem_size=opts.mem,
95                                 disk_size=opts.size, swap_size=opts.swap,
96                                 disk_template=opts.disk_template,
97                                 mode=constants.INSTANCE_IMPORT,
98                                 pnode=pnode, snode=snode,
99                                 vcpus=opts.vcpus, ip_check=opts.ip_check,
100                                 ip=opts.ip, bridge=opts.bridge, start=False,
101                                 src_node=opts.src_node, src_path=opts.src_dir,
102                                 wait_for_sync=opts.wait_for_sync, mac="auto")
103   SubmitOpCode(op)
104   return 0
105
106
107 # this is defined separately due to readability only
108 import_opts = [
109   DEBUG_OPT,
110   make_option("-n", "--node", dest="node",
111               help="Target node and optional secondary node",
112               metavar="<pnode>[:<snode>]"),
113   cli_option("-s", "--os-size", dest="size", help="Disk size, in MiB unless"
114              " a suffix is used",
115              default=20 * 1024, type="unit", metavar="<size>"),
116   cli_option("--swap-size", dest="swap", help="Swap size",
117              default=4 * 1024, type="unit", metavar="<size>"),
118   cli_option("-m", "--memory", dest="mem", help="Memory size",
119              default=128, type="unit", metavar="<mem>"),
120   make_option("-p", "--cpu", dest="vcpus", help="Number of virtual CPUs",
121               default=1, type="int", metavar="<PROC>"),
122   make_option("-t", "--disk-template", dest="disk_template",
123               help="Custom disk setup (diskless, plain, local_raid1,"
124               " remote_raid1 or drbd)", default=None, metavar="TEMPL"),
125   make_option("-i", "--ip", dest="ip",
126               help="IP address ('none' [default], 'auto', or specify address)",
127               default='none', type="string", metavar="<ADDRESS>"),
128   make_option("--no-wait-for-sync", dest="wait_for_sync", default=True,
129               action="store_false", help="Don't wait for sync (DANGEROUS!)"),
130   make_option("-b", "--bridge", dest="bridge",
131               help="Bridge to connect this instance to",
132               default=None, metavar="<bridge>"),
133   make_option("--src-node", dest="src_node", help="Source node",
134               metavar="<node>"),
135   make_option("--src-dir", dest="src_dir", help="Source directory",
136               metavar="<dir>"),
137   make_option("--no-ip-check", dest="ip_check", default=True,
138               action="store_false", help="Don't check that the instance's IP"
139               " is alive"),
140   ]
141
142 commands = {
143   'list': (PrintExportList, ARGS_NONE,
144            [DEBUG_OPT,
145             make_option("--node", dest="nodes", default=[], action="append",
146                         help="List only backups stored on this node"
147                              " (can be used multiple times)"),
148             ],
149            "", "Lists instance exports available in the ganeti cluster"),
150   'export': (ExportInstance, ARGS_ONE,
151              [DEBUG_OPT, FORCE_OPT,
152               make_option("-n", "--node", dest="node", help="Target node",
153                           metavar="<node>"),
154               make_option("","--noshutdown", dest="shutdown",
155                           action="store_false", default=True,
156                           help="Don't shutdown the instance (unsafe)"), ],
157              "-n <target_node> [opts...] <name>",
158              "Exports an instance to an image"),
159   'import': (ImportInstance, ARGS_ONE, import_opts, "[opts...] <name>",
160              "Imports an instance from an exported image"),
161   }
162
163 if __name__ == '__main__':
164   sys.exit(GenericMain(commands))