Revision a7a19281

b/INSTALL
2 2
=====================
3 3

  
4 4
Before installing, please verify that you have the following programs:
5
  - Xen virtualization (version 3.0.x or 3.1)
6
    http://xen.xensource.com/
7
  - DRBD (kernel module and userspace utils)
8
    http://www.drbd.org/
5 9
  - LVM2
6 10
    http://sourceware.org/lvm2/
11
  - OpenSSL
12
    http://www.openssl.org/
7 13
  - OpenSSH
8 14
    http://www.openssh.com/portable.html
9
  - DRBD (kernel module and userspace utils)
10
    http://www.drbd.org/
15
  - bridge utilities
16
    http://bridge.sourceforge.net/
11 17
  - fping
12 18
    http://fping.sourceforge.net/
19
  - iproute2
20
    http://developer.osdl.org/dev/iproute2
21
  - arping (part of iputils package)
22
    ftp://ftp.inr.ac.ru/ip-routing/iputils-current.tar.gz
23
  - mdadm (Linux Software Raid tools)
24
    http://www.kernel.org/pub/linux/utils/raid/mdadm/
25
  - Python 2.4
26
    http://www.python.org
13 27
  - Python Twisted library (the core is enough)
14 28
    http://twistedmatrix.com/
15 29
  - Python OpenSSL bindings
16 30
    http://pyopenssl.sourceforge.net/
17 31

  
18
For testing, you also need the YAML module for Python, http://pyyaml.org/.
32
For testing, you also need the YAML module for Python (http://pyyaml.org/).
19 33

  
20 34

  
21 35
Installation of the software
22 36
============================
23 37

  
24
To install, simply do ./configure && make && make install
38
To install, simply do ``./configure --localstatedir=/var && make && make install``
25 39

  
26 40
This will install the software under /usr/local. You then need to copy
27 41
ganeti.init to /etc/init.d and integrate it into your boot sequence
28 42
(``chkconfig``, ``update-rc.d``, etc.).
29 43

  
44
More details about the installation process are in the docs/installing.pdf file.
45

  
30 46

  
31 47
Cluster initialisation
32 48
======================
b/README
1 1
Ganeti 1.2
2 2
==========
3 3

  
4
For installation instructions, read the INSTALL file.
4
For installation instructions, read the INSTALL and the docs/installing.pdf
5
files.
5 6

  
6 7
For a brief introduction, read the ganeti(7) manpage and the other pages
7 8
it suggests.
b/docs/installing.sgml
81 81
        <emphasis role="strong">Mandatory:</emphasis> While Ganeti is
82 82
        developed with the ability to modularly run on different
83 83
        virtualization environments in mind the only one currently
84
        useable on a live system is Xen.
84
        useable on a live system is <ulink
85
        url="http://xen.xensource.com/">Xen</ulink>.
85 86
      </para>
86 87

  
87 88
      <para>
......
109 110
      <title>Installing DRBD</title>
110 111

  
111 112
      <para>
112
        Recommended: DRBD is required if you want to use the high
113
        availability (HA) features of Ganeti, but optional if you
114
        don't require HA or only run Ganeti on single-node
115
        clusters. You can upgrade a non-HA cluster to an HA one later,
116
        but you might need to export and reimport all your instances
117
        to take advantage of the new features.
113
        Recommended: <ulink url="http://www.drbd.org/">DRBD</ulink>
114
        is required if you want to use the high availability (HA)
115
        features of Ganeti, but optional if you don't require HA or
116
        only run Ganeti on single-node clusters. You can upgrade a
117
        non-HA cluster to an HA one later, but you might need to
118
        export and reimport all your instances to take advantage of
119
        the new features.
118 120
      </para>
119 121

  
120 122
      <para>
......
146 148

  
147 149
    </sect2>
148 150

  
151
    <sect2>
152
      <title>Other required software</title>
153

  
154
      <para>Besides Xen and DRBD, you will need to install the
155
      following:</para>
156

  
157
      <itemizedlist>
158
        <listitem>
159
          <simpara><ulink url="http://sourceware.org/lvm2/">LVM
160
          version 2</ulink></simpara>
161
        </listitem>
162
        <listitem>
163
          <simpara><ulink
164
          url="http://www.openssl.org/">OpenSSL</ulink></simpara>
165
        </listitem>
166
        <listitem>
167
          <simpara><ulink
168
          url="http://www.openssh.com/portable.html">OpenSSH</ulink></simpara>
169
        </listitem>
170
        <listitem>
171
          <simpara><ulink url="http://bridge.sourceforge.net/">Bridge
172
          utilities</ulink></simpara>
173
        </listitem>
174
        <listitem>
175
          <simpara><ulink
176
          url="http://fping.sourceforge.net/">fping</ulink></simpara>
177
        </listitem>
178
        <listitem>
179
          <simpara><ulink
180
          url="http://developer.osdl.org/dev/iproute2">iproute2</ulink></simpara>
181
        </listitem>
182
        <listitem>
183
          <simpara><ulink
184
          url="ftp://ftp.inr.ac.ru/ip-routing/iputils-current.tar.gz">arping</ulink>
185
          (part of iputils package)</simpara>
186
        </listitem>
187
        <listitem>
188
          <simpara><ulink
189
          url="http://www.kernel.org/pub/linux/utils/raid/mdadm/">mdadm</ulink>
190
          (Linux Software Raid tools)</simpara>
191
        </listitem>
192
        <listitem>
193
          <simpara><ulink url="http://www.python.org">Python 2.4</ulink></simpara>
194
        </listitem>
195
        <listitem>
196
          <simpara><ulink url="http://twistedmatrix.com/">Python
197
          Twisted library</ulink> - the core library is
198
          enough</simpara>
199
        </listitem>
200
        <listitem>
201
          <simpara><ulink
202
          url="http://pyopenssl.sourceforge.net/">Python OpenSSL
203
          bindings</ulink></simpara>
204
        </listitem>
205
      </itemizedlist>
206

  
207
      <para>These programs are supplied as part of most Linux
208
      distributions, so usually they can be installed via apt or
209
      similar methods. Also many of them will already be installed on
210
      a standard machine. On Debian Etch you can use this command line
211
      to install all of them:</para>
212

  
213
      <screen>
214
# apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
215
> fping python2.4 python-twisted-core python-pyopenssl openssl
216
      </screen>
217
    </sect2>
218

  
149 219
  </sect1>
150 220

  
151 221

  
......
263 333
    <sect2>
264 334
      <title>Installing the Operating System support packages</title>
265 335

  
266
      <para>Another important component for Ganeti is the OS support packages,
267
        which let different operating systems be used as instances. You can
268
        install them by installing the relevant ganeti-instance-OS package.
336
      <para>
337
        Another important component for Ganeti are the OS support
338
        packages, which let different operating systems be used as
339
        instances. You can grab a simple package that allows
340
        installing Debian Etch instances on the project web site
341
        (after download, untar it and follow the instructions in the
342
        <filename>README</filename> file).
343
      </para>
344

  
345
      <para>
346
        Alternatively, you can create your own OS definitions, see
347
        <citerefentry>
348
        <refentrytitle>ganeti-os-interface</refentrytitle>
349
        <manvolnum>8</manvolnum>
350
        </citerefentry>.
269 351
      </para>
270 352

  
271 353
    </sect2>

Also available in: Unified diff