slight improvement to docs
[mirror/dsa-wiki.git] / input / howto / install-ganeti.creole
1 == How To Install Ganeti Clusters and Instances ==
2
3 === suppositions ===
4
5 Suppose that there are two identical hosts: foo.debian.org and bar.debian.org.
6
7 They are running squeeze and have been integrated into Debian infrastructure.
8
9 They will serve as nodes in a ganeti cluster named foobar.debian.org.
10
11 They have a RAID1 array exposing three partitions: c0d0p1 for /, c0d0p2 for
12 swap and c0d0p3 for lvm volume groups to be used by ganeti via drbd.
13
14 They have two network interfaces: eth0 (public) and eth1 (private).
15
16 The public network is A.B.C.0/24 with gateway A.B.C.254.
17
18 The private network is E.F.G.0/24 with no gateway.
19
20 Suppose that the first instance to be hosted on foobar.debian.org is
21 qux.debian.org.
22
23 The following DNS records exist:
24
25 {{{
26     foobar.debian.org.                  IN A   A.B.C.1
27     foo.debian.org.                     IN A   A.B.C.2
28     bar.debian.org.                     IN A   A.B.C.3
29     qux.debian.org.                     IN A   A.B.C.4
30     foo.debprivate-hoster.debian.org.   IN A   E.F.G.2
31     bar.debprivate-hoster.debian.org.   IN A   E.F.G.3
32 }}}
33
34 === install required packages ===
35
36 On each node, install the required packages:
37
38 {{{
39     apt-get install fai-client ssed extlinux
40     apt-get install -t squeeze-backports drbd8-utils ganeti2 ganeti-instance-debootstrap ganeti-htools
41 }}}
42
43 === configure kernel modules ===
44
45 On each node, ensure that the required kernel modules are loaded at boot:
46
47 {{{
48     ainsl /etc/modules 'drbd minor_count=255 usermode_helper=/bin/true'
49     ainsl /etc/modules 'hmac'
50     ainsl /etc/modules 'tun'
51 }}}
52
53 === configure networking ===
54
55 On each node, ensure that br0 (not eth0) and eth1 are configured.
56
57 The bridge interface, br0, is used by the guest virtual machines to reach the
58 public network.
59
60 If the guest virtual machines need to access the private network, then br1
61 should be configured rather than eth1.
62
63 To prevent the link address changing due to startup/shutdown of virtual
64 machines, explicitly set the value.
65
66 {{{
67     # /etc/networking/interfaces for foo.debian.org
68
69     auto br0
70     iface br0 inet static
71       bridge_ports eth0
72       bridge_maxwait 0
73       bridge_fd 0
74       address A.B.C.2
75       netmask 255.255.255.0
76       gateway A.B.C.254
77       up ip link set addr $(cat /sys/class/net/$IFACE/address) dev $IFACE
78
79     auto eth1
80     iface eth1 inet static
81       address E.F.G.2
82       netmask 255.255.255.0
83 }}}
84
85 {{{
86     # /etc/networking/interfaces for bar.debian.org
87
88     auto br0
89     iface br0 inet static
90       bridge_ports eth0
91       bridge_maxwait 0
92       bridge_fd 0
93       address A.B.C.3
94       netmask 255.255.255.0
95       gateway A.B.C.254
96       up ip link set addr $(cat /sys/class/net/$IFACE/address) dev $IFACE
97
98     auto eth1
99     iface eth1 inet static
100       address E.F.G.3
101       netmask 255.255.255.0
102 }}}
103
104 === configure lvm ===
105
106 On each node, configure lvm to ignore drbd devices and to prefer
107 {{{/dev/cciss}}} devices names over {{{/dev/block}}} device names
108 ([[http://code.google.com/p/ganeti/issues/detail?id=93|why?]]):
109
110 {{{
111     ssed -i \
112       -e 's#^\(\s*filter\s\).*#\1= [ "a|.*|", "r|/dev/drbd[0-9]+|" ]#' \
113       -e 's#^\(\s*preferred_names\s\).*#\1= [ "^/dev/dm-*/", "^/dev/cciss/" ]#' \
114       /etc/lvm/lvm.conf
115     service lvm2 restart
116 }}}
117
118 === create lvm volume groups ===
119
120 On each node, create a volume group:
121
122 {{{
123     vgcreate vg_ganeti /dev/cciss/c0d0p3
124 }}}
125
126 === create kvmU symbolic links ===
127
128 On each node, create vmlinuz and initrd symlinks as expected by the kvm
129 hypervisor (not strictly required if all guests will boot from their own
130 kernels):
131
132 {{{
133     ln -s -T /boot/vmlinuz-2.6.32-5-amd64 /boot/vmlinuz-2.6-kvmU
134     ln -s -T /boot/initrd.img-2.6.32-5-amd64 /boot/initrd.img-2.6-kvmU
135 }}}
136
137 === exchange ssh keys ===
138
139 ipsum loren bacon puppet: the ssh keys for nodes must be added to root:/etc/.ssh/authorized_keys (or /etc/ssh/keys/root) on all nodes; puppet can handle this (poorly; needs improvement)
140
141 === configure iptables (via ferm) ===
142
143 ipsum loren bacon puppet: the nodes must connect to each other over the private network for drbd purposes; puppet can handle this (poorly; needs improvement)
144
145 === instantiate the cluster ===
146
147 On the master node (foo) only:
148
149 {{{
150     gnt-cluster init \
151       --master-netdev br0 \
152       --vg-name vg_ganeti \
153       --secondary-ip E.F.G.2 \
154       --enabled-hypervisors kvm \
155       --nic-parameters link=br0 \
156       --mac-prefix 00:16:37 \
157       --no-ssh-init \
158       --no-etc-hosts \
159       --hypervisor-parameters kvm:initrd_path=/boot/initrd.img-2.6-kvmU,kernel_path=/boot/vmlinuz-2.6-kvmU \
160       foobar.debian.org
161 }}}
162
163 Note the following:
164
165 * the master network device is set to br0, matching the public network bridge interface created above
166 * the volume group is set to vg_ganeti, matching the volume group created above
167 * the secondary IP address is set to the value of the master node's interface on the private network
168 * the nic parameters for instances is set to use br0 as default bridge
169 * the MAC prefix is registered in the dsa-kvm git repo
170
171 === add slave nodes ===
172
173 For each slave node (only bar for this example), on the master node (foo):
174
175 {{{
176     gnt-node add \
177       --secondary-ip E.F.G.3 \
178       --no-ssh-key-check \
179       --no-node-setup \
180       bar.debian.org
181 }}}
182
183 Note the following:
184
185 * the secondary IP address is set to the value of the slave node's interface on the private network
186
187 === verify cluster ===
188
189 On the master node (foo):
190
191 {{{
192     gnt-cluster verify
193 }}}
194
195 If everything has been configured correctly, no errors should be reported.
196
197 === create the 'dsa' variant ===
198
199 ipsum loren bacon deboostrap+dsa
200
201 * create /etc/ganeti/instance-debootstrap/variants/dsa.conf
202 * add 'dsa' to /etc/ganeti/instance-debootstrap/variants.list
203 * obtain ??-dsa-* from tristano:/etc/ganeti/instance-debootstrap/hooks
204
205 ----
206
207 == How To Install Ganeti Instances ==
208
209 Suppose that qux.debian.org will be an instance (a virtual machine) hosted on
210 the foobar.debian.org ganeti cluster.
211
212 Before adding the instance, an LDAP entry must be created so that an A record
213 for the instance (A.B.C.4) exists.
214
215 === create the instance ===
216
217 On the master node (foo):
218
219 {{{
220     gnt-instance add \
221       --node foo:bar \
222       --disk-template drbd \
223       --os-size 4GiB \
224       --os-type debootstrap+dsa \
225       --hypervisor-parameters kvm:initrd_path=,kernel_path= \
226       --net 0:ip=A.B.C.4 \
227       qux.debian.org
228 }}}
229
230 Note the following:
231
232 * the primary and secondary nodes have been explicitly set
233 * the operating system type is 'debootstrap+dsa'
234 * the network interfarce 0 (eth1 on the system) is set to the instance's interface on the public network
235
236 ----
237
238 == Variations ==
239
240 If the instances require access to the private network, then there are two modifications necessary.
241
242 === re-configure networking ===
243
244 Ensure that br1 is configured (rather than eth1).
245
246 {{{
247     # /etc/networking/interfaces for foo.debian.org
248
249     auto br0
250     iface br0 inet static
251       bridge_ports eth0
252       bridge_maxwait 0
253       bridge_fd 0
254       address A.B.C.2
255       netmask 255.255.255.0
256       gateway A.B.C.254
257       up ip link set addr $(cat /sys/class/net/$IFACE/address) dev $IFACE
258
259     auto br1
260     iface br1 inet static
261       bridge_ports eth1
262       bridge_maxwait 0
263       bridge_fd 0
264       address E.F.G.2
265       netmask 255.255.255.0
266       up ip link set addr $(cat /sys/class/net/$IFACE/address) dev $IFACE
267 }}}
268
269 === create or update the instance  ===
270
271 When creating the instance, indicate both netwokrs:
272
273 {{{
274     gnt-instance add \
275       --node foo:bar \
276       --disk-template drbd \
277       --os-size 4GiB \
278       --os-type debootstrap+dsa \
279       --hypervisor-parameters kvm:initrd_path=,kernel_path= \
280       --net 0:ip=A.B.C.4,1:ip=E.F.G.4 \
281       qux.debian.org
282 }}}
283
284 Please note that the dsa bootscript will only configure eth1 (nic0).  If
285 specifying a second internface, the guest operating system must be updated
286 manually.
287
288 When updating an existing instance, add the interface:
289
290 {{{
291     gnt-instance shutdown qux.debian.org
292     gnt-instance modify \
293       --net add:ip=E.F.G.4 \
294       qux.debian.org
295     gnt-instance startup qux.debian.org
296 }}}
297
298 Please note that the hook scripts are run only at instance instantiation.  When
299 adding interfaces to an instance, the guest opearting system must be updated
300 manually.
301