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>-o <replaceable>os-type</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>-o</option> options specifies the operating
 135         system to be installed. The available operating systems can
 136         be listed with <command>gnt-os list</command>.
 137       </para>
 138
 139       <para>
 140         The <option>-m</option> option specifies the memory size for
 141         the instance, in mebibytes (defaults to 128 MiB).
 142       </para>
 143
 144       <para>
 145         The <option>-b</option> option specifies the bridge to which the
 146         instance will be connected. (defaults to the cluster-wide default
 147         bridge specified at cluster intialization time).
 148       </para>
 149
 150       <para>
 151         The <option>-t</option> options specifies the disk layout type for
 152         the instance. The available choices are:
 153         <variablelist>
 154           <varlistentry>
 155             <term>diskless</term>
 156             <listitem>
 157               <para>
 158                 This creates an instance with no disks. Its useful for
 159                 testing only (or other special cases).
 160               </para>
 161             </listitem>
 162           </varlistentry>
 163           <varlistentry>
 164             <term>plain</term>
 165             <listitem>
 166               <para>Disk devices will be logical volumes.</para>
 167             </listitem>
 168           </varlistentry>
 169           <varlistentry>
 170             <term>local_raid1</term>
 171             <listitem>
 172               <para>
 173                 Disk devices will be md raid1 arrays over two local
 174                 logical volumes.
 175               </para>
 176             </listitem>
 177           </varlistentry>
 178           <varlistentry>
 179             <term>remote_raid1</term>
 180             <listitem>
 181               <para>
 182                 Disk devices will be md raid1 arrays with one
 183                 component (so it's not actually raid1): a drbd (0.7.x)
 184                 device between the instance's primary node and the
 185                 node given by the second value of the
 186                 <option>--node</option> option.
 187               </para>
 188             </listitem>
 189           </varlistentry>
 190           <varlistentry>
 191             <term>drbd</term>
 192             <listitem>
 193               <para>
 194                 Disk devices will be drbd (version 8.x) on top of lvm
 195                 volumes. They are equivalent in functionality to
 196                 <replaceable>remote_raid1</replaceable>, but are
 197                 recommended for new instances (if you have drbd 8.x
 198                 installed).
 199               </para>
 200             </listitem>
 201           </varlistentry>
 202         </variablelist>
 203       </para>
 204
 205       <para>
 206         If you do not want gnt-backup to wait for the disk mirror
 207         to be synced, use the <option>--no-wait-for-sync</option>
 208         option.
 209       </para>
 210
 211       <para>
 212         Example:
 213         <screen>
 214 # gnt-backup import -t plain -s 30 -m 512 -n node1.example.com \
 215 > --src-node=node2.example.com \
 216 > --src-dir=/srv/ganeti/exports/instance3.example.com \
 217 > instance3.example.com
 218         </screen>
 219       </para>
 220
 221     </refsect2>
 222
 223     <refsect2>
 224       <title>LIST</title>
 225
 226       <cmdsynopsis>
 227         <command>list</command>
 228         <arg>--node=<replaceable>NODE</replaceable></arg>
 229       </cmdsynopsis>
 230
 231       <para>
 232         Lists the exports currently available in the default directory
 233         in all the nodes of the current cluster, or optionally only a
 234         subset of them specified using the <option>--node</option>
 235         option (which can be used multiple times)
 236       </para>
 237
 238       <para>
 239       Example:
 240 <screen>
 241 # gnt-backup list --nodes node1 --nodes node2
 242 </screen>
 243     </refsect2>
 244
 245   </refsect1>
 246
 247   &footer;
 248
 249 </refentry>
 250
 251 <!-- Keep this comment at the end of the file
 252 Local variables:
 253 mode: sgml
 254 sgml-omittag:t
 255 sgml-shorttag:t
 256 sgml-minimize-attributes:nil
 257 sgml-always-quote-attributes:t
 258 sgml-indent-step:2
 259 sgml-indent-data:t
 260 sgml-parent-document:nil
 261 sgml-default-dtd-file:nil
 262 sgml-exposed-tags:nil
 263 sgml-local-catalogs:nil
 264 sgml-local-ecat-files:nil
 265 End:
 266 -->