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

   1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2
   3   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
   4   <!-- Please adjust the date whenever revising the manpage. -->
   5   <!ENTITY dhdate      "<date>Jul 6, 2007</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">
  11
  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">
  16 ]>
  17
  18 <refentry>
  19   <refentryinfo>
  20     <copyright>
  21       <year>2007</year>
  22       <holder>Google Inc.</holder>
  23     </copyright>
  24     &dhdate;
  25   </refentryinfo>
  26   <refmeta>
  27     &dhucpackage;
  28
  29     &dhsection;
  30     <refmiscinfo>ganeti 1.2</refmiscinfo>
  31   </refmeta>
  32   <refnamediv>
  33     <refname>&dhpackage;</refname>
  34
  35     <refpurpose>ganeti instance import/export</refpurpose>
  36   </refnamediv>
  37   <refsynopsisdiv>
  38     <cmdsynopsis>
  39       <command>&dhpackage; </command>
  40
  41       <arg choice="req">command</arg>
  42       <arg>arguments...</arg>
  43     </cmdsynopsis>
  44   </refsynopsisdiv>
  45   <refsect1>
  46     <title>DESCRIPTION</title>
  47
  48     <para>
  49       The <command>&dhpackage;</command> is used for importing and exporting
  50       instances and their configuration from a ganeti system. It is useful for
  51       backing instances up and also to migrate them between clusters.
  52     </para>
  53
  54   </refsect1>
  55   <refsect1>
  56     <title>COMMANDS</title>
  57
  58     <refsect2>
  59       <title>EXPORT</title>
  60
  61       <cmdsynopsis>
  62         <command>export</command>
  63         <arg choice="req">-n <replaceable>node</replaceable></arg>
  64         <arg>--noshutdown</arg>
  65         <arg choice="req"><replaceable>instance</replaceable></arg>
  66       </cmdsynopsis>
  67
  68       <para>
  69         Exports an instance to the target node. All the instance data
  70         and its configuration will be exported under the
  71         /srv/ganeti/exports/<replaceable>instance</replaceable>
  72         directory on the target node.
  73       </para>
  74
  75       <para>
  76         The <option>--noshutdown</option> option will create a
  77         snapshot disk of the instance without shutting it down first.
  78         While this is faster and involves no downtime, it cannot be
  79         guaranteed that the instance data will be in a consistent state
  80         in the exported dump.
  81       </para>
  82
  83       <para>
  84         Example:
  85         <screen>
  86 # gnt-backup export -n node1.example.com instance3.example.com
  87         </screen>
  88       </para>
  89     </refsect2>
  90
  91     <refsect2>
  92       <title>IMPORT</title>
  93       <cmdsynopsis>
  94         <command>import</command>
  95         <arg choice="req">-n <replaceable>node<optional>:secondary-node</optional></replaceable></arg>
  96         <arg>-s <replaceable>disksize</replaceable></arg>
  97         <arg>--swap-size <replaceable>disksize</replaceable></arg>
  98         <arg>-m <replaceable>memsize</replaceable></arg>
  99         <arg>-b <replaceable>bridge</replaceable></arg>
 100         <sbr>
 101         <arg choice="req">-t<group>
 102             <arg>diskless</arg>
 103             <arg>plain</arg>
 104             <arg>local_raid1</arg>
 105             <arg>remote_raid1</arg>
 106             <arg>drbd</arg>
 107           </group>
 108         </arg>
 109         <sbr>
 110         <arg choice="req">--src-node=<replaceable>source-node</replaceable></arg>
 111         <arg choice="req">--src-dir=<replaceable>source-dir</replaceable></arg>
 112         <arg choice="req"><replaceable>instance</replaceable></arg>
 113       </cmdsynopsis>
 114       <para>
 115         Imports a new instance from an export residing on
 116         <replaceable>source-node</replaceable> in
 117         <replaceable>source-dir</replaceable>.
 118         <replaceable>instance</replaceable> must be in DNS and
 119         resolve to a IP in the same network as the nodes in the
 120         cluster.
 121       </para>
 122
 123       <para>
 124         The <option>-s</option> option specifies the disk size for
 125         the instance, in mebibytes (defaults to
 126         <constant>20480MiB</constant> =
 127         <constant>20GiB</constant>). You can also use one of the
 128         suffixes <literal>m</literal>, <literal>g</literal> or
 129         <literal>t</literal> to specificy the exact the units used;
 130         these suffixes map to mebibytes, gibibytes and tebibytes.
 131       </para>
 132
 133       <para>
 134         The <option>--swap-size</option> option specifies the swap
 135         disk size (in mebibytes) for the instance (the one presented
 136         as <filename class="devicefile">/dev/sdb</filename>). The
 137         default is <constant>4096MiB</constant>. As for the disk
 138         size, you can specify other suffixes.
 139       </para>
 140
 141       <para>
 142         The <option>-m</option> option specifies the memory size for
 143         the instance, in mebibytes (defaults to 128 MiB).
 144       </para>
 145
 146       <para>
 147         The <option>-b</option> option specifies the bridge to which the
 148         instance will be connected. (defaults to the cluster-wide default
 149         bridge specified at cluster intialization time).
 150       </para>
 151
 152       <para>
 153         The <option>-t</option> options specifies the disk layout type for
 154         the instance. The available choices are:
 155         <variablelist>
 156           <varlistentry>
 157             <term>diskless</term>
 158             <listitem>
 159               <para>
 160                 This creates an instance with no disks. Its useful for
 161                 testing only (or other special cases).
 162               </para>
 163             </listitem>
 164           </varlistentry>
 165           <varlistentry>
 166             <term>plain</term>
 167             <listitem>
 168               <para>Disk devices will be logical volumes.</para>
 169             </listitem>
 170           </varlistentry>
 171           <varlistentry>
 172             <term>local_raid1</term>
 173             <listitem>
 174               <para>
 175                 Disk devices will be md raid1 arrays over two local
 176                 logical volumes.
 177               </para>
 178             </listitem>
 179           </varlistentry>
 180           <varlistentry>
 181             <term>remote_raid1</term>
 182             <listitem>
 183               <para>
 184                 Disk devices will be md raid1 arrays with one
 185                 component (so it's not actually raid1): a drbd (0.7.x)
 186                 device between the instance's primary node and the
 187                 node given by the second value of the
 188                 <option>--node</option> option.
 189               </para>
 190             </listitem>
 191           </varlistentry>
 192           <varlistentry>
 193             <term>drbd</term>
 194             <listitem>
 195               <para>
 196                 Disk devices will be drbd (version 8.x) on top of lvm
 197                 volumes. They are equivalent in functionality to
 198                 <replaceable>remote_raid1</replaceable>, but are
 199                 recommended for new instances (if you have drbd 8.x
 200                 installed).
 201               </para>
 202             </listitem>
 203           </varlistentry>
 204         </variablelist>
 205       </para>
 206
 207       <para>
 208         If you do not want gnt-backup to wait for the disk mirror
 209         to be synced, use the <option>--no-wait-for-sync</option>
 210         option.
 211       </para>
 212
 213       <para>
 214         Example:
 215         <screen>
 216 # gnt-backup import -t plain -s 30 -m 512 -n node1.example.com \
 217 > --src-node=node2.example.com \
 218 > --src-dir=/srv/ganeti/exports/instance3.example.com \
 219 > instance3.example.com
 220         </screen>
 221       </para>
 222
 223     </refsect2>
 224
 225     <refsect2>
 226       <title>LIST</title>
 227
 228       <cmdsynopsis>
 229         <command>list</command>
 230         <arg>--node=<replaceable>NODE</replaceable></arg>
 231       </cmdsynopsis>
 232
 233       <para>
 234         Lists the exports currently available in the default directory
 235         in all the nodes of the current cluster, or optionally only a
 236         subset of them specified using the <option>--node</option>
 237         option (which can be used multiple times)
 238       </para>
 239
 240       <para>
 241       Example:
 242 <screen>
 243 # gnt-backup list --nodes node1 --nodes node2
 244 </screen>
 245     </refsect2>
 246
 247   </refsect1>
 248
 249   &footer;
 250
 251 </refentry>
 252
 253 <!-- Keep this comment at the end of the file
 254 Local variables:
 255 mode: sgml
 256 sgml-omittag:t
 257 sgml-shorttag:t
 258 sgml-minimize-attributes:nil
 259 sgml-always-quote-attributes:t
 260 sgml-indent-step:2
 261 sgml-indent-data:t
 262 sgml-parent-document:nil
 263 sgml-default-dtd-file:nil
 264 sgml-exposed-tags:nil
 265 sgml-local-catalogs:nil
 266 sgml-local-ecat-files:nil
 267 End:
 268 -->