Statistics
| Branch: | Tag: | Revision:

root / docs / install.sgml @ ac232de3

History | View | Annotate | Download (28.5 kB)

1
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
2
]>
3
  <article class="specification">
4
  <articleinfo>
5
    <title>Ganeti installation tutorial</title>
6
  </articleinfo>
7
  <para>Documents Ganeti version 1.2</para>
8

    
9
  <sect1>
10
    <title>Introduction</title>
11

    
12
    <para>
13
      Ganeti is a cluster virtualization management system based on
14
      Xen. This document explains how to bootstrap a Ganeti node (Xen
15
      <literal>dom0</literal>), create a running cluster and install
16
      virtual instance (Xen <literal>domU</literal>).  You need to
17
      repeat most of the steps in this document for every node you
18
      want to install, but of course we recommend creating some
19
      semi-automatic procedure if you plan to deploy Ganeti on a
20
      medium/large scale.
21
    </para>
22

    
23
    <para>
24
      A basic Ganeti terminology glossary is provided in the
25
      introductory section of the <emphasis>Ganeti administrator's
26
      guide</emphasis>. Please refer to that document if you are
27
      uncertain about the terms we are using.
28
    </para>
29

    
30
    <para>
31
      Ganeti has been developed for Linux and is
32
      distribution-agnostic.  This documentation will use Debian Etch
33
      as an example system but the examples can easily be translated
34
      to any other distribution.  You are expected to be familiar with
35
      your distribution, its package management system, and Xen before
36
      trying to use Ganeti.
37
    </para>
38

    
39
    <para>This document is divided into two main sections:
40

    
41
      <itemizedlist>
42
        <listitem>
43
          <simpara>Installation of the base system and base
44
          components</simpara>
45
        </listitem>
46
        <listitem>
47
          <simpara>Configuration of the environment for
48
          Ganeti</simpara>
49
        </listitem>
50
      </itemizedlist>
51

    
52
    Each of these is divided into sub-sections. While a full Ganeti
53
    system will need all of the steps specified, some are not strictly
54
    required for every environment. Which ones they are, and why, is
55
    specified in the corresponding sections.
56
    </para>
57

    
58
  </sect1>
59

    
60
  <sect1>
61
    <title>Installing the base system and base components</title>
62

    
63
    <sect2>
64
      <title>Hardware requirements</title>
65

    
66
      <para>
67
         Any system supported by your Linux distribution is fine.
68
         64-bit systems are better as they can support more memory.
69
      </para>
70

    
71
      <para>
72
         Any disk drive recognized by Linux
73
         (<literal>IDE</literal>/<literal>SCSI</literal>/<literal>SATA</literal>/etc.)
74
         is supported in Ganeti. Note that no shared storage
75
         (e.g. <literal>SAN</literal>) is needed to get high-availability features. It is
76
         highly recommended to use more than one disk drive to improve
77
         speed. But Ganeti also works with one disk per machine.
78
      </para>
79

    
80
    <sect2>
81
      <title>Installing the base system</title>
82

    
83
      <para>
84
        <emphasis role="strong">Mandatory</emphasis> on all nodes.
85
      </para>
86

    
87
      <para>
88
        It is advised to start with a clean, minimal install of the
89
        operating system. The only requirement you need to be aware of
90
        at this stage is to partition leaving enough space for a big
91
        (<emphasis role="strong">minimum
92
        <constant>20GiB</constant></emphasis>) LVM volume group which
93
        will then host your instance filesystems. The volume group
94
        name Ganeti 1.2 uses (by default) is
95
        <emphasis>xenvg</emphasis>.
96
      </para>
97

    
98
      <para>
99
        While you can use an existing system, please note that the
100
        Ganeti installation is intrusive in terms of changes to the
101
        system configuration, and it's best to use a newly-installed
102
        system without important data on it.
103
      </para>
104

    
105
      <para>
106
        Also, for best results, it's advised that the nodes have as
107
        much as possible the same hardware and software
108
        configuration. This will make administration much easier.
109
      </para>
110

    
111
      <sect3>
112
        <title>Hostname issues</title>
113
        <para>
114
          Note that Ganeti requires the hostnames of the systems
115
          (i.e. what the <computeroutput>hostname</computeroutput>
116
          command outputs to be a fully-qualified name, not a short
117
          name. In other words, you should use
118
          <literal>node1.example.com</literal> as a hostname and not
119
          just <literal>node1</literal>.
120
        </para>
121

    
122
        <formalpara>
123
          <title>Debian</title>
124
          <para>
125
            Note that Debian Etch configures the hostname differently
126
            than you need it for Ganeti. For example, this is what
127
            Etch puts in <filename>/etc/hosts</filename> in certain
128
            situations:
129
<screen>
130
127.0.0.1       localhost
131
127.0.1.1       node1.example.com node1
132
</screen>
133

    
134
          but for Ganeti you need to have:
135
<screen>
136
127.0.0.1       localhost
137
192.168.1.1     node1.example.com node1
138
</screen>
139
            replacing <literal>192.168.1.1</literal> with your node's
140
            address. Also, the file <filename>/etc/hostname</filename>
141
            which configures the hostname of the system should contain
142
            <literal>node1.example.com</literal> and not just
143
            <literal>node1</literal> (you need to run the command
144
            <computeroutput>/etc/init.d/hostname.sh
145
            start</computeroutput> after changing the file).
146
          </para>
147
        </formalpara>
148
      </sect3>
149

    
150
    </sect2>
151

    
152
    <sect2>
153
      <title>Installing Xen</title>
154

    
155
      <para>
156
        <emphasis role="strong">Mandatory</emphasis> on all nodes.
157
      </para>
158

    
159
      <para>
160
        While Ganeti is developed with the ability to modularly run on
161
        different virtualization environments in mind the only one
162
        currently useable on a live system is <ulink
163
        url="http://xen.xensource.com/">Xen</ulink>. Supported
164
        versions are: <simplelist type="inline">
165
        <member><literal>3.0.3</literal></member>
166
        <member><literal>3.0.4</literal></member>
167
        <member><literal>3.1</literal></member> </simplelist>.
168
      </para>
169

    
170
      <para>
171
        Please follow your distribution's recommended way to install
172
        and set up Xen, or install Xen from the upstream source, if
173
        you wish, following their manual.
174
      </para>
175

    
176
      <para>
177
        After installing Xen you need to reboot into your xenified
178
        dom0 system. On some distributions this might involve
179
        configuring GRUB appropriately, whereas others will configure
180
        it automatically when you install Xen from a package.
181
      </para>
182

    
183
      <formalpara><title>Debian</title>
184
      <para>
185
        Under Debian Etch or Sarge+backports you can install the
186
        relevant <literal>xen-linux-system</literal> package, which
187
        will pull in both the hypervisor and the relevant
188
        kernel. Also, if you are installing a 32-bit Etch, you should
189
        install the <computeroutput>libc6-xen</computeroutput> package
190
        (run <computeroutput>apt-get install
191
        libc6-xen</computeroutput>).
192
      </para>
193
      </formalpara>
194

    
195
      <sect3>
196
        <title>Xen settings</title>
197

    
198
        <para>
199
          It's recommended that dom0 is restricted to a low amount of
200
          memory (<constant>512MiB</constant> is reasonable) and that
201
          memory ballooning is disabled in the file
202
          <filename>/etc/xen/xend-config.sxp</filename> by setting the
203
          value <literal>dom0-min-mem</literal> to
204
          <constant>0</constant>, like this:
205
          <computeroutput>(dom0-min-mem 0)</computeroutput>
206
        </para>
207

    
208
        <para>
209
          For optimum performance when running both CPU and I/O
210
          intensive instances, it's also recommended that the dom0 is
211
          restricted to one CPU only, for example by booting with the
212
          kernel parameter <literal>nosmp</literal>.
213
        </para>
214

    
215
        <formalpara>
216
          <title>Debian</title>
217
          <para>
218
            Besides the ballooning change which you need to set in
219
            <filename>/etc/xen/xend-config.sxp</filename>, you need to
220
            set the memory and nosmp parameters in the file
221
            <filename>/boot/grub/menu.lst</filename>. You need to
222
            modify the variable <literal>xenhopt</literal> to add
223
            <userinput>dom0_mem=512M</userinput> like this:
224
<screen>
225
## Xen hypervisor options to use with the default Xen boot option
226
# xenhopt=dom0_mem=512M
227
</screen>
228
            and the <literal>xenkopt</literal> needs to include the
229
            <userinput>nosmp</userinput> option like this:
230
<screen>
231
## Xen Linux kernel options to use with the default Xen boot option
232
# xenkopt=nosmp
233
</screen>
234

    
235
          Any existing parameters can be left in place: it's ok to
236
          have <computeroutput>xenkopt=console=tty0
237
          nosmp</computeroutput>, for example. After modifying the
238
          files, you need to run:
239
<screen>
240
/sbin/update-grub
241
</screen>
242
          </para>
243
        </formalpara>
244

    
245
      </sect3>
246

    
247
      <sect3>
248
        <title>Selecting the instance kernel</title>
249

    
250
        <para>
251
          After you have installed xen, you need to tell Ganeti
252
          exactly what kernel to use for the instances it will
253
          create. This is done by creating a
254
          <emphasis>symlink</emphasis> from your actual kernel to
255
          <filename>/boot/vmlinuz-2.6-xenU</filename>, and one from
256
          your initrd to
257
          <filename>/boot/initrd-2.6-xenU</filename>. Note that if you
258
          don't use an initrd for the <literal>domU</literal> kernel,
259
          you don't need to create the initrd symlink.
260
        </para>
261

    
262
        <formalpara>
263
          <title>Debian</title>
264
          <para>
265
            After installation of the
266
            <literal>xen-linux-system</literal> package, you need to
267
            run (replace the exact version number with the one you
268
            have):
269
            <screen>
270
cd /boot
271
ln -s vmlinuz-2.6.18-5-xen-686 vmlinuz-2.6-xenU
272
ln -s initrd.img-2.6.18-5-xen-686 initrd-2.6-xenU
273
            </screen>
274
          </para>
275
        </formalpara>
276
      </sect3>
277

    
278
    </sect2>
279

    
280
    <sect2>
281
      <title>Installing DRBD</title>
282

    
283
      <para>
284
        Recommended on all nodes: <ulink
285
        url="http://www.drbd.org/">DRBD</ulink> is required if you
286
        want to use the high availability (HA) features of Ganeti, but
287
        optional if you don't require HA or only run Ganeti on
288
        single-node clusters. You can upgrade a non-HA cluster to an
289
        HA one later, but you might need to export and re-import all
290
        your instances to take advantage of the new features.
291
      </para>
292

    
293
      <para>
294
        Supported DRBD version: the <literal>0.7</literal>
295
        series. It's recommended to have at least version
296
        <literal>0.7.24</literal> if you use <command>udev</command>
297
        since older versions have a bug related to device discovery
298
        which can be triggered in cases of hard drive failure.
299
      </para>
300

    
301
      <para>
302
        Now the bad news: unless your distribution already provides it
303
        installing DRBD might involve recompiling your kernel or
304
        anyway fiddling with it. Hopefully at least the xenified
305
        kernel source to start from will be provided.
306
      </para>
307

    
308
      <para>
309
        The good news is that you don't need to configure DRBD at all.
310
        Ganeti will do it for you for every instance you set up.  If
311
        you have the DRBD utils installed and the module in your
312
        kernel you're fine. Please check that your system is
313
        configured to load the module at every boot, and that it
314
        passes the following option to the module:
315
        <computeroutput>minor_count=64</computeroutput> (this will
316
        allow you to use up to 32 instances per node).
317
      </para>
318

    
319
      <formalpara><title>Debian</title>
320
        <para>
321
         You can just install (build) the DRBD 0.7 module with the
322
         following commands (make sure you are running the Xen
323
         kernel):
324
        </para>
325
      </formalpara>
326

    
327
      <screen>
328
apt-get install drbd0.7-module-source drbd0.7-utils
329
m-a update
330
m-a a-i drbd0.7
331
echo drbd minor_count=64 >> /etc/modules
332
modprobe drbd minor_count=64
333
      </screen>
334

    
335
    </sect2>
336

    
337
    <sect2>
338
      <title>Other required software</title>
339

    
340
      <para>Besides Xen and DRBD, you will need to install the
341
      following (on all nodes):</para>
342

    
343
      <itemizedlist>
344
        <listitem>
345
          <simpara><ulink url="http://sourceware.org/lvm2/">LVM
346
          version 2</ulink></simpara>
347
        </listitem>
348
        <listitem>
349
          <simpara><ulink
350
          url="http://www.openssl.org/">OpenSSL</ulink></simpara>
351
        </listitem>
352
        <listitem>
353
          <simpara><ulink
354
          url="http://www.openssh.com/portable.html">OpenSSH</ulink></simpara>
355
        </listitem>
356
        <listitem>
357
          <simpara><ulink url="http://bridge.sourceforge.net/">Bridge
358
          utilities</ulink></simpara>
359
        </listitem>
360
        <listitem>
361
          <simpara><ulink
362
          url="http://fping.sourceforge.net/">fping</ulink></simpara>
363
        </listitem>
364
        <listitem>
365
          <simpara><ulink
366
          url="http://developer.osdl.org/dev/iproute2">iproute2</ulink></simpara>
367
        </listitem>
368
        <listitem>
369
          <simpara><ulink
370
          url="ftp://ftp.inr.ac.ru/ip-routing/iputils-current.tar.gz">arping</ulink>
371
          (part of iputils package)</simpara>
372
        </listitem>
373
        <listitem>
374
          <simpara><ulink
375
          url="http://www.kernel.org/pub/linux/utils/raid/mdadm/">mdadm</ulink>
376
          (Linux Software Raid tools)</simpara>
377
        </listitem>
378
        <listitem>
379
          <simpara><ulink url="http://www.python.org">Python 2.4</ulink></simpara>
380
        </listitem>
381
        <listitem>
382
          <simpara><ulink url="http://twistedmatrix.com/">Python
383
          Twisted library</ulink> - the core library is
384
          enough</simpara>
385
        </listitem>
386
        <listitem>
387
          <simpara><ulink
388
          url="http://pyopenssl.sourceforge.net/">Python OpenSSL
389
          bindings</ulink></simpara>
390
        </listitem>
391
      </itemizedlist>
392

    
393
      <para>
394
        These programs are supplied as part of most Linux
395
        distributions, so usually they can be installed via apt or
396
        similar methods. Also many of them will already be installed
397
        on a standard machine.
398
      </para>
399

    
400

    
401
      <formalpara><title>Debian</title>
402

    
403
      <para>You can use this command line to install all of them:</para>
404

    
405
      </formalpara>
406
      <screen>
407
# apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
408
  fping python2.4 python-twisted-core python-pyopenssl openssl \
409
  mdadm
410
      </screen>
411

    
412
    </sect2>
413

    
414
  </sect1>
415

    
416

    
417
  <sect1>
418
    <title>Setting up the environment for Ganeti</title>
419

    
420
    <sect2>
421
      <title>Configuring the network</title>
422

    
423
      <para><emphasis role="strong">Mandatory</emphasis> on all nodes.</para>
424

    
425
      <para>
426
        Ganeti relies on Xen running in "bridge mode", which means the
427
        instances network interfaces will be attached to a software bridge
428
        running in dom0. Xen by default creates such a bridge at startup, but
429
        your distribution might have a different way to do things.
430
      </para>
431

    
432
      <para>
433
        Beware that the default name Ganeti uses is
434
        <hardware>xen-br0</hardware> (which was used in Xen 2.0)
435
        while Xen 3.0 uses <hardware>xenbr0</hardware> by
436
        default. The default bridge your Ganeti cluster will use for new
437
        instances can be specified at cluster initialization time.
438
      </para>
439

    
440
      <formalpara><title>Debian</title>
441
        <para>
442
          The recommended Debian way to configure the xen bridge is to
443
          edit your <filename>/etc/network/interfaces</filename> file
444
          and substitute your normal Ethernet stanza with the
445
          following snippet:
446

    
447
        <screen>
448
auto xen-br0
449
iface xen-br0 inet static
450
        address <replaceable>YOUR_IP_ADDRESS</replaceable>
451
        netmask <replaceable>YOUR_NETMASK</replaceable>
452
        network <replaceable>YOUR_NETWORK</replaceable>
453
        broadcast <replaceable>YOUR_BROADCAST_ADDRESS</replaceable>
454
        gateway <replaceable>YOUR_GATEWAY</replaceable>
455
        bridge_ports eth0
456
        bridge_stp off
457
        bridge_fd 0
458
        </screen>
459
        </para>
460
      </formalpara>
461

    
462
     <para>
463
The following commands need to be executed on the local console
464
     </para>
465
      <screen>
466
ifdown eth0
467
ifup xen-br0
468
      </screen>
469

    
470
      <para>
471
        To check if the bridge is setup, use <command>ip</command>
472
        and <command>brctl show</command>:
473
      <para>
474

    
475
      <screen>
476
# ip a show xen-br0
477
9: xen-br0: &lt;BROADCAST,MULTICAST,UP,10000&gt; mtu 1500 qdisc noqueue
478
    link/ether 00:20:fc:1e:d5:5d brd ff:ff:ff:ff:ff:ff
479
    inet 10.1.1.200/24 brd 10.1.1.255 scope global xen-br0
480
    inet6 fe80::220:fcff:fe1e:d55d/64 scope link
481
       valid_lft forever preferred_lft forever
482

    
483
# brctl show xen-br0
484
bridge name     bridge id               STP enabled     interfaces
485
xen-br0         8000.0020fc1ed55d       no              eth0
486
      </screen>
487

    
488

    
489
    </sect2>
490

    
491
    <sect2>
492
      <title>Configuring LVM</title>
493

    
494

    
495
      <para><emphasis role="strong">Mandatory</emphasis> on all nodes.</para>
496

    
497
      <note>
498
        <simpara>The volume group is required to be at least
499
        <constant>20GiB</constant>.</simpara>
500
      </note>
501
      <para>
502
        If you haven't configured your LVM volume group at install
503
        time you need to do it before trying to initialize the Ganeti
504
        cluster. This is done by formatting the devices/partitions you
505
        want to use for it and then adding them to the relevant volume
506
        group:
507

    
508
       <screen>
509
pvcreate /dev/sda3
510
vgcreate xenvg /dev/sda3
511
       </screen>
512
or
513
       <screen>
514
pvcreate /dev/sdb1
515
pvcreate /dev/sdc1
516
vgcreate xenvg /dev/sdb1 /dev/sdc1
517
       </screen>
518
      </para>
519

    
520
      <para>
521
	If you want to add a device later you can do so with the
522
	<citerefentry><refentrytitle>vgextend</refentrytitle>
523
	<manvolnum>8</manvolnum></citerefentry> command:
524
      </para>
525

    
526
      <screen>
527
pvcreate /dev/sdd1
528
vgextend xenvg /dev/sdd1
529
      </screen>
530

    
531
      <formalpara>
532
        <title>Optional</title>
533
        <para>
534
          It is recommended to configure LVM not to scan the DRBD
535
          devices for physical volumes. This can be accomplished by
536
          editing <filename>/etc/lvm/lvm.conf</filename> and adding
537
          the <literal>/dev/drbd[0-9]+</literal> regular expression to
538
          the <literal>filter</literal> variable, like this:
539
<screen>
540
    filter = [ "r|/dev/cdrom|", "r|/dev/drbd[0-9]+|" ]
541
</screen>
542
        </para>
543
      </formalpara>
544

    
545
    </sect2>
546

    
547
    <sect2>
548
      <title>Installing Ganeti</title>
549

    
550
      <para><emphasis role="strong">Mandatory</emphasis> on all nodes.</para>
551

    
552
      <para>
553
        It's now time to install the Ganeti software itself.  Download
554
        the source from <ulink
555
        url="http://code.google.com/p/ganeti/"></ulink>.
556
      </para>
557

    
558
        <screen>
559
tar xvzf ganeti-1.2b1.tar.gz
560
cd ganeti-1.2b1
561
./configure --localstatedir=/var
562
make
563
make install
564
mkdir /srv/ganeti/ /srv/ganeti/os /srv/ganeti/export
565
        </screen>
566

    
567
      <para>
568
        You also need to copy the file
569
        <filename>docs/examples/ganeti.initd</filename>
570
        from the source archive to
571
        <filename>/etc/init.d/ganeti</filename> and register it with
572
        your distribution's startup scripts, for example in Debian:
573
      </para>
574
      <screen>update-rc.d ganeti defaults 20 80</screen>
575

    
576
      <para>
577
        In order to automatically restart failed instances, you need
578
        to setup a cron job run the
579
        <computeroutput>ganeti-watcher</computeroutput> program. A
580
        sample cron file is provided in the source at
581
        <filename>docs/examples/ganeti.cron</filename> and you can
582
        copy that (eventually altering the path) to
583
        <filename>/etc/cron.d/ganeti</filename>
584
      </para>
585

    
586
    </sect2>
587

    
588
    <sect2>
589
      <title>Installing the Operating System support packages</title>
590

    
591
      <para><emphasis role="strong">Mandatory</emphasis> on all nodes.</para>
592

    
593
      <para>
594
        To be able to install instances you need to have an Operating
595
        System installation script. An example for Debian Etch is
596
        provided on the project web site.  Download it from <ulink
597
        url="http://code.google.com/p/ganeti/"></ulink> and follow the
598
        instructions in the <filename>README</filename> file.  Here is
599
        the installation procedure:
600
      </para>
601

    
602
      <screen>
603
cd /srv/ganeti/os
604
tar xvf instance-debian-etch-0.1.tar
605
mv instance-debian-etch-0.1 debian-etch
606
      </screen>
607

    
608
      <para>
609
        In order to use this OS definition, you need to have internet
610
        access from your nodes and have <citerefentry>
611
        <refentrytitle>debootstrap</refentrytitle>
612
        <manvolnum>8</manvolnum> </citerefentry> installed on all the
613
        nodes.
614
      </para>
615
      <formalpara>
616
        <title>Debian</title>
617
        <para>
618
          Use this command on all nodes to install
619
          <computeroutput>debootstrap</computeroutput>:
620

    
621
          <screen>apt-get install debootstrap</screen>
622
        </para>
623
      </formalpara>
624

    
625
      <para>
626
        Alternatively, you can create your own OS definitions. See the
627
        manpage
628
        <citerefentry>
629
        <refentrytitle>ganeti-os-interface</refentrytitle>
630
        <manvolnum>8</manvolnum>
631
        </citerefentry>.
632
      </para>
633

    
634
    </sect2>
635

    
636
    <sect2>
637
      <title>Initializing the cluster</title>
638

    
639
      <para><emphasis role="strong">Mandatory:</emphasis> only on one
640
      node per cluster.</para>
641

    
642

    
643
      <para>The last step is to initialize the cluster. After you've repeated
644
        the above process on all of your nodes, choose one as the master, and execute:
645
      </para>
646

    
647
      <screen>
648
gnt-cluster init <replaceable>CLUSTERNAME</replaceable>
649
      </screen>
650

    
651
      <para>
652
        The <replaceable>CLUSTERNAME</replaceable> is a hostname,
653
        which must be resolvable (e.g. it must exist in DNS or in
654
        <filename>/etc/hosts</filename>) by all the nodes in the
655
        cluster. You must choose a name different from any of the
656
        nodes names for a multi-node cluster. In general the best
657
        choice is to have a unique name for a cluster, even if it
658
        consists of only one machine, as you will be able to expand it
659
        later without any problems.
660
      </para>
661

    
662
      <para>
663
        If the bridge name you are using is not
664
        <literal>xen-br0</literal>, use the <option>-b
665
        <replaceable>BRIDGENAME</replaceable></option> option to
666
        specify the bridge name. In this case, you should also use the
667
        <option>--master-netdev
668
        <replaceable>BRIDGENAME</replaceable></option> option with the
669
        same <replaceable>BRIDGENAME</replaceable> argument.
670
      </para>
671

    
672
      <para>
673
        You can use a different name than <literal>xenvg</literal> for
674
        the volume group (but note that the name must be identical on
675
        all nodes). In this case you need to specify it by passing the
676
        <option>-g <replaceable>VGNAME</replaceable></option> option
677
        to <computeroutput>gnt-cluster init</computeroutput>.
678
      </para>
679

    
680
      <para>
681
        You can also invoke the command with the
682
        <option>--help</option> option in order to see all the
683
        possibilities.
684
      </para>
685

    
686
    </sect2>
687

    
688
    <sect2>
689
      <title>Joining the nodes to the cluster</title>
690

    
691
      <para>
692
        <emphasis role="strong">Mandatory:</emphasis> for all the
693
        other nodes.
694
      </para>
695

    
696
      <para>
697
        After you have initialized your cluster you need to join the
698
        other nodes to it. You can do so by executing the following
699
        command on the master node:
700
      </para>
701
        <screen>
702
gnt-node add <replaceable>NODENAME</replaceable>
703
        </screen>
704
    </sect2>
705

    
706
    <sect2>
707
      <title>Separate replication network</title>
708

    
709
      <para><emphasis role="strong">Optional</emphasis></para>
710
      <para>
711
        Ganeti uses DRBD to mirror the disk of the virtual instances
712
        between nodes. To use a dedicated network interface for this
713
        (in order to improve performance or to enhance security) you
714
        need to configure an additional interface for each node.  Use
715
        the <option>-s</option> option with
716
        <computeroutput>gnt-cluster init</computeroutput> and
717
        <computeroutput>gnt-node add</computeroutput> to specify the
718
        IP address of this secondary interface to use for each
719
        node. Note that if you specified this option at cluster setup
720
        time, you must afterwards use it for every node add operation.
721
      </para>
722
    </sect2>
723

    
724
    <sect2>
725
      <title>Testing the setup</title>
726

    
727
      <para>
728

    
729
        Execute the <computeroutput>gnt-node list</computeroutput>
730
        command to see all nodes in the cluster:
731
      <screen>
732
# gnt-node list
733
Node              DTotal  DFree MTotal MNode MFree Pinst Sinst
734
node1.example.com 197404 197404   2047  1896   125     0     0
735
      </screen>
736
    </para>
737
  </sect2>
738

    
739
  <sect1>
740
    <title>Setting up and managing virtual instances</title>
741
    <sect2>
742
      <title>Setting up virtual instances</title>
743
      <para>
744
        This step shows how to setup a virtual instance with either
745
        non-mirrored disks (<computeroutput>plain</computeroutput>) or
746
        with network mirrored disks
747
        (<computeroutput>remote_raid1</computeroutput>).  All commands
748
        need to be executed on the Ganeti master node (the one on
749
        which <computeroutput>gnt-cluster init</computeroutput> was
750
        run).  Verify that the OS scripts are present on all cluster
751
        nodes with <computeroutput>gnt-os list</computeroutput>.
752
      </para>
753
      <para>
754
        To create a virtual instance, you need a hostname which is
755
        resolvable (DNS or <filename>/etc/hosts</filename> on all
756
        nodes). The following command will create a non-mirrored
757
        instance for you:
758
      </para>
759
      <screen>
760
gnt-instance add --node=node1 -o debian-etch -t plain inst1.example.com
761
* creating instance disks...
762
adding instance inst1.example.com to cluster config
763
Waiting for instance inst1.example.com to sync disks.
764
Instance inst1.example.com's disks are in sync.
765
creating os for instance inst1.example.com on node node1.example.com
766
* running the instance OS create scripts...
767
      </screen>
768

    
769
      <para>
770
        The above instance will have no network interface enabled.
771
        You can access it over the virtual console with
772
        <computeroutput>gnt-instance console
773
        <literal>inst1</literal></computeroutput>. There is no
774
        password for root.  As this is a Debian instance, you can
775
        modify the <filename>/etc/network/interfaces</filename> file
776
        to setup the network interface (<literal>eth0</literal> is the
777
        name of the interface provided to the instance).
778
      </para>
779

    
780
      <para>
781
        To create a network mirrored instance, change the argument to
782
        the <option>-t</option> option from <literal>plain</literal>
783
        to <literal>remote_raid1</literal> and specify the node on
784
        which the mirror should reside with the
785
        <option>--secondary-node</option> option, like this:
786
      </para>
787

    
788
      <screen>
789
# gnt-instance add -t remote_raid1 --secondary-node node1 \
790
  -n node2 -o debian-etch instance2
791
* creating instance disks...
792
adding instance instance2 to cluster config
793
Waiting for instance instance1 to sync disks.
794
- device sdb:  3.50% done, 304 estimated seconds remaining
795
- device sdb: 21.70% done, 270 estimated seconds remaining
796
- device sdb: 39.80% done, 247 estimated seconds remaining
797
- device sdb: 58.10% done, 121 estimated seconds remaining
798
- device sdb: 76.30% done, 72 estimated seconds remaining
799
- device sdb: 94.80% done, 18 estimated seconds remaining
800
Instance instance2's disks are in sync.
801
creating os for instance instance2 on node node2.example.com
802
* running the instance OS create scripts...
803
* starting instance...
804
      </screen>
805

    
806
    </sect2>
807

    
808
    <sect2>
809
      <title>Managing virtual instances</title>
810
      <para>
811
        All commands need to be executed on the Ganeti master node
812
      </para>
813

    
814
      <para>
815
        To access the console of an instance, use
816
        <computeroutput>gnt-instance console
817
        <replaceable>INSTANCENAME</replaceable></computeroutput>.
818
      </para>
819

    
820
      <para>
821
        To shutdown an instance, use <computeroutput>gnt-instance
822
        shutdown
823
        <replaceable>INSTANCENAME</replaceable></computeroutput>. To
824
        startup an instance, use <computeroutput>gnt-instance startup
825
        <replaceable>INSTANCENAME</replaceable></computeroutput>.
826
      </para>
827

    
828
      <para>
829
        To failover an instance to its secondary node (only possible
830
        in <literal>remote_raid1</literal> setup), use
831
        <computeroutput>gnt-instance failover
832
        <replaceable>INSTANCENAME</replaceable></computeroutput>.
833
      </para>
834

    
835
      <para>
836
        For more instance and cluster administration details, see the
837
        <emphasis>Ganeti administrator's guide</emphasis>.
838
      </para>
839

    
840
    </sect2>
841

    
842
  </sect1>
843

    
844
  </article>