Update gnt-backup online help
[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 # 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 from optparse import make_option
28
29 from ganeti.cli import *
30 from ganeti import opcodes
31 from ganeti import constants
32 from ganeti import errors
33 from ganeti import utils
34
35
36 _VALUE_TRUE = "true"
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)
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   SubmitOpCode(op)
78
79
80 def ImportInstance(opts, args):
81   """Add an instance to the cluster.
82
83   @param opts: the command line options selected by the user
84   @type args: list
85   @param args: should contain only one element, the new instance name
86   @rtype: int
87   @return: the desired exit code
88
89   """
90   instance = args[0]
91
92   (pnode, snode) = SplitNodeOption(opts.node)
93
94   hypervisor = None
95   hvparams = {}
96   if opts.hypervisor:
97     hypervisor, hvparams = opts.hypervisor
98
99   if opts.nics:
100     try:
101       nic_max = max(int(nidx[0])+1 for nidx in opts.nics)
102     except ValueError, err:
103       raise errors.OpPrereqError("Invalid NIC index passed: %s" % str(err))
104     nics = [{}] * nic_max
105     for nidx, ndict in opts.nics.items():
106       nidx = int(nidx)
107       nics[nidx] = ndict
108   elif opts.no_nics:
109     # no nics
110     nics = []
111   else:
112     # default of one nic, all auto
113     nics = [{}]
114
115   if opts.disk_template == constants.DT_DISKLESS:
116     if opts.disks:
117       raise errors.OpPrereqError("Diskless instance but disk"
118                                  " information passed")
119     disks = []
120   else:
121     if not opts.disks:
122       raise errors.OpPrereqError("No disk information specified")
123     try:
124       disk_max = max(int(didx[0])+1 for didx in opts.disks)
125     except ValueError, err:
126       raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err))
127     disks = [{}] * disk_max
128     for didx, ddict in opts.disks:
129       didx = int(didx)
130       if "size" not in ddict:
131         raise errors.OpPrereqError("Missing size for disk %d" % didx)
132       try:
133         ddict["size"] = utils.ParseUnit(ddict["size"])
134       except ValueError, err:
135         raise errors.OpPrereqError("Invalid disk size for disk %d: %s" %
136                                    (didx, err))
137       disks[didx] = ddict
138
139   ValidateBeParams(opts.beparams)
140
141   op = opcodes.OpCreateInstance(instance_name=instance,
142                                 disk_template=opts.disk_template,
143                                 disks=disks,
144                                 nics=nics,
145                                 mode=constants.INSTANCE_IMPORT,
146                                 pnode=pnode, snode=snode,
147                                 ip_check=opts.ip_check,
148                                 start=False,
149                                 src_node=opts.src_node, src_path=opts.src_dir,
150                                 wait_for_sync=opts.wait_for_sync,
151                                 file_storage_dir=opts.file_storage_dir,
152                                 file_driver=opts.file_driver,
153                                 iallocator=opts.iallocator,
154                                 hypervisor=hypervisor,
155                                 hvparams=hvparams,
156                                 beparams=opts.beparams)
157
158   SubmitOpCode(op)
159   return 0
160
161
162 def RemoveExport(opts, args):
163   """Remove an export from the cluster.
164
165   @param opts: the command line options selected by the user
166   @type args: list
167   @param args: should contain only one element, the name of the
168       instance whose backup should be removed
169   @rtype: int
170   @return: the desired exit code
171
172   """
173   instance = args[0]
174   op = opcodes.OpRemoveExport(instance_name=args[0])
175
176   SubmitOpCode(op)
177   return 0
178
179
180 # this is defined separately due to readability only
181 import_opts = [
182   DEBUG_OPT,
183   make_option("-n", "--node", dest="node",
184               help="Target node and optional secondary node",
185               metavar="<pnode>[:<snode>]"),
186   keyval_option("-B", "--backend", dest="beparams",
187                 type="keyval", default={},
188                 help="Backend parameters"),
189   make_option("-t", "--disk-template", dest="disk_template",
190               help="Custom disk setup (diskless, file, plain, drbd)",
191               default=None, metavar="TEMPL"),
192   ikv_option("--disk", help="Disk information",
193              default=[], dest="disks",
194              action="append",
195              type="identkeyval"),
196   ikv_option("--net", help="NIC information",
197              default=[], dest="nics",
198              action="append",
199              type="identkeyval"),
200   make_option("--no-nics", default=False, action="store_true",
201               help="Do not create any network cards for the instance"),
202   make_option("--no-wait-for-sync", dest="wait_for_sync", default=True,
203               action="store_false", help="Don't wait for sync (DANGEROUS!)"),
204   make_option("--src-node", dest="src_node", help="Source node",
205               metavar="<node>"),
206   make_option("--src-dir", dest="src_dir", help="Source directory",
207               metavar="<dir>"),
208   make_option("--no-ip-check", dest="ip_check", default=True,
209               action="store_false", help="Don't check that the instance's IP"
210               " is alive"),
211   make_option("--iallocator", metavar="<NAME>",
212               help="Select nodes for the instance automatically using the"
213               " <NAME> iallocator plugin", default=None, type="string"),
214   make_option("--file-storage-dir", dest="file_storage_dir",
215               help="Relative path under default cluster-wide file storage dir"
216               " to store file-based disks", default=None,
217               metavar="<DIR>"),
218   make_option("--file-driver", dest="file_driver", help="Driver to use"
219               " for image files", default="loop", metavar="<DRIVER>"),
220   ikv_option("-H", "--hypervisor", dest="hypervisor",
221               help="Hypervisor and hypervisor options, in the format"
222               " hypervisor:option=value,option=value,...", default=None,
223               type="identkeyval"),
224   ]
225
226 commands = {
227   'list': (PrintExportList, ARGS_NONE,
228            [DEBUG_OPT,
229             make_option("--node", dest="nodes", default=[], action="append",
230                         help="List only backups stored on this node"
231                              " (can be used multiple times)"),
232             ],
233            "", "Lists instance exports available in the ganeti cluster"),
234   'export': (ExportInstance, ARGS_ONE,
235              [DEBUG_OPT, FORCE_OPT,
236               make_option("-n", "--node", dest="node", help="Target node",
237                           metavar="<node>"),
238               make_option("","--noshutdown", dest="shutdown",
239                           action="store_false", default=True,
240                           help="Don't shutdown the instance (unsafe)"), ],
241              "-n <target_node> [opts...] <name>",
242              "Exports an instance to an image"),
243   'import': (ImportInstance, ARGS_ONE, import_opts,
244              ("[...] -t disk-type -n node[:secondary-node]"
245               " <name>"),
246              "Imports an instance from an exported image"),
247   'remove': (RemoveExport, ARGS_ONE,
248              [DEBUG_OPT],
249              "<name>",
250              "Remove exports of named instance from the filesystem."),
251   }
252
253 if __name__ == '__main__':
254   sys.exit(GenericMain(commands))