Statistics
| Branch: | Tag: | Revision:

root / doc / install.sgml @ 6c4811dc

History | View | Annotate | Download (30.2 kB)

1 f1a808df Guido Trotter
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
2 f1a808df Guido Trotter
]>
3 f1a808df Guido Trotter
  <article class="specification">
4 f1a808df Guido Trotter
  <articleinfo>
5 b212bf8b Iustin Pop
    <title>Ganeti installation tutorial</title>
6 f1a808df Guido Trotter
  </articleinfo>
7 f1a808df Guido Trotter
  <para>Documents Ganeti version 1.2</para>
8 f1a808df Guido Trotter
9 f1a808df Guido Trotter
  <sect1>
10 f1a808df Guido Trotter
    <title>Introduction</title>
11 f1a808df Guido Trotter
12 5d6dd340 Iustin Pop
    <para>
13 32ad0582 Iustin Pop
      Ganeti is a cluster virtualization management system based on
14 32ad0582 Iustin Pop
      Xen. This document explains how to bootstrap a Ganeti node (Xen
15 32ad0582 Iustin Pop
      <literal>dom0</literal>), create a running cluster and install
16 32ad0582 Iustin Pop
      virtual instance (Xen <literal>domU</literal>).  You need to
17 32ad0582 Iustin Pop
      repeat most of the steps in this document for every node you
18 32ad0582 Iustin Pop
      want to install, but of course we recommend creating some
19 32ad0582 Iustin Pop
      semi-automatic procedure if you plan to deploy Ganeti on a
20 32ad0582 Iustin Pop
      medium/large scale.
21 32ad0582 Iustin Pop
    </para>
22 32ad0582 Iustin Pop
23 32ad0582 Iustin Pop
    <para>
24 32ad0582 Iustin Pop
      A basic Ganeti terminology glossary is provided in the
25 32ad0582 Iustin Pop
      introductory section of the <emphasis>Ganeti administrator's
26 32ad0582 Iustin Pop
      guide</emphasis>. Please refer to that document if you are
27 32ad0582 Iustin Pop
      uncertain about the terms we are using.
28 32ad0582 Iustin Pop
    </para>
29 32ad0582 Iustin Pop
30 32ad0582 Iustin Pop
    <para>
31 32ad0582 Iustin Pop
      Ganeti has been developed for Linux and is
32 32ad0582 Iustin Pop
      distribution-agnostic.  This documentation will use Debian Etch
33 32ad0582 Iustin Pop
      as an example system but the examples can easily be translated
34 32ad0582 Iustin Pop
      to any other distribution.  You are expected to be familiar with
35 32ad0582 Iustin Pop
      your distribution, its package management system, and Xen before
36 32ad0582 Iustin Pop
      trying to use Ganeti.
37 f1a808df Guido Trotter
    </para>
38 f1a808df Guido Trotter
39 f1a808df Guido Trotter
    <para>This document is divided into two main sections:
40 f1a808df Guido Trotter
41 f1a808df Guido Trotter
      <itemizedlist>
42 f1a808df Guido Trotter
        <listitem>
43 32ad0582 Iustin Pop
          <simpara>Installation of the base system and base
44 e3c826ec Michael Hanselmann
            components</simpara>
45 f1a808df Guido Trotter
        </listitem>
46 f1a808df Guido Trotter
        <listitem>
47 5d6dd340 Iustin Pop
          <simpara>Configuration of the environment for
48 e3c826ec Michael Hanselmann
            Ganeti</simpara>
49 f1a808df Guido Trotter
        </listitem>
50 f1a808df Guido Trotter
      </itemizedlist>
51 f1a808df Guido Trotter
52 e3c826ec Michael Hanselmann
      Each of these is divided into sub-sections. While a full Ganeti system
53 e3c826ec Michael Hanselmann
      will need all of the steps specified, some are not strictly required for
54 e3c826ec Michael Hanselmann
      every environment. Which ones they are, and why, is specified in the
55 e3c826ec Michael Hanselmann
      corresponding sections.
56 f1a808df Guido Trotter
    </para>
57 f1a808df Guido Trotter
58 f1a808df Guido Trotter
  </sect1>
59 f1a808df Guido Trotter
60 f1a808df Guido Trotter
  <sect1>
61 32ad0582 Iustin Pop
    <title>Installing the base system and base components</title>
62 32ad0582 Iustin Pop
63 32ad0582 Iustin Pop
    <sect2>
64 32ad0582 Iustin Pop
      <title>Hardware requirements</title>
65 32ad0582 Iustin Pop
66 32ad0582 Iustin Pop
      <para>
67 e3c826ec Michael Hanselmann
        Any system supported by your Linux distribution is fine.  64-bit
68 e3c826ec Michael Hanselmann
        systems are better as they can support more memory.
69 32ad0582 Iustin Pop
      </para>
70 32ad0582 Iustin Pop
71 32ad0582 Iustin Pop
      <para>
72 e3c826ec Michael Hanselmann
        Any disk drive recognized by Linux
73 e3c826ec Michael Hanselmann
        (<literal>IDE</literal>/<literal>SCSI</literal>/<literal>SATA</literal>/etc.)
74 e3c826ec Michael Hanselmann
        is supported in Ganeti. Note that no shared storage (e.g.
75 e3c826ec Michael Hanselmann
        <literal>SAN</literal>) is needed to get high-availability features. It
76 e3c826ec Michael Hanselmann
        is highly recommended to use more than one disk drive to improve speed.
77 e3c826ec Michael Hanselmann
        But Ganeti also works with one disk per machine.
78 32ad0582 Iustin Pop
      </para>
79 f1a808df Guido Trotter
80 f1a808df Guido Trotter
    <sect2>
81 f1a808df Guido Trotter
      <title>Installing the base system</title>
82 f1a808df Guido Trotter
83 0bac47cf Iustin Pop
      <para>
84 0bac47cf Iustin Pop
        <emphasis role="strong">Mandatory</emphasis> on all nodes.
85 0bac47cf Iustin Pop
      </para>
86 0bac47cf Iustin Pop
87 0bac47cf Iustin Pop
      <para>
88 0bac47cf Iustin Pop
        It is advised to start with a clean, minimal install of the
89 0bac47cf Iustin Pop
        operating system. The only requirement you need to be aware of
90 0bac47cf Iustin Pop
        at this stage is to partition leaving enough space for a big
91 16450d30 Iustin Pop
        (<emphasis role="strong">minimum
92 16450d30 Iustin Pop
        <constant>20GiB</constant></emphasis>) LVM volume group which
93 16450d30 Iustin Pop
        will then host your instance filesystems. The volume group
94 16450d30 Iustin Pop
        name Ganeti 1.2 uses (by default) is
95 32ad0582 Iustin Pop
        <emphasis>xenvg</emphasis>.
96 0bac47cf Iustin Pop
      </para>
97 f1a808df Guido Trotter
98 5d6dd340 Iustin Pop
      <para>
99 16450d30 Iustin Pop
        While you can use an existing system, please note that the
100 0bac47cf Iustin Pop
        Ganeti installation is intrusive in terms of changes to the
101 0bac47cf Iustin Pop
        system configuration, and it's best to use a newly-installed
102 0bac47cf Iustin Pop
        system without important data on it.
103 0bac47cf Iustin Pop
      </para>
104 0bac47cf Iustin Pop
105 0bac47cf Iustin Pop
      <para>
106 0bac47cf Iustin Pop
        Also, for best results, it's advised that the nodes have as
107 0bac47cf Iustin Pop
        much as possible the same hardware and software
108 0bac47cf Iustin Pop
        configuration. This will make administration much easier.
109 f1a808df Guido Trotter
      </para>
110 f1a808df Guido Trotter
111 5a96795f Iustin Pop
      <sect3>
112 5a96795f Iustin Pop
        <title>Hostname issues</title>
113 5a96795f Iustin Pop
        <para>
114 5a96795f Iustin Pop
          Note that Ganeti requires the hostnames of the systems
115 5a96795f Iustin Pop
          (i.e. what the <computeroutput>hostname</computeroutput>
116 5a96795f Iustin Pop
          command outputs to be a fully-qualified name, not a short
117 5a96795f Iustin Pop
          name. In other words, you should use
118 5a96795f Iustin Pop
          <literal>node1.example.com</literal> as a hostname and not
119 5a96795f Iustin Pop
          just <literal>node1</literal>.
120 5a96795f Iustin Pop
        </para>
121 5a96795f Iustin Pop
122 5a96795f Iustin Pop
        <formalpara>
123 5a96795f Iustin Pop
          <title>Debian</title>
124 5a96795f Iustin Pop
          <para>
125 5a96795f Iustin Pop
            Note that Debian Etch configures the hostname differently
126 5a96795f Iustin Pop
            than you need it for Ganeti. For example, this is what
127 5a96795f Iustin Pop
            Etch puts in <filename>/etc/hosts</filename> in certain
128 5a96795f Iustin Pop
            situations:
129 5a96795f Iustin Pop
<screen>
130 5a96795f Iustin Pop
127.0.0.1       localhost
131 5a96795f Iustin Pop
127.0.1.1       node1.example.com node1
132 5a96795f Iustin Pop
</screen>
133 5a96795f Iustin Pop
134 5a96795f Iustin Pop
          but for Ganeti you need to have:
135 5a96795f Iustin Pop
<screen>
136 5a96795f Iustin Pop
127.0.0.1       localhost
137 5a96795f Iustin Pop
192.168.1.1     node1.example.com node1
138 5a96795f Iustin Pop
</screen>
139 5a96795f Iustin Pop
            replacing <literal>192.168.1.1</literal> with your node's
140 5a96795f Iustin Pop
            address. Also, the file <filename>/etc/hostname</filename>
141 5a96795f Iustin Pop
            which configures the hostname of the system should contain
142 5a96795f Iustin Pop
            <literal>node1.example.com</literal> and not just
143 5a96795f Iustin Pop
            <literal>node1</literal> (you need to run the command
144 5a96795f Iustin Pop
            <computeroutput>/etc/init.d/hostname.sh
145 5a96795f Iustin Pop
            start</computeroutput> after changing the file).
146 5a96795f Iustin Pop
          </para>
147 5a96795f Iustin Pop
        </formalpara>
148 5a96795f Iustin Pop
      </sect3>
149 5a96795f Iustin Pop
150 f1a808df Guido Trotter
    </sect2>
151 f1a808df Guido Trotter
152 f1a808df Guido Trotter
    <sect2>
153 f1a808df Guido Trotter
      <title>Installing Xen</title>
154 f1a808df Guido Trotter
155 5d6dd340 Iustin Pop
      <para>
156 0bac47cf Iustin Pop
        <emphasis role="strong">Mandatory</emphasis> on all nodes.
157 32ad0582 Iustin Pop
      </para>
158 32ad0582 Iustin Pop
159 32ad0582 Iustin Pop
      <para>
160 0bac47cf Iustin Pop
        While Ganeti is developed with the ability to modularly run on
161 0bac47cf Iustin Pop
        different virtualization environments in mind the only one
162 0bac47cf Iustin Pop
        currently useable on a live system is <ulink
163 0bac47cf Iustin Pop
        url="http://xen.xensource.com/">Xen</ulink>. Supported
164 0bac47cf Iustin Pop
        versions are: <simplelist type="inline">
165 0bac47cf Iustin Pop
        <member><literal>3.0.3</literal></member>
166 0bac47cf Iustin Pop
        <member><literal>3.0.4</literal></member>
167 0bac47cf Iustin Pop
        <member><literal>3.1</literal></member> </simplelist>.
168 f1a808df Guido Trotter
      </para>
169 f1a808df Guido Trotter
170 5d6dd340 Iustin Pop
      <para>
171 5d6dd340 Iustin Pop
        Please follow your distribution's recommended way to install
172 5d6dd340 Iustin Pop
        and set up Xen, or install Xen from the upstream source, if
173 5d6dd340 Iustin Pop
        you wish, following their manual.
174 f1a808df Guido Trotter
      </para>
175 f1a808df Guido Trotter
176 5d6dd340 Iustin Pop
      <para>
177 051f92ec Michael Hanselmann
        After installing Xen you need to reboot into your Xen-ified
178 0bac47cf Iustin Pop
        dom0 system. On some distributions this might involve
179 0bac47cf Iustin Pop
        configuring GRUB appropriately, whereas others will configure
180 0bac47cf Iustin Pop
        it automatically when you install Xen from a package.
181 f1a808df Guido Trotter
      </para>
182 f1a808df Guido Trotter
183 32ad0582 Iustin Pop
      <formalpara><title>Debian</title>
184 32ad0582 Iustin Pop
      <para>
185 32ad0582 Iustin Pop
        Under Debian Etch or Sarge+backports you can install the
186 16450d30 Iustin Pop
        relevant <literal>xen-linux-system</literal> package, which
187 727830bf Iustin Pop
        will pull in both the hypervisor and the relevant
188 727830bf Iustin Pop
        kernel. Also, if you are installing a 32-bit Etch, you should
189 958c8f40 Guido Trotter
        install the <computeroutput>libc6-xen</computeroutput> package
190 727830bf Iustin Pop
        (run <computeroutput>apt-get install
191 727830bf Iustin Pop
        libc6-xen</computeroutput>).
192 32ad0582 Iustin Pop
      </para>
193 32ad0582 Iustin Pop
      </formalpara>
194 32ad0582 Iustin Pop
195 16450d30 Iustin Pop
      <sect3>
196 0a2a0d91 Iustin Pop
        <title>Xen settings</title>
197 0a2a0d91 Iustin Pop
198 0a2a0d91 Iustin Pop
        <para>
199 0a2a0d91 Iustin Pop
          It's recommended that dom0 is restricted to a low amount of
200 0a2a0d91 Iustin Pop
          memory (<constant>512MiB</constant> is reasonable) and that
201 0a2a0d91 Iustin Pop
          memory ballooning is disabled in the file
202 0a2a0d91 Iustin Pop
          <filename>/etc/xen/xend-config.sxp</filename> by setting the
203 0a2a0d91 Iustin Pop
          value <literal>dom0-min-mem</literal> to
204 0a2a0d91 Iustin Pop
          <constant>0</constant>, like this:
205 0a2a0d91 Iustin Pop
          <computeroutput>(dom0-min-mem 0)</computeroutput>
206 0a2a0d91 Iustin Pop
        </para>
207 0a2a0d91 Iustin Pop
208 0a2a0d91 Iustin Pop
        <para>
209 0a2a0d91 Iustin Pop
          For optimum performance when running both CPU and I/O
210 0a2a0d91 Iustin Pop
          intensive instances, it's also recommended that the dom0 is
211 0a2a0d91 Iustin Pop
          restricted to one CPU only, for example by booting with the
212 0a2a0d91 Iustin Pop
          kernel parameter <literal>nosmp</literal>.
213 0a2a0d91 Iustin Pop
        </para>
214 0a2a0d91 Iustin Pop
215 0a2a0d91 Iustin Pop
        <formalpara>
216 0a2a0d91 Iustin Pop
          <title>Debian</title>
217 0a2a0d91 Iustin Pop
          <para>
218 ac232de3 Iustin Pop
            Besides the ballooning change which you need to set in
219 0a2a0d91 Iustin Pop
            <filename>/etc/xen/xend-config.sxp</filename>, you need to
220 0a2a0d91 Iustin Pop
            set the memory and nosmp parameters in the file
221 0a2a0d91 Iustin Pop
            <filename>/boot/grub/menu.lst</filename>. You need to
222 0a2a0d91 Iustin Pop
            modify the variable <literal>xenhopt</literal> to add
223 0a2a0d91 Iustin Pop
            <userinput>dom0_mem=512M</userinput> like this:
224 0a2a0d91 Iustin Pop
<screen>
225 0a2a0d91 Iustin Pop
## Xen hypervisor options to use with the default Xen boot option
226 0a2a0d91 Iustin Pop
# xenhopt=dom0_mem=512M
227 0a2a0d91 Iustin Pop
</screen>
228 0a2a0d91 Iustin Pop
            and the <literal>xenkopt</literal> needs to include the
229 0a2a0d91 Iustin Pop
            <userinput>nosmp</userinput> option like this:
230 0a2a0d91 Iustin Pop
<screen>
231 0a2a0d91 Iustin Pop
## Xen Linux kernel options to use with the default Xen boot option
232 0a2a0d91 Iustin Pop
# xenkopt=nosmp
233 0a2a0d91 Iustin Pop
</screen>
234 0a2a0d91 Iustin Pop
235 0a2a0d91 Iustin Pop
          Any existing parameters can be left in place: it's ok to
236 0a2a0d91 Iustin Pop
          have <computeroutput>xenkopt=console=tty0
237 0a2a0d91 Iustin Pop
          nosmp</computeroutput>, for example. After modifying the
238 0a2a0d91 Iustin Pop
          files, you need to run:
239 0a2a0d91 Iustin Pop
<screen>
240 0a2a0d91 Iustin Pop
/sbin/update-grub
241 0a2a0d91 Iustin Pop
</screen>
242 0a2a0d91 Iustin Pop
          </para>
243 0a2a0d91 Iustin Pop
        </formalpara>
244 0a2a0d91 Iustin Pop
245 0a2a0d91 Iustin Pop
      </sect3>
246 0a2a0d91 Iustin Pop
247 0a2a0d91 Iustin Pop
      <sect3>
248 16450d30 Iustin Pop
        <title>Selecting the instance kernel</title>
249 16450d30 Iustin Pop
250 16450d30 Iustin Pop
        <para>
251 051f92ec Michael Hanselmann
          After you have installed Xen, you need to tell Ganeti
252 16450d30 Iustin Pop
          exactly what kernel to use for the instances it will
253 16450d30 Iustin Pop
          create. This is done by creating a
254 16450d30 Iustin Pop
          <emphasis>symlink</emphasis> from your actual kernel to
255 16450d30 Iustin Pop
          <filename>/boot/vmlinuz-2.6-xenU</filename>, and one from
256 16450d30 Iustin Pop
          your initrd to
257 16450d30 Iustin Pop
          <filename>/boot/initrd-2.6-xenU</filename>. Note that if you
258 16450d30 Iustin Pop
          don't use an initrd for the <literal>domU</literal> kernel,
259 16450d30 Iustin Pop
          you don't need to create the initrd symlink.
260 16450d30 Iustin Pop
        </para>
261 16450d30 Iustin Pop
262 16450d30 Iustin Pop
        <formalpara>
263 16450d30 Iustin Pop
          <title>Debian</title>
264 16450d30 Iustin Pop
          <para>
265 16450d30 Iustin Pop
            After installation of the
266 16450d30 Iustin Pop
            <literal>xen-linux-system</literal> package, you need to
267 16450d30 Iustin Pop
            run (replace the exact version number with the one you
268 16450d30 Iustin Pop
            have):
269 16450d30 Iustin Pop
            <screen>
270 16450d30 Iustin Pop
cd /boot
271 16450d30 Iustin Pop
ln -s vmlinuz-2.6.18-5-xen-686 vmlinuz-2.6-xenU
272 16450d30 Iustin Pop
ln -s initrd.img-2.6.18-5-xen-686 initrd-2.6-xenU
273 16450d30 Iustin Pop
            </screen>
274 16450d30 Iustin Pop
          </para>
275 16450d30 Iustin Pop
        </formalpara>
276 16450d30 Iustin Pop
      </sect3>
277 16450d30 Iustin Pop
278 f1a808df Guido Trotter
    </sect2>
279 f1a808df Guido Trotter
280 f1a808df Guido Trotter
    <sect2>
281 f1a808df Guido Trotter
      <title>Installing DRBD</title>
282 f1a808df Guido Trotter
283 5d6dd340 Iustin Pop
      <para>
284 0bac47cf Iustin Pop
        Recommended on all nodes: <ulink
285 0bac47cf Iustin Pop
        url="http://www.drbd.org/">DRBD</ulink> is required if you
286 0bac47cf Iustin Pop
        want to use the high availability (HA) features of Ganeti, but
287 0bac47cf Iustin Pop
        optional if you don't require HA or only run Ganeti on
288 0bac47cf Iustin Pop
        single-node clusters. You can upgrade a non-HA cluster to an
289 32ad0582 Iustin Pop
        HA one later, but you might need to export and re-import all
290 0bac47cf Iustin Pop
        your instances to take advantage of the new features.
291 0bac47cf Iustin Pop
      </para>
292 0bac47cf Iustin Pop
293 0bac47cf Iustin Pop
      <para>
294 6c4811dc Iustin Pop
        Supported DRBD versions: the <literal>0.7</literal> series
295 6c4811dc Iustin Pop
        <emphasis role="strong">or</emphasis>
296 6c4811dc Iustin Pop
        <literal>8.0.x</literal>. It's recommended to have at least
297 6c4811dc Iustin Pop
        version <literal>0.7.24</literal> if you use
298 6c4811dc Iustin Pop
        <command>udev</command> since older versions have a bug
299 6c4811dc Iustin Pop
        related to device discovery which can be triggered in cases of
300 6c4811dc Iustin Pop
        hard drive failure.
301 f1a808df Guido Trotter
      </para>
302 f1a808df Guido Trotter
303 5d6dd340 Iustin Pop
      <para>
304 5d6dd340 Iustin Pop
        Now the bad news: unless your distribution already provides it
305 5d6dd340 Iustin Pop
        installing DRBD might involve recompiling your kernel or
306 051f92ec Michael Hanselmann
        anyway fiddling with it. Hopefully at least the Xen-ified
307 5d6dd340 Iustin Pop
        kernel source to start from will be provided.
308 f1a808df Guido Trotter
      </para>
309 f1a808df Guido Trotter
310 5d6dd340 Iustin Pop
      <para>
311 5d6dd340 Iustin Pop
        The good news is that you don't need to configure DRBD at all.
312 5d6dd340 Iustin Pop
        Ganeti will do it for you for every instance you set up.  If
313 5d6dd340 Iustin Pop
        you have the DRBD utils installed and the module in your
314 5d6dd340 Iustin Pop
        kernel you're fine. Please check that your system is
315 727830bf Iustin Pop
        configured to load the module at every boot, and that it
316 6c4811dc Iustin Pop
        passes the following option to the module (for
317 6c4811dc Iustin Pop
        <literal>0.7.x</literal>:
318 727830bf Iustin Pop
        <computeroutput>minor_count=64</computeroutput> (this will
319 6c4811dc Iustin Pop
        allow you to use up to 32 instances per node) or for
320 6c4811dc Iustin Pop
        <literal>8.0.x</literal> you can use up to
321 6c4811dc Iustin Pop
        <constant>255</constant>
322 6c4811dc Iustin Pop
        (i.e. <computeroutput>minor_count=255</computeroutput>, but
323 6c4811dc Iustin Pop
        for most clusters <constant>128</constant> should be enough).
324 f1a808df Guido Trotter
      </para>
325 f1a808df Guido Trotter
326 32ad0582 Iustin Pop
      <formalpara><title>Debian</title>
327 32ad0582 Iustin Pop
        <para>
328 32ad0582 Iustin Pop
         You can just install (build) the DRBD 0.7 module with the
329 851765bb Iustin Pop
         following commands (make sure you are running the Xen
330 851765bb Iustin Pop
         kernel):
331 32ad0582 Iustin Pop
        </para>
332 32ad0582 Iustin Pop
      </formalpara>
333 32ad0582 Iustin Pop
334 32ad0582 Iustin Pop
      <screen>
335 32ad0582 Iustin Pop
apt-get install drbd0.7-module-source drbd0.7-utils
336 32ad0582 Iustin Pop
m-a update
337 32ad0582 Iustin Pop
m-a a-i drbd0.7
338 727830bf Iustin Pop
echo drbd minor_count=64 >> /etc/modules
339 727830bf Iustin Pop
modprobe drbd minor_count=64
340 32ad0582 Iustin Pop
      </screen>
341 6c4811dc Iustin Pop
      <para>or for using DRBD <literal>8.x</literal> from the etch
342 6c4811dc Iustin Pop
      backports:</para>
343 6c4811dc Iustin Pop
      <screen>
344 6c4811dc Iustin Pop
apt-get install -t etch-backports drbd8-module-source drbd8-utils
345 6c4811dc Iustin Pop
m-a update
346 6c4811dc Iustin Pop
m-a a-i drbd8
347 6c4811dc Iustin Pop
echo drbd minor_count=128 >> /etc/modules
348 6c4811dc Iustin Pop
modprobe drbd minor_count=128
349 6c4811dc Iustin Pop
      </screen>
350 32ad0582 Iustin Pop
351 61bf23ec Iustin Pop
      <para>
352 61bf23ec Iustin Pop
        It is also recommended that you comment out the default
353 61bf23ec Iustin Pop
        resources in the <filename>/etc/dbrd.conf</filename> file, so
354 61bf23ec Iustin Pop
        that the init script doesn't try to configure any drbd
355 61bf23ec Iustin Pop
        devices. You can do this by prefixing all
356 61bf23ec Iustin Pop
        <literal>resource</literal> lines in the file with the keyword
357 61bf23ec Iustin Pop
        <literal>skip</literal>, like this:
358 61bf23ec Iustin Pop
      </para>
359 61bf23ec Iustin Pop
360 61bf23ec Iustin Pop
      <screen>
361 61bf23ec Iustin Pop
skip resource r0 {
362 61bf23ec Iustin Pop
...
363 61bf23ec Iustin Pop
}
364 61bf23ec Iustin Pop
365 61bf23ec Iustin Pop
skip resource "r1" {
366 61bf23ec Iustin Pop
...
367 61bf23ec Iustin Pop
}
368 61bf23ec Iustin Pop
      </screen>
369 61bf23ec Iustin Pop
370 f1a808df Guido Trotter
    </sect2>
371 f1a808df Guido Trotter
372 a7a19281 Iustin Pop
    <sect2>
373 a7a19281 Iustin Pop
      <title>Other required software</title>
374 a7a19281 Iustin Pop
375 a7a19281 Iustin Pop
      <para>Besides Xen and DRBD, you will need to install the
376 0bac47cf Iustin Pop
      following (on all nodes):</para>
377 a7a19281 Iustin Pop
378 a7a19281 Iustin Pop
      <itemizedlist>
379 a7a19281 Iustin Pop
        <listitem>
380 a7a19281 Iustin Pop
          <simpara><ulink url="http://sourceware.org/lvm2/">LVM
381 a7a19281 Iustin Pop
          version 2</ulink></simpara>
382 a7a19281 Iustin Pop
        </listitem>
383 a7a19281 Iustin Pop
        <listitem>
384 a7a19281 Iustin Pop
          <simpara><ulink
385 a7a19281 Iustin Pop
          url="http://www.openssl.org/">OpenSSL</ulink></simpara>
386 a7a19281 Iustin Pop
        </listitem>
387 a7a19281 Iustin Pop
        <listitem>
388 a7a19281 Iustin Pop
          <simpara><ulink
389 a7a19281 Iustin Pop
          url="http://www.openssh.com/portable.html">OpenSSH</ulink></simpara>
390 a7a19281 Iustin Pop
        </listitem>
391 a7a19281 Iustin Pop
        <listitem>
392 a7a19281 Iustin Pop
          <simpara><ulink url="http://bridge.sourceforge.net/">Bridge
393 a7a19281 Iustin Pop
          utilities</ulink></simpara>
394 a7a19281 Iustin Pop
        </listitem>
395 a7a19281 Iustin Pop
        <listitem>
396 a7a19281 Iustin Pop
          <simpara><ulink
397 a7a19281 Iustin Pop
          url="http://developer.osdl.org/dev/iproute2">iproute2</ulink></simpara>
398 a7a19281 Iustin Pop
        </listitem>
399 a7a19281 Iustin Pop
        <listitem>
400 a7a19281 Iustin Pop
          <simpara><ulink
401 a7a19281 Iustin Pop
          url="ftp://ftp.inr.ac.ru/ip-routing/iputils-current.tar.gz">arping</ulink>
402 a7a19281 Iustin Pop
          (part of iputils package)</simpara>
403 a7a19281 Iustin Pop
        </listitem>
404 a7a19281 Iustin Pop
        <listitem>
405 a7a19281 Iustin Pop
          <simpara><ulink
406 a7a19281 Iustin Pop
          url="http://www.kernel.org/pub/linux/utils/raid/mdadm/">mdadm</ulink>
407 a7a19281 Iustin Pop
          (Linux Software Raid tools)</simpara>
408 a7a19281 Iustin Pop
        </listitem>
409 a7a19281 Iustin Pop
        <listitem>
410 a7a19281 Iustin Pop
          <simpara><ulink url="http://www.python.org">Python 2.4</ulink></simpara>
411 a7a19281 Iustin Pop
        </listitem>
412 a7a19281 Iustin Pop
        <listitem>
413 a7a19281 Iustin Pop
          <simpara><ulink url="http://twistedmatrix.com/">Python
414 a7a19281 Iustin Pop
          Twisted library</ulink> - the core library is
415 a7a19281 Iustin Pop
          enough</simpara>
416 a7a19281 Iustin Pop
        </listitem>
417 a7a19281 Iustin Pop
        <listitem>
418 a7a19281 Iustin Pop
          <simpara><ulink
419 a7a19281 Iustin Pop
          url="http://pyopenssl.sourceforge.net/">Python OpenSSL
420 a7a19281 Iustin Pop
          bindings</ulink></simpara>
421 319856a9 Michael Hanselmann
        </listitem>
422 319856a9 Michael Hanselmann
        <listitem>
423 319856a9 Michael Hanselmann
          <simpara><ulink
424 319856a9 Michael Hanselmann
          url="http://www.undefined.org/python/#simplejson">simplejson Python
425 319856a9 Michael Hanselmann
          module</ulink></simpara>
426 a2cfdea2 Iustin Pop
        </listitem>
427 a2cfdea2 Iustin Pop
        <listitem>
428 a2cfdea2 Iustin Pop
          <simpara><ulink
429 a2cfdea2 Iustin Pop
          url="http://pyparsing.wikispaces.com/">pyparsing Python
430 a2cfdea2 Iustin Pop
          module</ulink></simpara>
431 a7a19281 Iustin Pop
        </listitem>
432 a7a19281 Iustin Pop
      </itemizedlist>
433 a7a19281 Iustin Pop
434 32ad0582 Iustin Pop
      <para>
435 32ad0582 Iustin Pop
        These programs are supplied as part of most Linux
436 32ad0582 Iustin Pop
        distributions, so usually they can be installed via apt or
437 32ad0582 Iustin Pop
        similar methods. Also many of them will already be installed
438 32ad0582 Iustin Pop
        on a standard machine.
439 32ad0582 Iustin Pop
      </para>
440 32ad0582 Iustin Pop
441 32ad0582 Iustin Pop
442 32ad0582 Iustin Pop
      <formalpara><title>Debian</title>
443 32ad0582 Iustin Pop
444 32ad0582 Iustin Pop
      <para>You can use this command line to install all of them:</para>
445 a7a19281 Iustin Pop
446 32ad0582 Iustin Pop
      </formalpara>
447 a7a19281 Iustin Pop
      <screen>
448 a7a19281 Iustin Pop
# apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
449 16abfbc2 Alexander Schreiber
  python2.4 python-twisted-core python-pyopenssl openssl \
450 65ca7c46 Iustin Pop
  mdadm
451 a7a19281 Iustin Pop
      </screen>
452 5cd0d9c0 Iustin Pop
453 a7a19281 Iustin Pop
    </sect2>
454 a7a19281 Iustin Pop
455 f1a808df Guido Trotter
  </sect1>
456 f1a808df Guido Trotter
457 f1a808df Guido Trotter
458 f1a808df Guido Trotter
  <sect1>
459 f1a808df Guido Trotter
    <title>Setting up the environment for Ganeti</title>
460 f1a808df Guido Trotter
461 f1a808df Guido Trotter
    <sect2>
462 f1a808df Guido Trotter
      <title>Configuring the network</title>
463 f1a808df Guido Trotter
464 0bac47cf Iustin Pop
      <para><emphasis role="strong">Mandatory</emphasis> on all nodes.</para>
465 0bac47cf Iustin Pop
466 32ad0582 Iustin Pop
      <para>
467 32ad0582 Iustin Pop
        Ganeti relies on Xen running in "bridge mode", which means the
468 32ad0582 Iustin Pop
        instances network interfaces will be attached to a software bridge
469 32ad0582 Iustin Pop
        running in dom0. Xen by default creates such a bridge at startup, but
470 32ad0582 Iustin Pop
        your distribution might have a different way to do things.
471 f1a808df Guido Trotter
      </para>
472 f1a808df Guido Trotter
473 f1a808df Guido Trotter
      <para>
474 32ad0582 Iustin Pop
        Beware that the default name Ganeti uses is
475 32ad0582 Iustin Pop
        <hardware>xen-br0</hardware> (which was used in Xen 2.0)
476 32ad0582 Iustin Pop
        while Xen 3.0 uses <hardware>xenbr0</hardware> by
477 32ad0582 Iustin Pop
        default. The default bridge your Ganeti cluster will use for new
478 32ad0582 Iustin Pop
        instances can be specified at cluster initialization time.
479 32ad0582 Iustin Pop
      </para>
480 5d6dd340 Iustin Pop
481 32ad0582 Iustin Pop
      <formalpara><title>Debian</title>
482 32ad0582 Iustin Pop
        <para>
483 051f92ec Michael Hanselmann
          The recommended Debian way to configure the Xen bridge is to
484 32ad0582 Iustin Pop
          edit your <filename>/etc/network/interfaces</filename> file
485 32ad0582 Iustin Pop
          and substitute your normal Ethernet stanza with the
486 32ad0582 Iustin Pop
          following snippet:
487 32ad0582 Iustin Pop
488 32ad0582 Iustin Pop
        <screen>
489 32ad0582 Iustin Pop
auto xen-br0
490 32ad0582 Iustin Pop
iface xen-br0 inet static
491 5d6dd340 Iustin Pop
        address <replaceable>YOUR_IP_ADDRESS</replaceable>
492 5d6dd340 Iustin Pop
        netmask <replaceable>YOUR_NETMASK</replaceable>
493 5d6dd340 Iustin Pop
        network <replaceable>YOUR_NETWORK</replaceable>
494 5d6dd340 Iustin Pop
        broadcast <replaceable>YOUR_BROADCAST_ADDRESS</replaceable>
495 5d6dd340 Iustin Pop
        gateway <replaceable>YOUR_GATEWAY</replaceable>
496 32ad0582 Iustin Pop
        bridge_ports eth0
497 f1a808df Guido Trotter
        bridge_stp off
498 f1a808df Guido Trotter
        bridge_fd 0
499 32ad0582 Iustin Pop
        </screen>
500 32ad0582 Iustin Pop
        </para>
501 32ad0582 Iustin Pop
      </formalpara>
502 32ad0582 Iustin Pop
503 32ad0582 Iustin Pop
     <para>
504 32ad0582 Iustin Pop
The following commands need to be executed on the local console
505 32ad0582 Iustin Pop
     </para>
506 32ad0582 Iustin Pop
      <screen>
507 32ad0582 Iustin Pop
ifdown eth0
508 32ad0582 Iustin Pop
ifup xen-br0
509 32ad0582 Iustin Pop
      </screen>
510 32ad0582 Iustin Pop
511 32ad0582 Iustin Pop
      <para>
512 32ad0582 Iustin Pop
        To check if the bridge is setup, use <command>ip</command>
513 32ad0582 Iustin Pop
        and <command>brctl show</command>:
514 32ad0582 Iustin Pop
      <para>
515 32ad0582 Iustin Pop
516 32ad0582 Iustin Pop
      <screen>
517 32ad0582 Iustin Pop
# ip a show xen-br0
518 32ad0582 Iustin Pop
9: xen-br0: &lt;BROADCAST,MULTICAST,UP,10000&gt; mtu 1500 qdisc noqueue
519 32ad0582 Iustin Pop
    link/ether 00:20:fc:1e:d5:5d brd ff:ff:ff:ff:ff:ff
520 32ad0582 Iustin Pop
    inet 10.1.1.200/24 brd 10.1.1.255 scope global xen-br0
521 32ad0582 Iustin Pop
    inet6 fe80::220:fcff:fe1e:d55d/64 scope link
522 32ad0582 Iustin Pop
       valid_lft forever preferred_lft forever
523 32ad0582 Iustin Pop
524 32ad0582 Iustin Pop
# brctl show xen-br0
525 32ad0582 Iustin Pop
bridge name     bridge id               STP enabled     interfaces
526 32ad0582 Iustin Pop
xen-br0         8000.0020fc1ed55d       no              eth0
527 5d6dd340 Iustin Pop
      </screen>
528 f1a808df Guido Trotter
529 f1a808df Guido Trotter
530 f1a808df Guido Trotter
    </sect2>
531 f1a808df Guido Trotter
532 f1a808df Guido Trotter
    <sect2>
533 f1a808df Guido Trotter
      <title>Configuring LVM</title>
534 f1a808df Guido Trotter
535 32ad0582 Iustin Pop
536 0bac47cf Iustin Pop
      <para><emphasis role="strong">Mandatory</emphasis> on all nodes.</para>
537 0bac47cf Iustin Pop
538 16450d30 Iustin Pop
      <note>
539 16450d30 Iustin Pop
        <simpara>The volume group is required to be at least
540 16450d30 Iustin Pop
        <constant>20GiB</constant>.</simpara>
541 16450d30 Iustin Pop
      </note>
542 f1a808df Guido Trotter
      <para>
543 5d6dd340 Iustin Pop
        If you haven't configured your LVM volume group at install
544 5d6dd340 Iustin Pop
        time you need to do it before trying to initialize the Ganeti
545 5d6dd340 Iustin Pop
        cluster. This is done by formatting the devices/partitions you
546 5d6dd340 Iustin Pop
        want to use for it and then adding them to the relevant volume
547 5d6dd340 Iustin Pop
        group:
548 5d6dd340 Iustin Pop
549 5d6dd340 Iustin Pop
       <screen>
550 32ad0582 Iustin Pop
pvcreate /dev/sda3
551 32ad0582 Iustin Pop
vgcreate xenvg /dev/sda3
552 32ad0582 Iustin Pop
       </screen>
553 32ad0582 Iustin Pop
or
554 32ad0582 Iustin Pop
       <screen>
555 32ad0582 Iustin Pop
pvcreate /dev/sdb1
556 f1a808df Guido Trotter
pvcreate /dev/sdc1
557 32ad0582 Iustin Pop
vgcreate xenvg /dev/sdb1 /dev/sdc1
558 5d6dd340 Iustin Pop
       </screen>
559 32ad0582 Iustin Pop
      </para>
560 f1a808df Guido Trotter
561 f1a808df Guido Trotter
      <para>
562 5d6dd340 Iustin Pop
	If you want to add a device later you can do so with the
563 53b78ba4 Guido Trotter
	<citerefentry><refentrytitle>vgextend</refentrytitle>
564 5d6dd340 Iustin Pop
	<manvolnum>8</manvolnum></citerefentry> command:
565 5d6dd340 Iustin Pop
      </para>
566 5d6dd340 Iustin Pop
567 5d6dd340 Iustin Pop
      <screen>
568 32ad0582 Iustin Pop
pvcreate /dev/sdd1
569 32ad0582 Iustin Pop
vgextend xenvg /dev/sdd1
570 5d6dd340 Iustin Pop
      </screen>
571 89624642 Iustin Pop
572 89624642 Iustin Pop
      <formalpara>
573 89624642 Iustin Pop
        <title>Optional</title>
574 89624642 Iustin Pop
        <para>
575 89624642 Iustin Pop
          It is recommended to configure LVM not to scan the DRBD
576 89624642 Iustin Pop
          devices for physical volumes. This can be accomplished by
577 89624642 Iustin Pop
          editing <filename>/etc/lvm/lvm.conf</filename> and adding
578 89624642 Iustin Pop
          the <literal>/dev/drbd[0-9]+</literal> regular expression to
579 89624642 Iustin Pop
          the <literal>filter</literal> variable, like this:
580 89624642 Iustin Pop
<screen>
581 89624642 Iustin Pop
    filter = [ "r|/dev/cdrom|", "r|/dev/drbd[0-9]+|" ]
582 89624642 Iustin Pop
</screen>
583 89624642 Iustin Pop
        </para>
584 89624642 Iustin Pop
      </formalpara>
585 89624642 Iustin Pop
586 f1a808df Guido Trotter
    </sect2>
587 f1a808df Guido Trotter
588 f1a808df Guido Trotter
    <sect2>
589 f1a808df Guido Trotter
      <title>Installing Ganeti</title>
590 f1a808df Guido Trotter
591 0bac47cf Iustin Pop
      <para><emphasis role="strong">Mandatory</emphasis> on all nodes.</para>
592 0bac47cf Iustin Pop
593 1005b0c1 Iustin Pop
      <para>
594 32ad0582 Iustin Pop
        It's now time to install the Ganeti software itself.  Download
595 32ad0582 Iustin Pop
        the source from <ulink
596 32ad0582 Iustin Pop
        url="http://code.google.com/p/ganeti/"></ulink>.
597 1005b0c1 Iustin Pop
      </para>
598 f1a808df Guido Trotter
599 5d6dd340 Iustin Pop
        <screen>
600 32ad0582 Iustin Pop
tar xvzf ganeti-1.2b1.tar.gz
601 32ad0582 Iustin Pop
cd ganeti-1.2b1
602 bd205d0e Michael Hanselmann
./configure --localstatedir=/var --sysconfdir=/etc
603 f1a808df Guido Trotter
make
604 f1a808df Guido Trotter
make install
605 1005b0c1 Iustin Pop
mkdir /srv/ganeti/ /srv/ganeti/os /srv/ganeti/export
606 5d6dd340 Iustin Pop
        </screen>
607 f1a808df Guido Trotter
608 1005b0c1 Iustin Pop
      <para>
609 32ad0582 Iustin Pop
        You also need to copy the file
610 bd205d0e Michael Hanselmann
        <filename>doc/examples/ganeti.initd</filename>
611 32ad0582 Iustin Pop
        from the source archive to
612 32ad0582 Iustin Pop
        <filename>/etc/init.d/ganeti</filename> and register it with
613 1005b0c1 Iustin Pop
        your distribution's startup scripts, for example in Debian:
614 f1a808df Guido Trotter
      </para>
615 1005b0c1 Iustin Pop
      <screen>update-rc.d ganeti defaults 20 80</screen>
616 f1a808df Guido Trotter
617 727830bf Iustin Pop
      <para>
618 727830bf Iustin Pop
        In order to automatically restart failed instances, you need
619 727830bf Iustin Pop
        to setup a cron job run the
620 727830bf Iustin Pop
        <computeroutput>ganeti-watcher</computeroutput> program. A
621 727830bf Iustin Pop
        sample cron file is provided in the source at
622 bd205d0e Michael Hanselmann
        <filename>doc/examples/ganeti.cron</filename> and you can
623 727830bf Iustin Pop
        copy that (eventually altering the path) to
624 727830bf Iustin Pop
        <filename>/etc/cron.d/ganeti</filename>
625 727830bf Iustin Pop
      </para>
626 727830bf Iustin Pop
627 f1a808df Guido Trotter
    </sect2>
628 f1a808df Guido Trotter
629 f1a808df Guido Trotter
    <sect2>
630 f1a808df Guido Trotter
      <title>Installing the Operating System support packages</title>
631 f1a808df Guido Trotter
632 0bac47cf Iustin Pop
      <para><emphasis role="strong">Mandatory</emphasis> on all nodes.</para>
633 0bac47cf Iustin Pop
634 a7a19281 Iustin Pop
      <para>
635 32ad0582 Iustin Pop
        To be able to install instances you need to have an Operating
636 32ad0582 Iustin Pop
        System installation script. An example for Debian Etch is
637 32ad0582 Iustin Pop
        provided on the project web site.  Download it from <ulink
638 32ad0582 Iustin Pop
        url="http://code.google.com/p/ganeti/"></ulink> and follow the
639 32ad0582 Iustin Pop
        instructions in the <filename>README</filename> file.  Here is
640 32ad0582 Iustin Pop
        the installation procedure:
641 a7a19281 Iustin Pop
      </para>
642 a7a19281 Iustin Pop
643 32ad0582 Iustin Pop
      <screen>
644 32ad0582 Iustin Pop
cd /srv/ganeti/os
645 32ad0582 Iustin Pop
tar xvf instance-debian-etch-0.1.tar
646 32ad0582 Iustin Pop
mv instance-debian-etch-0.1 debian-etch
647 32ad0582 Iustin Pop
      </screen>
648 32ad0582 Iustin Pop
649 a7a19281 Iustin Pop
      <para>
650 16450d30 Iustin Pop
        In order to use this OS definition, you need to have internet
651 116b0c88 Iustin Pop
        access from your nodes and have the <citerefentry>
652 16450d30 Iustin Pop
        <refentrytitle>debootstrap</refentrytitle>
653 116b0c88 Iustin Pop
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
654 116b0c88 Iustin Pop
        <refentrytitle>dump</refentrytitle><manvolnum>8</manvolnum>
655 116b0c88 Iustin Pop
        </citerefentry> and <citerefentry>
656 116b0c88 Iustin Pop
        <refentrytitle>restore</refentrytitle>
657 116b0c88 Iustin Pop
        <manvolnum>8</manvolnum> </citerefentry> commands installed on
658 116b0c88 Iustin Pop
        all nodes.
659 16450d30 Iustin Pop
      </para>
660 16450d30 Iustin Pop
      <formalpara>
661 16450d30 Iustin Pop
        <title>Debian</title>
662 16450d30 Iustin Pop
        <para>
663 116b0c88 Iustin Pop
          Use this command on all nodes to install the required
664 116b0c88 Iustin Pop
          packages:
665 16450d30 Iustin Pop
666 116b0c88 Iustin Pop
          <screen>apt-get install debootstrap dump</screen>
667 16450d30 Iustin Pop
        </para>
668 16450d30 Iustin Pop
      </formalpara>
669 16450d30 Iustin Pop
670 16450d30 Iustin Pop
      <para>
671 32ad0582 Iustin Pop
        Alternatively, you can create your own OS definitions. See the
672 0bac47cf Iustin Pop
        manpage
673 a7a19281 Iustin Pop
        <citerefentry>
674 a7a19281 Iustin Pop
        <refentrytitle>ganeti-os-interface</refentrytitle>
675 a7a19281 Iustin Pop
        <manvolnum>8</manvolnum>
676 a7a19281 Iustin Pop
        </citerefentry>.
677 f1a808df Guido Trotter
      </para>
678 f1a808df Guido Trotter
679 f1a808df Guido Trotter
    </sect2>
680 f1a808df Guido Trotter
681 f1a808df Guido Trotter
    <sect2>
682 f1a808df Guido Trotter
      <title>Initializing the cluster</title>
683 f1a808df Guido Trotter
684 5d6dd340 Iustin Pop
      <para><emphasis role="strong">Mandatory:</emphasis> only on one
685 5d6dd340 Iustin Pop
      node per cluster.</para>
686 f1a808df Guido Trotter
687 f1a808df Guido Trotter
688 f1a808df Guido Trotter
      <para>The last step is to initialize the cluster. After you've repeated
689 32ad0582 Iustin Pop
        the above process on all of your nodes, choose one as the master, and execute:
690 5d6dd340 Iustin Pop
      </para>
691 f1a808df Guido Trotter
692 5d6dd340 Iustin Pop
      <screen>
693 5d6dd340 Iustin Pop
gnt-cluster init <replaceable>CLUSTERNAME</replaceable>
694 5d6dd340 Iustin Pop
      </screen>
695 f1a808df Guido Trotter
696 5d6dd340 Iustin Pop
      <para>
697 0bac47cf Iustin Pop
        The <replaceable>CLUSTERNAME</replaceable> is a hostname,
698 0bac47cf Iustin Pop
        which must be resolvable (e.g. it must exist in DNS or in
699 0bac47cf Iustin Pop
        <filename>/etc/hosts</filename>) by all the nodes in the
700 0bac47cf Iustin Pop
        cluster. You must choose a name different from any of the
701 0bac47cf Iustin Pop
        nodes names for a multi-node cluster. In general the best
702 0bac47cf Iustin Pop
        choice is to have a unique name for a cluster, even if it
703 0bac47cf Iustin Pop
        consists of only one machine, as you will be able to expand it
704 0bac47cf Iustin Pop
        later without any problems.
705 0bac47cf Iustin Pop
      </para>
706 0bac47cf Iustin Pop
707 0bac47cf Iustin Pop
      <para>
708 32ad0582 Iustin Pop
        If the bridge name you are using is not
709 32ad0582 Iustin Pop
        <literal>xen-br0</literal>, use the <option>-b
710 32ad0582 Iustin Pop
        <replaceable>BRIDGENAME</replaceable></option> option to
711 32ad0582 Iustin Pop
        specify the bridge name. In this case, you should also use the
712 32ad0582 Iustin Pop
        <option>--master-netdev
713 32ad0582 Iustin Pop
        <replaceable>BRIDGENAME</replaceable></option> option with the
714 32ad0582 Iustin Pop
        same <replaceable>BRIDGENAME</replaceable> argument.
715 1005b0c1 Iustin Pop
      </para>
716 1005b0c1 Iustin Pop
717 1005b0c1 Iustin Pop
      <para>
718 32ad0582 Iustin Pop
        You can use a different name than <literal>xenvg</literal> for
719 32ad0582 Iustin Pop
        the volume group (but note that the name must be identical on
720 32ad0582 Iustin Pop
        all nodes). In this case you need to specify it by passing the
721 32ad0582 Iustin Pop
        <option>-g <replaceable>VGNAME</replaceable></option> option
722 32ad0582 Iustin Pop
        to <computeroutput>gnt-cluster init</computeroutput>.
723 f1a808df Guido Trotter
      </para>
724 f1a808df Guido Trotter
725 5d6dd340 Iustin Pop
      <para>
726 32ad0582 Iustin Pop
        You can also invoke the command with the
727 32ad0582 Iustin Pop
        <option>--help</option> option in order to see all the
728 32ad0582 Iustin Pop
        possibilities.
729 f1a808df Guido Trotter
      </para>
730 32ad0582 Iustin Pop
731 f1a808df Guido Trotter
    </sect2>
732 f1a808df Guido Trotter
733 f1a808df Guido Trotter
    <sect2>
734 32ad0582 Iustin Pop
      <title>Joining the nodes to the cluster</title>
735 f1a808df Guido Trotter
736 5d6dd340 Iustin Pop
      <para>
737 5d6dd340 Iustin Pop
        <emphasis role="strong">Mandatory:</emphasis> for all the
738 5d6dd340 Iustin Pop
        other nodes.
739 f1a808df Guido Trotter
      </para>
740 f1a808df Guido Trotter
741 f1a808df Guido Trotter
      <para>
742 0bac47cf Iustin Pop
        After you have initialized your cluster you need to join the
743 0bac47cf Iustin Pop
        other nodes to it. You can do so by executing the following
744 0bac47cf Iustin Pop
        command on the master node:
745 32ad0582 Iustin Pop
      </para>
746 5d6dd340 Iustin Pop
        <screen>
747 5d6dd340 Iustin Pop
gnt-node add <replaceable>NODENAME</replaceable>
748 5d6dd340 Iustin Pop
        </screen>
749 32ad0582 Iustin Pop
    </sect2>
750 f1a808df Guido Trotter
751 32ad0582 Iustin Pop
    <sect2>
752 32ad0582 Iustin Pop
      <title>Separate replication network</title>
753 32ad0582 Iustin Pop
754 32ad0582 Iustin Pop
      <para><emphasis role="strong">Optional</emphasis></para>
755 32ad0582 Iustin Pop
      <para>
756 32ad0582 Iustin Pop
        Ganeti uses DRBD to mirror the disk of the virtual instances
757 32ad0582 Iustin Pop
        between nodes. To use a dedicated network interface for this
758 32ad0582 Iustin Pop
        (in order to improve performance or to enhance security) you
759 32ad0582 Iustin Pop
        need to configure an additional interface for each node.  Use
760 32ad0582 Iustin Pop
        the <option>-s</option> option with
761 32ad0582 Iustin Pop
        <computeroutput>gnt-cluster init</computeroutput> and
762 32ad0582 Iustin Pop
        <computeroutput>gnt-node add</computeroutput> to specify the
763 ac232de3 Iustin Pop
        IP address of this secondary interface to use for each
764 32ad0582 Iustin Pop
        node. Note that if you specified this option at cluster setup
765 32ad0582 Iustin Pop
        time, you must afterwards use it for every node add operation.
766 f1a808df Guido Trotter
      </para>
767 f1a808df Guido Trotter
    </sect2>
768 f1a808df Guido Trotter
769 32ad0582 Iustin Pop
    <sect2>
770 32ad0582 Iustin Pop
      <title>Testing the setup</title>
771 f1a808df Guido Trotter
772 32ad0582 Iustin Pop
      <para>
773 32ad0582 Iustin Pop
        Execute the <computeroutput>gnt-node list</computeroutput>
774 32ad0582 Iustin Pop
        command to see all nodes in the cluster:
775 32ad0582 Iustin Pop
      <screen>
776 32ad0582 Iustin Pop
# gnt-node list
777 32ad0582 Iustin Pop
Node              DTotal  DFree MTotal MNode MFree Pinst Sinst
778 32ad0582 Iustin Pop
node1.example.com 197404 197404   2047  1896   125     0     0
779 32ad0582 Iustin Pop
      </screen>
780 f1a808df Guido Trotter
    </para>
781 32ad0582 Iustin Pop
  </sect2>
782 f1a808df Guido Trotter
783 32ad0582 Iustin Pop
  <sect1>
784 32ad0582 Iustin Pop
    <title>Setting up and managing virtual instances</title>
785 32ad0582 Iustin Pop
    <sect2>
786 32ad0582 Iustin Pop
      <title>Setting up virtual instances</title>
787 32ad0582 Iustin Pop
      <para>
788 32ad0582 Iustin Pop
        This step shows how to setup a virtual instance with either
789 32ad0582 Iustin Pop
        non-mirrored disks (<computeroutput>plain</computeroutput>) or
790 32ad0582 Iustin Pop
        with network mirrored disks
791 6c4811dc Iustin Pop
        (<computeroutput>remote_raid1</computeroutput> for drbd 0.7
792 6c4811dc Iustin Pop
        and <computeroutput>drbd</computeroutput> for drbd 8.x).  All
793 6c4811dc Iustin Pop
        commands need to be executed on the Ganeti master node (the
794 6c4811dc Iustin Pop
        one on which <computeroutput>gnt-cluster init</computeroutput>
795 6c4811dc Iustin Pop
        was run).  Verify that the OS scripts are present on all
796 6c4811dc Iustin Pop
        cluster nodes with <computeroutput>gnt-os
797 6c4811dc Iustin Pop
        list</computeroutput>.
798 32ad0582 Iustin Pop
      </para>
799 32ad0582 Iustin Pop
      <para>
800 32ad0582 Iustin Pop
        To create a virtual instance, you need a hostname which is
801 32ad0582 Iustin Pop
        resolvable (DNS or <filename>/etc/hosts</filename> on all
802 32ad0582 Iustin Pop
        nodes). The following command will create a non-mirrored
803 32ad0582 Iustin Pop
        instance for you:
804 32ad0582 Iustin Pop
      </para>
805 32ad0582 Iustin Pop
      <screen>
806 32ad0582 Iustin Pop
gnt-instance add --node=node1 -o debian-etch -t plain inst1.example.com
807 32ad0582 Iustin Pop
* creating instance disks...
808 32ad0582 Iustin Pop
adding instance inst1.example.com to cluster config
809 32ad0582 Iustin Pop
Waiting for instance inst1.example.com to sync disks.
810 32ad0582 Iustin Pop
Instance inst1.example.com's disks are in sync.
811 32ad0582 Iustin Pop
creating os for instance inst1.example.com on node node1.example.com
812 32ad0582 Iustin Pop
* running the instance OS create scripts...
813 32ad0582 Iustin Pop
      </screen>
814 32ad0582 Iustin Pop
815 32ad0582 Iustin Pop
      <para>
816 32ad0582 Iustin Pop
        The above instance will have no network interface enabled.
817 32ad0582 Iustin Pop
        You can access it over the virtual console with
818 32ad0582 Iustin Pop
        <computeroutput>gnt-instance console
819 32ad0582 Iustin Pop
        <literal>inst1</literal></computeroutput>. There is no
820 32ad0582 Iustin Pop
        password for root.  As this is a Debian instance, you can
821 ac232de3 Iustin Pop
        modify the <filename>/etc/network/interfaces</filename> file
822 32ad0582 Iustin Pop
        to setup the network interface (<literal>eth0</literal> is the
823 32ad0582 Iustin Pop
        name of the interface provided to the instance).
824 32ad0582 Iustin Pop
      </para>
825 f1a808df Guido Trotter
826 32ad0582 Iustin Pop
      <para>
827 32ad0582 Iustin Pop
        To create a network mirrored instance, change the argument to
828 32ad0582 Iustin Pop
        the <option>-t</option> option from <literal>plain</literal>
829 6c4811dc Iustin Pop
        to <literal>remote_raid1</literal> (drbd 0.7) or
830 6c4811dc Iustin Pop
        <literal>drbd</literal> (drbd 8.0) and specify the node on
831 4677a909 Michael Hanselmann
        which the mirror should reside with the second value of the
832 4677a909 Michael Hanselmann
        <option>--node</option> option, like this:
833 32ad0582 Iustin Pop
      </para>
834 32ad0582 Iustin Pop
835 32ad0582 Iustin Pop
      <screen>
836 4677a909 Michael Hanselmann
# gnt-instance add -t remote_raid1 -n node1:node2 -o debian-etch instance2
837 32ad0582 Iustin Pop
* creating instance disks...
838 32ad0582 Iustin Pop
adding instance instance2 to cluster config
839 32ad0582 Iustin Pop
Waiting for instance instance1 to sync disks.
840 32ad0582 Iustin Pop
- device sdb:  3.50% done, 304 estimated seconds remaining
841 32ad0582 Iustin Pop
- device sdb: 21.70% done, 270 estimated seconds remaining
842 32ad0582 Iustin Pop
- device sdb: 39.80% done, 247 estimated seconds remaining
843 32ad0582 Iustin Pop
- device sdb: 58.10% done, 121 estimated seconds remaining
844 32ad0582 Iustin Pop
- device sdb: 76.30% done, 72 estimated seconds remaining
845 32ad0582 Iustin Pop
- device sdb: 94.80% done, 18 estimated seconds remaining
846 32ad0582 Iustin Pop
Instance instance2's disks are in sync.
847 4677a909 Michael Hanselmann
creating os for instance instance2 on node node1.example.com
848 32ad0582 Iustin Pop
* running the instance OS create scripts...
849 32ad0582 Iustin Pop
* starting instance...
850 32ad0582 Iustin Pop
      </screen>
851 32ad0582 Iustin Pop
852 32ad0582 Iustin Pop
    </sect2>
853 32ad0582 Iustin Pop
854 32ad0582 Iustin Pop
    <sect2>
855 32ad0582 Iustin Pop
      <title>Managing virtual instances</title>
856 32ad0582 Iustin Pop
      <para>
857 32ad0582 Iustin Pop
        All commands need to be executed on the Ganeti master node
858 32ad0582 Iustin Pop
      </para>
859 32ad0582 Iustin Pop
860 32ad0582 Iustin Pop
      <para>
861 32ad0582 Iustin Pop
        To access the console of an instance, use
862 32ad0582 Iustin Pop
        <computeroutput>gnt-instance console
863 32ad0582 Iustin Pop
        <replaceable>INSTANCENAME</replaceable></computeroutput>.
864 32ad0582 Iustin Pop
      </para>
865 32ad0582 Iustin Pop
866 32ad0582 Iustin Pop
      <para>
867 32ad0582 Iustin Pop
        To shutdown an instance, use <computeroutput>gnt-instance
868 32ad0582 Iustin Pop
        shutdown
869 32ad0582 Iustin Pop
        <replaceable>INSTANCENAME</replaceable></computeroutput>. To
870 32ad0582 Iustin Pop
        startup an instance, use <computeroutput>gnt-instance startup
871 32ad0582 Iustin Pop
        <replaceable>INSTANCENAME</replaceable></computeroutput>.
872 32ad0582 Iustin Pop
      </para>
873 32ad0582 Iustin Pop
874 32ad0582 Iustin Pop
      <para>
875 32ad0582 Iustin Pop
        To failover an instance to its secondary node (only possible
876 6c4811dc Iustin Pop
        in <literal>remote_raid1</literal> or <literal>drbd</literal>
877 6c4811dc Iustin Pop
        disk templates), use <computeroutput>gnt-instance failover
878 32ad0582 Iustin Pop
        <replaceable>INSTANCENAME</replaceable></computeroutput>.
879 32ad0582 Iustin Pop
      </para>
880 32ad0582 Iustin Pop
881 32ad0582 Iustin Pop
      <para>
882 32ad0582 Iustin Pop
        For more instance and cluster administration details, see the
883 32ad0582 Iustin Pop
        <emphasis>Ganeti administrator's guide</emphasis>.
884 32ad0582 Iustin Pop
      </para>
885 32ad0582 Iustin Pop
886 32ad0582 Iustin Pop
    </sect2>
887 32ad0582 Iustin Pop
888 32ad0582 Iustin Pop
  </sect1>
889 f1a808df Guido Trotter
890 f1a808df Guido Trotter
  </article>