Statistics
| Branch: | Tag: | Revision:

root / doc / install.rst @ 36691f08

History | View | Annotate | Download (28.3 kB)

1
Ganeti installation tutorial
2
============================
3

    
4
Documents Ganeti version |version|
5

    
6
.. contents::
7

    
8
.. highlight:: shell-example
9

    
10
Introduction
11
------------
12

    
13
Ganeti is a cluster virtualization management system based on Xen or
14
KVM. This document explains how to bootstrap a Ganeti node (Xen *dom0*,
15
the host Linux system for KVM), create a running cluster and install
16
virtual instances (Xen *domUs*, KVM guests).  You need to repeat most of
17
the steps in this document for every node you want to install, but of
18
course we recommend creating some semi-automatic procedure if you plan
19
to deploy Ganeti on a medium/large scale.
20

    
21
A basic Ganeti terminology glossary is provided in the introductory
22
section of the :doc:`admin`. Please refer to that document if you are
23
uncertain about the terms we are using.
24

    
25
Ganeti has been developed for Linux and should be distribution-agnostic.
26
This documentation will use Debian Squeeze as an example system but the
27
examples can be translated to any other distribution. You are expected
28
to be familiar with your distribution, its package management system,
29
and Xen or KVM before trying to use Ganeti.
30

    
31
This document is divided into two main sections:
32

    
33
- Installation of the base system and base components
34

    
35
- Configuration of the environment for Ganeti
36

    
37
Each of these is divided into sub-sections. While a full Ganeti system
38
will need all of the steps specified, some are not strictly required for
39
every environment. Which ones they are, and why, is specified in the
40
corresponding sections.
41

    
42
Installing the base system and base components
43
----------------------------------------------
44

    
45
Hardware requirements
46
+++++++++++++++++++++
47

    
48
Any system supported by your Linux distribution is fine. 64-bit systems
49
are better as they can support more memory.
50

    
51
Any disk drive recognized by Linux (``IDE``/``SCSI``/``SATA``/etc.) is
52
supported in Ganeti. Note that no shared storage (e.g. ``SAN``) is
53
needed to get high-availability features (but of course, one can be used
54
to store the images). Whilte it is highly recommended to use more than
55
one disk drive in order to improve speed, Ganeti also works with one
56
disk per machine.
57

    
58
Installing the base system
59
++++++++++++++++++++++++++
60

    
61
**Mandatory** on all nodes.
62

    
63
It is advised to start with a clean, minimal install of the operating
64
system. The only requirement you need to be aware of at this stage is to
65
partition leaving enough space for a big (**minimum** 20GiB) LVM volume
66
group which will then host your instance filesystems, if you want to use
67
all Ganeti features. The volume group name Ganeti uses (by default) is
68
``xenvg``.
69

    
70
You can also use file-based storage only, without LVM, but this setup is
71
not detailed in this document.
72

    
73
If you choose to use RBD-based instances, there's no need for LVM
74
provisioning. However, this feature is experimental, and is not yet
75
recommended for production clusters.
76

    
77
While you can use an existing system, please note that the Ganeti
78
installation is intrusive in terms of changes to the system
79
configuration, and it's best to use a newly-installed system without
80
important data on it.
81

    
82
Also, for best results, it's advised that the nodes have as much as
83
possible the same hardware and software configuration. This will make
84
administration much easier.
85

    
86
Hostname issues
87
~~~~~~~~~~~~~~~
88

    
89
Note that Ganeti requires the hostnames of the systems (i.e. what the
90
``hostname`` command outputs to be a fully-qualified name, not a short
91
name. In other words, you should use *node1.example.com* as a hostname
92
and not just *node1*.
93

    
94
.. admonition:: Debian
95

    
96
   Debian usually configures the hostname differently than you need it
97
   for Ganeti. For example, this is what it puts in ``/etc/hosts`` in
98
   certain situations::
99

    
100
     127.0.0.1       localhost
101
     127.0.1.1       node1.example.com node1
102

    
103
   but for Ganeti you need to have::
104

    
105
     127.0.0.1       localhost
106
     192.0.2.1       node1.example.com node1
107

    
108
   replacing ``192.0.2.1`` with your node's address. Also, the file
109
   ``/etc/hostname`` which configures the hostname of the system
110
   should contain ``node1.example.com`` and not just ``node1`` (you
111
   need to run the command ``/etc/init.d/hostname.sh start`` after
112
   changing the file).
113

    
114
.. admonition:: Why a fully qualified host name
115

    
116
   Although most distributions use only the short name in the
117
   /etc/hostname file, we still think Ganeti nodes should use the full
118
   name. The reason for this is that calling 'hostname --fqdn' requires
119
   the resolver library to work and is a 'guess' via heuristics at what
120
   is your domain name. Since Ganeti can be used among other things to
121
   host DNS servers, we don't want to depend on them as much as
122
   possible, and we'd rather have the uname() syscall return the full
123
   node name.
124

    
125
   We haven't ever found any breakage in using a full hostname on a
126
   Linux system, and anyway we recommend to have only a minimal
127
   installation on Ganeti nodes, and to use instances (or other
128
   dedicated machines) to run the rest of your network services. By
129
   doing this you can change the /etc/hostname file to contain an FQDN
130
   without the fear of breaking anything unrelated.
131

    
132

    
133
Installing The Hypervisor
134
+++++++++++++++++++++++++
135

    
136
**Mandatory** on all nodes.
137

    
138
While Ganeti is developed with the ability to modularly run on different
139
virtualization environments in mind the only two currently useable on a
140
live system are Xen and KVM. Supported Xen versions are: 3.0.3 and later
141
3.x versions, and 4.x (tested up to 4.1).  Supported KVM versions are 72
142
and above.
143

    
144
Please follow your distribution's recommended way to install and set up
145
Xen, or install Xen from the upstream source, if you wish, following
146
their manual. For KVM, make sure you have a KVM-enabled kernel and the
147
KVM tools.
148

    
149
After installing Xen, you need to reboot into your new system. On some
150
distributions this might involve configuring GRUB appropriately, whereas
151
others will configure it automatically when you install the respective
152
kernels. For KVM no reboot should be necessary.
153

    
154
.. admonition:: Xen on Debian
155

    
156
   Under Debian you can install the relevant ``xen-linux-system``
157
   package, which will pull in both the hypervisor and the relevant
158
   kernel. Also, if you are installing a 32-bit system, you should
159
   install the ``libc6-xen`` package (run ``apt-get install
160
   libc6-xen``).
161

    
162
Xen settings
163
~~~~~~~~~~~~
164

    
165
It's recommended that dom0 is restricted to a low amount of memory
166
(512MiB or 1GiB is reasonable) and that memory ballooning is disabled in
167
the file ``/etc/xen/xend-config.sxp`` by setting the value
168
``dom0-min-mem`` to 0, like this::
169

    
170
  (dom0-min-mem 0)
171

    
172
For optimum performance when running both CPU and I/O intensive
173
instances, it's also recommended that the dom0 is restricted to one CPU
174
only, for example by booting with the kernel parameter ``maxcpus=1``.
175

    
176
It is recommended that you disable xen's automatic save of virtual
177
machines at system shutdown and subsequent restore of them at reboot.
178
To obtain this make sure the variable ``XENDOMAINS_SAVE`` in the file
179
``/etc/default/xendomains`` is set to an empty value.
180

    
181
If you want to use live migration make sure you have, in the xen config
182
file, something that allows the nodes to migrate instances between each
183
other. For example:
184

    
185
.. code-block:: text
186

    
187
  (xend-relocation-server yes)
188
  (xend-relocation-port 8002)
189
  (xend-relocation-address '')
190
  (xend-relocation-hosts-allow '^192\\.0\\.2\\.[0-9]+$')
191

    
192

    
193
The second line assumes that the hypervisor parameter
194
``migration_port`` is set 8002, otherwise modify it to match. The last
195
line assumes that all your nodes have secondary IPs in the
196
192.0.2.0/24 network, adjust it accordingly to your setup.
197

    
198
.. admonition:: Debian
199

    
200
   Besides the ballooning change which you need to set in
201
   ``/etc/xen/xend-config.sxp``, you need to set the memory and nosmp
202
   parameters in the file ``/boot/grub/menu.lst``. You need to modify
203
   the variable ``xenhopt`` to add ``dom0_mem=1024M`` like this:
204

    
205
   .. code-block:: text
206

    
207
     ## Xen hypervisor options to use with the default Xen boot option
208
     # xenhopt=dom0_mem=1024M
209

    
210
   and the ``xenkopt`` needs to include the ``maxcpus`` option like
211
   this:
212

    
213
   .. code-block:: text
214

    
215
     ## Xen Linux kernel options to use with the default Xen boot option
216
     # xenkopt=maxcpus=1
217

    
218
   Any existing parameters can be left in place: it's ok to have
219
   ``xenkopt=console=tty0 maxcpus=1``, for example. After modifying the
220
   files, you need to run::
221

    
222
     $ /sbin/update-grub
223

    
224
If you want to run HVM instances too with Ganeti and want VNC access to
225
the console of your instances, set the following two entries in
226
``/etc/xen/xend-config.sxp``:
227

    
228
.. code-block:: text
229

    
230
  (vnc-listen '0.0.0.0') (vncpasswd '')
231

    
232
You need to restart the Xen daemon for these settings to take effect::
233

    
234
  $ /etc/init.d/xend restart
235

    
236
Selecting the instance kernel
237
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
238

    
239
After you have installed Xen, you need to tell Ganeti exactly what
240
kernel to use for the instances it will create. This is done by creating
241
a symlink from your actual kernel to ``/boot/vmlinuz-3-xenU``, and one
242
from your initrd to ``/boot/initrd-3-xenU`` [#defkernel]_. Note that
243
if you don't use an initrd for the domU kernel, you don't need to create
244
the initrd symlink.
245

    
246
.. admonition:: Debian
247

    
248
   After installation of the ``xen-linux-system`` package, you need to
249
   run (replace the exact version number with the one you have)::
250

    
251
     $ cd /boot
252
     $ ln -s vmlinuz-%2.6.26-1%-xen-amd64 vmlinuz-3-xenU
253
     $ ln -s initrd.img-%2.6.26-1%-xen-amd64 initrd-3-xenU
254

    
255
   By default, the initrd doesn't contain the Xen block drivers needed
256
   to mount the root device, so it is recommended to update the initrd
257
   by following these two steps:
258

    
259
   - edit ``/etc/initramfs-tools/modules`` and add ``xen_blkfront``
260
   - run ``update-initramfs -u``
261

    
262
Installing DRBD
263
+++++++++++++++
264

    
265
Recommended on all nodes: DRBD_ is required if you want to use the high
266
availability (HA) features of Ganeti, but optional if you don't require
267
them or only run Ganeti on single-node clusters. You can upgrade a
268
non-HA cluster to an HA one later, but you might need to convert all
269
your instances to DRBD to take advantage of the new features.
270

    
271
.. _DRBD: http://www.drbd.org/
272

    
273
Supported DRBD versions: 8.0-8.3. It's recommended to have at least
274
version 8.0.12. Note that for version 8.2 and newer it is needed to pass
275
the ``usermode_helper=/bin/true`` parameter to the module, either by
276
configuring ``/etc/modules`` or when inserting it manually.
277

    
278
Now the bad news: unless your distribution already provides it
279
installing DRBD might involve recompiling your kernel or anyway fiddling
280
with it. Hopefully at least the Xen-ified kernel source to start from
281
will be provided (if you intend to use Xen).
282

    
283
The good news is that you don't need to configure DRBD at all. Ganeti
284
will do it for you for every instance you set up.  If you have the DRBD
285
utils installed and the module in your kernel you're fine. Please check
286
that your system is configured to load the module at every boot, and
287
that it passes the following option to the module:
288
``minor_count=NUMBER``. We recommend that you use 128 as the value of
289
the minor_count - this will allow you to use up to 64 instances in total
290
per node (both primary and secondary, when using only one disk per
291
instance). You can increase the number up to 255 if you need more
292
instances on a node.
293

    
294

    
295
.. admonition:: Debian
296

    
297
   On Debian, you can just install (build) the DRBD module with the
298
   following commands, making sure you are running the target (Xen or
299
   KVM) kernel::
300

    
301
     $ apt-get install drbd8-source drbd8-utils
302
     $ m-a update
303
     $ m-a a-i drbd8
304
     $ echo drbd minor_count=128 usermode_helper=/bin/true >> /etc/modules
305
     $ depmod -a
306
     $ modprobe drbd minor_count=128 usermode_helper=/bin/true
307

    
308
   It is also recommended that you comment out the default resources in
309
   the ``/etc/drbd.conf`` file, so that the init script doesn't try to
310
   configure any drbd devices. You can do this by prefixing all
311
   *resource* lines in the file with the keyword *skip*, like this:
312

    
313
   .. code-block:: text
314

    
315
     skip {
316
       resource r0 {
317
         ...
318
       }
319
     }
320

    
321
     skip {
322
       resource "r1" {
323
         ...
324
       }
325
     }
326

    
327
Installing RBD
328
++++++++++++++
329

    
330
Recommended on all nodes: RBD_ is required if you want to create
331
instances with RBD disks residing inside a RADOS cluster (make use of
332
the rbd disk template). RBD-based instances can failover or migrate to
333
any other node in the ganeti cluster, enabling you to exploit of all
334
Ganeti's high availabilily (HA) features.
335

    
336
.. attention::
337
   Be careful though: rbd is still experimental! For now it is
338
   recommended only for testing purposes.  No sensitive data should be
339
   stored there.
340

    
341
.. _RBD: http://ceph.newdream.net/
342

    
343
You will need the ``rbd`` and ``libceph`` kernel modules, the RBD/Ceph
344
userspace utils (ceph-common Debian package) and an appropriate
345
Ceph/RADOS configuration file on every VM-capable node.
346

    
347
You will also need a working RADOS Cluster accessible by the above
348
nodes.
349

    
350
RADOS Cluster
351
~~~~~~~~~~~~~
352

    
353
You will need a working RADOS Cluster accesible by all VM-capable nodes
354
to use the RBD template. For more information on setting up a RADOS
355
Cluster, refer to the `official docs <http://ceph.newdream.net/>`_.
356

    
357
If you want to use a pool for storing RBD disk images other than the
358
default (``rbd``), you should first create the pool in the RADOS
359
Cluster, and then set the corresponding rbd disk parameter named
360
``pool``.
361

    
362
Kernel Modules
363
~~~~~~~~~~~~~~
364

    
365
Unless your distribution already provides it, you might need to compile
366
the ``rbd`` and ``libceph`` modules from source. You will need Linux
367
Kernel 3.2 or above for the kernel modules. Alternatively you will have
368
to build them as external modules (from Linux Kernel source 3.2 or
369
above), if you want to run a less recent kernel, or your kernel doesn't
370
include them.
371

    
372
Userspace Utils
373
~~~~~~~~~~~~~~~
374

    
375
The RBD template has been tested with ``ceph-common`` v0.38 and
376
above. We recommend using the latest version of ``ceph-common``.
377

    
378
.. admonition:: Debian
379

    
380
   On Debian, you can just install the RBD/Ceph userspace utils with
381
   the following command::
382

    
383
      $ apt-get install ceph-common
384

    
385
Configuration file
386
~~~~~~~~~~~~~~~~~~
387

    
388
You should also provide an appropriate configuration file
389
(``ceph.conf``) in ``/etc/ceph``. For the rbd userspace utils, you'll
390
only need to specify the IP addresses of the RADOS Cluster monitors.
391

    
392
.. admonition:: ceph.conf
393

    
394
   Sample configuration file:
395

    
396
   .. code-block:: text
397

    
398
    [mon.a]
399
           host = example_monitor_host1
400
           mon addr = 1.2.3.4:6789
401
    [mon.b]
402
           host = example_monitor_host2
403
           mon addr = 1.2.3.5:6789
404
    [mon.c]
405
           host = example_monitor_host3
406
           mon addr = 1.2.3.6:6789
407

    
408
For more information, please see the `Ceph Docs
409
<http://ceph.newdream.net/docs/latest/>`_
410

    
411
Other required software
412
+++++++++++++++++++++++
413

    
414
See :doc:`install-quick`.
415

    
416
Setting up the environment for Ganeti
417
-------------------------------------
418

    
419
Configuring the network
420
+++++++++++++++++++++++
421

    
422
**Mandatory** on all nodes.
423

    
424
You can run Ganeti either in "bridged mode" or in "routed mode". In
425
bridged mode, the default, the instances network interfaces will be
426
attached to a software bridge running in dom0. Xen by default creates
427
such a bridge at startup, but your distribution might have a different
428
way to do things, and you'll definitely need to manually set it up under
429
KVM.
430

    
431
Beware that the default name Ganeti uses is ``xen-br0`` (which was used
432
in Xen 2.0) while Xen 3.0 uses ``xenbr0`` by default. See the
433
`Initializing the cluster`_ section to learn how to choose a different
434
bridge, or not to use one at all and use "routed mode".
435

    
436
In order to use "routed mode" under Xen, you'll need to change the
437
relevant parameters in the Xen config file. Under KVM instead, no config
438
change is necessary, but you still need to set up your network
439
interfaces correctly.
440

    
441
By default, under KVM, the "link" parameter you specify per-nic will
442
represent, if non-empty, a different routing table name or number to use
443
for your instances. This allows isolation between different instance
444
groups, and different routing policies between node traffic and instance
445
traffic.
446

    
447
You will need to configure your routing table basic routes and rules
448
outside of ganeti. The vif scripts will only add /32 routes to your
449
instances, through their interface, in the table you specified (under
450
KVM, and in the main table under Xen).
451

    
452
.. admonition:: Bridging issues with certain kernels
453

    
454
    Some kernel versions (e.g. 2.6.32) have an issue where the bridge
455
    will automatically change its ``MAC`` address to the lower-numbered
456
    slave on port addition and removal. This means that, depending on
457
    the ``MAC`` address of the actual NIC on the node and the addresses
458
    of the instances, it could be that starting, stopping or migrating
459
    instances will lead to timeouts due to the address of the bridge
460
    (and thus node itself) changing.
461

    
462
    To prevent this, it's enough to set the bridge manually to a
463
    specific ``MAC`` address, which will disable this automatic address
464
    change. In Debian, this can be done as follows in the bridge
465
    configuration snippet::
466

    
467
      up ip link set addr $(cat /sys/class/net/$IFACE/address) dev $IFACE
468

    
469
    which will "set" the bridge address to the initial one, disallowing
470
    changes.
471

    
472
.. admonition:: Bridging under Debian
473

    
474
   The recommended way to configure the Xen bridge is to edit your
475
   ``/etc/network/interfaces`` file and substitute your normal
476
   Ethernet stanza with the following snippet::
477

    
478
     auto xen-br0
479
     iface xen-br0 inet static
480
        address %YOUR_IP_ADDRESS%
481
        netmask %YOUR_NETMASK%
482
        network %YOUR_NETWORK%
483
        broadcast %YOUR_BROADCAST_ADDRESS%
484
        gateway %YOUR_GATEWAY%
485
        bridge_ports eth0
486
        bridge_stp off
487
        bridge_fd 0
488
        # example for setting manually the bridge address to the eth0 NIC
489
        up ip link set addr $(cat /sys/class/net/eth0/address) dev $IFACE
490

    
491
The following commands need to be executed on the local console::
492

    
493
  $ ifdown eth0
494
  $ ifup xen-br0
495

    
496
To check if the bridge is setup, use the ``ip`` and ``brctl show``
497
commands::
498

    
499
  $ ip a show xen-br0
500
  9: xen-br0: <BROADCAST,MULTICAST,UP,10000> mtu 1500 qdisc noqueue
501
      link/ether 00:20:fc:1e:d5:5d brd ff:ff:ff:ff:ff:ff
502
      inet 10.1.1.200/24 brd 10.1.1.255 scope global xen-br0
503
      inet6 fe80::220:fcff:fe1e:d55d/64 scope link
504
         valid_lft forever preferred_lft forever
505

    
506
  $ brctl show xen-br0
507
  bridge name     bridge id               STP enabled     interfaces
508
  xen-br0         8000.0020fc1ed55d       no              eth0
509

    
510
.. _configure-lvm-label:
511

    
512
Configuring LVM
513
+++++++++++++++
514

    
515
**Mandatory** on all nodes.
516

    
517
The volume group is required to be at least 20GiB.
518

    
519
If you haven't configured your LVM volume group at install time you need
520
to do it before trying to initialize the Ganeti cluster. This is done by
521
formatting the devices/partitions you want to use for it and then adding
522
them to the relevant volume group::
523

    
524
  $ pvcreate /dev/%sda3%
525
  $ vgcreate xenvg /dev/%sda3%
526

    
527
or::
528

    
529
  $ pvcreate /dev/%sdb1%
530
  $ pvcreate /dev/%sdc1%
531
  $ vgcreate xenvg /dev/%sdb1% /dev/%sdc1%
532

    
533
If you want to add a device later you can do so with the *vgextend*
534
command::
535

    
536
  $ pvcreate /dev/%sdd1%
537
  $ vgextend xenvg /dev/%sdd1%
538

    
539
Optional: it is recommended to configure LVM not to scan the DRBD
540
devices for physical volumes. This can be accomplished by editing
541
``/etc/lvm/lvm.conf`` and adding the ``/dev/drbd[0-9]+`` regular
542
expression to the ``filter`` variable, like this:
543

    
544
.. code-block:: text
545

    
546
  filter = ["r|/dev/cdrom|", "r|/dev/drbd[0-9]+|" ]
547

    
548
Note that with Ganeti a helper script is provided - ``lvmstrap`` which
549
will erase and configure as LVM any not in-use disk on your system. This
550
is dangerous and it's recommended to read its ``--help`` output if you
551
want to use it.
552

    
553
Installing Ganeti
554
+++++++++++++++++
555

    
556
**Mandatory** on all nodes.
557

    
558
It's now time to install the Ganeti software itself.  Download the
559
source from the project page at `<http://code.google.com/p/ganeti/>`_,
560
and install it (replace 2.6.0 with the latest version)::
561

    
562
  $ tar xvzf ganeti-%2.6.0%.tar.gz
563
  $ cd ganeti-%2.6.0%
564
  $ ./configure --localstatedir=/var --sysconfdir=/etc
565
  $ make
566
  $ make install
567
  $ mkdir /srv/ganeti/ /srv/ganeti/os /srv/ganeti/export
568

    
569
You also need to copy the file ``doc/examples/ganeti.initd`` from the
570
source archive to ``/etc/init.d/ganeti`` and register it with your
571
distribution's startup scripts, for example in Debian::
572

    
573
  $ update-rc.d ganeti defaults 20 80
574

    
575
In order to automatically restart failed instances, you need to setup a
576
cron job run the *ganeti-watcher* command. A sample cron file is
577
provided in the source at ``doc/examples/ganeti.cron`` and you can copy
578
that (eventually altering the path) to ``/etc/cron.d/ganeti``.
579

    
580
What gets installed
581
~~~~~~~~~~~~~~~~~~~
582

    
583
The above ``make install`` invocation, or installing via your
584
distribution mechanisms, will install on the system:
585

    
586
- a set of python libraries under the *ganeti* namespace (depending on
587
  the python version this can be located in either
588
  ``lib/python-$ver/site-packages`` or various other locations)
589
- a set of programs under ``/usr/local/sbin`` or ``/usr/sbin``
590
- if the htools component was enabled, a set of programs unde
591
  ``/usr/local/bin`` or ``/usr/bin/``
592
- man pages for the above programs
593
- a set of tools under the ``lib/ganeti/tools`` directory
594
- an example iallocator script (see the admin guide for details) under
595
  ``lib/ganeti/iallocators``
596
- a cron job that is needed for cluster maintenance
597
- an init script for automatic startup of Ganeti daemons
598
- provided but not installed automatically by ``make install`` is a bash
599
  completion script that hopefully will ease working with the many
600
  cluster commands
601

    
602
Installing the Operating System support packages
603
++++++++++++++++++++++++++++++++++++++++++++++++
604

    
605
**Mandatory** on all nodes.
606

    
607
To be able to install instances you need to have an Operating System
608
installation script. An example OS that works under Debian and can
609
install Debian and Ubuntu instace OSes is provided on the project web
610
site.  Download it from the project page and follow the instructions in
611
the ``README`` file.  Here is the installation procedure (replace 0.9
612
with the latest version that is compatible with your ganeti version)::
613

    
614
  $ cd /usr/local/src/
615
  $ wget http://ganeti.googlecode.com/files/ganeti-instance-debootstrap-%0.9%.tar.gz
616
  $ tar xzf ganeti-instance-debootstrap-%0.9%.tar.gz
617
  $ cd ganeti-instance-debootstrap-%0.9%
618
  $ ./configure
619
  $ make
620
  $ make install
621

    
622
In order to use this OS definition, you need to have internet access
623
from your nodes and have the *debootstrap*, *dump* and *restore*
624
commands installed on all nodes. Also, if the OS is configured to
625
partition the instance's disk in
626
``/etc/default/ganeti-instance-debootstrap``, you will need *kpartx*
627
installed.
628

    
629
.. admonition:: Debian
630

    
631
   Use this command on all nodes to install the required packages::
632

    
633
     $ apt-get install debootstrap dump kpartx
634

    
635
   Or alternatively install the OS definition from the Debian package::
636

    
637
     $ apt-get install ganeti-instance-debootstrap
638

    
639
.. admonition:: KVM
640

    
641
   In order for debootstrap instances to be able to shutdown cleanly
642
   they must install have basic ACPI support inside the instance. Which
643
   packages are needed depend on the exact flavor of Debian or Ubuntu
644
   which you're installing, but the example defaults file has a
645
   commented out configuration line that works for Debian Lenny and
646
   Squeeze::
647

    
648
     EXTRA_PKGS="acpi-support-base,console-tools,udev"
649

    
650
   ``kbd`` can be used instead of ``console-tools``, and more packages
651
   can be added, of course, if needed.
652

    
653
Alternatively, you can create your own OS definitions. See the manpage
654
:manpage:`ganeti-os-interface`.
655

    
656
Initializing the cluster
657
++++++++++++++++++++++++
658

    
659
**Mandatory** once per cluster, on the first node.
660

    
661
The last step is to initialize the cluster. After you have repeated the
662
above process on all of your nodes, choose one as the master, and
663
execute::
664

    
665
  $ gnt-cluster init %CLUSTERNAME%
666

    
667
The *CLUSTERNAME* is a hostname, which must be resolvable (e.g. it must
668
exist in DNS or in ``/etc/hosts``) by all the nodes in the cluster. You
669
must choose a name different from any of the nodes names for a
670
multi-node cluster. In general the best choice is to have a unique name
671
for a cluster, even if it consists of only one machine, as you will be
672
able to expand it later without any problems. Please note that the
673
hostname used for this must resolve to an IP address reserved
674
**exclusively** for this purpose, and cannot be the name of the first
675
(master) node.
676

    
677
If you want to use a bridge which is not ``xen-br0``, or no bridge at
678
all, change it with the ``--nic-parameters`` option. For example to
679
bridge on br0 you can add::
680

    
681
  --nic-parameters link=br0
682

    
683
Or to not bridge at all, and use a separate routing table::
684

    
685
  --nic-parameters mode=routed,link=100
686

    
687
If you don't have a ``xen-br0`` interface you also have to specify a
688
different network interface which will get the cluster IP, on the master
689
node, by using the ``--master-netdev <device>`` option.
690

    
691
You can use a different name than ``xenvg`` for the volume group (but
692
note that the name must be identical on all nodes). In this case you
693
need to specify it by passing the *--vg-name <VGNAME>* option to
694
``gnt-cluster init``.
695

    
696
To set up the cluster as an Xen HVM cluster, use the
697
``--enabled-hypervisors=xen-hvm`` option to enable the HVM hypervisor
698
(you can also add ``,xen-pvm`` to enable the PVM one too). You will also
699
need to create the VNC cluster password file
700
``/etc/ganeti/vnc-cluster-password`` which contains one line with the
701
default VNC password for the cluster.
702

    
703
To setup the cluster for KVM-only usage (KVM and Xen cannot be mixed),
704
pass ``--enabled-hypervisors=kvm`` to the init command.
705

    
706
You can also invoke the command with the ``--help`` option in order to
707
see all the possibilities.
708

    
709
Hypervisor/Network/Cluster parameters
710
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
711

    
712
Please note that the default hypervisor/network/cluster parameters may
713
not be the correct one for your environment. Carefully check them, and
714
change them either at cluster init time, or later with ``gnt-cluster
715
modify``.
716

    
717
Your instance types, networking environment, hypervisor type and version
718
may all affect what kind of parameters should be used on your cluster.
719

    
720
For example kvm instances are by default configured to use a host
721
kernel, and to be reached via serial console, which works nice for Linux
722
paravirtualized instances. If you want fully virtualized instances you
723
may want to handle their kernel inside the instance, and to use VNC.
724

    
725
Joining the nodes to the cluster
726
++++++++++++++++++++++++++++++++
727

    
728
**Mandatory** for all the other nodes.
729

    
730
After you have initialized your cluster you need to join the other nodes
731
to it. You can do so by executing the following command on the master
732
node::
733

    
734
  $ gnt-node add %NODENAME%
735

    
736
Separate replication network
737
++++++++++++++++++++++++++++
738

    
739
**Optional**
740

    
741
Ganeti uses DRBD to mirror the disk of the virtual instances between
742
nodes. To use a dedicated network interface for this (in order to
743
improve performance or to enhance security) you need to configure an
744
additional interface for each node.  Use the *-s* option with
745
``gnt-cluster init`` and ``gnt-node add`` to specify the IP address of
746
this secondary interface to use for each node. Note that if you
747
specified this option at cluster setup time, you must afterwards use it
748
for every node add operation.
749

    
750
Testing the setup
751
+++++++++++++++++
752

    
753
Execute the ``gnt-node list`` command to see all nodes in the cluster::
754

    
755
  $ gnt-node list
756
  Node              DTotal  DFree MTotal MNode MFree Pinst Sinst
757
  node1.example.com 197404 197404   2047  1896   125     0     0
758

    
759
The above shows a couple of things:
760

    
761
- The various Ganeti daemons can talk to each other
762
- Ganeti can examine the storage of the node (DTotal/DFree)
763
- Ganeti can talk to the selected hypervisor (MTotal/MNode/MFree)
764

    
765
Cluster burnin
766
~~~~~~~~~~~~~~
767

    
768
With Ganeti a tool called :command:`burnin` is provided that can test
769
most of the Ganeti functionality. The tool is installed under the
770
``lib/ganeti/tools`` directory (either under ``/usr`` or ``/usr/local``
771
based on the installation method). See more details under
772
:ref:`burnin-label`.
773

    
774
Further steps
775
-------------
776

    
777
You can now proceed either to the :doc:`admin`, or read the manpages of
778
the various commands (:manpage:`ganeti(7)`, :manpage:`gnt-cluster(8)`,
779
:manpage:`gnt-node(8)`, :manpage:`gnt-instance(8)`,
780
:manpage:`gnt-job(8)`).
781

    
782
.. rubric:: Footnotes
783

    
784
.. [#defkernel] The kernel and initrd paths can be changed at either
785
   cluster level (which changes the default for all instances) or at
786
   instance level.
787

    
788
.. vim: set textwidth=72 :
789
.. Local Variables:
790
.. mode: rst
791
.. fill-column: 72
792
.. End: