1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
3 <!-- Fill in your name for FIRSTNAME and SURNAME. -->
4 <!-- Please adjust the date whenever revising the manpage. -->
5 <!ENTITY dhdate "<date>February 11, 2009</date>">
6 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
7 allowed: see man(7), man(1). -->
8 <!ENTITY dhsection "<manvolnum>8</manvolnum>">
9 <!ENTITY dhucpackage "<refentrytitle>gnt-backup</refentrytitle>">
10 <!ENTITY dhpackage "gnt-backup">
12 <!ENTITY debian "<productname>Debian</productname>">
13 <!ENTITY gnu "<acronym>GNU</acronym>">
14 <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
15 <!ENTITY footer SYSTEM "footer.sgml">
24 <holder>Google Inc.</holder>
32 <refmiscinfo>ganeti 2.0</refmiscinfo>
35 <refname>&dhpackage;</refname>
37 <refpurpose>ganeti instance import/export</refpurpose>
41 <command>&dhpackage; </command>
43 <arg choice="req">command</arg>
44 <arg>arguments...</arg>
48 <title>DESCRIPTION</title>
51 The <command>&dhpackage;</command> is used for importing and exporting
52 instances and their configuration from a ganeti system. It is useful for
53 backing instances up and also to migrate them between clusters.
58 <title>COMMANDS</title>
64 <command>export</command>
65 <arg choice="req">-n <replaceable>node</replaceable></arg>
66 <arg>--shutdown-timeout=<replaceable>N</replaceable></arg>
67 <arg>--noshutdown</arg>
68 <arg choice="req"><replaceable>instance</replaceable></arg>
73 Exports an instance to the target node. All the instance data
74 and its configuration will be exported under the
75 /srv/ganeti/export/<replaceable>instance</replaceable>
76 directory on the target node.
80 The <option>--shutdown-timeout</option> is used to specify how
81 much time to wait before forcing the shutdown (xm destroy in xen,
82 killing the kvm process, for kvm). By default two minutes are
83 given to each instance to stop.
87 The <option>--noshutdown</option> option will create a
88 snapshot disk of the instance without shutting it down first.
89 While this is faster and involves no downtime, it cannot be
90 guaranteed that the instance data will be in a consistent state
95 The exit code of the command is 0 if all disks were backed up
96 successfully, 1 if no data was backed up or if the
97 configuration export failed, and 2 if just some of the disks
98 failed to backup. The exact details of the failures will be
99 shown during the command execution (and will be stored in the
100 job log). It is recommended that for any non-zero exit code,
101 the backup is considered invalid, and retried.
107 # gnt-backup export -n node1.example.com instance3.example.com
113 <title>IMPORT</title>
115 <command>import</command>
118 <arg>-n <replaceable>node<optional>:secondary-node</optional></replaceable></arg> <arg>--iallocator
119 <replaceable>name</replaceable></arg>
123 <arg rep="repeat">--disk <replaceable>N</replaceable>:size=<replaceable>VAL</replaceable><arg>,mode=<replaceable>ro|rw</replaceable></arg></arg>
126 <arg rep="repeat">--net <replaceable>N</replaceable><arg rep="repeat">:options</arg></arg>
130 <arg>-B <replaceable>BEPARAMS</replaceable></arg>
132 <arg>-H <replaceable>HYPERVISOR</replaceable><arg>:<arg choice="plain" rep="repeat">option=<replaceable>value</replaceable></arg></arg></arg>
134 <arg>--src-node=<replaceable>source-node</replaceable></arg>
135 <arg>--src-dir=<replaceable>source-dir</replaceable></arg>
138 <arg choice="req">-t<group>
146 <arg choice="req"><replaceable>instance</replaceable></arg>
149 Imports a new instance from an export residing on
150 <replaceable>source-node</replaceable> in
151 <replaceable>source-dir</replaceable>.
152 <replaceable>instance</replaceable> must be in DNS and resolve
153 to a IP in the same network as the nodes in the cluster. If
154 the source node and directory are not passed, the last backup
155 in the cluster is used, as visible with the
156 <command>list</command> command.
160 The <option>disk</option> option specifies the parameters for
161 the disks of the instance. The numbering of disks starts at
162 zero, and at least one disk needs to be passed. For each disk,
163 at least the size needs to be given, and optionally the access
164 mode (read-only or the default of read-write) can also be
165 specified. The size is interpreted (when no unit is given) in
166 mebibytes. You can also use one of the suffixes
167 <literal>m</literal>, <literal>g</literal> or
168 <literal>t</literal> to specificy the exact the units used;
169 these suffixes map to mebibytes, gibibytes and tebibytes.
173 Alternatively, a single-disk instance can be created via the
174 <option>-s</option> option which takes a single argument,
175 the size of the disk. This is similar to the Ganeti 1.2
176 version (but will only create one disk).
180 The minimum disk specification is therefore
181 <userinput>--disk 0:size=20G</userinput> (or <userinput>-s
182 20G</userinput> when using the <option>-s</option> option),
183 and a three-disk instance can be specified as
184 <userinput>--disk 0:size=20G --disk 1:size=4G --disk
185 2:size=100G</userinput>.
189 The NICs of the instances can be specified via the
190 <option>--net</option> option. By default, one NIC is created
191 for the instance, with the MAC set to the original MAC of the
192 instance (as it was at export time). Each NIC can take up to
193 three parameters (all optional):
198 <simpara>either a value or <constant>GENERATE</constant>
199 to generate a new unique MAC, or
200 <constant>AUTO</constant> to reuse the old MAC</simpara>
206 <simpara>specifies the IP address assigned to the
207 instance from the Ganeti side (this is not necessarily
208 what the instance will use, but what the node expects
209 the instance to use)</simpara>
215 <simpara>specifies the connection mode for this nic:
216 routed or bridged.</simpara>
222 <simpara>in bridged mode specifies the bridge to attach
223 this NIC to, in routed mode it's intended to
224 differentiate between different routing tables/instance
225 groups (but the meaning is dependent on the network
226 script, see gnt-cluster(8) for more details)</simpara>
230 Of these "mode" and "link" are nic parameters, and inherit their
231 default at cluster level.
235 Alternatively, if no network is desired for the instance, you
236 can prevent the default of one NIC with the
237 <option>--no-nics</option> option.
241 The <option>-B</option> option specifies the backend
242 parameters for the instance. If no such parameters are
243 specified, the values are inherited from the cluster. Possible
249 <simpara>the memory size of the instance; as usual,
250 suffixes can be used to denote the unit, otherwise the
251 value is taken in mebibites</simpara>
257 <simpara>the number of VCPUs to assign to the instance
258 (if this value makes sense for the hypervisor)</simpara>
262 <term>auto_balance</term>
264 <simpara>whether the instance is considered in the N+1
265 cluster checks (enough redundancy in the cluster to
266 survive a node failure)</simpara>
273 The <option>-t</option> options specifies the disk layout type for
274 the instance. The available choices are:
277 <term>diskless</term>
280 This creates an instance with no disks. Its useful for
281 testing only (or other special cases).
288 <para>Disk devices will be logical volumes.</para>
295 Disk devices will be drbd (version 8.x) on top of lvm
303 <para>Disk devices will be backed up by files, under the
305 class="directory">@RPL_FILE_STORAGE_DIR@</filename>. By
306 default, each instance will get a directory (as its own
307 name) under this path, and each disk is stored as
308 individual files in this (instance-specific)
316 The <option>--iallocator</option> option specifies the instance
317 allocator plugin to use. If you pass in this option the allocator will
318 select nodes for this instance automatically, so you don't need to pass
319 them with the <option>-n</option> option. For more information please
320 refer to the instance allocator documentation.
324 The optional second value of the <option>--node</option> is used for
325 the drbd template and specifies the remote node.
329 If you do not want gnt-backup to wait for the disk mirror
330 to be synced, use the <option>--no-wait-for-sync</option>
337 # gnt-backup import -t plain --disk 0:size=1G -B memory=512 \
338 > -n node1.example.com \
339 > instance3.example.com
349 <command>list</command>
350 <arg>--node=<replaceable>NODE</replaceable></arg>
354 Lists the exports currently available in the default directory
355 in all the nodes of the current cluster, or optionally only a
356 subset of them specified using the <option>--node</option>
357 option (which can be used multiple times)
363 # gnt-backup list --nodes node1 --nodes node2
369 <title>REMOVE</title>
371 <command>remove</command>
372 <arg choice="req">instance_name</arg>
376 Removes the backup for the given instance name, if any. If the
377 backup was for a deleted instances, it is needed to pass the
378 <acronym>FQDN</acronym> of the instance, and not only the
390 <!-- Keep this comment at the end of the file
395 sgml-minimize-attributes:nil
396 sgml-always-quote-attributes:t
399 sgml-parent-document:nil
400 sgml-default-dtd-file:nil
401 sgml-exposed-tags:nil
402 sgml-local-catalogs:nil
403 sgml-local-ecat-files:nil